拒绝写重复代码,试试这套开源的 SpringBoot 组件,效率翻倍~

【项目实战】Graceful Response是Spring Boot 技术栈下的优雅响应处理组件,核心目标是解决后端接口开发中“响应格式不统一、异常处理冗余、错误码管理混乱”三大痛点 隐藏timestamp字段。自定义成功默认错误码(如将 200 改为 0)。自定义响应字段名(如将code改为errorCode// 1. 定义业务异常(继承组件提供的基础异常类)// 关联错误码:1001,错误信息:用户不存在super(1001, "用户不存在");// 2. Controller 中直接抛出,无需处理// 直接抛出// 3. 组件自动返回响应"message": "用户不存在",系统错误码:1000~9999(如 500:系统内部错误、400:参数错误)。 阅读详情

👉 这是一个或许对你有用的社群

🐱 一对一交流/面试小册/简历优化/求职解惑,欢迎加入「芋道快速开发平台」知识星球。下面是星球提供的部分资料: 

c538a4e5f5ad9062c3b75d2929cf4de0.gif

👉这是一个或许对你有用的开源项目

国产 Star 破 10w+ 的开源项目,前端包括管理后台 + 微信小程序,后端支持单体和微服务架构。

功能涵盖 RBAC 权限、SaaS 多租户、数据权限、商城、支付、工作流、大屏报表、微信公众号、CRM 等等功能:

  • Boot 仓库:https://gitee.com/zhijiantianya/ruoyi-vue-pro

  • Cloud 仓库:https://gitee.com/zhijiantianya/yudao-cloud

  • 视频教程:https://doc.iocoder.cn

【国内首批】支持 JDK 21 + SpringBoot 3.2.2、JDK 8 + Spring Boot 2.7.18 双版本 

来源:github.com/feiniao
jin/graceful-response


1 简介

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

强烈推荐你花3分钟学会它!

本项目案例工程代码:https://github.com/feiniaojin/graceful-response-example.git ,注意选择最新版本的分支。

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

注意,3.2.1-boot2版本的Graceful Response源码由单独的仓库进行维护,地址为:https://github.com/feiniaojin/graceful-response-boot2

3.2.1-boot2和3.2.1-boot3除了支持的SpringBoot版本不一样,其他实现完全一致,Maven引用时只需要根据对应的SpringBoot版本选择Graceful Response的version即可,两者的groupId、artifactId是一致的。

基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

  • 项目地址:https://github.com/YunaiV/ruoyi-vue-pro

  • 视频教程:https://doc.iocoder.cn/video/

2 快速入门

2.1 Spring Boot接口开发现状

目前,业界使用Spring Boot进行接口开发时,往往存在效率底下、重复劳动、可读性差等问题。以下伪代码相信大家非常熟悉,我们大部分项目的Controller接口都是这样的。

@Controller
public class Controller {

    @GetMapping("/query")
    @ResponseBody
    public Response query(Map<String, Object> paramMap) {
        Response res = new Response();
        try {
            //1.校验params参数合法性,包括非空校验、长度校验等
            if (illegal(paramMap)) {
                res.setCode(1);
                res.setMsg("error");
                return res;
            }
            //2.调用Service的一系列操作,得到查询结果
            Object data = service.query(params);
            //3.将操作结果设置到res对象中
            res.setData(data);
            res.setCode(0);
            res.setMsg("ok");
            return res;
        } catch (Exception e) {
            //4.异常处理:一堆丑陋的try...catch,如果有错误码的,还需要手工填充错误码
            res.setCode(1);
            res.setMsg("error");
            return res;
        }
    }
}

这段伪代码存在什么样的问题呢?

第一个问题,效率低下。 Controller层的代码应该尽量简洁,上面的伪代码其实只是为了将数据查询的结果进行封装,使其以统一的格式进行返回。例如以下格式的响应体:

{
  "code": 0,
  "msg": "ok",
  "data": {
    "id": 1,
    "name": "username"
  }
}

查询过程中如果发生异常,需要在Controller进行手工捕获,根据捕获的异常人工地设置错误码,当然,也用同样的格式封装错误码进行返回。

可以看到,除了调用service层的query方法这一行,其他大部分的代码都执行进行结果的封装,大量的冗余、低价值的代码导致我们的开发活动效率很低。

第二个问题,重复劳动。 以上捕获异常、封装执行结果的操作,每个接口都会进行一次,因此造成大量重复劳动。

第三个问题,可读性低。 上面的核心代码被淹没在许多冗余代码中,很难阅读,如同大海捞针。

我们可以通过Graceful Response这个组件解决这样的问题。

2.2. 快速入门

2.2.1 引入Graceful Response组件

Graceful Response已发布至maven中央仓库,我们可以直接引入到项目中。

maven依赖如下:

<dependency>
    <groupId>com.feiniaojin</groupId>
    <artifactId>graceful-response</artifactId>
    <version>{latest.version}</version>
</dependency>
Spring Boot版本Graceful Response最新版本
2.x3.2.1-boot2
3.x3.2.1-boot3
2.2.2 启用Graceful Response

在启动类中引入@EnableGracefulResponse注解,即可启用Graceful Response组件。

@EnableGracefulResponse
@SpringBootApplication
public class ExampleApplication {
    public static void main(String[] args) {
        SpringApplication.run(ExampleApplication.class, args);
    }
}
2.2.3 Controller层

引入Graceful Response后,我们不需要再手工进行查询结果的封装,直接返回实际结果即可,Graceful Response会自动完成封装的操作。

Controller层示例如下。

@Controller
public class Controller {
    @RequestMapping("/get")
    @ResponseBody
    public UserInfoView get(Long id) {
        log.info("id={}", id);
        return UserInfoView.builder().id(id).name("name" + id).build();
    }
}

在示例代码中,Controller层的方法直接返回了UserInfoView对象,没有进行封装的操作,但经过Graceful Response处理后,我们还是得到了以下的响应结果。

{
  "status": {
    "code": "0",
    "msg": "ok"
  },
  "payload": {
    "id": 1,
    "name": "name1"
  }
}

而对于命令操作(Command)尽量不返回数据,因此command操作的方法的返回值应该是void,Graceful Response对于对于返回值类型void的方法,也会自动进行封装。

public class Controller {
    @RequestMapping("/command")
    @ResponseBody
    public void command() {
        //业务操作
    }
}

成功调用该接口,将得到:

{
  "status": {
    "code": "200",
    "msg": "success"
  },
  "payload": {}
}
2.2.4 Service层

在引入Graceful Response前,有的开发者在定义Service层的方法时,为了在接口中返回异常码,干脆直接将Service层方法定义为Response,淹没了方法的正常返回值。

Response的代码如下。

//lombok注解
@Data
public class Response {
    private String code;
    private String msg;
    private Object data;
}

直接返回Response的Service层方法:

/**
 * 直接返回Reponse的Service
 * 不规范
 */
public interface Service {
    public Reponse commandMethod(Command command);
}

Graceful Response引入@ExceptionMapper注解,通过该注解将异常和错误码关联起来,这样Service方法就不需要再维护Response的响应码了,直接抛出业务异常,由Graceful Response进行异常和响应码的关联。

@ExceptionMapper的用法如下。

/**
 * NotFoundException的定义,使用@ExceptionMapper注解修饰
 * code:代表接口的异常码
 * msg:代表接口的异常提示
 */
@ExceptionMapper(code = "1404", msg = "找不到对象")
public class NotFoundException extends RuntimeException {

}

Service接口定义:

public interface QueryService {
    UserInfoView queryOne(Query query);
}

Service接口实现:

public class QueryServiceImpl implements QueryService {
    @Resource
    private UserInfoMapper mapper;

    public UserInfoView queryOne(Query query) {
        UserInfo userInfo = mapper.findOne(query.getId());
        if (Objects.isNull(userInfo)) {
            //这里直接抛自定义异常
            throw new NotFoundException();
        }
        //……后续业务操作
    }
}

当Service层的queryOne方法抛出NotFoundException时,Graceful Response会进行异常捕获,并将NotFoundException对应的异常码和异常信息封装到统一的响应对象中,最终接口返回以下JSON。

{
  "status": {
    "code": "1404",
    "msg": "找不到对象"
  },
  "payload": {}
}
2.2.5 参数校验

Graceful Response对JSR-303数据校验规范和Hibernate Validator进行了增强,Graceful Response自身不提供参数校验的功能,但是用户使用了Hibernate Validator后,Graceful Response可以通过@ValidationStatusCode注解为参数校验结果提供响应码,并将其统一封装返回。

例如以下的UserInfoQuery。

@Data
public class UserInfoQuery {
    @NotNull(message = "userName is null !")
    @Length(min = 6, max = 12)
    @ValidationStatusCode(code = "520")
    private String userName;
}

UserInfoQuery对象中定义了@NotNull和@Length两个校验规则,在未引入Graceful Response的情况下,会直接抛出异常;

在引入Graceful Response但是没有加入@ValidationStatusCode注解的情况下,会以默认的错误码进行返回;

在上面的UserInfoQuery中由于使用了@ValidationStatusCode注解,并指定异常码为520,则当userName字段任意校验不通过时,都会使用异常码520进行返回,如下。

{
  "status": {
    "code": "520",
    "msg": "userName is null !"
  },
  "payload": {}
}

而对于Controller层直接校验方法入参的场景,Graceful Response也进行了增强,如以下Controller。

public class Controller {

    @RequestMapping("/validateMethodParam")
    @ResponseBody
    @ValidationStatusCode(code = "1314")
    public void validateMethodParam(
            @NotNull(message = "userId不能为空") Long userId,
            @NotNull(message = "userName不能为空") Long userName) {
        //省略业务逻辑
    }
}

如果该方法入参校验触发了userId和userName的校验异常,将以错误码1314进行返回,如下。

{
  "status": {
    "code": "1314",
    "msg": "userId不能为空"
  },
  "payload": {}
}
2.2.6 自定义Response格式

Graceful Response内置了两种风格的响应格式,并通过graceful-response.response-style进行配置。

graceful-response.response-style=0,或者不配置(默认情况),将以以下的格式进行返回:

{
  "status": {
    "code": 1007,
    "msg": "有内鬼,终止交易"
  },
  "payload": {
  }
}

graceful-response.response-style=1,将以以下的格式进行返回:

{
  "code": "1404",
  "msg": "not found",
  "data": {
  }
}

如果这两种格式均不满足业务需要,Graceful Response也支持用户自定义响应体,关于自定义响应体的技术实现,请到自定义Response格式进行了解。

本项目提供的进阶功能,包括

  • 第三方组件汽车(Swagger、执行器等)

  • 自定义响应

  • 异常请求放行

  • 异常别名

  • 常用配置项

目前该组件在GitHub上已经有两百多Star,很多朋友已经开始用了,大家可以通过下方链接了解下:

  • https://github.com/feiniaojin/graceful-response


欢迎加入我的知识星球,全面提升技术能力。

👉 加入方式,“长按”或“扫描”下方二维码噢:

66ec7189df8fe58d1a4cd2405608e115.png

星球的内容包括:项目实战、面试招聘、源码解析、学习路线。

2a06733d3fab89060b8ee6880bcb771d.png

cb88596259433ac65a025e965b6a6124.pnge4a9b7c45b6ef7bd4d7fd24b8be436fb.png2d6ce5070bac186e78819b9f19fdcfc2.png8fe8d965702f09f6b8922530ac6b1348.png

文章有帮助的话,在看,转发吧。
谢谢支持哟 (*^__^*)
打造Spring Boot优雅响应神器:一文解锁Graceful Response设计秘籍 对于成功的响应,可以通过一个辅助方法来简化构造。Java3 return new GracefulResponse(HttpStatus.OK.value(), "操作成功", data);4 }5}通过上述设计,"Graceful Response"虽为概念性的描述,但我们构建了一个实用的响应处理框架,它确保了API响应的一致性,提升了用户体验,同时简化了错误处理逻辑,增强了系统的可维护性和扩展性。在Spring Boot应用中,这样的设计可以显著提升开发效率和应用的健壮性。 阅读详情

