ThinkPHP 通用的API格式封装实例代码

 更新时间:2023年08月29日 14:22:28   作者:杀死一只知更鸟debug  
这篇文章主要介绍了ThinkPHP通用的API格式封装,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

ThinkPHP 通用的API格式封装

1.创建status.php 用于设置通用的状态码返回枚举类

<?php
return[
    "success"=>1,
    "error"=>0,
    "controller_not_found"=>-1,
    "action_not_found"=>-2,
];

2.将API返回格式统一封装

<?php
/**API 统一格式化
 * @param $status
 * @param $message
 * @param $data
 * @param $httpStatus
 * @return \think\response\Json
 */
function show($status,$message,$data=[],$httpStatus=200){
    $result = [
      "status"=>$status,
      "message"=>$message,
      "data"=>$data,
    ];
    return json($result,$httpStatus);
}

3.重写BaseController中的__call方法

在BaseController中重写__call方法,当调用不存在的方法时,就会调用__call方法,会传入请求方法和参数

<?php
declare (strict_types = 1);
namespace app;
use think\App;
use think\exception\ValidateException;
use think\Validate;
/**
 * 控制器基础类
 */
abstract class BaseController
{
    /**
     * Request实例
     * @var \think\Request
     */
    protected $request;
    /**
     * 应用实例
     * @var \think\App
     */
    protected $app;
    /**
     * 是否批量验证
     * @var bool
     */
    protected $batchValidate = false;
    /**
     * 控制器中间件
     * @var array
     */
    protected $middleware = [];
    /**
     * 构造方法
     * @access public
     * @param  App  $app  应用对象
     */
    public function __construct(App $app)
    {
        $this->app     = $app;
        $this->request = $this->app->request;
        // 控制器初始化
        $this->initialize();
    }
    // 初始化
    protected function initialize()
    {}
    /**
     * 验证数据
     * @access protected
     * @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('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);
    }
	// 重写__call部分
    public function __call(string $name, array $arguments)
    {
        // TODO: Implement __call() method.
        return show(config("status.action_not_found"),"找不到{$name}方法",null,404);
    }
}

在这里插入图片描述

4.在控制器下面新建Error控制器,然后添加__call方法

在控制器下面新建Error控制器,然后添加__call方法,这样就会调用不存在的控制器的时候会调用__call方法,会传入请求的控制器名称和参数

<?php
namespace app\index\controller;
class Error{
    public function __call(string $name, array $arguments)
    {
        // TODO: Implement __call() method.
        return show(config("status.controller_not_found"),"找不到{$name}控制器",null,404);
    }
}

测试

在这里插入图片描述

在这里插入图片描述

假定一个成功的请求,测试一下

public function jsonTest(){
    $data = ['name' => 'thinkphp', 'status' => '1'];
    return show(config("status.success"),"请求成功",$data);
}

在这里插入图片描述

到此这篇关于ThinkPHP 通用的API格式封装的文章就介绍到这了,更多相关ThinkPHP  API格式封装内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Yii框架视图、视图布局、视图数据块操作示例

    Yii框架视图、视图布局、视图数据块操作示例

    这篇文章主要介绍了Yii框架视图、视图布局、视图数据块操作,结合实例形式分析了Yii框架相关的视图、布局、控制器及数据相关操作技巧,需要的朋友可以参考下
    2019-10-10
  • thinkPHP中多维数组的遍历方法

    thinkPHP中多维数组的遍历方法

    这篇文章主要介绍了thinkPHP中多维数组的遍历方法,以简单实例形式分析了thinkPHP中foreach语句的使用技巧,需要的朋友可以参考下
    2016-01-01
  • Symfony2学习笔记之插件格式分析

    Symfony2学习笔记之插件格式分析

    这篇文章主要介绍了Symfony2的插件格式,详细分析了Symfony2的插件原理及创建与使用插件的相关技巧,需要的朋友可以参考下
    2016-03-03
  • ThinkPHP中ajax使用实例教程

    ThinkPHP中ajax使用实例教程

    这篇文章主要介绍了ThinkPHP中ajax使用, 是ThinkPHP开发中非常实用的技巧,需要的朋友可以参考下
    2014-08-08
  • php parse_str() 函数的定义和用法

    php parse_str() 函数的定义和用法

    下面小编就为大家带来一篇php parse_str() 函数的定义和用法。小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-05-05
  • php数组去重复数据示例

    php数组去重复数据示例

    这篇文章主要介绍了php数组去重复数据示例,有时候获得的php数组中总是出现value重复的,使用下面的方法就可以去掉重复数据
    2014-02-02
  • 基于php 随机数的深入理解

    基于php 随机数的深入理解

    本篇文章是对php随机数进行了详细的分析介绍,需要的朋友参考下
    2013-06-06
  • php函数重载的替代方法--伪重载详解

    php函数重载的替代方法--伪重载详解

    对于弱类型语言来说,PHP函数重载,并不像一般的OOP那样。而弱类型本来就不区分,所以无法通过这些来实现。但是,可以通过下面的方法来实现简单的伪重载吧。
    2015-05-05
  • 纯PHP代码实现支付宝批量付款

    纯PHP代码实现支付宝批量付款

    最近在做一个使用支付宝转账的项目,其中有需求把我难到了:批量支付成功后不知道怎么接收系统返回的通知,经过朋友帮忙,此功能实现,下面小编把具体代码整理分享给大家,供大家参考
    2015-12-12
  • thinkphp文件处理类Dir.class.php的用法分析

    thinkphp文件处理类Dir.class.php的用法分析

    这篇文章主要介绍了thinkphp文件处理类Dir.class.php的用法,以实例形式分析了基于文件处理类Dir.class.php的自定义函数del的使用,是非常实用的技巧,需要的朋友可以参考下
    2014-12-12

最新评论