tp6怎么输出json格式

ThinkPHP6 完全指南：如何正确输出 JSON 格式数据

在 Web 开发中，JSON（JavaScript Object Notation）已成为前后端数据交换的主流格式，ThinkPHP6（TP6）作为国内流行的 PHP 开发框架，提供了多种便捷的方式来输出 JSON 格式数据，本文将详细介绍在 TP6 中实现 JSON 输出的各种方法，帮助开发者根据实际需求选择最合适的方案。

使用 response()->json() 方法

ThinkPHP6 提供了最直接的 JSON 输出方式——通过 response()->json() 方法，这是官方推荐的标准做法，能够自动处理数据编码和 HTTP 头部设置。

基本用法

public function index()
{
    $data = [
        'code' => 200,
        'msg'  => 'success',
        'data' => ['id' => 1, 'name' => 'ThinkPHP']
    ];
    return json($data);
}

高级用法

public function detail()
{
    $user = User::find(1);
    return json($user)
        ->header('Access-Control-Allow-Origin', '*')
        ->contentType('application/json;charset=utf-8');
}

使用控制器返回

在控制器中,可以直接返回数组或对象，TP6 会自动将其转换为 JSON 格式。

返回数组

public function list()
{
    $list = Db::table('user')->select();
    return [
        'code' => 0,
        'msg'  => 'ok',
        'data' => $list
    ];
}

返回集合

public function collection()
{
    $list = User::select();
    return json($list);
}

使用 API 资源类

对于复杂的 API 响应，可以使用 TP6 的资源类（Resource）来规范化 JSON 输出。

创建资源类

php think make:resource UserResource

使用资源类

public function show($id)
{
    $user = User::find($id);
    return new UserResource($user);
}

资源类示例：

<?php
namespace app\resource;
class UserResource
{
    public function __construct($user)
    {
        $this->user = $user;
    }
    public function toArray()
    {
        return [
            'id'    => $this->user->id,
            'name'  => $this->user->name,
            'email' => $this->user->email
        ];
    }
}

全局响应处理

可以在全局中间件或服务类中统一处理 JSON 响应，确保整个应用的输出格式一致。

全局响应中间件

<?php
namespace app\middleware;
class ResponseMiddleware
{
    public function handle($request, \Closure $next)
    {
        $response = $next($request);
        if (is_array($response)) {
            $response = json($response);
        }
        return $response;
    }
}

异常处理中的 JSON 输出

在异常处理中,也可以返回 JSON 格式的错误信息。

自定义异常处理器

<?php
namespace app\exception;
class ApiException extends \Exception
{
    public function render()
    {
        return json([
            'code' => $this->code,
            'msg'  => $this->message,
            'data' => []
        ], $this->code);
    }
}

最佳实践建议

1. 统一响应格式：建议所有 API 响应都遵循统一的格式，如：

   {
       "code": 200,
       "msg": "success",
       "data": {}
   }

2. 正确设置 HTTP 状态码：根据业务场景设置合适的 HTTP 状态码（200、404、500 等）。

3. 处理中文编码：确保 JSON 输出时中文正确显示，可以设置 contentType('application/json;charset=utf-8')。

4. 安全性考虑：敏感数据应在输出前进行过滤或加密处理。

常见问题解决

JSON 中文显示乱码

确保响应头中包含正确的字符集：

return json($data)->contentType('application/json;charset=utf-8');

输出 JSON 时包含 null 值

使用 JSON_UNESCAPED_UNICODE 和 JSON_UNESCAPED_SLASHES 选项：

return json($data, 256); // 256 = JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES

自定义 JSON 编码选项

可以在 config/app.php 中配置默认的 JSON 编码选项：

'json_encode_option' => 256,

ThinkPHP6 提供了灵活多样的 JSON 输出方式，开发者可以根据项目需求选择最适合的方案，无论是简单的数组输出，还是复杂的资源类处理，TP6 都能轻松应对，这些 JSON 输出技巧，将大大提高 API 开发的效率和规范性，为构建高质量的 Web 应用奠定坚实基础。