Hyperf入门

Hyperf入门

    概述

    摘取一段Hyperf官网上对自己的描述：

    Hyperf将超高速和灵活性作为自己的基因，Hyperspeed + Flexibility = Hyperf

    Hyperf框架初衷是作为一个真正为PHP微服务铺路的框架。

    最近公司的项目，在技术选型上采用hyperf来实现，借此机会我也体验了一把基于微服务的理念来做开发。

    安装

    因为还需要使用到redis、mongodb、mysql，为了方便，我是通过yaml文件来安装的，下面贴出来供大家参考：

version: "3"

services:
  redis:
    image: redis:6.2.1
    container_name: hyperf-redis
    restart: always
    privileged: true
    # environment:
    #   - TZ=Asia/Shanghai
    ports:
      - "26379:6379"
    networks:
      internal:
        ipv4_address: 172.25.2.2
  mysql:
    image: mariadb:10.3.28
    container_name: hyperf-mysql
    restart: always
    privileged: true
    environment:
      MYSQL_ROOT_PASSWORD: "123456"
    ports:
      - "23306:3306"
    volumes:
      - /root/hyperf/data/mysql:/var/lib/mysql:rw
    networks:
      internal:
        ipv4_address: 172.25.2.3
  mongo:
    image: mongo:4.4
    container_name: hyperf-mongo
    restart: always
    privileged: true
    # environment:
    #   MONGO_INITDB_ROOT_USERNAME: 'root'
    #   MONGO_INITDB_ROOT_PASSWORD: '123456'
    ports:
      - "27017:27017"
    volumes:
      - /root/hyperf/data/mongo:/data/db:rw
    networks:
      internal:
        ipv4_address: 172.25.2.4
  hyperf:
    image: 569529989/hyperf:7.3-alpine-v3.11-swoole-mongo
    container_name: hyperf-skeleton
    privileged: true
    environment:
      - APP_PROJECT=hyperf
      - APP_ENV=test
    ports:
      - "29501:9501"
    volumes:
      - /root/hyperf/data/project:/data/project
    networks:
      internal:
         ipv4_address: 172.25.2.5
    tty: true
    entrypoint:
      - /bin/sh
#    depends_on:
#      - mysql
#      - mongo
#      - redis
networks:
  internal:
    driver: bridge
    ipam:
      config:
      - subnet: 172.25.2.0/24

      有一点要说明的是：

      因为hyperf官方的镜像：hyperf/hyperf:7.4-alpine-v3.11-swoole，这个PHP镜像中安装的扩展很少，主要是为了减少镜像的大小。

      但是我们日常使用php，会用到很多初始镜像内不存在的扩展，比如我这里还需要用到mongodb扩展。于是我在官方的镜像基础上打的包 +mongo扩展，制作了一个新的镜像。

     目录结构

      1、整体结构

     

     2、配置文件结构

    

     那么是如何读取配置呢？

     config/config.php中

<?php

declare(strict_types=1);
use Hyperf\Contract\StdoutLoggerInterface;
use Psr\Log\LogLevel;

return [
    'app_name' => env('APP_NAME', 'skeleton'),
    'app' => [
        'name_space' => env('NAME_SPACE', 'App\Controller')
    ],
];


// 读取配置的其中一种方式为：config('app.name_space')

    如果上面的文件绝对路径为：config/autoload/client.php，那么获取的代码为：config('client.app.name_space')

    3、app的目录结构

    

    微服务

    这里有一个原则：

    所有调用的服务都应该放在 service 里面去调用 ，而不是在控制器里面直接调用 model或者logic，也不是在中间件里面直接调用model或者logic   

     

     下面贴一段示例代码：

 AuthServiceInterface.php

<?php
namespace App\Service\V1\Auth;


interface AuthServiceInterface
{
    // 鉴权
    public function checkAccess(string $route, int $uid): array;

    // 获取所有定义的路由
    public function getAllDefRoute(): array;

    // 系统权限添加入库
    public function refreshItem(): array;

    // 获取所有的角色/路由/权限列表
    public function getItemList(array $data): array;
}

    AuthService.php

<?php

namespace App\Service\V1\Auth;

use App\Logic\AuthLogic;
use Hyperf\RpcServer\Annotation\RpcService;

/**
 * @RpcService(name="AuthService", protocol="jsonrpc", server="jsonrpc")
 *
 * Class AuthService
 * @package App\Service\V1
 */
class AuthService implements AuthServiceInterface
{
    // 鉴权
    public function checkAccess(string $route, int $uid): array
    {
        return AuthLogic::checkAccess($route, $uid);
    }

    // 角色/权限-增加
    public function addItem(array $data): array
    {
        return AuthLogic::addItem($data);
    }

    // 角色/权限-删除
    public function deleteItem(string $name): array
    {
        return AuthLogic::deleteItem($name);
    }
}
        

   服务的调用，参考下面代码：

<?php

declare(strict_types=1);

namespace App\Middleware;

class CheckLoginMiddleware implements MiddlewareInterface
{
    // ...

    // 鉴权
    public function checkAccess($uid, $path)
    {
        $authService = new AuthService();
        $accessRes = $authService->checkAccess($path, $uid);
        return $accessRes;
    }
}    

    中间件

     config/autoload/middlewares.php中

     

   说明：比如项目的需求是先检查是否有登录权限，才去进行参数校验，就需要把登录中间件放到参数校验中间件前面去。

   表单请求验证

   对于复杂的验证场景，我们可以创建一个 表单请求(FormRequest)，表单请求是包含验证逻辑的一个自定义请求类。

   啥也不说了，直接贴代码：

   控制器 AuthController.php中

<?php

declare(strict_types=1);

namespace App\Controller\V1;

use App\Constants\ErrorCode;


/**
 * 权限操作模块
 * Class AuthController
 * @package App\Controller\V1
 */
class AuthController extends AbstractController
{
    // ...

    /**
     * 给角色添加路由/权限
     * @param AuthChildRequest $validator
     * @return array
     */
    public function addChild(AuthChildRequest $validator)
    {
        // 参数校验
        $validatedData = $validator->validated();

        // 限流 防止恶意请求
        $uid = $this->request->getAttribute('uid');
        $res = $this->rateLimit(__FUNCTION__ . '_' . $uid);
        if ($res['code'] != 0) {
            return $res;
        }
        // ...  
}    

    表单验证类 AuthChildRequest.php

<?php

declare(strict_types=1);

namespace App\Request\Auth;

use Hyperf\Validation\Request\FormRequest;

class AuthChildRequest extends FormRequest
{
    /**
     * Determine if the user is authorized to make this request.
     */
    public function authorize(): bool
    {
        return true;
    }

    /**
     * Get custom attributes for validator errors.
     */
    public function attributes(): array
    {
        return [
            'parent' => '角色',
            'child' => '路由',
        ];
    }

    /**
     * Get the validation rules that apply to the request.
     */
    public function rules(): array
    {
        return [
            'parent' => 'required|string|max:255',
            'child' => 'required|string', // 多个之间用英文逗号隔开
        ];
    }

    /**
     * 获取已定义验证规则的错误消息
     */
    public function messages(): array
    {
        return [
            'required' => ':attribute必填',
        ];
    }
}

 

 

参考链接：

https://hyperf.wiki/2.1/#/