README

面向 Laravel 9 / 10 / 11 / 12 的辅助开发工具集：脚手架、数据仓库、统一响应、异常处理与三方集成。

命名空间为 Readfly\Laravel，运行时零外部工具库依赖，三方 SDK 按需引入。

特性

一条命令生成 Model / Repository / Service / Hook / Cacher / Controller / Request / Migration / Route
支持 --fields 声明字段，自动生成迁移字段、模型 cast 与请求校验规则
数据仓库全部使用参数绑定，修复原版 like 与排序中的 SQL 拼接风险
统一响应结构（state/code/msg/data/extras），可选 locale/consuming/request_id
真实可用的全局中间件：请求 ID、CORS 预检、异常统一 JSON 渲染、响应耗时
微信（公众号 / 小程序）、抖音小程序、阿里云短信统一封装，可选依赖缺失时给出明确提示
阿里云 OSS / 七牛云 OSS 上传统一封装：服务端上传、文件上传、删除、存在性、URL 与前端直传签名
兼容 Laravel 9-12 的自动发现（package discovery）与手动注册

环境要求

依赖	版本
PHP	>= 8.1
Laravel	9.x / 10.x / 11.x / 12.x
Composer	2.x

安装

包名 readfly/laravel：

composer require readfly/laravel

Laravel 会自动发现服务提供者。若关闭了自动发现，手动注册：

// config/app.php（Laravel 9/10）
'providers' => [
    Readfly\Laravel\LaravelToolkitServiceProvider::class,
],

// bootstrap/providers.php（Laravel 11+）
return [
    Readfly\Laravel\LaravelToolkitServiceProvider::class,
];

发布配置：

php artisan vendor:publish --tag=toolkit-config

初始化（生成签名 / AES 密钥、应用版本号，创建 storage 软链）：

php artisan builder:laravel --domain=api.example.com

注册中间件

Laravel 10：

// app/Http/Kernel.php
protected $middleware = [
    // ...
    \Readfly\Laravel\Http\Middleware\BasicLaravelMiddleware::class,
];

Laravel 11+：

// bootstrap/app.php
->withMiddleware(function (Middleware $middleware) {
    $middleware->append(\Readfly\Laravel\Http\Middleware\BasicLaravelMiddleware::class);
})

中间件行为由 config/toolkit.php 的 middleware 节点控制。

命令

builder:package

php artisan builder:package users \
  --desc="用户信息表" \
  --dictionary=api/v1 \
  --fields="name:string(64):用户名称;email:?email:邮箱;age:int:年龄=0;meta:?json:扩展信息" \
  --index=email --unique=email \
  --migration --cache --controller --request --route

生成：

app/Models/Api/V1/User.php
app/Repository/Api/V1/UserRepository.php
app/Services/Api/V1/UserService.php
app/Hooks/Api/V1/UserHook.php
app/Caches/Api/V1/UserCacher.php
app/Http/Controllers/Api/V1/UserController.php
app/Http/Requests/Api/V1/UserRequest.php
database/migrations/api/2026_11_06_000000_create_api_v1_user_table.php
routes/generated/users.php

迁移文件位于 database/migrations/<目录> 子目录，执行时需指定路径：

php artisan migrate --path=database/migrations/api

路由片段不会自动注册，按提示在 routes/api.php 中引入即可。

字段语法

字段名:类型(参数):注释:默认值:是否可空
字段名:类型(参数):注释=默认值

示例：

定义	生成
`name:string(64):名称`	`$table->string('name', 64)->comment('名称')`
`age:int:年龄=0`	`$table->integer('age')->default(0)`
`meta:?json:扩展`	`$table->json('meta')->nullable()`
`price:decimal(10,2):价格`	`$table->decimal('price', 10, 2)`，cast `decimal:2`
`status:tinyint:状态=1`	`$table->tinyInteger('status')->default(1)`

支持类型：string char text mediumText longText int bigint tinyint smallint mediumint decimal float double bool json jsonb date datetime timestamp time year uuid enum binary email url。

builder:interface

php artisan builder:interface orders \
  --desc="订单表" --dictionary=api/v1 \
  --fields="order_no:string(32):订单号;amount:decimal(10,2):金额" \
  --request --route

生成 Interfaces/Api/V1/Services、Controllers、Hooks 三件套，可选 Request 与路由片段。

toolkit:doctor

php artisan toolkit:doctor

检查 PHP 版本、扩展、配置发布、storage 权限、头像资源与可选依赖。

数据仓库

use App\Repository\Api\V1\UserRepository;

$repository = new UserRepository();

