jmhc/hyperf-api

Hyperf restful api.

Maintainers

Details

github.com/jumihc-company/hyperf-api

Homepage

Source

Issues

Installs: 42

Dependents: 0

Suggesters: 0

Security: 0

Stars: 4

Watchers: 3

Forks: 0

Open Issues: 0

dev-master 2020-04-07 10:00 UTC

Requires

MIT b58e4e211551fe17a6bddc130c43e2b4c0b4d210

  • jumihc <jumihuchuang.woop@126.com>

apirestfulhyperfjmhc

This package is auto-updated.

Last update: 2024-04-07 19:02:27 UTC

README

安装配置

使用以下命令安装：

composer require jmhc/hyperf-api

发布文件：

// 发布所有文件
php bin/hyperf.php vendor:publish jmhc/hyperf-api
// 发布 Translation 组件的文件
php bin/hyperf.php vendor:publish hyperf/translation
// 发布验证器组件的文件
php bin/hyperf.php vendor:publish hyperf/validation

使用说明

环境变量值参考：env

restful参考: restful

快速使用

  1. 安装
  2. 发布配置
  3. 注册中间件
  4. 继承异常处理程序

中间件

  • 必须注册全局中间件 Jmhc\Restful\Middleware\ParamsHandlerMiddleware
  • 可选中间件查看 中间件列表

异常处理

  • 修改 App\Exceptions\Handler 继承的方法为 Jmhc\Restful\Handlers\ExceptionHandler
  • 其他异常捕获调用父类 response() 方法并重写，参考 Jmhc\Restful\Handlers\ExceptionHandler->response()

控制器

  • 直接继承 Jmhc\Restful\Controllers\BaseController

模型

  • 可选继承 Jmhc\Restful\Models\BaseModel 、 Jmhc\Restful\Models\BasePivot 、 Jmhc\Restful\Models\UserModel 、Jmhc\Restful\Models\VersionModel

服务层(逻辑层)

  • 直接继承 Jmhc\Restful\Services\BaseService

控制器

需继承 Jmhc\Restful\Controllers\BaseController

  • 可使用 Jmhc\Restful\Traits\RequestInfoTrait 里的参数
  • 可使用 Jmhc\Restful\Traits\UserInfoTrait 里的参数、方法
  • 可使用 Jmhc\Restful\Traits\ResourceController 里的方法

模型

普通模型

需继承 Jmhc\Restful\Models\BaseModel

  • 可使用 Jmhc\Restful\Traits\ModelTrait 里的方法

中间表模型

需继承 Jmhc\Restful\Models\BasePivot

  • 可使用 Jmhc\Restful\Traits\ModelTrait 里的方法

mongodb模型

需继承 Jmhc\Restful\Models\BaseMongo

使用前需配置，参考 配置

  • 可使用 Jmhc\Restful\Traits\ModelTrait 里的方法

服务层(逻辑层)

需继承 Jmhc\Restful\Services\BaseService

  • 可使用 Jmhc\Restful\Traits\RequestInfoTrait 里的参数
  • 可使用 Jmhc\Restful\Traits\UserInfoTrait 里的参数、方法
  • 可使用 Jmhc\Restful\Traits\ResourceService 里的方法
class TestController extends BaseController
{
    /**
     * @Inject()
     * @var TestService
     */
    protected $service;
    
    public function index()
    {
    	$this->request->params->a = 'a';
    	// 当初始化实例化service后，方法中有更新$this->request->params时,应当调用服务层updateAttribute方法更新$this->request->params
    	$this->service->updateAttribute()->index();
    }
    
    public function index()
    {
    	// 当初始化实例化service后，方法中无更新$this->request->params
    	$this->service->index();
    }
}

命令行

创建控制器

创建的控制器默认继承基础控制器 BaseController

--controller-extends-custom 参数修改继承基础控制器

