Thinkphp封装统一响应

已于 2024-04-22 15:43:41 修改
阅读量608 收藏 10
点赞数 4
分类专栏： PHP 文章标签： thinkphp 响应
于 2024-04-22 09:37:11 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/C_jian/article/details/138060543
版权
本文介绍了如何使用自定义trait在ThinkPHP项目中统一API接口的‘成功’、‘失败’和‘异常’响应数据格式，提供了详细的示例和方法调用说明。
摘要由CSDN通过智能技术生成

前言

我们平时开发新项目api接口的时候总是要先自定义自己的响应数据格式，但是每个人的风格习惯不同，导致开发人员封装的响应数据格式不统一，而且需要花时间去重复写。本篇文章主要是统一 API 开发过程中「成功」、「失败」以及「异常」情况下的响应数据格式。

封装响应

为了方便调整适合自己的响应格式，这里使用自定义trait来实现

我们新建文件application/common/traits/CustomResponse（基于tp5，其他版本类似），文件内容直接复制下面的代码然后保存，注意修改为你的命名空间：

<?php

namespace app\common\traits;

use think\exception\HttpResponseException;
use think\Response;

trait CustomResponse{
    //默认输出类型，可选择json、jsonp、xml、html、view、redirect等
    //参考thinkphp文档https://doc.thinkphp.cn/v5_1/xiangyingshuchu.html
    protected $type = 'json';

    /**
     * 操作成功返回的数据.
     *
     * @param mixed  $data   要返回的数据
     * @param string $msg    提示信息
     * @param int    $code   错误码，默认为1
     * @param string $type   输出类型
     * @param array  $header 发送的 Header 信息
     */
    protected function success($data = null, $msg = '请求成功', $code = 200, array $header = [])
    {
        $this->result($msg, $data, $code, $header, 'success');
    }

    /**
     * 操作成功返回默认message
     *
     * @param string $msg    提示信息
     */
    protected function ok($msg = '请求成功')
    {
        $this->result($msg,null, 200);
    }

    /**
     * 操作失败返回的数据.
     *
     * @param string $msg    提示信息
     * @param mixed  $data   要返回的数据
     * @param int    $code   错误码，默认为0
     * @param string $type   输出类型
     * @param array  $header 发送的 Header 信息
     */
    protected function fail($msg = '请求失败', $data = null, $code = 500, array $header = [])
    {
        $this->result($msg, $data, $code, $header, 'fail');
    }

    /**
     * 系统异常返回的数据.
     *
     * @param string $msg    提示信息
     * @param mixed  $data   要返回的数据
     * @param int    $code   错误码，默认为0
     * @param string $type   输出类型
     * @param array  $header 发送的 Header 信息
     */
    protected function error($msg = '系统异常', $data = null, $code = 500, array $header = [])
    {
        $this->result($msg, $data, $code, $header, 'error');
    }

    /**
     * BadRequest
     *
     */
    protected function errorBadRequest()
    {
        $this->result('400 Bad Request',null, 400, [], 'error');
    }

    /**
     * Unauthorized
     *
     */
    protected function errorUnauthorized()
    {
        $this->result('Unauthorized',null, 401, [], 'error');
    }

    /**
     * Forbidden
     *
     */
    protected function errorForbidden()
    {
        $this->result('403 Forbidden',null, 403, [], 'error');
    }

    /**
     * 404 Not Found
     *
     */
    protected function errorNotFound()
    {
        $this->result('404 Not Found',null, 404, [], 'error');
    }

    /**
     * Method Not Allowed
     *
     */
    protected function errorMethodNotAllowed()
    {
        $this->result('Method Not Allowed',null, 405, [], 'error');
    }

    /**
     * 返回封装后的 API 数据到客户端.
     *
     * @param mixed  $msg    提示信息
     * @param mixed  $data   要返回的数据
     * @param int    $code   错误码，默认为0
     * @param string $type   输出类型，支持json/xml/jsonp
     * @param array  $header 发送的 Header 信息
     *
     * @throws HttpResponseException
     * @return void
     */
    protected function result($msg, $data = null, $code = 200, array $header = [], $status = 'success')
    {
        $result = [
            'code' => $code,
            'status' => $status, // 状态有success、fail、error3种
            'msg'  => $msg,
            'data' => $data,
        ];

        if (isset($header['statuscode'])) {
            $code = $header['statuscode'];
            unset($header['statuscode']);
        } else {
            //未设置状态码,根据code值判断
            $code = $code >= 1000 || $code < 200 ? 200 : $code;
        }

        $response = Response::create($result, $this->type, $code)->header($header);

        throw new HttpResponseException($response);
    }
}

