You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 

196 lines
5.7 KiB

<?php
declare(strict_types=1);
/**
* BaseController.php
* Created by PhpStorm.
* Date: 2026/10/17
* Time: 09:40
* Author: qian.guo
* E-mail: yiyezhiqiutel@gmail.com
*/
namespace app;
use app\middleware\LoginCheck;
use think\App;
use think\exception\ValidateException;
use think\Validate;
/**
* 控制器基类(前台接口统一继承)
*
* 本文件是**官方骨架版本 + 本项目扩展**的合并体,不是任何一方单独覆盖。
*
* 保留官方的部分(不能删):
* - $app / $request 注入 + initialize() 钩子
* - validate() 快速验证(官方控制器用它,删掉会在运行时报方法不存在)
*
* 本项目新增的部分:
* - $account_id:由 LoginCheck 中间件写入,未登录为 0
* - $offset / $limit:统一分页口径,避免每个控制器自己解析、出现两套规则
*
* 合并原则:官方提供的能力一个不删,只在其上追加。
* 早期版本曾直接用本项目版本覆盖官方文件,丢掉 validate() —— 那种错误只在
* 真正调用验证时才会炸,属于典型的"静态检查全绿但运行时缺方法"。
*/
abstract class BaseController
{
/**
* Request 实例
* @var \think\Request
*/
protected $request;
/**
* 应用实例
* @var App
*/
protected $app;
// 当前登录账号ID,未登录为 0
protected $account_id = 0;
// 偏移量
protected $offset = 0;
// 每页条数
protected $limit = 10;
/**
* 是否批量验证
* @var bool
*/
protected $batchValidate = false;
/**
* 控制器中间件
* @var array
*/
protected $middleware = [];
/**
* 构造方法
*
* 为什么 $app 是可选参数(官方版本是必传):
* 本项目各控制器都重写了自己的构造函数(注入 WxService / ScoreService 等),
* 内部调 `parent::__construct()` 时不会再传 App。
* 若这里强制必传,会直接 ArgumentCountError,而报错指向控制器的
* parent::__construct() 那一行,看上去像控制器写错了。
* 用 `?: app()` 兜底既能兼容两边写法,也不丢官方的 App 注入能力。
*
* @param App|null $app 应用对象
*/
public function __construct(?App $app = null)
{
// 规范 4.4 禁三元,故用 if 而不是 $app ?: app()
if ($app === null) {
$app = app();
}
$this->app = $app;
$this->request = $this->app->request;
// 登录态与分页是本项目所有接口的共同依赖,
// 放在 initialize() 之前:子类若重写 initialize(),
// 忘调 parent 也不会丢掉这两项
$this->account_id = LoginCheck::accountId();
$this->initPageParam();
// 控制器初始化(官方钩子,子类可重写)
$this->initialize();
}
/**
* 初始化
* initialize
* @return void
*/
protected function initialize()
{
}
/**
* 解析分页参数
* initPageParam
*
* 规则(三条,写在这里是为了只有一处口径):
* - limit 限幅 10~100:太小会让客户端疯狂翻页,太大会拖垮数据库
* - 传了 last 就当游标用,直接作为偏移量 —— 「加载更多」场景不能清空已加载列表
* - 否则按 page 计算常规偏移
*
* @return void
*/
private function initPageParam()
{
$limit = intval($this->request->param('limit', 10));
if ($limit < 10) {
$limit = 10;
}
if ($limit > 100) {
$limit = 100;
}
$this->limit = $limit;
$offset = 0;
if ($this->request->has('last')) {
$offset = intval($this->request->param('last', 0));
} else {
$page = intval($this->request->param('page', 1));
if ($page < 1) {
$page = 1;
}
$offset = ($page - 1) * $this->limit;
}
if ($offset < 0) {
$offset = 0;
}
$this->offset = $offset;
}
/**
* 验证数据(官方实现,保持原样)
* validate
* @param array $data 数据
* @param string|array $validate 验证器名或者验证规则数组
* @param array $message 提示信息
* @param bool $batch 是否批量验证
* @return array|string|true
* @throws ValidateException
*/
protected function validate(array $data, string|array $validate, array $message = [], bool $batch = false)
{
if (is_array($validate)) {
$v = new Validate();
$v->rule($validate);
} else {
if (strpos($validate, '.')) {
// 支持场景
[$validate, $scene] = explode('.', $validate);
}
// 官方原写法:$class = false !== strpos($validate, '\\') ? $validate : $this->app->parseClass(...);
// 规范 4.4 禁三元,故改写为 if。逻辑与原实现完全等价:
// 带了命名空间分隔符就当作完整类名,否则当验证器别名去解析
if (false !== strpos($validate, '\\')) {
$class = $validate;
} else {
$class = $this->app->parseClass('validate', $validate);
}
$v = new $class();
if (!empty($scene)) {
$v->scene($scene);
}
}
$v->message($message);
// 是否批量验证
if ($batch || $this->batchValidate) {
$v->batch(true);
}
return $v->failException(true)->check($data);
}
}