// 创建 Test 控制器位于 app/Http/Controllers/Test.php
php bin/hyperf.php jmhc-api:make-controller test
// 创建 Test 控制器修改继承父类
php bin/hyperf.php jmhc-api:make-controller test --controller-extends-custom App/BaseController
// 创建 Test 控制器并添加后缀，位于 app/Http/Controllers/TestController.php
php bin/hyperf.php jmhc-api:make-controller test -s
// 创建 Test 控制器位于 app/Http/Index/Controllers/Test.php
php bin/hyperf.php jmhc-api:make-controller test -m index
...

创建服务层(逻辑层)

创建的服务默认继承基础服务 BaseService

--service-extends-custom 参数修改继承基础服务

// 创建 Test 服务位于 app/Http/Services/Test.php
php bin/hyperf.php jmhc-api:make-service test
// 创建 Test 服务修改继承父类
php bin/hyperf.php jmhc-api:make-service test --service-extends-custom App\BaseService
// 创建 Test 服务并添加后缀，位于 app/Http/Services/TestService.php
php bin/hyperf.php jmhc-api:make-service test -s
// 创建 Test 服务位于 app/Http/Index/Services/Test.php
php bin/hyperf.php jmhc-api:make-service test -m index
...

创建模型

不传 name 将会从数据库读取所有表创建

--model-extends-custom 参数修改继承基础模型

// 创建公用模型位于 app/Common/Models 并排除 test，foos 表
php bin/hyperf.php jmhc-api:make-model --dir Common/Models -t test -t foos
// 创建 Test 模型位于 app/Http/Models/Test.php
php bin/hyperf.php jmhc-api:make-model test
// 创建 Test 模型修改继承父类
php bin/hyperf.php jmhc-api:make-model test --model-extends-custom App\BaseModel
// 创建 Test 服务并添加后缀，位于 app/Http/Models/TestModel.php
php bin/hyperf.php jmhc-api:make-model test -s
// 创建 Test 模型位于 app/Http/Index/Models/Test.php
php bin/hyperf.php jmhc-api:make-model test -m index
...

通过文件创建所需文件

此命令通过 config('jmhc-build-file') 获取需要创建的文件名称

使用 *-extends-custom 修改对应继承父类

// 生成控制器、模型、服务、迁移、填充
php bin/hyperf.php jmhc-api:make-with-file --controller --model --service --migration
// 覆盖生成所有文件
php bin/hyperf.php jmhc-api:make-with-file -f
// 覆盖生成控制器
php bin/hyperf.php jmhc-api:make-with-file --force-controller
...

生成工厂文件

// 通过指定目录创建factory,位于 app/Http/Common/Factory/Service.php
php bin/hyperf.php jmhc-api:make-factory service --scan-dir Http/Services --scan-dir Http/Index/Services

// 通过指定目录创建factory,并增加后缀、保存至其他路径,位于 app/Http/Commons/Factory/ServiceFactory.php
php bin/hyperf.php jmhc-api:make-factory service --scan-dir Http/Services --dir Commons/Factory -s
...

维护模式

// 开启维护模式
php bin/hyperf.php jmhc-api:down

// 开启维护模式，并设置维护消息
php bin/hyperf.php jmhc-api:down --message 服务器维护中

// 关闭维护模式
php bin/hyperf.php jmhc-api:up

中间件

用法加粗为必须调用