相关推荐

李沐之数值稳定性+模型初始化和激活函数

层记为t,这里的y不是预测,还包括了损失函数,y是优化函数,不是预测的结果y。第t层是输出。所有的h都是一些向量,向量关于向量的导数是一个矩阵,所以用了很多次的矩阵乘法,出问题就在这里。

m0_51133942的博客 1527

Graceful Response 构建 Spring Boot 下优雅的响应处理

当抛出异常时我们希望根据不同的异常返回不同的错误码,在中为我们提供了注解,可以快速的指定返回的错误码和提示。@ExceptionMapper(code = "1003", msg = "自定义异常", msgReplaceable = true)super();@Slf4j/*** 返回对象形式*///具体逻辑// ....// 抛出异常/*** Command 形式*///具体逻辑// ....// 抛出异常。

小毕超博客 2835

【汽车ECU标定技术解析】DCM文件与A2L、HEX的协同工作机制

本文深入解析了汽车ECU标定中DCM、A2L与HEX三大核心文件的协同工作机制。A2L文件作为定义标定变量地址与规则的“图纸”,DCM文件承载工程师调试后的具体标定数据,最终通过A2L的地址映射,将DCM数据固化生成可刷入ECU的HEX文件,形成完整的标定数据流转闭环。

weixin_29214559的博客 438

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

