API接口通用返回类，TP通用

野性酷女 2023-02-14 05:53 128阅读 0赞

<?php
    /**
     * Created by PhpStorm.
     * User: Administrator
     * Date: 2020/9/28
     * Time: 14:47
     */
    
    namespace app\common;
    
    use think\exception\HttpResponseException;
    use think\Request;
    use think\Response;
    
    class ApiResponse
    { 
    
        public static $successCode = 200;
        public static $errorCode = 400;
    
        /**
         * 构造函数
         * ApiResponse constructor.
         * @param int $code 返回码
         * @param string $msg 返回信息
         * @param array $data 返回数据
         * @param array $header 设置跨域
         */
        private function __construct($code = 0, $msg = "", $data = [], array $header = [])
        { 
            $result = [
                'code' => $code,
                'msg' => $msg,
                'time' => Request::instance()->server('REQUEST_TIME'),
                'data' => $data,
            ];
    
            $type = $this->getResponseType();
            $response = Response::create($result, $type)->header($header);
            throw  new HttpResponseException($response);
        }
    
        /**
         * 返回成功
         * @param $msg
         * @param null $data
         * @return ApiResponse
         */
        public static function success($msg, $data = null)
        { 
            return new ApiResponse(self::$successCode, $msg, $data);
        }
    
        /**
         * 返回错误
         * @param $msg
         * @return ApiResponse
         */
        public static function error($msg)
        { 
            return new ApiResponse(self::$errorCode, $msg);
    
        }
    
    
        /**
         * token失效返回登录页面
         * @param $msg
         * @param int $code
         * @return ApiResponse
         */
        public static function result($msg, $code = 302)
        { 
            return new ApiResponse($code, $msg);
        }
    
        /**
         * 获取当前的response 输出类型
         * @access protected
         * @return string
         */
        private function getResponseType()
        { 
            return 'json';
        }
    
    
    }

以上不考虑跨域访问，如果有跨域问题可以设定header头部，在构造函数中添加：

$header['Access-Control-Allow-Origin']  = '*';
     $header['Access-Control-Allow-Headers'] = 'X-Requested-With,Content-Type';
     $header['Access-Control-Allow-Methods'] = 'GET,POST,PATCH,PUT,DELETE,OPTIONS';

注意：这个头部不能随便添加，如果在某些公共方法中已添加过header 则此处无需添加，否则会报错跨域。