背??景越来越多的项目开始基于前后端分离模式开发，这对后端接口的消息格式有一定的要求。通常，我们使用JSON格式作为前后端交换的数据格式，以减少通信成本等。在这篇文章中，我将带你了解基于SpringBoot框架的返回消息的封装和统一的异常处理。基本消息格式通用消息格式通常包括状态码、状态描述（或错误信息）、业务数据等信息。在此基础上，不同的建筑师和项目建设者可能会做出调整。但总的来说，它们基本上是一样的。在SpringBoot项目中，接口返回的消息通常至少包含三个属性：code：请求接口的返回码，成功或异常的返回码，比如定义请求成功。message：请求接口的描述，即返回码的描述。data：请求接口成功返回的业务数据。示例消息如下：{"code":200,"message":"SUCCESS","data":{"info":"Testsuccessful"}}在上面的消息格式中，不同的设计者可能会有一些分歧，特别是代码值的定义。如果完全基于RESTfulAPI设计，code字段可能不需要存在，而是通过HTTP协议提供的GET、POST、PUT、DELETE操作完成资源访问。但在实践中，无论是由于国内大部分程序员的习惯，还是HTTP协议提供的操作方式的局限，很少有完全遵循RESTfulAPI方式设计的。通常通过自定义Code值来赋予业务意义或业务错误编码。虽然Code可以不完全遵循RESTfulAPI风格来定义，但是Code值的自定义有两种形式：跟随HTTP状态码和自定义。像上面的例子，用200表示返回成功，就是以HTTP响应状态码的形式返回，比如还有其他的400、401、404、500等，当然还有完全独立的定义，比如用0表示成功，1表示失败，再跟进通用代码，业务分类代码等来定义。在此，笔者暂不评论每种形式的优劣，仅列举几种常规形式。大家了解相应的情况，才能知其然，做出选择。响应参数封装实践创建一个SpringBoot项目，引入Lombok依赖（代码简化）。对应的核心依赖如下：org.projectlomboklombok创建一个枚举类来定义返回的错误代码：@Getter@AllArgsConstructorpublicenumResponseCodeEnums{SUCCESS(200,"success"),FAIL(500,"失败"),HTTP_STATUS_200(200,"ok"),HTTP_STATUS_400(400,"请求错误"),HTTP_STATUS_401(401,"无认证"),HTTP_STATUS_403(403,"无权限"),HTTP_STATUS_500(500,"服务器错误");私有最终代码；privatefinalStringmessage;}这里只定义了一些通用的、基于HTTP响应状态的代码，业务相关的代码可以根据业务需求定义。定义统一返回结果实体类：@DatapublicclassResponseInfo{/***statuscode*/protectedintcode;/***响应信息*/protectedStringmessage;/***返回数据*/私有T数据；publicstaticResponseInfosuccess(){返回新的ResponseInfo<>();}publicstaticResponseInfosuccess(Tdata){returnnewResponseInfo<>(data);}publicstaticResponseInfofail(Stringmessage){returnnewResponseInfo<>(ResponseCodeEnums.FAIL.getCode(),message);}publicResponseInfo(){this.code=ResponseCodeEnums.SUCCESS.getCode();这。message=ResponseCodeEnums.SUCCESS.getMessage();}publicResponseInfo(ResponseCodeEnumsstatusEnums){this.code=statusEnums.getCode();this.message=statusEnums.getMessage();}/***如果没有返回数据，可以人为指定状态码和提示信息*/publicResponseInfo(intcode,Stringmsg){this.code=code;this.message=味精；}/***当有数据返回时，状态码为200，默认提示信息为“操作成功！”*/publicResponseInfo(T数据）{this.data=数据；this.code=ResponseCodeEnums.SUCCESS.getCode();this.message=ResponseCodeEnums.SUCCESS.getMessage();}/***有数据返回，状态码为200，提示手动指定信息*/publicResponseInfo(Tdata,Stringmsg){this.data=data;this.code=ResponseCodeEnums.SUCCESS.getCode();this.message=味精；ResponseInfo中使用了泛型和公共方法，对构造方法进行了封装，方便在业务中使用。示例只提供了部分方法的封装，可以根据自己的业务场景和需求进一步封装。接口统一消息封装的使用：@Slf4j@RestControllerpublicclassTestController{@RequestMapping("/calc")publicResponseInfocalc(Integerid){try{//模拟异常业务代码intnum=1/ID;log.info("计算结果num={}",num);返回ResponseInfo.success();}catch(Exceptione){returnResponseInfo.fail("系统异常，请联系管理员！");}}}在浏览器中访问：http://localhost:8080/calc，返回结果如下：{"code":500,"message":"系统异常，请联系管理员！","data":null}这是因为没有传id参数，导致业务抛出异常，返回异常信息。在浏览器中访问：http://localhost:8080/calc?id=1，返回结果如下：{"code":200,"message":"success","data":null}返回结果通常情况下。统一的异常处理在上面的例子中，我们以try...catch的形式捕获并处理异常。在SpringBoot中，我们可以通过RestControllerAdvice注解定义全局的异常处理，这样就不用到处try...catch了。@Slf4j@RestControllerAdvicepublicclassExceptionHandlerAdvice{/***参数格式异常处理*/@ExceptionHandler({IllegalArgumentException.class})@ResponseStatus(HttpStatus.BAD_REQUEST)publicResponseInfobadRequestException((IllegalArgumentException.logerexr)格式为invalid:{}",ex.getMessage());returnnewResponseInfo<>(HttpStatus.BAD_REQUEST.value()+"","参数格式不匹配！");}/***权限不足异常处理*/@ExceptionHandler({AccessDeniedException.class})@ResponseStatus(HttpStatus.FORBIDDEN)publicResponseInfobadRequestException(AccessDeniedExceptionex){返回新的ResponseInfo<>(HttpStatus.FORBIDDEN.value()+"",ex.getMessage());}/***缺少参数的异常处理*/@ExceptionHandler({MissingServletRequestParameterException.class})@ResponseStatus(HttpStatus.BAD_REQUEST)publicResponseInfobadRequestException(Exceptionex){returnnewResponseInfo<>(Http_REQUS.BVAlue()+"","缺少必需的参数！");}/***空指针异常*/@ExceptionHandler(NullPointerException.class)@ResponseStatus(value=HttpStatus.INTERNAL_SERVER_ERROR)publicResponseInfohandleTypeMismatchException(NullPointerExceptionex){log.error("NullPointerException,{}",ex.getMessage());returnResponseInfo.fail("空指针异常");}@ExceptionHandler(Exception.class)@ResponseStatus(value=HttpStatus.INTERNAL_SERVER_ERROR)publicResponseInfohandleUnexpectedServer(Exceptionex){log.error("系统异常：",ex);returnResponseInfo.fail("系统出现异常，请联系管理员");}/***系统异常处理*/@ExceptionHandler(Throwable.class)@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)publicResponseInfoexception(Throwablethrowable){log.error("系统异常",throwable);returnnewResponseInfo<>(HttpStatus.INTERNAL_SERVER_ERROR.value()+"系统异常，请联系管理员！");}}在上面的方法中，对一些常见的异常进行了统一的处理。通常，业务异常是根据业务需要定义和处理的。您可以根据项目中异常的使用情况进行扩展。关于@RestControllerAdvice的几点说明：@RestControllerAdvice注解包含@Component注解，它将被注解的类作为组件交给Spring管理。@RestControllerAdvice注解中包含@ResponseBody注解，在处理异常后输出一个JSON格式的打包数据给调用者。@RestControllerAdvice注解有一个basePackages属性，用于拦截哪个包中的异常信息，一般不指定，拦截项目工程中的所有异常。通过方法上的@ExceptionHandler注解指定具体的异常，在方法中处理异常信息，最后通过统一的JSON结构将结果返回给调用者。重新定义一个接口：@RequestMapping("/calc1")publicResponseInfocalc1(Integerid){//模拟异常业务代码intnum=1/id;log.info("计算结果num={}",num);返回ResponseInfo.success();}请求时，不传id值，即在浏览器中访问：{"code":500,"message":"空指针异常","data":null}可见统一异常handling拦截空指针异常，返回ExceptionHandlerAdvice中定义的统一消息格式。总结在使用SpringBoot或者其他项目的时候，统一的消息格式和统一的异常处理是很有必要的。本文介绍基于SpringBoot的实现。如果项目中使用了其他技术栈，可以考虑相应的处理方式。同时，可以将日常生活中很多类似的功能统一处理，避免大量无效的硬编码。
