Graceful Response 构建 Spring Boot 响应处理的方法

 更新时间:2024年01月25日 11:11:13   作者:小毕超  
Graceful Response是一个Spring Boot技术栈下的优雅响应处理器,提供一站式统一返回值封装、全局异常处理、自定义异常错误码等功能,本文介绍Graceful Response 构建 Spring Boot 下优雅的响应处理,感兴趣的朋友一起看看吧

一、Graceful Response

Graceful Response 是一个 Spring Boot 技术栈下的优雅响应处理器,提供一站式统一返回值封装、全局异常处理、自定义异常错误码等功能,使用Graceful Response进行web接口开发不仅可以节省大量的时间,还可以提高代码质量,使代码逻辑更清晰。

github地址:https://github.com/feiniaojin/graceful-response

对应 SpringBoot 版本

Spring Boot版本Graceful Response版本graceful-response-example分支
2.x3.4.0-boot23.4.0-boot2
3.x3.4.0-boot33.4.0-boot3

二、快速使用

引入依赖:

<dependency>
    <groupId>com.feiniaojin</groupId>
    <artifactId>graceful-response</artifactId>
    <version>3.4.0-boot2</version>
</dependency>

启动类增加注解:

@EnableGracefulResponse

声明测试接口:

@Slf4j
@RestController
@RequestMapping("/test")
public class TestController {
    /**
     * 返回对象形式
     */
    @GetMapping("/t1")
    public Map<String, String> t1() {
        //具体逻辑
        return Collections.singletonMap("status","abc");
    }
    /**
     * Command 形式
     */
    @GetMapping("/t2")
    public void t2() {
        // 具体逻辑
    }
}

测试 /test/t1 接口:

测试 /test/t2 接口:

三、返回格式调整

Graceful Response 内置了两种风格的返回,可以通过修改 graceful-response.response-style 进行切换,分别是:

默认格式:

graceful-response:
  response-style: 0

第二种模式:

{
  "status": {
    "code": 200,
    "msg": "success"
  },
  "payload": {
  }
}

格式如下:

{
  "code": "200",
  "msg": "success",
  "data": {
  }
}

如果需要自定义返回格式则需要实现 Response 接口,并在配置中通过graceful-response.response-class-full-name 进行指定,例如:

@Data
public class CustomResponse implements Response {

    private String code;

    private Long timestamp = System.currentTimeMillis();

    private String message;

    private Object data = Collections.EMPTY_MAP;

    @Override
    public void setStatus(ResponseStatus statusLine) {
        this.code = statusLine.getCode();
        this.message = statusLine.getMsg();
    }

    @Override
    @JsonIgnore
    public ResponseStatus getStatus() {
        return null;
    }

    @Override
    public void setPayload(Object payload) {
        this.data = payload;
    }

    @Override
    @JsonIgnore
    public Object getPayload() {
        return null;
    }
}

然后在配置文件中声明:

graceful-response:
  response-class-full-name: com.bxc.retrydemo.handler.CustomResponse

再次访问上面的测试接口:

四、自定义异常和错误码

当抛出异常时我们希望根据不同的异常返回不同的错误码,在 Graceful Response 中为我们提供了 @ExceptionMapper 注解,可以快速的指定返回的错误码和提示。

例如:

@ExceptionMapper(code = "1003", msg = "自定义异常", msgReplaceable = true)
public class MyException extends RuntimeException {
    public MyException() {
        super();
    }
    public MyException(String message) {
        super(message);
    }
    public MyException(String message, Throwable cause) {
        super(message, cause);
    }
    public MyException(Throwable cause) {
        super(cause);
    }
    public MyException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
        super(message, cause, enableSuppression, writableStackTrace);
    }
}

测试接口修改:

@Slf4j
@RestController
@RequestMapping("/test")
public class TestController {
    /**
     * 返回对象形式
     */
    @GetMapping("/t1")
    public Map<String, String> t1(Integer a) {
        //具体逻辑
        // ....
        // 抛出异常
        if (a == 0){
            throw new MyException();
        }
        return Collections.singletonMap("status","abc");
    }
    /**
     * Command 形式
     */
    @GetMapping("/t2")
    public void t2(Integer a) {
        //具体逻辑
        // ....
        // 抛出异常
        if (a == 0){
            throw new MyException("t2 接口执行异常");
        }
    }
}

测试 /test/t1 接口:

测试 /test/t2 接口:

五、参数校验异常错误码

有的时候我们需要校验某个参数是否合法,当在不同情况下需要返回不同的错误码,在 Graceful Response 中对JSR-303数据校验规范和Hibernate Validator进行了增强,Graceful Response自身不提供参数校验的功能,但是用户使用了Hibernate Validator后,Graceful Response可以通过@ValidationStatusCode注解为参数校验结果提供响应码,并将其统一封装返回。

例如:

@Data
public class TestDTO {
    @NotNull(message = "name 不可为空")
    @Length(min = 1, max = 5, message = "name 的长度在 1-5 之间")
    @ValidationStatusCode(code = "1003")
    private String name;
    @NotNull(message = "age 不可为空")
    @Min(value = 0,message = "age 不可小于 0 ")
    @ValidationStatusCode(code = "1004")
    private Integer age;
}

声明测试接口:

@Slf4j
@RestController
@RequestMapping("/test")
public class TestController {
    @PostMapping("/t3")
    public void t3(@Validated TestDTO dto) {
        //具体逻辑
        // ....
    }
}

