SpringBoot 通過註解封裝API

包裝前：

{"name":"王月","age":0}

包裝後：

{"status":{"code":0,"name":"OK","msg":"succeed"},"result":{"name":"王月","age":0}}

實現思路：ResponseBodyAdvice+自定義註解

ResponseBodyAdvice實現類：

@ControllerAdvice
public class FocusResponseBodyAdvice implements ResponseBodyAdvice {

  /**
   * 在這個方法完成 "怎樣封裝結果集"
   */
  @Override
  public Object beforeBodyWrite(Object returnValue, MethodParameter methodParameter, MediaType mediaType, Class clas, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
    return ApiResp.ok(returnValue);
  }

  /**
   * 在這個方法完成 "是否對這個接口生效"  方案1.直接判斷方法名 方案二2.判斷哪些接口打註解[推薦]
   */

  @Override
  public boolean supports(MethodParameter methodParameter, Class clas) {
    AnnotatedElement annotatedElement = methodParameter.getAnnotatedElement();
    FocusAnnotation focusController = AnnotationUtils.findAnnotation(annotatedElement, FocusAnnotation.class);
    return focusController != null;
  }
}

自定義註解類：

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FocusAnnotation {
}

基類:

public class GirlFriend {

  private String name;
  private int age;

  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

  public int getAge() {
    return age;
  }

  public void setAge(int age) {
    this.age = age;
  }

}

響應包裝類：

  public class ApiResp {
  public static ApiResp OK = new ApiResp(Status.OK);

  public static ApiResp error(Status status) {
    return new ApiResp(status);
  }

  public static ApiResp ok(Object result) {
    return new ApiResp(Status.OK, result);
  }

  private final Status status;

  private final Object result;

  public ApiResp(Status status) {
    this(status, null);
  }

  public ApiResp(Status status, Object result) {
    this.status = status;
    this.result = result;
  }

  public Status getStatus() {
    return status;
  }

  public Object getResult() {
    return result;
  }
}

響應類包裝類2：

public class Status {
  public static Status OK = new Status(0, "OK", "succeed");

  private final int code;
  private final String name;
  private String msg;

  /**
   * @param code 錯誤碼
   */
  public Status(int code) {
    this(code, String.valueOf(code), String.valueOf(code));
  }

  /**
   * @param code 錯誤碼
   * @param name 錯誤的名字
   */
  public Status(int code, String name) {
    this(code, name, name);
  }

  /**
   * @param code 錯誤碼
   * @param name 錯誤的名字
   * @param msg  錯誤信息，用於提示
   */
  public Status(int code, String name, String msg) {
    this.code = code;
    this.name = name;
    this.msg = msg;
  }
  
  /**
   * @return 錯誤碼
   */
  public int getCode() {
    return code;
  }

  /**
   * @return 錯誤的名字
   */
  public String getName() {
    return name;
  }

  /**
   * @return 錯誤信息，用於提示
   */
  public String getMsg() {
    return msg;
  }

  /**
   * @param msg 錯誤信息，用於提示
   */
  public Status setMsg(String msg) {
    this.msg = msg;
    return this;
  }

}

Controller類：

@Controller
public class MainController {

    @RequestMapping(value = "/annotation",method = RequestMethod.GET)
    @ResponseBody
    @FocusAnnotation   //只有第一個加了自定義註解
    public GirlFriend sayHello(){
        GirlFriend girlFriend = new GirlFriend();
        girlFriend.setName("王月");
        return girlFriend;
    }

    @RequestMapping(value = "/annotation2",method = RequestMethod.GET)
    @ResponseBody
    public GirlFriend sayHello2(){
        GirlFriend girlFriend = new GirlFriend();
        girlFriend.setName("王月");
        return girlFriend;
    }
}