SpringBoot统一返回格式怎么实现

这篇文章主要讲解了“SpringBoot统一返回格式怎么实现”，文中的讲解内容简单清晰，易于学习与理解，下面请大家跟着小编的思路慢慢深入，一起来研究和学习“SpringBoot统一返回格式怎么实现”吧！先看一下最基本的例子，直接将结果原封不动返回：返回结果：{
“name”:”张三”,
“age”:30
}假如已经与前端开发妹子约定好了格式，比如：那么我们首先需要编写一个封装结果类Result。为了方便封装，在这个类中增加一个success方法：后台接口代码微调一下，返回值改为Result，泛型为原返回值的类型：返回结果：{
“code”:0,
“msg”:”success”,
“data”:{
“name”:”张三”,
“age”:30
}
}至此，返回结果完美符合格式。但是这样的代码并不算简洁：每个接口的返回值都必须是Result，并且return的时候都要用Result.success()方法封装一下。那么，有没有更优雅的方法？我们继续往下看：实际使用场景中，并不是所有接口都需要统一格式。我们这里使用一个注解作为开关，按需控制接口返回格式。这里有一点要注意，这个advice中supports方法中判断返回结果类型必须为非String类型。如果返回结果为String类型，那么result要转为json字符串后再返回，需要再写一个advice。这段代码与最开始一样，并没有返回Result，仅仅加上了@ApiResult注解，我们看返回结果：{
“code”:0,
“msg”:”success”,
“data”:{
“name”:”张三”,
“ag免费云主机域名e”:30
}
}大功告成！以上只是最精简的例子，实际使用中还结合了统一异常封装、自定义返回格式等功能。我们注意到@ApiResult注解中，有三个参数：successCode、successMsg、resultClass，就是为了自定义返回格式预留的，下面再看两个场景：如果个别接口的返回格式与默认格式相同，但是要求code等于200时才代表成功，那么修改下successCode参数即可：返回成功时，结果中的code和msg都变为设置的值：{
“code”:200,
“msg”:”ok”,
“data”:{
“name”:”张三”,
“age”:30
}
}如果某个接口的返回格式不是默认的返回格式，比如约定返回returnCode、returnDesc、data（对应默认的code、msg、data）。那么则需要新增一个返回结果类，比如ReturnResult：然后修改接口上的@ApiResult注解中的resultClass属性这时，返回结果就变为想要的格式了：{
“returnCode”:”0″,
“returnDesc”:”success”,
“data”:{
“name”:”张三”,
“age”:30
}
}感谢各位的阅读，以上就是“SpringBoot统一返回格式怎么实现”的内容了，经过本文的学习后，相信大家对SpringBoot统一返回格式怎么实现这一问题有了更深刻的体会，具体使用情况还需要大家实践验证。这里是百云主机，小编将为大家推送更多相关知识点的文章，欢迎关注！

相关推荐: GoFrame基于性能怎么测试grpool使用场景

今天小编给大家分享一下GoFrame基于性能怎么测试grpool使用场景的相关知识点，内容详细，逻辑清晰，相信大部分人都还太了解这方面的知识，所以分享这篇文章给大家参考一下，希望大家阅读完这篇文章后有所收获，下面我们一起来了解一下吧。grpool相比于goro…

免责声明：本站发布的图片视频文字，以转载和分享为主，文章观点不代表本站立场，本站不承担相关法律责任；如果涉及侵权请联系邮箱：360163164@qq.com举报，并提供相关证据，经查实将立刻删除涉嫌侵权内容。