2024 java使用Graceful Response,告别自己的封装响应,看我这一篇,足够你用!

m0_47484034的博客 1273

Android 13高通平台CTS camera部分fail项修改(续)

接着上一篇,有几个提了case高通也分析了很久的fail项,其中最离谱的是问题1,第一个接手case的人反反复复处理、内部排查踢皮球、要求log,折腾了很久,最终就给出个解不了的结论。后面还是靠着自己发现了一些蛛丝马迹,并且换了个case接手人才最终解决。

hkj887tg的博客 2061

【无标题】 Python自动化法律文书撰写

Jinja2是一个功能强大的模板引擎,支持丰富的语法和功能。除了条件判断和循环语句外,Jinja2还支持过滤器、宏、继承等高级特性,非常适合处理复杂的文书模板。

master_chenchen的博客 2065

拒绝加班!这款高效 SpringBoot 组件,3分钟拉满生产力~

全新前后端微商城项目,手把手教学!全新前后端微商城项目,手把手教学!全新前后端微商城项目,手把手教学!Graceful Response是一个Spring Boot技术栈下的优雅响应处理器,提供一站式统一返回值封装、全局异常处理、自定义异常错误码等功能,使用Graceful Response进行web接口开发不仅可以节省大量的时间,还可以提高代码质量,使代码逻辑更清晰。强烈推荐你花3分钟学会它!本...

