欢迎来到尧图网

客户服务 关于我们

您的位置:首页 > 教育 > 锐评 > Laravel Trait 实现 统一JSON 响应格式

Laravel Trait 实现 统一JSON 响应格式

2026/2/2 21:26:02 来源:https://blog.csdn.net/zhu_lizhen/article/details/146804181  浏览:    关键词:Laravel Trait 实现 统一JSON 响应格式

首先什么是 Trait ?

Trait 是 PHP 5.4 引入的一个代码复用机制,它解决了 PHP 单继承的限制问题。

Trait 基本概念

Trait 是一种代码复用机制,即可以理解为 可重用的方法集合

trait Loggable {public function log($message) {echo "Log: $message\n";}
}

Trait 的特点

  • 不是类:不能实例化

  • 不是接口:可以包含具体实现

  • 解决单继承限制:一个类可以使用多个 Trait,这是重点,因为PHP只能单继承,很好弥补了这一弱势。

  • 代码复用:可以理解为帮助方法,多个类使用,不用重复多次写

Trait的 使用 ,Use 即可

class User {use Loggable ;
}//laravel 常见的伪删除,等等
class User extends Model {use SoftDeletes; // 软删除功能
}

多个 Trait 使用


class MyClass {use TraitA, TraitB;
}

当多个 Trait 有同名方法时

trait A {public function conflict() { echo "A"; }
}
trait B {public function conflict() { echo "B"; }
}
class MyClass {use A, B {A::conflict insteadof B;  // 使用 A 的 conflict 方法B::conflict as conflictB; // 将 B 的 conflict 方法重命名}
}

Trait 与继承的优先级

方法解析优先级(从高到低):

  1. 当前类中的方法权重最高

  2. 其次是Trait 中的方法

  3. 最后继承的父类中的方法

Trait 还有一些其他的特性 等等,大家去看看语法。重点来了

Laravel 开发统一的 JSON 响应格式,用来做Api响应。

直接上源码:

<?php
namespace App\Http\Trait;use Illuminate\Http\JsonResponse;
use Illuminate\Support\Facades\Response;trait ResponseJson
{/*** 默认成功状态码*/protected int $successCode = 200;/*** 默认错误状态码*/protected int $errorCode = 101;/*** 返回成功 JSON 响应** @param string $message 成功消息* @param mixed $data 返回数据* @param array $headers 附加头信息* @param int $httpStatus HTTP 状态码* @return JsonResponse*/public function success(string $message,mixed  $data = [],array  $headers = [],int    $httpStatus = 200): JsonResponse{return Response::json(['code' => $this->successCode,'message' => $message,'data' => $data,], $httpStatus, $headers);}/*** 返回错误 JSON 响应** @param string $message 错误消息* @param int|null $code 业务错误码* @param mixed $data 附加数据* @param array $headers 附加头信息* @param int $httpStatus HTTP 状态码* @return JsonResponse*/public function error(string $message,int    $code = NULL,mixed  $data = [],array  $headers = [],int    $httpStatus = 400): JsonResponse{return Response::json(['code' => $code ?? $this->errorCode,'message' => $message,'data' => $data,], $httpStatus, $headers);}/*** 根据数据自动返回成功或错误响应** @param array $responseData 必须包含 code, message, data* @param array $headers 附加头信息* @return JsonResponse*/public function autoResponse(array $responseData, array $headers = []): JsonResponse{if(!isset($responseData['code'], $responseData['message'])){return $this->error('Invalid response format', 500, [], $headers, 500);}return $responseData['code'] === $this->successCode? $this->success($responseData['message'], $responseData['data'] ?? [], $headers): $this->error($responseData['message'], $responseData['code'], $responseData['data'] ?? [], $headers);}
}

Api接口直接使用

class TestController extends Controller
{use ResponseJson;public function index(){//return $this->success('success', [1, 2, 3]);return $this->error('error', 11, [1, 2, 3]);}
}

代码分析

  1. 封装了成功和错误和自定义的响应方法,success ,error,autoResponse
  2. 支持自定义 HTTP 状态码和 headers
  3. success ,error 保持一致的参数顺序 (消息 -> 数据/代码 -> headers -> HTTP状态码),使用的时候尽量减少干扰
  4. 区分业务编码 code 和 HTTP 状态码 httpStatus,一个是业务上的区分,一个是接口通信上的状态。
  5. 增强的 autoResponse 方法,处理自定义的相关情况
  6. 严格的参数类型声明和验证
  7. 灵活性、可维护性和类型安全性

版权声明:

本网仅为发布的内容提供存储空间,不对发表、转载的内容提供任何形式的保证。凡本网注明“来源:XXX网络”的作品,均转载自其它媒体,著作权归作者所有,商业转载请联系作者获得授权,非商业转载请注明出处。

我们尊重并感谢每一位作者,均已注明文章来源和作者。如因作品内容、版权或其它问题,请及时与我们联系,联系邮箱:809451989@qq.com,投稿邮箱:809451989@qq.com

热搜词