springboot2.2.X手册：构建多元化的API接口，我们这样子设计

 

无规矩不成方圆，任何一个软件，如果刚开始没有定义好规范，任由各个开发进行按照自己的喜好进行开发，后面运维的兄弟，估计整天就要骂娘了。

开发一时爽，运维火葬场，运维一个软件，往往比开发一个软件要辛苦好多，毕竟很多时候，运维都要从不明白需求，不理解系统架构，不理解数据结构的0开始。

今天来做一个定义多业务的接口规范，考虑到每家企业的业务不一样，只提供参考。

---

目录

定义多业务接口

统一接口消息体

定义全局异常

构建拦截的信息体

整合swagger接口可视化

运行

---

 

 

 

定义多业务接口

在后端的服务中，我们的服务只会提供API接口，以便提供数据，根据业务需求，我们把接口分为三类

1、后端系统服务接口view，主要提供给后台管理系统使用，面向B端

2、前端系统服务接口application，主要提供给小程序，H5使用，面向C端

3、第三方服务接口external，主要提供给第三方使用

 

 

 

统一接口消息体

/**
 * 消息影响实体
 * @author：溪云阁
 * @date：2020年5月2日
 */
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
@ApiModel(value = "响应类", description = "响应类")
public class ResponseMsg<T> {

    @ApiModelProperty(value = "响应状态", example = "00，成功；01，失败")
    private String respStatus;

    @ApiModelProperty(value = "响应描述", example = "例如:找不到用户信息")
    private Object respDesc;

    @ApiModelProperty(value = "响应实体")
    private T data;

}

定义全局异常

1、统一异常

/**
 * 全局公共异常类
 * @author：溪云阁
 * @date：2020年5月2日
 */
@Slf4j
public class CommonRuntimeException extends RuntimeException {

    private static final long serialVersionUID = 1L;

    @Setter
    @Getter
    private Object[] params;

    public CommonRuntimeException(Throwable e, Object... params) {
        super(e);
        this.params = params;
    }

    public CommonRuntimeException(Object... params) {
        this(null, params);
    }

    public CommonRuntimeException(Throwable e) {
        this(null, e);
    }

    public CommonRuntimeException() {
    }

    @Override
    public String getMessage() {
        log.error("获取到的错误信息:{}", super.getMessage());
        log.error("获取到的错误内容:{}", super.fillInStackTrace());
        return super.getMessage();
    }

    /**
     * 重写fillInStackTrace 业务异常不需要堆栈信息，提高效率.
     * @author 溪云阁
     * @return
     */
    @Override
    public Throwable fillInStackTrace() {
        return this;
    }
}

2、统一异常处理

/**
 * 统一异常处理
 * @author：溪云阁
 * @date：2020年5月2日
 */
@RestControllerAdvice
public class CommonExceptionHandler {

    /**
     * 对错误信息进行处理
     * @author 溪云阁
     * @param e 拦截到的错误信息
     * @r