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

已于 2024-04-29 11:52:48 修改
阅读量1.1k 收藏 7
点赞数 12
CC 4.0 BY-SA版权
分类专栏： java工作中的难点 java工具类 文章标签： java Graceful
于 2024-04-29 11:48:20 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/m0_47484034/article/details/138306906
该博客介绍Java Spring Boot快速入门方法。包括根据Spring Boot版本导入依赖，配置文件时有两种响应风格，可参考官网手册自定义；启动类添加注解后即可直接使用，还提及运行效果，同时给出官网手册相关参考地址。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

参考官网手册地址：快速入门 | 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
# 自定义的失败提示，
最低0.47元/天 解锁文章

200万优质内容无限畅学
打造Spring Boot优雅响应神器：一文解锁Graceful Response设计秘籍
java专栏
05-11 494
对于成功的响应，可以通过一个辅助方法来简化构造。Java3 return new GracefulResponse(HttpStatus.OK.value(), "操作成功", data);4 }5}通过上述设计，"Graceful Response"虽为概念性的描述，但我们构建了一个实用的响应处理框架，它确保了API响应的一致性，提升了用户体验，同时简化了错误处理逻辑，增强了系统的可维护性和扩展性。在Spring Boot应用中，这样的设计可以显著提升开发效率和应用的健壮性。
【C++ 线程池设计 】从零开始 深入理解与实践：C++ 线程池的高级设计
探索C++编程的奥秘，分享深入的技术见解和实践，旨在激发读者创造力与解决问题的思维。
01-09 2298
线程池是一种软件设计模式，它维护一个待办任务队列和一个工作线程集合。在这种模式下，线程不是对每个任务单独创建和销毁，而是从池中重复使用。这种方法可以减少线程创建和销毁的开销，提高任务处理的效率。
拒绝写重复代码，试试这套开源的 SpringBoot 组件
weixin_44421461的博客
03-10 313
????这是一个或许对你有用的社群????一对一交流/面试小册/简历优化/求职解惑，欢迎加入「芋道快速开发平台」知识星球。下面是星球提供的部分资料：《项目实战（视频）》：从书中学，往事中“练”《互联网高频面试题》：面朝简历学习，春暖花开《架构 x 系统设计》：摧枯拉朽，掌控面试高频场景题《精进 Java 学习指南》：系统学习，互联网主流技术栈《必读 Java 源码专栏》：知其然，知其所以然????这是一个或许...
Graceful Response 构建 Spring Boot 下优雅的响应处理
小毕超博客
01-02 2348
当抛出异常时我们希望根据不同的异常返回不同的错误码，在中为我们提供了注解，可以快速的指定返回的错误码和提示。@ExceptionMapper(code = "1003", msg = "自定义异常", msgReplaceable = true)super();@Slf4j/*** 返回对象形式*///具体逻辑// ....// 抛出异常/*** Command 形式*///具体逻辑// ....// 抛出异常。
Graceful Response 教程：Spring Boot 接口响应处理指南
gitblog_00008的博客
04-20 373
Graceful Response 教程：Spring Boot 接口响应处理指南 1. 项目目录结构及介绍 Graceful Response 是一个专为 Spring Boot 设计的响应处理库，它优化了API返回值管理、异常处理等多个方面。下面是项目的基本目录结构概述： graceful-response/ ├── assets # 静态资源文件夹 ...
探索高效API开发的新境界：Graceful Response
gitblog_00044的博客
05-24 439
探索高效API开发的新境界：Graceful Response 项目介绍 在Web API开发中，我们时常被繁琐的响应结构构建和异常处理困扰。Graceful Response 是一款专为Spring Boot打造的响应处理器，旨在提升开发效率、优化代码结构，让你的接口开发变得简单而优雅。它集成了统一返回值封装、全局异常处理和自定义异常错误码等功能，让你从重复劳动中解脱出来，专注于核心业务逻辑的实...
Graceful Java Programming 优雅Java编程 小贴士3
linliangyi2006的专栏
05-04 129
Http请求编码是个老问题了，不论是UTF-8还是GBK，在咖啡的印象中，这个应该是7年前，刚学Java web时候碰到的。 最近在做一个老项目，准确的说是在老项目上做修改的时候，编码问题又发生了。 [b]问题背景：[/b] 1.一个历经三年前的项目，使用的是Jboss，老项目的编码在Jboss上设置了Http Encoding=GBK。就是说，老项目的设计者只考虑了客户端使用G...
七万字长文带你搞定Dubbo！超详细解析助你过春招！
Viper的程序员修炼手册
12-06 1524
Table of Contents generated with DocToc 1、Dubbo的架构原理 Dubbo架构图 节点角色说明 调用关系说明 整体架构分层设计 Dubbo和Spring Cloud区别 2、Dubbo自己的SPI实现 SPI的设计目标 SPI的具体约定 dubbo为什么不直接使用JDK的SPI？ dubbo的SPI目的：获取一个实现类的对象 ExtensionLoader 关于objectFactory的一些细节 3、SPI 与 API的区别 1. 接口位于【..
分布式文件系统FastDFS
企业实战系列集 ●●● https://ximenjianxue.blog.youkuaiyun.com
09-08 7250
概述 FastDFS是一个开源的轻量级分布式文件系统，是我国一款开源的分布式文件系统 由阿里巴巴开发，其真题架构由跟踪服务器（tracker server）、存储服务器（storage server）和客户端（client）三个部分组成，主要解决了海量数据存储问题，特别适合以中小文件（建议范围：4KB < file_size <500MB）为载体的在线服务。 特点： 1>Fast......
go-chassis 运行时做了什么？
goodspeeed的专栏
11-29 1353
什么是 chassis?Chassis，是一种微服务模式。在这种模式中，用户并不需要自己去处理构建微服务过程中外部配置、日志、健康检查、分布式追踪等，而是将他们交给专门的框架来处理。用户...
Graceful Java Programming 优雅Java编程 之 一个经典的线程锁
linliangyi2006的专栏
02-26 177
功能： 1.实现跨客户端的多用户同步锁 2.实现多重嵌套的同步锁 说明： 这是本人7年Java生涯以来最钟爱的一段Java代码，其结构简洁，设计优雅，充分显示了作者对Java多线程机制的领悟；更重要的它可以很轻量级的嵌入到任何类的任何方法的任何代码段，来实现该代码段的线程同步。实在是经典中的经典啊！ [code="java"] public class Transactio...
Graceful Java Programming 优雅Java编程 小贴士2
linliangyi2006的专栏
02-26 175
[size=large][align=center]Java内存控制问题[/align][/size] 正如大多数人所知，Java语言对内存回收是通过GC进行的，这与C++不同。 在C++中，通过new操作创建的内存空间要求程序员通过delete操作回收，如果不回收就会发生内存泄露。 在Java中，虚拟机采用有向图结构监视内存中的所有对象（即，用一张有向图将对象的引...
个人在使用 Graceful Response 时遇到的问题（个人原因导致的）
qq_41650131的博客
10-31 346
（2）GracefulResponse 传递给前端的异常信息，经常默认在前面加上了触发异常的类名【已解决】抛出的异常没有成功地返回给前端，返回给前端的错误信息是一串陌生的类名【已解决】方法，因为该方法会在返回的 message 前加异常类名。经排查后发现是由于“异常链”导致的，这样，传给前端的就是。，那么这里不建议使用。
Graceful Java Programming 优雅Java编程 小贴士1
linliangyi2006的专栏
02-26 121
[size=large][align=center]关于HTTP协议的图片传输注意事项[/align][/size] 在编写Http servlet 时，有时要用到 HttpServletResponse 返回动态生成的图片信息。此时，务必注意Http response head中两个属性的设置，一个是contentType，一个是contentLength。 正确的设置...
springboot-参数校验集成Graceful Response
weixin_39744852的博客
12-04 577
*** NotFoundException的定义，使用@ExceptionMapper注解修饰* code:代表接口的异常码* msg:代表接口的异常提示*/@ExceptionMapper(code = "1404", msg = "找不到对象")@Data")@Override@Override@Override@Overridereturn msg;注意，不需要返回的属性可以返回null或者加上@JsonIgnore注解。
优雅响应开源项目教程
gitblog_00850的博客
08-21 284
优雅响应开源项目教程 项目目录结构及介绍 graceful-response/ ├── src/ │ ├── main/ │ │ ├── java/ │ │ │ ├── com/ │ │ │ │ ├── feiniaojin/ │ │ │ │ │ ├── gracefulresponse/ │ │ │ │ │ │ ...
推荐优雅的错误处理——`graceful`
gitblog_00078的博客
05-26 269
推荐优雅的错误处理——graceful 当你的Node.js应用遇到未捕获的异常时，是否希望它能优雅地退出，而不是瞬间崩溃？这就是graceful这个开源项目要解决的问题。基于process.on('uncaughtException')，graceful提供了一种最佳的方式来应对程序中的uncaughtException。 项目介绍 graceful是一个轻量级的模块，旨在帮助开发者在出现异常时...
一站式统一返回值封装、异常处理、异常错误码解决方案—最强的Sping Boot接口优雅响应处理器
京东科技开发者
08-21 864
Graceful Response内置了两种风格的响应格式，可以在文件中通过进行配置。•gr.responseStyle=0，或者不配置（默认情况）"msg": "有内鬼，终止交易"},"data": {•自定义响应格式如果以上两种格式均不能满足业务需要，可以通过自定义去满足，Response@Override@Override@Override@Overridereturn msg;注意，不需要返回的属性可以返回null或者加上注解。
[已解决] graceful-response导致swagger2无法访问默认页面
xj_0000的博客
04-09 509
[已解决] graceful-response导致swagger2无法访问默认页面
我的springboot 项目，用@ServerEndpoint 创建websocket服务端，在java服务重启的时候怎么优雅关闭这个服务端
最新发布
02-26
<think>好的，我现在需要解决用户的问题：在Spring Boot项目中，使用@ServerEndpoint创建的WebSocket服务端，在Java服务重启时如何优雅关闭。用户希望优雅地关闭服务端，避免强制断开导致客户端出现问题。 首先，我要回忆一下Spring Boot中WebSocket的使用。用户提到使用了@ServerEndpoint注解，这通常意味着他们可能没有使用Spring的WebSocket支持，而是依赖于Java自带的API，比如javax.websocket。在Spring Boot中，如果要使用@ServerEndpoint，通常需要配置一个ServerEndpointExporter的Bean来扫描这些端点。 接下来，用户的问题是关于优雅关闭。优雅关闭一般指在关闭应用前，先处理完当前的请求，释放资源，通知客户端，然后再终止服务。对于WebSocket来说，可能需要关闭所有活跃的连接，并阻止新的连接建立。 首先，我需要考虑如何捕获服务关闭的事件。在Spring Boot中，可以通过@PreDestroy注解或者实现DisposableBean接口来在Bean销毁前执行一些操作。或者，可以监听ContextClosedEvent事件，当应用上下文关闭时触发。 然后，如何获取所有活跃的WebSocket会话。每个使用@ServerEndpoint注解的类在实例化时，可能通过@OnOpen方法将Session保存到一个静态集合中，或者通过其他方式管理。因此，用户需要确保在WebSocket端点类中维护了一个所有活跃Session的集合，比如使用ConcurrentHashMap来保存，并在@OnOpen和@OnClose方法中添加和移除Session。 当服务关闭时，需要遍历所有活跃的Session，依次调用session.close()方法，并可能发送一个关闭消息或状态码，通知客户端连接即将关闭。同时，可能需要设置一个超时时间，避免某些Session无法及时关闭导致服务无法终止。 另外，可能还需要停止接受新的连接请求。在关闭过程中，新的连接请求应该被拒绝，这可能需要通过某种机制，比如设置一个标志位，在@OnOpen方法中检查该标志位，如果服务正在关闭，则拒绝新连接。 接下来，我需要考虑如何将这些步骤整合到Spring Boot的生命周期中。例如，在Bean销毁前，或者在收到ContextClosedEvent时，触发关闭WebSocket连接的逻辑。 可能还需要注意线程安全问题，比如在遍历Session集合时，可能会有并发的添加或移除操作，需要使用线程安全的集合，并在遍历时进行适当的同步处理。 此外，Tomcat或其他Servlet容器在关闭时，可能会自动关闭WebSocket连接，但可能不够优雅，比如直接断开而不发送关闭帧。因此，主动关闭每个Session，发送适当的关闭码和原因，是更优雅的方式。 还需要考虑的是，当应用接收到终止信号（如kill命令）时，如何触发关闭流程。Spring Boot的优雅关闭通常可以通过配置server.shutdown=graceful，并设置超时时间。这可能与WebSocket的关闭流程配合使用，确保在Servlet容器关闭前，WebSocket连接已经被妥善处理。 总结一下，解决方案的大致步骤可能是： 1. 在WebSocket端点类中维护所有活跃的Session。 2. 监听Spring Boot的关闭事件（如ContextClosedEvent）。 3. 在关闭事件触发时，遍历所有Session，发送关闭消息并关闭。 4. 阻止新的连接在关闭过程中被建立。 5. 处理可能出现的异常和超时，确保服务能顺利终止。 需要验证这些步骤是否正确，比如如何正确获取所有Session，如何确保关闭事件被触发，以及如何处理可能的问题，如某些Session无法关闭的情况。同时，要考虑不同Servlet容器的行为差异，比如Tomcat和Jetty可能会有不同的处理方式，但@ServerEndpoint通常是标准API，应该与容器无关。</think>在Spring Boot项目中，使用`@ServerEndpoint`创建的WebSocket服务端，需通过以下步骤实现优雅关闭，确保服务重启时客户端连接被妥善处理： --- ### **1. 管理活跃的WebSocket会话** 在WebSocket端点类中，**维护一个静态集合存储所有活跃的Session**，确保能遍历并关闭它们： ```java @ServerEndpoint("/ws") @Component public class WebSocketEndpoint { private static final Set<Session> sessions = ConcurrentHashMap.newKeySet(); @OnOpen public void onOpen(Session session) { sessions.add(session); } @OnClose public void onClose(Session session) { sessions.remove(session); } // 获取所有活跃会话的方法 public static Set<Session> getActiveSessions() { return sessions; } } ``` --- ### **2. 监听Spring Boot关闭事件** 通过实现`DisposableBean`接口或监听`ContextClosedEvent`事件，触发关闭逻辑： ```java @Component public class WebSocketShutdownHook implements DisposableBean { @Override public void destroy() throws Exception { closeAllWebSocketConnections(); } private void closeAllWebSocketConnections() { Set<Session> sessions = WebSocketEndpoint.getActiveSessions(); for (Session session : sessions) { try { // 发送自定义关闭消息（可选） if (session.isOpen()) { session.getAsyncRemote().sendText("SERVER_SHUTDOWN"); } // 发送标准关闭帧（状态码和原因） session.close(new CloseReason(CloseReason.CloseCodes.NORMAL_CLOSURE, "Server shutdown")); } catch (IOException e) { // 处理异常 } } } } ``` --- ### **3. 阻止新连接的建立** 在关闭过程中**拒绝新连接**，通过标志位控制： ```java @ServerEndpoint("/ws") @Component public class WebSocketEndpoint { private static volatile boolean isShuttingDown = false; @OnOpen public void onOpen(Session session) throws IOException { if (isShuttingDown) { session.close(new CloseReason(CloseReason.CloseCodes.UNEXPECTED_CONDITION, "Server is shutting down")); return; } sessions.add(session); } // 设置关闭标志的方法 public static void setShuttingDown(boolean shuttingDown) { isShuttingDown = shuttingDown; } } ``` --- ### **4. 整合Spring Boot优雅关闭** 在`application.properties`中启用优雅关闭（需Spring Boot 2.3+）： ```properties server.shutdown=graceful spring.lifecycle.timeout-per-shutdown-phase=30s ``` 这会确保HTTP请求处理完毕后关闭容器，结合WebSocket关闭逻辑更安全。 --- ### **5. 完整关闭流程示例** ```java @Component public class WebSocketShutdownHook implements DisposableBean { @Override public void destroy() { WebSocketEndpoint.setShuttingDown(true); // 阻止新连接 closeAllWebSocketConnections(); // 关闭现有连接 } private void closeAllWebSocketConnections() { // 遍历并关闭所有Session（同上） } } ``` --- ### **注意事项** - **线程安全**：使用`ConcurrentHashMap`或`CopyOnWriteArraySet`管理Session集合。 - **超时处理**：若某些Session未及时关闭，需设置超时（如`session.setMaxIdleTimeout(5000)`）。 - **容器兼容性**：不同Servlet容器（Tomcat/Jetty）对WebSocket关闭的行为一致，但需测试验证。 --- 通过以上步骤，服务重启时会主动通知客户端、关闭连接，避免强制断开导致的问题。
评论 5
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

假客套

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值