引入trait

在基类控制器或者直接在需要的控制器中引入trait

<?php

namespace app\index\controller;

use app\common\traits\CustomResponse; # 引入trait的命名空间

class Controller{
    use CustomResponse; # 引入trait
    
    
}

注意事项：index模块继承的Controller默认use Jump，里面也有success、fail、error方法，所以同时使用的话会冲突，只能二选一

成功响应

<?php

namespace app\index\controller;

class Index extends Controller
{
    //test
    public function index()
    {
        $this->success();
    }
}

更多用法

  • 返回默认message

    $this->ok();

//返回结果
{
    "code": 200,
    "status": "success",
    "msg": "请求成功",
    "data": null
}

  • 返回指定message

    $this->ok('提交成功');

//返回结果
{
    "code": 200,
    "status": "success",
    "msg": "提交成功",
    "data": null
}

  • 仅返回data

    $data = ['id' => 1, 'name' => 'test'];
$this->success($data);

//返回结果
{
    "code": 200,
    "status": "success",
    "msg": "请求成功",
    "data": {
        "id": 1,
        "name": "test"
    }
}

  • 返回data和message

    $data = ['id' => 1, 'name' => 'test'];
$this->success($data, '成功');

//返回结果
{
    "code": 200,
    "status": "success",
    "msg": "成功",
    "data": {
        "id": 1,
        "name": "test"
    }
}

  • 返回data和message并指定状态码

    $data = ['id' => 1, 'name' => 'test'];
$this->success($data, '成功', 201);

//返回结果
{
    "code": 201,
    "status": "success",
    "msg": "成功",
    "data": {
        "id": 1,
        "name": "test"
    }
}

  • 添加header

    $data = ['id' => 1, 'name' => 'test'];
$this->success($data, '成功', 201, ['Content-Type:application/json; charset=utf-8']);

//返回结果
{
    "code": 201,
    "status": "success",
    "msg": "成功",
    "data": {
        "id": 1,
        "name": "test"
    }
}

失败响应

  • 返回默认message

    $this->fail();

//返回结果
{
	"code": 500,
	"status": "fail",
	"msg": "请求失败",
	"data": null
}

  • 返回指定message

    $this->fail('提交失败');

//返回结果
{
	"code": 500,
	"status": "fail",
	"msg": "提交失败",
	"data": null
}

  • data和message

    $data = ['name' => 'test'];
$this->fail('提交失败', $data);

//返回结果
{
	"code": 500,
	"status": "fail",
	"msg": "提交失败",
	"data": {
		"name": "test"
	}
}

  • 返回data和message并指定状态码

    $data = ['name' => 'test'];
$this->fail('提交失败', $data, 501);

//返回结果
{
	"code": 501,
	"status": "fail",
	"msg": "提交失败",
	"data": {
		"name": "test"
	}
}

  • 添加header

    $data = ['name' => 'test'];
$this->fail('提交失败', $data, 501, ['Content-Type:application/json; charset=utf-8']);

//返回结果
{
	"code": 501,
	"status": "fail",
	"msg": "提交失败",
	"data": {
		"name": "test"
	}
}

异常响应

  • 自定义异常

    $this->error('系统异常');

//返回结果
{
	"code": 500,
	"status": "error",
	"msg": "系统异常",
	"data": null
}

    用法与失败响应相同，只是status字段有差别

  • Bad Request

    $this->errorBadRequest();

//返回结果
{
	"code": 400,
	"status": "error",
	"msg": "400 Bad Request",
	"data": null
}

  • 未登录授权

    $this->errorUnauthorized();

//返回结果
{
	"code": 401,
	"status": "error",
	"msg": "Unauthorized",
	"data": null
}

  • 403 Forbidden

    $this->errorForbidden();

//返回结果
{
	"code": 403,
	"status": "error",
	"msg": "Forbidden",
	"data": null
}

  • 404 Not Found

    $this->errorNotFound();

//返回结果
{
	"code": 404,
	"status": "error",
	"msg": "404 Not Found",
	"data": null
}

  • Method Not Allowed

    $this->errorMethodNotAllowed();

