Java后端统一API方案

需求分析

  1. 接口请求格式的统一设计
  2. 接口响应格式的统一设计
  3. 灵活配置统一接口

统一API的格式及配置方式

将请求体和响应体，分为公有域和私有域(data数据体)两部分。请求体的公有域主要包含私有域(data数据体)。响应体的公有域中包含响应状态码、响应状态信息、错误详情和私有域(data数据体)。
对于需要统一API处理的接口，可以通过注解进行配置

公有域的定义
package com.example.demo.api;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class PublicDomain<T> implements Serializable {

    private T data;
}

请求体可直接使用公有域格式

响应体的定义
package com.example.demo.api;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import lombok.Data;

@Data
@JsonPropertyOrder({"resCode", "resMessage", "errorMessage", "data"})
public class ResultVo<T> extends PublicDomain<T> {

    // 响应状态码
    private int resCode;
    // 错误详情
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private String errorMessage;

    public ResultVo() {
    }

    public ResultVo(T data) {
        super(data);
    }

    public ResultVo(int resCode, T data) {
        super(data);
        this.resCode = resCode;
    }

    public ResultVo(RuntimeException e) {
        this.resCode = 2;
        this.errorMessage = e.getMessage();
    }

    public ResultVo(Throwable throwable) {
        this.resCode = 3;
        this.errorMessage = throwable.getMessage();
    }

    public ResultVo(int resCode, String errorMessage, T data) {
        super(data);
        this.resCode = resCode;
        this.errorMessage = errorMessage;
    }

    public int getResCode() {
        return resCode;
    }

    // 响应状态信息
    public String getResMessage() {
        switch (resCode) {
            case 0:
                return "success";
            case 1:
                return "fail";
            case 2:
                return "validate fail";
            default:
                return "error";
        }
    }

    public String getErrorMessage() {
        return errorMessage;
    }
}
  • @JsonPropertyOrder注解表示属性顺序
  • @JsonInclude(JsonInclude.Include.NON_NULL)注解表示，只有该属性不为null时才显示

样例中的响应状态码设计比较简单：

  • 0：响应成功，对应的resMessage为：success
  • 1：处理失败，对应的resMessage为：fail
  • 2：校验失败，对应的resMessage为：validate fail
  • 3：处理异常，对应的resMessage为：error
API接口配置注解
package com.example.demo.api;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Documented
@Target({ElementType.TYPE, ElementType.METHOD})
@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface Api {

    boolean request() default true;

    boolean response() default true;
}
  • request属性表示在请求时将data数据体转化为请求体对象
  • response属性表示响应时将响应体对象使用公有域类封装

统一API的处理

请求体的处理

请求体的处理需要基于RequestBodyAdvice实现

RequestBodyAdvice接口

该接口用于分别在请求体读取之前和读取后并且尚未转化为请求体对象时，对请求进行定制化处理。该接口存在一个适配器类RequestBodyAdviceAdapter，为接口定义的部分方法提供了默认实现。该接口定义了以下4个方法：

  • boolean supports(MethodParameter methodParameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType)
  • HttpInputMessage beforeBodyRead(HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) throws IOException
  • Object afterBodyRead(Object body, HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType)
  • Object handleEmptyBody(@Nullable Object body, HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType)
  • supports 方法用于判断是否支持对于当前请求的拦截处理。MethodParameter是请求参数(详情见下文)。Type是请求体对象的类型，MethodParameter也提供了一个getParameterType()的方法判断请求体对象类型，区别在于targetType可能是一个泛型类型，MethodParameter.getParameterType()返回的是一个没有泛型参数的类对象。Class<? extends HttpMessageConverter<?>>是http消息转化器类型，默认的是MappingJackson2HttpMessageConverter
  • beforeBodyRead 方法在请求体被读取前调用。HttpInputMessage是对请求的封装，包括请求头和请求体。其中请求体是以输入流InputStream的形式表示的
  • afterBodyRead 方法在请求体被读取后并且尚未被转化为对象时被调用
  • handleEmptyBody 方法在请求体为空时被调用
