基于spring boot 文档的统一输入、统一输出_springboot 输入输出-优快云博客

飞书链接：‬‬‌⁠⁠⁠‌‬‌⁠‍‌‬⁠‍‬‍‬‍‌‍‬"J2EE架构与程序设计（Springboot微服务） - 飞书云文档

目录展示：

添加状态码接口StatusCode：

package com.example.demo.vo;

/**
 * @className:StatusCode 状态码接口
 * @author:wuzongbo
 * @date: 2023/7/20
 **/
public interface     StatusCode {
    public int getCode();
    public  String getMsg();
}

添加状态码枚举 ResultCode：

package com.example.demo.vo;

import lombok.Getter;

/**
 * @className:ResultCode
 * @author:wuzongbo
 * @date: 2023/7/20
 **/
@Getter
public enum ResultCode implements  StatusCode{
   SUCCESS(1,"请求成功"),
   FAIL(0,"请求成功"),
   NO_DATA_ERROR(2,"no data"),
   VALIDATE_ERROR(1002, "参数校验失败"),
   FAILED(1001, "请求失败"),
   APP_ERROR(2000, "业务异常"),
   PRICE_ERROR(2001, "价格异常"),
   RESPONSE_PACK_ERROR(1003, "response返回包装失败"),

   USER_LOGIN_OK(2002,"用户登录成功"),
   USER_LOGIN_ERROR(2003,"用户登录失败"),
   EXCEPTION_ERROR(5000,"系统内部错误，请联系管理员");
  
   private  int code;
   private  String msg;

   ResultCode(int code,String msg){
      this.code=code;
      this.msg=msg;
   }

}

创建包装类 ResultVo：

package com.example.demo.vo;

import lombok.AllArgsConstructor;
import lombok.Data;

import java.util.Map;

/**
 * @className:ResultVo
 * @author:wuzongbo
 * @date: 2023/7/20
 **/
@Data
@AllArgsConstructor
public class ResultVo {
    /**
     * 状态码
     */
    private int code;
    /**
     * 状态信息
     */
    private  String msg;
    /**
     * 返回数据
     */
    private  Object data;
    /**
     * 是否成功
     */
    private  boolean success;


    // 默认返回成功状态码，数据对象
    public ResultVo(Object data) {
        this.code = ResultCode.SUCCESS.getCode();
        this.msg = ResultCode.SUCCESS.getMsg();
        this.success=true;
        this.data = data;
    }
      // 返回指定状态码，数据对象
    public ResultVo(StatusCode statusCode, Object data) {
        this.code = statusCode.getCode();
        this.msg = statusCode.getMsg();
        this.data = data;
    }

    // 只返回状态码
    public ResultVo(StatusCode statusCode) {
        this.code = statusCode.getCode();
        this.msg = statusCode.getMsg();
        this.data = null;

    }

    public  static  ResultVo error(StatusCode statusCode){
        return  new ResultVo(statusCode.getCode(),statusCode.getMsg(),null,false);
    }
    public  static  ResultVo error(StatusCode statusCode,Object data){
        return  new ResultVo(statusCode.getCode(),statusCode.getMsg(),data,false);
    }

  

}

对RestController 的方法进行封装 ControllerResponseAdvice AOP：

package com.example.demo.advice;

import com.example.demo.vo.ResultCode;
import com.example.demo.vo.ResultVo;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
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;

import java.util.List;

/**
 * @className:ControllerResponseAdvice
 * @author:wuzongbo
 * @date: 2023/7/20
 **/
@RestControllerAdvice(basePackages = "com.jqr.mycuo.mycuo.controller.admin")
public class ControllerResponseAdvice implements ResponseBodyAdvice<Object> {
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {

        // response是ResultVo类型，或者注释了NotControllerResponseAdvice都不进行包装
        return !returnType.getParameterType().isAssignableFrom(ResultVo.class);

    }

    @Override
    public Object beforeBodyWrite(Object data, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        // String类型不能直接包装

        System.out.println(List.class.isAssignableFrom(returnType.getParameterType()) );
        if (returnType.getGenericParameterType().equals(String.class)) {
            ObjectMapper objectMapper = new ObjectMapper();
            try {
                // 将数据包装在ResultVo里后转换为json串进行返回
                return objectMapper.writeValueAsString(new ResultVo(data));
            } catch (JsonProcessingException e) {
                throw new ApiException(ResultCode.RESPONSE_PACK_ERROR, e.getMessage());
            }
        }
        /* 
        判断集合数据 是否为空
        */
        if(List.class.isAssignableFrom(returnType.getParameterType())){
            List data1=(List) data;
            if(data1.isEmpty()){
                throw new ApiException(ResultCode.NO_DATA_ERROR,"no data"); //自定义异常
            }
            return new ResultVo(data);

        }
        // 否则直接包装成ResultVo返回
        return new ResultVo(data);

    }
}

自定义异常类ApiException：

package com.example.demo.advice;

import com.example.demo.vo.ResultCode;
import com.example.demo.vo.StatusCode;
import lombok.Getter;

/**
 * @className:ApiException
 * @author:wuzongbo
 * @date: 2023/7/20
 **/
@Getter
public class ApiException extends  RuntimeException{
   private int code;
   private String msg;

   // 手动设置异常
   public ApiException(StatusCode statusCode, String message) {
      // message用于用户设置抛出错误详情，例如：当前价格-5，小于0
      super(message);
      // 状态码
      this.code = statusCode.getCode();
      // 状态码配套的msg
      this.msg = statusCode.getMsg();
   }
   public  ApiException(String msg){
      super(msg);
      this.code= ResultCode.APP_ERROR.getCode();
      this.msg=ResultCode.APP_ERROR.getMsg();
   }


}