测试 /test/t3 接口:

六、手动抛出指定状态码和信息

Graceful Response 提供了 GracefulResponse 通用工具类,在需要抛出GracefulResponseException时,只需要调用raiseException方法即可。

例如:

@Slf4j
@RestController
@RequestMapping("/test")
public class TestController {
    /**
     * 返回对象形式
     */
    @GetMapping("/t1")
    public Map<String, String> t1(Integer a) {
        //具体逻辑
        // ....
        // 抛出异常
        if (a == 0) {
            GracefulResponse.raiseException("1065", "自定义抛出异常");
        }
        return Collections.singletonMap("status", "abc");
    }
}

测试 /test/t1 接口:

七、例外请求放行

Graceful Response 会对所有的 controller 方法处理,如果希望跳过自定处理返回可以可以添加 @ExcludeFromGracefulResponse注解:

例如:

@Slf4j
@RestController
@RequestMapping("/test")
public class TestController {
    /**
     * 返回对象形式
     */
    @GetMapping("/t1")
    @ExcludeFromGracefulResponse
    public Map<String, String> t1(Integer a) {
        //具体逻辑
        // ....
        return Collections.singletonMap("status", "abc");
    }
}

也可以根据包名进行排除,例如:

graceful-response:
  exclude-packages:
    - springfox.**
graceful-response:
  exclude-packages:
    - org.springframework.boot.actuate.*

八、常用配置

graceful-response:
  # 自定义Response类的全限定名,默认为空。 
  # 配置response-class-full-name后,response-style将不再生效
  response-class-full-name:
  # 是否打印异常日志,默认为false
  print-exception-in-global-advice: false
  # Response风格,不配置默认为0
  response-style: 0
  # 自定义的成功响应码,不配置则为0
  default-success-code: 0
  # 自定义的成功提示,默认为ok
  default-success-msg: ok
  # 自定义的失败响应码,默认为1
  default-error-code: 1
  # 自定义的失败提示,默认为error
  default-error-msg: error
  # 全局的参数校验错误码,默认等于default-error-code
  default-validate-error-code:
  # 例外包路径(支持数字, *和**通配符匹配),该包路径下的controller将被忽略处理
  exclude-packages:
    - com.lizhiadmin.pro.module.*.controller
  # 设置是否将原生异常错误信息detailMessage字段填充到Response的msg中
  # 默认为false,即不打开
  origin-exception-using-detail-message: false

到此这篇关于Graceful Response 构建 Spring Boot 下优雅的响应处理的文章就介绍到这了,更多相关Spring Boot 响应处理内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Mybatis Select Count(*)的返回值类型介绍

    Mybatis Select Count(*)的返回值类型介绍

    这篇文章主要介绍了Mybatis Select Count(*)的返回值类型,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • 深入理解Java注解的使用方法

    深入理解Java注解的使用方法

    这篇文章主要为大家详细介绍了Java注解的使用方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-07-07
  • SpringBoot Shiro配置自定义密码加密器代码实例

    SpringBoot Shiro配置自定义密码加密器代码实例

    这篇文章主要介绍了SpringBoot Shiro配置自定义密码加密器代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-03-03
  • SpringBoot+Jersey跨域文件上传的实现示例

    SpringBoot+Jersey跨域文件上传的实现示例

    在SpringBoot开发后端服务时,我们一般是提供接口给前端使用,本文主要介绍了SpringBoot+Jersey跨域文件上传的实现示例,具有一定的参考价值,感兴趣的可以了解一下
    2024-07-07
  • xxl-job如何滥用netty导致的问题及解决方案

    xxl-job如何滥用netty导致的问题及解决方案

    本篇文章讲解xxl-job作为一款分布式任务调度系统是如何滥用netty的,导致了怎样的后果以及如何修改源码解决这些问题,netty作为一种高性能的网络编程框架,十分受大家喜爱,今天就xxl-job滥用netty这一问题给大家详细下,感兴趣的朋友一起看看吧
    2021-05-05
  • Java 数据库连接池c3p0 介绍

    Java 数据库连接池c3p0 介绍

    这篇文章主要介给大家分享了 Java 数据库连接池c3p0 介绍,c3p0 是一个成熟的、高并发的 JDBC 连接池库,支持缓存和 PreparedStatements 的重用。它以LGPL v.2.1或EPL v.1.0授权,下面我们就一起来看看文章内容的详细介绍吧,需要的朋友也可以参考一下
    2021-11-11
  • springboot整合mongodb并实现crud步骤详解

    springboot整合mongodb并实现crud步骤详解

    这篇文章主要介绍了springboot整合mongodb并实现crud,本文分步骤通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-08-08
  • Java 垃圾回收机制详解(动力节点Java学院整理)

    Java 垃圾回收机制详解(动力节点Java学院整理)

    在系统运行过程中,会产生一些无用的对象,这些对象占据着一定的内存,如果不对这些对象清理回收无用对象的内存,可能会导致内存的耗尽,所以垃圾回收机制回收的是内存。下面通过本文给大家详细介绍java垃圾回收机制,一起学习吧
    2017-02-02
  • SpringBoot @NotBlank错误的解决方案

    SpringBoot @NotBlank错误的解决方案

    这篇文章主要介绍了SpringBoot @NotBlank错误的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • Spring中WebDataBinder使用详解

    Spring中WebDataBinder使用详解

    这篇文章主要为大家详细介绍了Spring中WebDataBinder的使用,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-07-07

最新评论