MethodParameter类

对方法参数及其上下文的封装,包括方法的入参和返回参数,并提供了一些相应的辅助方法。经常用于表示请求体对象和响应体对象。主要方法如下：

  • public Class<?> getParameterType()
  • public Method getMethod()
  • public <A extends Annotation> boolean hasMethodAnnotation(Class<A> annotationType)
  • public <A extends Annotation> A getMethodAnnotation(Class<A> annotationType)
  • public Class<?> getDeclaringClass()
  • public Class<?> getContainingClass()
  • getParameterType方法获取的是声明参数的的类对象
  • getMethod方法是获取参数所在方法
  • hasMethodAnnotation方法是判断参数所在方法是否存在某个类型的注解
  • getMethodAnnotation方法是获取参数所在方法某个类型的注解
  • getDeclaringClass方法是获取声明参数所在的类
  • getContainingClass方法是获取参数实际所在的类。与前一个方法的区别是，实际执行时，参数可能由于接口、动态代理等原因，参数实际所在的类是声明的类的子类或实现类
方案
  1. 在beforeBodyRead方法中对HttpInputMessage进行定制，修改请求体的输入流，将统一的基于公有域的输入流变成基于请求体对象的输入流(说直白点就是只把data属性的数据的流)
  2. 在afterBodyRead方法中使用PublicDomain和请求体类动态生成一个泛型类型(ParamererizedType)，用于将原请求体解析为公有域对象，然后将其私有域对象返回
样例代码：
package com.example.demo.api;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.MethodParameter;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpInputMessage;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.util.StreamUtils;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.RequestBodyAdviceAdapter;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Type;
import java.nio.charset.StandardCharsets;

@RestControllerAdvice(basePackages = "com.example.demo")
public class RequesstApiAdvice extends RequestBodyAdviceAdapter {

    @Autowired
    private ObjectMapper objectMapper;

    @Override
    public boolean supports(MethodParameter methodParameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) {
        Api apiAnn = methodParameter.hasMethodAnnotation(Api.class) ?
                methodParameter.getMethodAnnotation(Api.class) : methodParameter.getDeclaringClass().getAnnotation(Api.class);
        return apiAnn != null && apiAnn.request() && !PublicDomain.class.equals(methodParameter.getParameterType());
    }

    @Override
    public HttpInputMessage beforeBodyRead(HttpInputMessage inputMessage, MethodParameter parameter,
                                           Type targetType, Class<? extends HttpMessageConverter<?>> converterType) throws IOException {
        JsonNode jsonNode = objectMapper.readTree(inputMessage.getBody());
        JsonNode dataJsonNode = jsonNode.get("data");
        return new HttpInputMessage() {
            @Override
            public InputStream getBody() {
                if (dataJsonNode == null) {
                    return StreamUtils.emptyInput();
                }
                return new ByteArrayInputStream(dataJsonNode.toString().getBytes(StandardCharsets.UTF_8));
            }

            @Override
            public HttpHeaders getHeaders() {
                return inputMessage.getHeaders();
            }
        };
    }
}

项目中加入该组件后，凡是在控制类或接口方法上定义了@Api注解的接口，都必须将请求体放在data属性中了

响应体的处理

响应体的处理可以基于ResponseBodyAdvice，也可以基于HandlerMethodReturnValueHandler

ResponseBodyAdvice接口

对于响应的定制处理，有以下两个方法：

  • boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType)
  • T beforeBodyWrite(@Nullable T body, MethodParameter returnType, MediaType selectedContentType,
    Class<? extends HttpMessageConverter<?>> selectedConverterType,
    ServerHttpRequest request, ServerHttpResponse response)
  • supports：该组件是否支持给定的控制器方法返回类型和选择的HttpMessageConverter类型。用于判断是否需要做处理
  • beforeBodyWrite：在选择HttpMessageConverter之后调用，在调用其写方法之前调用。用于做返回处理
