接口交互

前端和后端进行交互，前端按照约定请求 URL 路径，并传入相关参数，后端服务器接收请求，进行业务处理，返回数据给前端。

针对 URL 路径的 restful 风格，以及传入参数的公共请求头的要求（如：app_version,api_version,device 等），老顾这里就不介绍了，小伙伴们可以自行去了解，也比较简单。

着重介绍一下后端服务器如何实现把数据返回给前端？

返回格式
后端返回给前端我们一般用 JSON 体方式，定义如下：

  1. {
  2.     #返回状态码
  3.     code:integer,        
  4.     #返回信息描述
  5.     message:string,
  6.     #返回值
  7.     data:object
  8. }

CODE 状态码

code 返回状态码，一般小伙伴们是在开发的时候需要什么，就添加什么。

如接口要返回用户权限异常，我们加一个状态码为 101 吧，下一次又要加一个数据参数异常，就加一个 102 的状态码。这样虽然能够照常满足业务，但状态码太凌乱了

我们应该可以参考 HTTP 请求返回的状态码，下面是常见的HTTP状态码：

200 - 请求成功 301 - 资源（网页等）被永久转移到其它URL 404 - 请求的资源（网页等）不存在 500 - 内部服务器错误

我们可以参考这样的设计，这样的好处就把错误类型归类到某个区间内，如果区间不够，可以设计成 4 位数。

  1. #1000～1999 区间表示参数错误
  2. #2000～2999 区间表示用户错误
  3. #3000～3999 区间表示接口异常

image.png
这样前端开发人员在得到返回值后，根据状态码就可以知道，大概什么错误，再根据 message 相关的信息描述，可以快速定位。

优雅优化

上面我们看到在 Result 类中增加了静态方法，使得业务处理代码简洁了。但小伙伴们有没有发现这样有几个问题：

  1. 每个方法的返回都是 Result 封装对象，没有业务含义
  2. 在业务代码中，成功的时候我们调用 Result.success，异常错误调用 Result.failure。是不是很多余
  3. 上面的代码，判断 id 是否为 null，其实我们可以使用 hibernate validate 做校验，没有必要在方法体中做判断。

我们最好的方式直接返回真实业务对象，最好不要改变之前的业务方式，如下图

  1. @RequestMapping("/queryList")
  2. public List queryQuestionRecommendList1() {
  3.     List list = new ArrayList();
  4.     list.add("zcq");
  5.     return list;
  6. }

这个和我们平时的代码是一样的，非常直观，直接返回 order 对象，这样是不是很完美。那实现方案是什么呢？

实现方案

小伙伴们怎么去实现是不是有点思路，在这个过程中，我们需要做几个事情

  1. 定义一个注解 @ResponseResult，表示这个接口返回的值需要包装一下
  2. 拦截请求，判断此请求是否需要被 @ResponseResult 注解
  3. 核心步骤就是实现接口 ResponseBodyAdvice 和 @ControllerAdvice，判断是否需要包装返回值，如果需要，就把 Controller 接口的返回值进行重写。

注解类

  1. @Retention(RetentionPolicy.RUNTIME)
  2. @Target({ElementType.TYPE, ElementType.METHOD})
  3. @Documented
  4. public @interface ResponseResult {
  6. }

用来标记方法的返回值，是否需要包装

拦截器

拦截请求，是否此请求返回的值需要包装，其实就是运行的时候，解析 @ResponseResult 注解

  1. @Component
  2. public class ResponseResultInterceptor implements HandlerInterceptor {
  4.     /**
  5.      * 标记名称
  6.      */
  7.     public static final String RESPONSE_RESULT_ANN = "RESPONSE-RESULT-ANN";
  9.     @Override
  10.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
  11.         if (handler instanceof HandlerMethod) {
  12.             final HandlerMethod handlerMethod = (HandlerMethod) handler;
  13.             final Class<?> clazz = handlerMethod.getBeanType();
  14.             final Method method = handlerMethod.getMethod();
  15.             if (clazz.isAnnotationPresent(ResponseResult.class)) {
  16.                 request.setAttribute(RESPONSE_RESULT_ANN, clazz.getAnnotation(ResponseResult.class));
  17.             } else if (method.isAnnotationPresent(ResponseResult.class)) {
  18.                 request.setAttribute(RESPONSE_RESULT_ANN, method.getAnnotation(ResponseResult.class));
  19.             }
  20.         }
  21.         return true;
  22.     }
  23. }

此代码核心思想，就是获取此请求，是否需要返回值包装，设置一个属性标记。

重写返回体

  1. @Slf4j
  2. @ControllerAdvice
  3. public class ResponseResultHandler implements ResponseBodyAdvice<Object> {
  5.     /**
  6.      * 标记名称
  7.      */
  8.     public static final String RESPONSE_RESULT_ANN = "RESPONSE-RESULT-ANN";
  10.     @Override
  11.     public boolean supports(final MethodParameter returnType, final Class<? extends HttpMessageConverter<?>> converterType) {
  12.         ServletRequestAttributes sra = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
  13.         HttpServletRequest request = sra.getRequest();
  14.         // 判断请求是否有包装标记
  15.         ResponseResult responseResultAnn = (ResponseResult) request.getAttribute(RESPONSE_RESULT_ANN);
  16.         return responseResultAnn != null;
  17.     }
  19.     @Override
  20.     public Object beforeBodyWrite(final Object body,
  21.                                   final MethodParameter returnType,
  22.                                   final MediaType selectedContentType,
  23.                                   final Class<? extends HttpMessageConverter<?>> selectedConverterType,
  24.                                   final ServerHttpRequest request,
  25.                                   final ServerHttpResponse response) {
  27.         log.info("进入返回体，格式重写处理中...");
  29.         return Result.buildSuccessResult(body);
  30.     }
  31. }

上面代码就是判断是否需要返回值包装，如果需要就直接包装。这里我们只处理了正常成功的包装，如果方法体报异常怎么办？处理异常也比较简单，只要判断 body 是否为异常类。
image.png

怎么做全局的异常处理，篇幅原因，这里就不做介绍了，只要思路理清楚了，自行改造就行。

重写 Controller

  1. @ResponseResult
  2.     @RequestMapping("/test")
  3.     public List queryList() {
  4.         List list = new ArrayList();
  5.         list.add("zcq");
  6.         return list;
  7.     }

返回：

  1. {
  2.     "success": true,
  3.     "code": 200,
  4.     "message": "请求成功",
  5.     "data": [
  6.         "zcq"
  7.     ]
  8. }

在控制器类上或者方法体上加上 @ResponseResult 注解，这样就 ok 了，简单吧。到此返回的设计思路完成，是不是又简洁，又优雅。

总结
这个方案还有没有别的优化空间，当然是有的。如：每次请求都要反射一下，获取请求的方法是否需要包装，其实可以做个缓存，不需要每次都需要解析。当然整体思路了解，小伙伴们就可以在此基础上面自行扩展。