中间件 用法 需要实现的契约或继承模型
Jmhc\Restful\Middleware\CorsMiddleware 允许跨域 ---
Jmhc\Restful\Middleware\ParamsHandlerMiddleware 参数处理 ---
Jmhc\Restful\Middleware\ConvertEmptyStringsToNullMiddleware 转换空字符串为null ---
Jmhc\Restful\Middleware\TrimStringsMiddleware 清除字符串空格 ---
Jmhc\Restful\Middleware\RequestLockMiddleware 请求锁定 ---
Jmhc\Restful\Middleware\RequestLogMiddleware 记录请求日志(debug) ---
Jmhc\Restful\Middleware\RequestPlatformMiddleware 设置请求平台，参考Jmhc\Restful\PlatformInfo ---
Jmhc\Restful\Middleware\CheckVersionMiddleware 检测应用版本 Jmhc\Restful\Contracts\VersionModelInterface
Jmhc\Restful\Models\VersionModel
Jmhc\Restful\Middleware\CheckSignatureMiddleware 验证请求签名 ---
Jmhc\Restful\Middleware\CheckTokenMiddleware 检测token，设置用户数据 Jmhc\Restful\Contracts\UserModelInterface
Jmhc\Restful\Models\UserModel
Jmhc\Restful\Middleware\CheckSdlMiddleware 单设备登录，需要复写 Jmhc\Restful\Handlers\ExceptionHandler->sdlHandler() ---
Jmhc\Restful\Middleware\CheckForMaintenanceModeMiddleware 检测维护模式 使用维护命令时需启用此中间件

异常处理

App\Exceptions\Handler 继承 Jmhc\Restful\Handlers\ExceptionHandler

其他异常捕获调用父类 response() 方法并重写，参考 Jmhc\Restful\Handlers\ExceptionHandler->response()

验证规则

Images

Jmhc\Restful\Rules\ImagesRule

验证图片字段后缀地址为 jpeg , jpg , png , bmp , gif , svg , webp

如：

1.png // true
1.pn // false
1.png,2.png // true

模型作用域

主键字段倒序

Jmhc\Restful\Scopes\PrimaryKeyDescScope

Jmhc\Restful\Models\BaseModel 已默认注册此全局作用域

trait介绍

InstanceTrait.php

Jmhc\Restful\Traits\InstanceTrait

单例类 trait

// 无构造参数使用
T::getInstance()->a();

// 有构造参数使用，c为构造参数名称
T::getInstance([
    'c' => ['a']
])->a();

ModelTrait.php

Jmhc\Restful\Traits\ModelTrait

模型辅助 trait

使用类:

  • Jmhc\Restful\Models\BaseModel
  • Jmhc\Restful\Models\BasePivot

RequestInfoTrait.php

Jmhc\Restful\Traits\RequestInfoTrait

请求信息绑定

使用类:

  • Jmhc\Restful\Controllers\BaseController
  • Jmhc\Restful\Services\BaseService

ResultThrowTrait.php

Jmhc\Restful\Traits\ResultThrowTrait

异常抛出辅助

UserInfoTrait.php

Jmhc\Restful\Traits\UserInfoTrait

用户信息绑定

使用类:

  • Jmhc\Restful\Controllers\BaseController
  • Jmhc\Restful\Services\BaseService

工具类介绍

Collection.php

Jmhc\Restful\Utils\Collection

集合，基于 Illuminate\Support\Collection

  • 修改__get 魔术方法
  • 新增__set , __isset , __unset 魔术方法

DbHelper.php

Jmhc\Restful\Utils\DbHelper

数据库辅助方法

// 返回所有表名
make(DbHelper::class)->getAllTables();

// 返回 mysql 链接下 users 表字段数据
make(DbHelper::class, [
    'name' => 'mysql'
])->getAllColumns('users');

Dispatch.php

Jmhc\Restful\Utils\Dispatch

获取当前请求类

// dispatch 实例
$dispatch = make(Dispatch::class, [
    'request' => $request,
]);
// 获取调用 class
$dispatch->getClass();
// 获取调用 method
$dispatch->getMethod();

FileSize.php

Jmhc\Restful\Utils\FileSize

转换文件尺寸

// 返回 2097152 字节
FileSize::get('2m');

// 返回 2147483648 字节
FileSize::get('2g');

Log.php

Jmhc\Restful\Utils\Log

文件日志保存

  • debug 日志受环境变量 LOG_DEBUG 控制

Sdl.php

Jmhc\Restful\Utils\Sdl

单设备登录类

Token.php

Jmhc\Restful\Utils\Token

令牌相关类