MarkerHub的博客 223

Natural Language Processing

作者:禅与计算机程序设计艺术 1.简介 自然语言处理(NLP)是研究如何使计算机理解和处理自然语言的理论和方法,目的是让电脑更好的理解、获取、生成、存储和沟通人类语言。20世纪80年代末,IBM的三位博士陈天奇、周博磊和王力雄在贝尔实验室创建了首个自然语言处理系统——“布莱克多·艾森豪威尔”(Bletc

AI天才研究院 731

拒绝写重复代码,试试这套开源的SpringBoot组件,效率翻倍~

往期热门文章: 1、我原以为是个笑话,没想到深挖一下背后还有故事。错怪官方了... 2、Lombok!代码“亚健康”元凶? 3、几行烂代码,用错 Transactional,赔了16万... 4、上班摸鱼神器!标星 17k 的安卓手机投屏工具! 5、Zed,有望打败 VS Code 吗?简介Graceful Response是一个Spring Boot技术栈下的优雅响应处理器,提供一站式统一返回...

Java后端技术 193

AUTOSAR OS演示项目搭建与验证

请注意,以上代码只是一个简单的示例,用于说明AUTOSAR OS项目的搭建和验证过程。此外,AUTOSAR OS还提供了其他功能和API,如事件、消息队列和任务间通信等,可以根据实际需求进行使用。AUTOSAR OS是AUTOSAR架构中的一部分,它提供了一种可移植且可扩展的操作系统,用于管理嵌入式应用程序的任务和资源。通过以上步骤,我们成功搭建了一个基于AUTOSAR OS的演示项目,并验证了应用程序任务的执行顺序。3、打开app.c文件,并编写一个简单的应用程序,作为我们的示例任务。

weixin_50547796的博客 195

生存曲线绘制及图例标签添加(使用R语言)

数据应该包含两列:一个是表示个体生存时间的时间变量(通常称为"时间(time)“)和一个是表示个体是否发生事件(如死亡)的事件变量(通常称为"事件(event)”)。通过修改上述代码中的数据和参数,您可以根据自己的需求绘制生存曲线,并添加相应的图例信息和标签。生存曲线是在生存分析中常用的工具,用于描述一组个体随时间的存活概率。函数的第一个参数指定图例的位置,这里我们选择了右上角(“topright”)。包来进行生存曲线的绘制,并通过添加图例信息和标签来增强可视化效果。的数据框,包含这两列数据。

CyberXZ的博客 558

升级 JDK17 一个不可拒绝的理由

往期热门文章: 1、SQL中为什么不要使用1=1? 2、同事使用 insert into select 迁移数据,开开心心上线,导致公司损失近10w! 3、拒绝写重复代码,试试这套开源的SpringBoot组件,效率翻倍~ 4、我原以为是个笑话,没想到深挖一下背后还有故事。错怪官方了... 5、Lombok!代码“亚健康”元凶? 作者:winjeg 链接:juejin.cn/post/73434...

Java后端技术 308

模型预测控制 (MPC, Model Predictive Control) 算法详解及案例分析

模型预测控制是一种基于模型的控制策略,通过在线求解一个有限时域的优化问题,预测系统的未来行为,并根据预测结果调整控制输入,以实现系统的稳定性和性能优化。

闲人编程的博客 2943

同事使用 insert into select 迁移数据,开开心心上线,导致公司损失近10w!

往期热门文章: 1、拒绝写重复代码,试试这套开源的SpringBoot组件,效率翻倍~ 2、我原以为是个笑话,没想到深挖一下背后还有故事。错怪官方了... 3、Lombok!代码“亚健康”元凶? 4、几行烂代码,用错 Transactional,赔了16万... 5、上班摸鱼神器!标星 17k 的安卓手机投屏工具!作者:xlecho来源:juejin.cn/post/69318901185381...

Java后端技术 310

Devexpress16.2.6破解工具

Devexpress16.2.6破解工具Devexpress16.2.6破解工具Devexpress16.2.6破解工具Devexpress16.2.6破解工具

NTscan扫描工具

ntscan是一个扫描器,可以扫描没有密码和弱密码的共享,先到配置文件中填写猜测的用户名和密码,扫描过程中右侧出现的是扫描日志。

SQL中为什么不要使用1=1?

往期热门文章: 1、同事使用 insert into select 迁移数据,开开心心上线,导致公司损失近10w! 2、拒绝写重复代码,试试这套开源的SpringBoot组件,效率翻倍~ 3、我原以为是个笑话,没想到深挖一下背后还有故事。错怪官方了... 4、Lombok!代码“亚健康”元凶? 5、几行烂代码,用错 Transactional,赔了16万... 作者:萤火架构 链接:https:...

Java后端技术 463

WINCC7.3破解文件

WINCC7.3硬件够破解文件,有需要的下载!WINCC7.3硬件够破解文件,有需要的下载!

SpringBoot响应封装:Graceful Response vs 自定义通用响应类选型指南

SpringBoot项目统一响应格式的两种实现方案对比:开源组件Graceful Response与自研通用响应类。Graceful Response提供开箱即用的统一响应封装和全局异常处理,减少样板代码,适合追求快速集成的团队;而自研方案通过Result类实现高度定制化,灵活性更强但需自行维护。选择时应权衡开发效率与长期维护成本,小型项目推荐Graceful Response,复杂项目可考虑自研方案。

wangzhilong1996的博客 1472

OV9734 DATASHEET,完整规格书

OV9734完整规格书,包括电气参数,尺寸规格,寄存器配置表等

从开源项目中学习如何自定义 Spring Boot Starter 小组件

从开源项目中学习如何自定义Spring Boot Starter小组件

打怪升级 1534

拒绝写重复代码,试试这套开源的 SpringBoot 组件

????这是一个或许对你有用的社群????一对一交流/面试小册/简历优化/求职解惑,欢迎加入「芋道快速开发平台」知识星球。下面是星球提供的部分资料:《项目实战(视频)》:从书中学,往事中“练”《互联网高频面试题》:面朝简历学习,春暖花开《架构 x 系统设计》:摧枯拉朽,掌控面试高频场景题《精进 Java 学习指南》:系统学习,互联网主流技术栈《必读 Java 源码专栏》:知其然,知其所以然????这是一个或许...

weixin_44421461的博客 374
上一篇: 生产大文件下载导致 OOM,顺藤摸瓜拿下
下一篇: SpringBoot 中实现订单30分钟自动取消的策略
公众号-芋道源码
博客等级 码龄10年 1637粉丝 377原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值