SpringBoot Response统一返回封装,全局异常处理
背景
几乎每家公司的Restful接口都是code,msg,data 这种封装
{"code":0,"msg":null,"data":null}
其后端代码:
@GetMapping("hello")
public Result list(){
return Result.ofSuccess("hello");
}
这种代码写多了也恶心,如何解放生产力呢?
解决方案
这里推荐参考 purgeteam 大神的项目 https://github.com/purgeteam/unified-dispose-springboot
简述
- 写一个RestControllerAdvice来拦截请求,将原始数据DTO自动封装为Result类型。
- 区分需要封装和不需要封装的控制器,适当排除。
注意事项
- 返回值如果是DTO,则一定要注意 setter和getter
- 返回值如果是String,则一定要 加 produce=MediaType.APPLICATION_JSON
最佳实践
- 可以不用包内的注解,自行启动
- 可以写一个子类覆盖原始行为
- 可以不用包内Result。例如有些公司code是int,有些公司的string
- 可以不用他的GlobalDefaultExceptionHandler,如果项目内有。
- String类型的数值返回null的时候,要写
produces=json
,否则默认会被StringEncoder处理,导致返回值为Content-Type=plain/text
欢迎加入博主的QQ群
Java 框架技术 202588131
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】博客园社区专享云产品让利特惠,阿里云新客6.5折上折
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 【.NET】调用本地 Deepseek 模型
· CSnakes vs Python.NET:高效嵌入与灵活互通的跨语言方案对比
· Plotly.NET 一个为 .NET 打造的强大开源交互式图表库
· DeepSeek “源神”启动!「GitHub 热点速览」
· 上周热点回顾(2.17-2.23)