在thinkphp8中实现restful接口并统一json返回格式，核心做法是定义一个基础控制器类继承`think\controller`，并在其中重写`initialize`方法或注册全局中间件来拦截响应。具体而言，可以在基类中通过`hook`机制或在路由配置后挂载中间件，将业务逻辑产生的数据封装为包含`code`、`msg`和`data`的标准结构，确保所有api端点返回一致的json对象。
如何创建统一的响应基类
创建一个名为`BaseController`的类，继承自`think\Controller`。在该类中定义静态方法用于生成标准响应，例如`success()`、`error()`和`fail()`。这些方法内部调用`json()`助手函数或构建`Response`对象，设置HTTP状态码和JSON内容。子类控制器只需继承`BaseController`即可复用这些方法，无需在每个动作中重复编写格式化代码。
namespace app\controller;
use think\Controller;
use think\facade\Json;
class BaseController extends Controller
{
protected function success($data = [], $msg = 'success', $code = 200)
{
return json([
'code' => $code,
'msg' => $msg,
'data' => $data
], $code);
}
protected function error($msg = 'error', $code = 400, $data = [])
{
return json([
'code' => $code,
'msg' => $msg,
'data' => $data
], $code);
}
}
上述代码定义了`BaseController`，其中`success`方法默认返回200状态码和成功消息，`error`方法默认返回400状态码和错误消息。开发者在具体的控制器如`User.php`中继承此类，调用`$this->success($user)`即可直接返回符合规范的JSON。
立即学习“PHP免费学习笔记（深入）”；
如何通过中间件统一处理异常与响应
除了基类方式，更优雅的做法是使用中间件。创建一个`ApiResponse`中间件，在`handle`方法中捕获控制器执行后的响应。如果响应不是标准的JSON格式（例如抛出了异常），中间件可以将其转换为统一的错误JSON。此外，中间件还可以用于验证请求头中的Content-Type是否为application/json，确保RESTful规范。
namespace app\middleware;
use think\Response;
class ApiResponse
{
public function handle($request, \Closure $next)
{
try {
$response = $next($request);
} catch (\Exception $e) {
$response = json([
'code' => 500,
'msg' => $e->getMessage(),
'data' => null
], 500);
}
// 确保所有响应都是JSON类型
if (!$response instanceof Response || $response->getHeader('Content-Type') !== 'application/json') {
$response = json([
'code' => 200,
'msg' => 'ok',
'data' => $response
], 200);
}
return $response;
}
}
在`middleware.php`中注册该中间件到全局或路由组。这样，即使控制器忘记调用`json()`助手函数，或者发生未捕获异常，最终输出给前端的始终是结构化的JSON。这种方式解耦了业务逻辑与响应格式，提高了代码的可维护性。
当使用BaseController时如何处理非JSON类型的视图渲染
如果在开发过程中需要返回HTML视图而非JSON，直接继承`BaseController`可能会导致问题，因为基类可能强制了JSON行为。解决此问题的方法是让需要返回视图的控制器继承原始的`think\Controller`而不是`BaseController`，或者在`BaseController`中增加判断逻辑。例如，检查请求的Accept头是否包含text/html，如果是则允许返回View对象。另一种做法是在`BaseController`中提供一个`view()`方法，该方法直接返回`think\facade\View`的结果，而不经过JSON封装。
