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/#/