目前很多项目都是前后端分离,前后端会事先约定好返回格式。那么后端如何做,才能优雅的返回统一格式呢,接下来,请大家跟着我,一步步来实现。,先看一下最基本的例子,直接将结果原封不动返回:,返回结果:,假如已经与前端开发妹子约定好了格式,比如:,那么我们首先需要编写一个封装结果类Result。为了方便封装,在这个类中增加一个success方法:,后台接口代码微调一下,返回值改为Result,泛型为原返回值的类型:,返回结果:,至此,返回结果完美符合格式。,但是这样的代码并不算简洁:每个接口的返回值都必须是Result<>,并且return的时候都要用Result.success()方法封装一下。,那么,有没有更优雅的方法?我们继续往下看:,实际使用场景中,并不是所有接口都需要统一格式。我们这里使用一个注解作为开关,按需控制接口返回格式。,这里有一点要注意,这个advice中supports方法中判断返回结果类型必须为非String类型。如果返回结果为String类型,那么result要转为json字符串后再返回,需要再写一个advice。,这段代码与最开始一样,并没有返回Result,仅仅加上了@ApiResult注解,我们看返回结果:,大功告成!,以上只是最精简的例子,实际使用中还结合了 统一异常封装、自定义返回格式 等功能。我们注意到@ApiResult注解中,有三个参数:successCode、successMsg、resultClass,就是为了自定义返回格式预留的,下面再看两个场景:,如果个别接口的返回格式与默认格式相同,但是要求code等于200时才代表成功,那么修改下successCode参数即可:,返回成功时,结果中的code和msg都变为设置的值:,如果某个接口的返回格式不是默认的返回格式,比如约定返回returnCode、returnDesc、data(对应默认的code、msg、data)。那么则需要新增一个返回结果类,比如ReturnResult:,然后修改接口上的@ApiResult注解中的resultClass属性:,这时,返回结果就变为想要的格式了:,只要按照上面一步步改造,即可实现统一返回格式,既简洁、又优雅。还等什么,搞起来吧~
© 版权声明
文章版权归作者所有,未经允许请勿转载。