$repository->insertGetId(['name' => '张三', 'age' => 18]);

$row = $repository->row(['id' => 1]);
$list = $repository->get(['age' => ['>=', 18]], ['name', 'age'], [], ['age' => 'desc']);
$page = $repository->lists(['name' => ['like', '张 三']], ['*'], [], ['id' => 'desc'], '', 1, 20);

条件 DSL

条件	说明
`['field' => 'value']`	等值
`['field' => ['>', 10]]`	比较 / `!=` / `>=` / `<` / `<=`
`['field' => ['like', '关键字']]`	忽略空格模糊匹配；`name\|email` 多字段 OR
`['field' => ['in', [1,2]]]`	`not-in` / `between` / `not-between` / `null` / `not-null`
`['field' => ['date', '2026-01-01']]`	`month` / `day` / `year` / `time`
`['field' => ['json-contains', ['a']]]`	JSON 查询
`['field' => ['column', 'other_field']]`	字段比较
`['field' => ['raw', ['sql = ?', [1]]]]`	原生 SQL（必须使用绑定）
`['or-age' => ['>', 10]]`	任意规则加 `or-` 前缀

排序：

['id' => 'desc']
['id' => [ModelModule::FIELD_ORDER_BY, [3, 1, 2]]]
[ModelModule::RANDOM_ORDER_BY => []]

统一响应

return responseSuccess(['id' => 1], '创建成功');
return responseError(Code::VALIDATE_FAILED, [], '参数错误', ['validations' => $errors]);

$service->information($request);
return responseService($service);

响应结构：

{
  "state": true,
  "code": 0,
  "msg": "创建成功",
  "data": {"id": 1},
  "extras": [],
  "locale": "zh_CN",
  "consuming": "1.23ms",
  "request_id": "..."
}

业务异常：

throw BusinessException::make(Code::FORBIDDEN, '无权操作');

中间件会将其渲染为统一 JSON。

三方集成

use Readfly\Laravel\Providers\WechatProvider;
use Readfly\Laravel\Providers\AliyunProvider;
use Readfly\Laravel\Providers\QiniuProvider;

WechatProvider::officeAccount()->sendTemplate($uuid, $openId, $data, 'order_paid');
WechatProvider::miniProgram()->code2Session($code);
AliyunProvider::sms()->send('13800000000', ['code' => '123456'], 'authenticate');

阿里云 OSS

use Readfly\Laravel\Providers\AliyunProvider;

$oss = AliyunProvider::oss();

$oss->put('uploads/a.png', $content, ['content_type' => 'image/png']);
$oss->putFile('uploads/a.png', '/tmp/a.png');
$oss->exists('uploads/a.png');
$oss->url('uploads/a.png');
$oss->delete('uploads/a.png');

// 前端 PostObject 直传凭证
$policy = $oss->postPolicy('uploads/', 3600);
// ['host' => ..., 'access_key_id' => ..., 'policy' => ..., 'signature' => ..., 'dir' => ..., 'expire_at' => ...]

配置位于 config/project.php 的 3rd_passports.aliyun.oss，visibility 为 private 时 url() 自动生成带签名的临时地址。

七牛云 OSS

use Readfly\Laravel\Providers\QiniuProvider;

$oss = QiniuProvider::oss();

$oss->put('uploads/a.png', $content);
$oss->putFile('uploads/a.png', '/tmp/a.png');
$oss->exists('uploads/a.png');
$oss->url('uploads/a.png');
$oss->delete('uploads/a.png');

// 前端直传凭证
$token = $oss->uploadToken('uploads/a.png', 3600);

配置位于 config/project.php 的 3rd_passports.qiniu.default，visibility 为 private 时 url() 自动生成私有空间下载地址。

可选依赖（仅在调用对应功能时需要）：

composer require intervention/image simplesoftwareio/simple-qrcode lustre/php-dfa-sensitive overtrue/easy-sms aliyuncs/oss-sdk-php qiniu/php-sdk

设计说明

配置统一放在 config/toolkit.php，支持 Laravel 9-12 自动发现
数据仓库条件全部使用参数绑定，字段名经过白名单校验
事务、缓存与响应对象均使用模型/框架原生连接
可选依赖缺失时抛出明确提示，不影响核心功能安装
脚手架直接生成迁移文件，不依赖解析 artisan 输出

测试

composer install
composer test

测试覆盖数据仓库条件 DSL、字段定义、模板渲染、响应对象与 PHPDoc 解析。所有源码与渲染后的脚手架模板均可通过 php -l 语法检查。

许可证

MIT，详见 LICENSE。

readfly / laravel

Package info

Security

Statistics