Skip to content

Latest commit

 

History

History
76 lines (59 loc) · 2.31 KB

agileway-web.MD

File metadata and controls

76 lines (59 loc) · 2.31 KB
Raw

agileway-web

统一返回值

不论是正常，还是异常情况，都提供统一返回值：

public final class RestRespBody<T> {
    private boolean success;
    private T data;
    private int statusCode;
    private long timestamp;
    private String errorCode;
    private String errorMessage;

}

结构描述：

{
  "success": false, # 是否成功
  "statusCode": 400, # http 响应状态码
  "timestamp": 1231231231423, # 时间戳
  "errorCode": "UM-xxx0" , # 错误码
  "errorMessage": "请求参数错误", # 错误内容
  "data": "返回的数据"

}

配置

agileway:
  rest:
    global-response-body:
      # 类别1：基于 package的配置
      basePackages: # Array<String> 配置指定的包下的类要进行统一的响应处理
      excludedBasePackages: # Array<String> 配置package 级别的排除，基于 basePackages进行排除
      excludedBasePackageClasses: # Array<String> 配置package 级别的排除，基于 basePackages进行排除
      # 类别2：基于 Class的配置
      assignableTypes: # Array<String> 配置只有这些类的子类才会被包含
      excludedAssignableTypes: # Array<String> 配置的这些类的子类会被排除
      # 类别3：基于 Annotation的配置，这些注解可以在类上，也可以在方法上。
      annotations: # Array<String> 类上存在这些注解的，都会被包含
      excludedAnnotations: # Array<String> 类上存在这些注解的，都会被排除
    
      # 类别4：直接进行 方法排除
      excludedMethods: # Array<String> 要排除的方法， 配置格式为：classFQN.methodName。

统一的异常处理

Spring 中虽然提供了统一的异常处理（基于@ControllerAdvice），但仍然有不能够处理的情况： 1）有人喜欢对Exception做二次包装，例如包装为RuntimeException 2）只能处理Controller层的异常，对于Filter中的处理不了 3）只能用于Spring应用

在Spring Boot 应用中启用统一异常处理、统一响应功能

在SpringBoot应用中如何启用? 1）引入 agileway-spring 2）在启动类上添加 @EnableGlobalRestHandlers 注解 3）在application.yml中做如下配置：

agileway:
  rest:
    global-response-body:
      base-packages:
        - com.bes.license.server.bootstrap.controller