控制器 Controller

    主要通过 @Controller + @RequestMapping 注解实现，通常前者定义 前缀，后者定义 后缀

    • 如下, 访问 index() 的路由是 /users/list (/users + list)

    类注解，设置在 Controller 类上，标记当前类是一个http控制器类

    • 显式指定路由前缀: @Controller(prefix="/route") 或 @Controller("/route")
    • 隐式指定路由前缀: @Controller() 默认自动解析 controller class 的名称，并且使用驼峰格式。

    比如:

    1. // file: app/Admin/HttpClientController.php
    3. /**
    4.  * @Controller()
    5.  */
    6. class HttpClientController
    7. {}

    上面的controller解析时，将会设置路由 prefix 为 httpClient，注意此操作不会解析文件夹，例如该 Controller 位于 app/Admin/HttpClientController.php，最终设置的路由 prefix 仍然为 httpClient。

    方法注解，用于控制类的Action方法上。

    1. /**
    2.  * @RequestMapping(route, method)
    3.  */
    4.  public function some() {}
    • route 设置路由path，也是默认参数。
    • method 设置允许的请求方法，可以多个。 e.g. GET POST。

    示例:

    • 显式指定路由后缀: @RequestMapping(route="index")或 @RequestMapping("index")
    • 隐式指定路由后缀: 不使用 @RequestMapping 或者使用 @RequestMapping(), 默认解析方法名为后缀
    • 限定HTTP方法: @RequestMapping(route="index", method=RequestMethod::GET) 指定路由支持的HTTP方法，默认是支持GET和POST
      • 比如 method={RequestMethod::POST,RequestMethod::PUT} 设置路由支持 POST 和 PUT

    使用说明

    • 通常一个完整的路由path等于 Controller的prefix + Action的route
    • 当你的action上的路由以 / 开头时，那完整的路由就是它，即不会再将 prefix 添加到它的前面。
    • 请切记要引入相关的注解类
    1. use Swoft\Http\Server\Bean\Annotation\Controller;
    2. use Swoft\Http\Server\Bean\Annotation\RequestMapping;
    3. use Swoft\Http\Server\Bean\Annotation\RequestMethod;

    可以通过命令行命令快速创建控制器类，以方便快速开发使用。

    1. // Gen DemoController class to `@app/Controllers`
    2. php bin/swoft gen:controller demo --prefix /demo -y
    4. // Gen UserController class to `@app/Controllers`(RESTFul 风格，会默认创建一些action)
    5. php bin/swoft gen:controller user --prefix /users --rest

    示例

    常用方法可以参考 Swoft项目 的 app/Controllers/RouteController.php:

    Swoft HTTP服务中的 Request，是对 基于 PSR-7 标准的封装，常用方法可以参考 app/Controllers/DemoController.php:

    1.  public function index(Request $request)
    2. {
    3.     // 获取所有GET参数
    4.     $get = $request->query();
    5.     // 获取name参数默认值defaultName
    6.     $getName = $request->query('name', 'defaultName');
    7.     // 获取所有POST参数
    8.     $post = $request->post();
    9.     // 获取name参数默认值defaultName
    10.     $postName = $request->post('name', 'defaultName');
    11.     // 获取所有参，包括GET或POST
    12.     $inputs = $request->input();
    13.     // 获取name参数默认值defaultName
    14.     $inputName = $request->input('name', 'defaultName');
    16.     return compact('get', 'getName', 'post', 'postName', 'inputs', 'inputName');
    17. }

    注意: 对 HTTP Request 进行了封装，不能像以往一样使用 $_POST / $_GET 等全局变量，也不推荐这样的使用方式，框架层通常都做了更好的封装和兼容，比如 $_POST 无法取到 application/json 格式的数据

    响应 Response

    当 Action 返回一个 array 或 Arrayable 对象，Response 将根据 Request Header 的 Accept 来返回数据，目前支持 View / Json / Raw

    可以参考 app/Controllers/IndexController.php:

    1. /**
    2.  * @RequestMapping("/")
    3.  * @View(template="index/index")
    4.  * @return array
    5. public function index(): array
    6. {
    7.     $name = 'Swoft';
    8.     $notes = [
    9.         'New Generation of PHP Framework',
    10.         'High Performance, Coroutine and Full Stack'
    11.     ];
    12.     $links = [
    13.         [
    14.             'name' => 'Home',
    15.             'link' => 'http://www.swoft.org',
    16.         ],
    17.         [
    18.             'name' => 'Documentation',
    19.             'link' => 'http://doc.swoft.org',
    20.         ],
    21.         [
    22.             'name' => 'Issue',
    23.             'link' => 'https://github.com/swoft-cloud/swoft/issues',
    24.         ],
    25.         [
    26.             'name' => 'GitHub',
    27.             'link' => 'https://github.com/swoft-cloud/swoft',
    28.         ],
    29.     ];
    30.     // 返回一个 array 或 Arrayable 对象，Response 将根据 Request Header 的 Accept 来返回数据，目前支持 View, Json, Raw
    31.     return compact('name', 'notes', 'links');
    32. }
    • 基本数据类型: bool int float(double) string
    • array
    • \Swoft\Contract\Arrayable 对象
    • XxxException: 在 Controller 内抛出异常将由 ExceptionHandler 捕获并进行处理, 4xx/5xx 的状态码也是通过抛异常, 然后由 ExceptionHandler 捕获并统一进行处理

    可以通过 @View 注解 或 view() 帮助函数来使用视图, 可以参考 app/Controllers/IndexController.php

    • 约定大于配置, 路由应该在用户看到 URI 的时候, 就能找到相应的 Controller/Action

    其他

    Controller 中也可以使用 Bean 相关的方法

    其他注解方法, 比如 @Inject，参考 Bean容器