2024 java使用Graceful Response，告别自己去封装响应，可以接收数据异常，快看我这一篇，足够你用！

news2024/11/24 19:25:18

参考官网手册地址：快速入门 | Docs

一、导入依赖（根据springboot查看对应依赖版本）

 <!--    Graceful    -->
        <dependency>
            <groupId>com.feiniaojin</groupId>
            <artifactId>graceful-response</artifactId>
            <version>3.5.2-boot2</version>
        </dependency>

二、配置文件

#graceful
graceful-response.response-class-full-name
# Response风格，不配置默认为0
graceful-response.response-style=1
# 自定义的成功提示，默认为ok
graceful-response.default-success-msg=success
# 自定义的成功响应码，不配置则为0
graceful-response.default-success-code=200
# 自定义的失败提示，默认为error
graceful-response.default-error-msg=error
# 自定义的失败响应码，默认为1
graceful-response.default-error-code=204
# 设置是否将原生异常错误信息detailMessage字段填充到Response的msg中
# 默认为false，即不打开
graceful-response.origin-exception-using-detail-message=true
# 是否打印异常日志，默认为false
print-exception-in-global-advice: false

1.特别注意，两种响应风格

响应风格0

{
    "status": {
        "code": "200",
        "msg": "success"
    },
    "payload": {
       //返回的数据
    }
}

响应风格1（个人常用）

{
    "code": "200",
    "msg": "success",
    "data": {
       //返回的数据
    }
}

两种都不是，请看官网手册，自定义就好

自定义Response格式 | Docs

2.还有关于异常的，请参考官网手册，则需选择

自定义异常和错误码 | Docs

三、启动类添加注解

@EnableGracefulResponse

四、直接使用

1.controller层
   @Autowired
    private 自己的Service 自己的Service;
  /**
     * 根据主键获取详细信息
     *
     * @param id 主键
     * @return 信息详情
     */
    @GetMapping("/getInfo/{id}")
    public 自己的实体类 getInfo(@PathVariable Integer id) {
        return 自己的Service.getInfo(id);
    }



2.service层
    /**
     * 根据主键获取详细信息
     *
     * @param id 主键
     * @return 信息详情
     */
   自己的实体类 getInfo(Integer id);



3.serviceImpl层
 /**
     * 根据主键获取详细信息
     *
     * @param id 主键
     * @return 信息详情
     */
  @Override
    public 自己的实体类 getInfo(Integer id) {
       //根据id获取实体类的逻辑
        自己的实体类 res=....
        return res;
    }