快速入门

    Hyperf 使用 nikic/fast-route 作为默认的路由组件并提供服务,您可以很方便的在 config/routes.php 中定义您的路由。不仅如此,框架还提供了极其强大和方便灵活的注解路由功能,关于路由的详情文档请查阅 章节

    路由的文件位于 hyperf-skeleton 项目的 config/routes.php ,下面是一些常用的用法示例。

    通过注解来定义路由

    Hyperf 提供了极其强大和方便灵活的 注解 功能,在路由的定义上也毫无疑问地提供了注解定义的方式,Hyperf 提供了 @Controller@AutoController 两种注解来定义一个 Controller,此处仅做简单的说明,更多细节请查阅 章节。

    @AutoController 为绝大多数简单的访问场景提供路由绑定支持,使用 @AutoController 时则 Hyperf 会自动解析所在类的所有 public 方法并提供 GETPOST 两种请求方式。

    1. <?php
    2. declare(strict_types=1);
    3. namespace App\Controller;
    4. use Hyperf\HttpServer\Contract\RequestInterface;
    5. use Hyperf\HttpServer\Annotation\AutoController;
    6. /**
    7. * @AutoController()
    8. */
    9. class IndexController
    10. {
    11. // Hyperf 会自动为此方法生成一个 /index/index 的路由,允许通过 GET 或 POST 方式请求
    12. public function index(RequestInterface $request)
    13. // 从请求中获得 id 参数
    14. $id = $request->input('id', 1);
    15. return (string)$id;
    16. }
    17. }

    通过 @Controller 注解定义路由

    @Controller 为满足更细致的路由定义需求而存在,使用 @Controller 注解用于表名当前类为一个 Controller类,同时需配合 @RequestMapping 注解来对请求方法和请求路径进行更详细的定义。我们也提供了多种快速便捷的 Mapping注解,如 @GetMapping@PostMapping@PutMapping@PatchMapping@DeleteMapping 5种便捷的注解用于表明允许不同的请求方法。

    Hyperf 是完全开放的,本质上没有规定您必须基于某种模式下去实现请求的处理,您可以采用传统的 MVC模式,亦可以采用 RequestHandler模式 来进行开发。我们以 MVC模式 来举个例子:在 app 文件夹内创建一个 Controller 文件夹并创建 IndexController.php 如下,index 方法内从请求中获取了 id 参数,并转换为 字符串 类型返回到客户端。

    1. <?php
    2. declare(strict_types=1);
    3. namespace App\Controller;
    4. use Hyperf\HttpServer\Contract\RequestInterface;
    5. use Hyperf\HttpServer\Annotation\AutoController;
    6. /**
    7. * @AutoController()
    8. */
    9. class IndexController
    10. {
    11. // Hyperf 会自动为此方法生成一个 /index/index 的路由,允许通过 GET 或 POST 方式请求
    12. public function index(RequestInterface $request)
    13. {
    14. // 从请求中获得 id 参数
    15. $id = $request->input('id', 1);
    16. // 转换 $id 为字符串格式并以 plain/text 的 Content-Type 返回 $id 的值给客户端
    17. return (string)$id;
    18. }

    依赖自动注入是 Hyperf 提供的一个非常强大的功能,也是保持框架灵活性的根基。Hyperf 提供了两种注入方式,一种是大家常见的通过构造函数注入,另一种是通过 @Inject 注解注入,下面我们举个例子并分别以两种方式展示注入的实现;假设我们存在一个 \App\Service\UserService 类,类中存在一个 getInfoById(int $id) 方法通过传递一个 id 并最终返回一个用户实体,由于返回值并不是我们这里所需要关注的,所以不做过多阐述,我们要关注的是在任意的类中获取 UserService 并调用里面的方法,一般的方法是通过 new UserService() 来实例化该服务类,但在 Hyperf 下,我们有更优的解决方法。

    通过 @Inject 注解注入

    只需对对应的类属性通过 @var 声明参数的类型,并使用 @Inject 注解标记属性 ,Hyperf 会自动注入对应的对象或值。

    1. <?php
    2. declare(strict_types=1);
    3. namespace App\Controller;
    4. use Hyperf\HttpServer\Contract\RequestInterface;
    5. use Hyperf\HttpServer\Annotation\AutoController;
    6. use Hyperf\Di\Annotation\Inject;
    7. use App\Service\UserService;
    8. /**
    9. * @AutoController()
    10. */
    11. class IndexController
    12. {
    13. /**
    14. * @Inject()
    15. * @var UserService
    16. */
    17. private $userService;
    18. // /index/info
    19. public function info(RequestInterface $request)
    20. {
    21. $id = $request->input('id', 1);
    22. return $this->userService->getInfoById((int)$id);
    23. }

    通过上面的示例我们不难发现 $userService 在没有实例化的情况下, 属性对应的类对象被自动注入了。不过这里的案例并未真正体现出依赖自动注入的好处及其强大之处,我们假设一下 UserService 也存在很多的依赖,而这些依赖同时又存在很多其它的依赖时,new 实例化的方式就需要手动实例化很多的对象并调整好对应的参数位,而在 Hyperf 里我们就无须手动管理这些依赖,只需要声明一下最终使用的类即可。而当 UserService 需要发生替换等剧烈的内部变化时,比如从一个本地服务替换成了一个 RPC 远程服务,也只需要通过配置调整依赖中 UserService 这个键值对应的类为新的RPC服务类即可。

    由于 Hyperf 内置了协程服务器,也就意味着 Hyperf 将以 CLI 的形式去运行,所以在定义好路由及实际的逻辑代码之后,我们需要在项目根目录并通过命令行运行 php bin/hyperf.php start 来启动服务。当 Console 界面显示服务启动后便可通过 cURL 或 浏览器对服务正常发起访问了。