基于ResponseBodyAdvice的样例代码：
package com.example.demo.api;

import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

@RestControllerAdvice(basePackages = "com.example.demo")
public class ResponseApiAdvice implements ResponseBodyAdvice {
    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        Api apiAnn = returnType.hasMethodAnnotation(Api.class) ?
                returnType.getMethodAnnotation(Api.class) : returnType.getDeclaringClass().getAnnotation(Api.class);
        return apiAnn != null && apiAnn.response();
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        return body instanceof ResultVo ? body : new ResultVo<>(body);
    }
}
HandlerMethodReturnValueHandler接口

HandlerMethodReturnValueHandler是处理控制器方法返回值的策略接口，定义的方法有以下两个：

  • boolean supportsReturnType(MethodParameter returnType)
  • void handleReturnValue(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception
  • supportsReturnType方法用于判断是否支持声明的响应体类型
  • handleReturnValue方法用于对响应进行处理
基于HandlerMethodReturnValueHandler的样例代码
package com.example.demo.api;

import org.springframework.core.MethodParameter;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.method.support.HandlerMethodReturnValueHandler;
import org.springframework.web.method.support.ModelAndViewContainer;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter;
import org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor;

import java.util.ArrayList;
import java.util.List;

@Component
public class ApiHandlerMethodReturnValueHandler implements HandlerMethodReturnValueHandler {

    private HandlerMethodReturnValueHandler handler;

    public ApiHandlerMethodReturnValueHandler(RequestMappingHandlerAdapter requestMappingHandlerAdapter) {
        List<HandlerMethodReturnValueHandler> originHandlers = requestMappingHandlerAdapter.getReturnValueHandlers();
        List<HandlerMethodReturnValueHandler> newHandlers = new ArrayList<>(originHandlers.size());
        for (HandlerMethodReturnValueHandler originHandler : originHandlers) {
            if (originHandler instanceof RequestResponseBodyMethodProcessor) {
                newHandlers.add(this);
                handler = originHandler;
            } else {
                newHandlers.add(originHandler);
            }
        }
        requestMappingHandlerAdapter.setReturnValueHandlers(newHandlers);
    }

    @Override
    public boolean supportsReturnType(MethodParameter returnType) {
        Api apiAnn = returnType.hasMethodAnnotation(Api.class) ?
                returnType.getMethodAnnotation(Api.class) : returnType.getDeclaringClass().getAnnotation(Api.class);
        return handler.supportsReturnType(returnType) && apiAnn != null && apiAnn.response();
    }

    @Override
    public void handleReturnValue(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception {
        Object response = returnValue instanceof ResultVo ? returnValue : new ResultVo<>(returnValue);
        handler.handleReturnValue(response, returnType, mavContainer, webRequest);
    }
}

异常情况的统一处理

异常情况的全局处理主要通过ExceptionHandler注解

package com.example.demo.api;

import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice(basePackages = "com.example.demo")
public class GlobalExceptionResolver {

    @ExceptionHandler(RuntimeException.class)
    public ResultVo throwableHandle(RuntimeException e) {
        return new ResultVo(e);
    }

    @ExceptionHandler(Throwable.class)
    public ResultVo throwableHandle(Throwable throwable) {
        return new ResultVo(throwable);
    }
}

如果是特定控制器内的处理，可以把throwableHandle方法写在Controller内

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 216,240评论 6赞 498
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 92,328评论 3赞 392
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 162,182评论 0赞 353
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 58,121评论 1赞 292
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 67,135评论 6赞 388
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 51,093评论 1赞 295
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 40,013评论 3赞 417
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,854评论 0赞 273
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 45,295评论 1赞 310
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,513评论 2赞 332
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,678评论 1赞 348
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,398评论 5赞 343
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,989评论 3赞 325
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,636评论 0赞 22
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,801评论 1赞 268
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,657评论 2赞 368
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,558评论 2赞 352

推荐阅读更多精彩内容