thinkphp 统一结果返回处理类

作者:mdo 发布时间: 2025-12-02 阅读量:6

返回结果处理,归根结底 主要是有两点 数据结构和返回的数据类型

1、数据类型 :一般情况下,API 需要返回数据类型是JSON

2、数据结构:需要一个code来表明 返回结果状态,一个msg用户状态的描述 一个data用于包含所需要的返回的数据

明白上面两点,后续的无非就是就行封装,具体怎么封装,看个人习惯。

<?php

declare(strict_types=1);

namespace wangqy\tcc\utils;

use think\Response;

class Result
{
    /**
     * 结果状态码
     *
     * @var int
     */
    protected $code = 0;
    /**
     * http请求状态码
     *
     * @var int
     */
    protected $httpCode = 200;

    /**
     * 响应结果类型.
     *
     * @var string
     */
    protected $responseType = 'json';

    /**
     * 失败返回信息.
     *
     * @param $code
     * @param $msg
     * @param $data
     *
     * @return Response
     */
    public function fail($msg, $code, $data = null)
    {
        return $this->make($code, $msg, $data);
    }

    /**
     * 仅返回说明.
     *
     * @param $msg
     *
     * @return Response
     */
    public function onlySucMsg($msg = 'success')
    {
        return $this->success(null, $msg);
    }

    /**
     * @return $this
     */
    public function setCode(int $code)
    {
        $this->code = $code;

        return $this;
    }

    /**
     * @return $this
     */
    public function setHttpCode(int $httpCode)
    {
        $this->httpCode = $httpCode;

        return $this;
    }

    /**
     * @return $this
     */
    public function setResponseType(string $responseType)
    {
        $this->responseType = $responseType;

        return $this;
    }

    /**
     * 成功返回信息.
     *
     * @param $data
     * @param $msg
     *
     * @return Response
     */
    public function success($data = null, $msg = 'success')
    {
        return $this->make($this->code, lang($msg), $data);
    }

    /**
     * @param int        $code
     * @param string     $msg
     * @param null|array $data
     *
     * @return Response
     */
    private function make($code, $msg, $data = null)
    {
        $extra = [
            'log_id' => $GLOBALS['log_id'] ?? '',
            'now' => time(),
        ];

        $res = compact('code', 'msg', 'extra');

        if (null !== $data) {
            $res['data'] = $data;
        }

        return Response::create($res, $this->responseType, $this->httpCode);
    }
}

在公共函数中:

if (!function_exists('result')) {
    /**
     * 获取当前json对象实例.
     *
     * @return App|object|Result
     */
    function result()
    {
        return app('result');
    }
}

在appService.php文件中增加

public $bind = [
    'result' => Result::class,
];

实例:

public function index()
{
    $data = ['name'=>'wordpress'];
    return result()->success($data);
}