接口控制器


不管是前后台分离,还是 APP 调用接口。所有的入口都是由api/v1/controller等同于api/版本号/控制器组成。

举个例子,比如http://host/api/v1/order_service/method/get.order.service.list

所有的控制器都直接或间接的继承于app\api\controller\CareyShop做为基类。
文件位置application/api/controller/CareyShop.php


控制器:

每一个控制器默认都会绑定一个对应的模型,模型的存放目录是application/common/model
比如App控制器对应的模型也是App,实际导入的文件是application/common/model/App.php,您可以通过static::$model这样的方式在控制器中完成对模型的调用。注意:完成继承的控制器必须要有对应模型,否则会报错。

基类主要完成请求参数验证、整理请求参数、数据初始化、验证身份、验证签名、验证权限、调度方法路由、返回数据结果。
控制器中的调度方法路由是二次开发必定会接触到的,他的定义如下:

可以看到他是一个数组,键名表示业务方法。键值也是一个数组,首位表示成员函数的名称,第二位是附带参数,含义如下:

  • 空:在无值的情况下,首先查找控制器内是否存在成员函数,否则查找对应模型下是否存在成员函数,如果还找不到则报错。
  • false:表明直接在控制器内查找是否存在成员函数,找不到则报错。
  • 命名空间:在指定的命名空间类中查找成员函数,找不到则报错。

模型:

控制器调用模型(或是指定的命名空间类成员函数)后会对函数首位参数进行赋值,值的内容由请求参数传递进来。
所以在模型中类的成员函数定义也分多种。

  1. 不需要参数的成员函数

    1. /**
    2. * 添加或编辑购物车商品
    3. * @access public
    4. * @return false|array
    5. * @throws
    6. */
    7. public function setCartItem()
    8. {
    9. return [];
    10. }
  2. 只需要请求参数的成员函数

    1. /**
    2. * 添加或编辑购物车商品
    3. * @access public
    4. * @param array $data 外部数据
    5. * @return false|array
    6. * @throws
    7. */
    8. public function setCartItem($data)
    9. {
    10. return [];
    11. }
  3. 带有请求参数和自定义参数的成员函数

    1. /**
    2. * 添加或编辑购物车商品
    3. * @access public
    4. * @param array $data 外部数据
    5. * @param bool $isBuyNow 是否立即购买
    6. * @return false|array
    7. * @throws
    8. */
    9. public function setCartItem($data, $isBuyNow = false)
    10. {
    11. return [];
    12. }

只要成员函数带有参数,那么第一个参数必定是属于请求参数,他是一个数组。
添加其他参数可以是任意类型,这个特点可以在框架内部调用时十分方便。

文档更新时间: 2018-07-06 13:51