springboot优雅地统一返回格式

web后端开发,统一后端数据的返回格式是每个项目都应该做的,得益于springboot的方法拦截,因此基于springboot可以非常优雅地统一返回的数据格式,以下是实现代码(演示的返回格式:{code: 0, success: true, data:{})。

1:写个枚举定义状态码以及是否成功的标识:

springboot优雅地统一返回格式

2:数据格式封装类ResultBuilder对控制器返回的数据进行封装:

springboot优雅地统一返回格式

到这里,基本的封装就完成了,可以在控制层进行使用。

springboot优雅地统一返回格式

读到这,虽然数据封装是实现了,但是并没有达到我们想要的优雅,优雅实现如下:

springboot优雅地统一返回格式

这里的关键是ResponseBodyAdvice接口的beforeBodyWrite方法,springboot在结果写给客户端时候调用,只要写一处,指定的包就都生效,需要注意的是ControllerAdvice注解最好指定生效的包名,不加包名的话会对整个系统的Controller进行扩展,会和某些功能产生冲突,如使用swagger出现空白页异常。

运行结果:

springboot优雅地统一返回格式