//返回结果
{
	"code": 405,
	"status": "error",
	"msg": "Method Not Allowed",
	"data": null
}

内置的方法不是很多，但是应该够用了，如果需要自定义可以在trait中添加自己需要的方法或字段，同样的，封装代码中的提示信息你也可以随便修改。

参考文章：

laravel-response: 🤖 Provide a standardized and unified response data format for Laravel and Lumen API projects. - 为 Laravel 和 Lumen API 项目提供一个规范统一的响应数据格式。 - Gitee.com

这货不是陈进坚
关注
  • 4
    点赞
  • 踩
  • 10
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
专栏目录
php tp6 错误接管分析,基于thinkphp6.0的success、error实现方法
weixin_34638409的博客
03-09 1278
最近把项目升级到tp6.0，一开始比较顺利，安装文档升级，但是升级指导指出：系统不再提供基础控制器类think\Controller ，原来的success 、error 、redirect 和result 方法需要自己在基础控制器类里面实现。这意味着需要自己来实现原来的一系列的函数我这里参考to5.1的跳转源码，进行改进得到，具体步骤如下：1、app目录下新建一个tpl文件夹，放入di...
ThinkPHP6项目基操（5.封装API数据格式及业务状态码统一管理）
张营的技术博客
11-29 3901
封装API数据格式及业务状态码统一管理一、封装API数据返回格式二、业务状态码统一管理 一、封装API数据返回格式 我们在返回API数据的时候，一般是使用json格式输出，如上节处理找不到控制器或方法返回数据： public function __call($name, $arguments) { // 如果是API模块，需要输出API的数据格式（一般是json） // 如果是模板引擎的方式，需要输出自定义错误页面 $result = [ 'status' =>
ThinkPHP 通用的API格式封装
m0_63622279的博客
08-28 898
在控制器下面新建Error控制器,然后添加__call方法,这样就会调用不存在的控制器的时候会调用__call方法,会传入请求的控制器名称和参数。在BaseController中重写__call方法,当调用不存在的方法时,就会调用__call方法,会传入请求方法和参数。假定一个成功的请求，测试一下。
thinkphp5的Auth权限认证实战
weixin_33885676的博客
12-05 1961
thinkphp5的Auth权限认证实战 一、总结 一句话总结：基于角色的权限管理（真正做一遍，就会发现很简单，不然一直都是半懂不懂的） 角色 权限 真正做一遍，就会发现很简单，不然一直都是半懂不懂的   1、Auth权限认证步骤？ auth 表 界面 a、建立auth表 改auth表名 各个表字段的意思 可以在基础表的基础上增加我们需要的字段 比如排序字段，比如无限级分...
thinkphp6 API封装接口类restful风格
code_nutter的博客
11-30 1510
对接口返回的数据进行统一封装，符合restful风格 function response($code=200, $msg='success', $data=[]) { $res = [ 'code' => $code, 'msg' => $msg, 'data' => $data ]; json($res)->send();die; } ...
ThinkPHP6.0 - 自定义异常处理优化代码可读性
s1095622320的博客
05-17 1186
今天凌晨写了一片关于laravel9.x 的自定义异常捕获返回json 今天看了一下文档 , 写了一下 , 发现TP自定义异常比Laravel稍微复杂一些 这里需要创建两个类才能实现这个自定义的异常 异常类 首先创建一个异常类 , 我实在 app \ common \ exception 这个文件夹创建的 注意 , 异常类是继承Exception <?php namespace app\common\exception; use think\Exception; class Bus
thinkphp6 api 响应封装(数据查询)
胡一可
12-04 2703
现在使用比较多的api风格是restful设计风格，也就是响应时的json数据应该包含有data数据、msg响应信息、code响应状态码、type数据格式等这几个信息。 而且数据响应的格式都应该保持格式一致，所以就涉及到响应数据的封装问题，封装好响应模式后，以后可以直接调用。 第一步，新建公共控制器common.php，定义响应returnapi()方法的数据模式进行封装； <?php namespace app\controller; use think\Response; class C
ThinkPHP5.0.24完整版
03-14
- **异常处理**：完善的异常处理机制，提供统一错误报告和日志记录，确保程序稳定运行。 2. **文件结构解析** - `.gitignore`：定义了Git版本控制系统忽略的文件和目录，避免无用文件被版本化。 - `composer....
thinkphp5高级手册
08-11
通过定义模型类，开发者可以封装数据库操作，使得代码更加模块化。模型类支持自动验证、自动完成、行为等特性，提升了代码的可维护性和一致性。 关于居美项目组的php代码规范V1.0.1，它为团队开发设定了统一的编码...
ThinkPHP6.0完全开发手册-02051436.pdf
02-14
- 统一和精简大量用法。 #### 二、安装与配置 - **安装**：ThinkPHP6.0可以通过Composer进行安装，或者手动下载源码包。 - **配置**：配置文件通常位于项目根目录下的`config`文件夹内，包含各种环境的配置信息，...
ThinkPhP 自定义接口返回
weixin_44871749的博客
04-11 1230
tp5.1 封装api接口自定义返回格式 <?php namespace app\common\library; class Response { const JSON = "json"; /** * 按综合方式输出通信数据 * @param integer $code 状态码 * @param string $message 提示信息 * @param array $data 数据 * @param string $type 数据类型 ...
thinkphp6搭建后端api接口
m0_67394002的博客
03-08 1320
这段时间学习了一下简单搭建一个api接口后端服务，现在记录一下。 本文主要内容 下载tp6 打开错误调试 隐藏入口文件 解决跨域问题-（使用全局中间件处理） 路由解决api版本控制 jwt token验证-（使用路由中间件验证） 统一的参数返回形式 异常捕捉 自动生成api文档（插件实现） 1、下载tp6 我使用的是集成环境phpstuday,安装了composer，通过composer安装tp6,thinkphp官网已经不再支持直接下载。 composer create-project topthin
thinkphp6 返回json数据封装
qq_66313178的博客
05-02 3641
写入公共文件 tp>app>common.php <?php // 这是系统自动生成的公共文件 //function_exists('success')判断是否有这个文件 //成功时调用 if(!function_exists('success')) { function success($code,$mes,$data) { return json([ 'code'=>$code, 'mes'=&.
TP5封装一个API接口JSON返回类
李观杰的博客
10-16 6537
TP5封装一个API接口JSON返回类 文件名及存放目录 project —&gt; extend —&gt; Gucci —&gt; ServerResponse.php 源码 &lt;?php /** * 统一返回处理类（ajax）允许跨域 * * 使用： ** * use Gucci\ServerResponse; * return ServerRespon...
php登录验证（包括用户名、密码、验证码、数据库、是否已登陆验证、自动登录和注销登录）
热门推荐
小坚的技术博客
10-19 1万+
登录界面 具体实现方法如下： login.html Title " alt="验证码"> 换一个 自动登录 登录 doLogin.php <?php header("Content-type:text/html;charset=UTF-8"); require "my
【php网页爬虫】php抓取网页数据
小坚的技术博客
09-20 9306
插件介绍： PHP Simple HTML DOM解析类：Simple HTML DOM parser 帮我们很好地解决了使用 php html 解析 问题。可以通过这个php类来解析html文档，对其中的html元素进行操作 (PHP5+以上版本)。 下载地址：https://github.com/samacs/simple_html_dom 使用方法： 1.引入si
thinkphp5 layui 开源 响应式前台
最新发布
11-19
ThinkPHP5是一款基于PHP的开源框架，可以帮助开发者快速构建Web应用程序。它拥有丰富的功能和灵活的扩展机制，非常适合用于快速开发和定制化需求。 Layui是一款优雅易用的前端UI框架，具有响应式设计，支持各种设备屏幕的适配。它提供了丰富的组件和基础样式，可以帮助开发者快速构建美观的前端界面。 当ThinkPHP5与Layui结合使用时，可以实现一个完整的开源、响应式前台系统。开发者可以利用ThinkPHP5的强大功能和灵活性，快速构建后台数据管理和逻辑处理，同时利用Layui的优雅UI组件和响应式设计，在前台展现出美观和用户友好的界面。 这种组合不仅能够提高开发效率，还可以使前端界面具有良好的视觉效果和用户体验。而且，由于它们都是开源框架，可以免费获取和使用，极大地降低了开发成本和技术门槛。 综上所述，ThinkPHP5与Layui的结合可以实现一个开源的、响应式的前台系统，为开发者提供了强大的工具和资源，使他们能够快速构建高质量的Web应用程序。
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值