程序员scholar 程序员scholar
首页
  • Java 基础

    • JavaSE
    • JavaIO
    • JavaAPI速查
  • Java 高级

    • JUC
    • JVM
    • Java新特性
    • 设计模式
  • Web 开发

    • Servlet
    • Java网络编程
  • Web 标准

    • HTML
    • CSS
    • JavaScript
  • 前端框架

    • Vue2
    • Vue3
    • 微信小程序
    • uni-app
  • 工具与库

    • jQuery
    • Ajax
    • Axios
    • Webpack
    • Vuex
    • WebSocket
    • 第三方登录
  • 后端与语言扩展

    • ES6
    • Typescript
    • node.js
  • Element-UI
  • Apache ECharts
  • 数据结构
  • HTTP协议
  • HTTPS协议
  • 计算机网络
  • Linux常用命令
  • Windows常用命令
  • SQL数据库

    • MySQL
    • MySQL速查
  • NoSQL数据库

    • Redis
    • ElasticSearch
  • 数据库

    • MyBatis
    • MyBatis-Plus
  • 消息中间件

    • RabbitMQ
  • 服务器

    • Nginx
  • Spring框架

    • Spring6
    • SpringMVC
    • SpringBoot
    • SpringSecurity
  • SpringCould微服务

    • SpringCloud基础
    • 微服务之DDD架构思想
  • 日常必备

    • 开发常用工具包
    • Hutoll工具包
    • IDEA常用配置
    • 开发笔记
    • 若依框架
    • 日常记录
    • 项目部署
    • 网站导航
    • 产品学习
    • 英语学习
  • 代码管理

    • Maven
    • Git教程
    • Git小乌龟教程
  • 运维工具

    • Docker
    • Jenkins
    • Kubernetes
  • 算法笔记

    • 算法思想
    • 刷题笔记
  • 面试问题常见

    • 十大经典排序算法
    • 面试常见问题集锦
关于
GitHub (opens new window)
首页
  • Java 基础

    • JavaSE
    • JavaIO
    • JavaAPI速查
  • Java 高级

    • JUC
    • JVM
    • Java新特性
    • 设计模式
  • Web 开发

    • Servlet
    • Java网络编程
  • Web 标准

    • HTML
    • CSS
    • JavaScript
  • 前端框架

    • Vue2
    • Vue3
    • 微信小程序
    • uni-app
  • 工具与库

    • jQuery
    • Ajax
    • Axios
    • Webpack
    • Vuex
    • WebSocket
    • 第三方登录
  • 后端与语言扩展

    • ES6
    • Typescript
    • node.js
  • Element-UI
  • Apache ECharts
  • 数据结构
  • HTTP协议
  • HTTPS协议
  • 计算机网络
  • Linux常用命令
  • Windows常用命令
  • SQL数据库

    • MySQL
    • MySQL速查
  • NoSQL数据库

    • Redis
    • ElasticSearch
  • 数据库

    • MyBatis
    • MyBatis-Plus
  • 消息中间件

    • RabbitMQ
  • 服务器

    • Nginx
  • Spring框架

    • Spring6
    • SpringMVC
    • SpringBoot
    • SpringSecurity
  • SpringCould微服务

    • SpringCloud基础
    • 微服务之DDD架构思想
  • 日常必备

    • 开发常用工具包
    • Hutoll工具包
    • IDEA常用配置
    • 开发笔记
    • 若依框架
    • 日常记录
    • 项目部署
    • 网站导航
    • 产品学习
    • 英语学习
  • 代码管理

    • Maven
    • Git教程
    • Git小乌龟教程
  • 运维工具

    • Docker
    • Jenkins
    • Kubernetes
  • 算法笔记

    • 算法思想
    • 刷题笔记
  • 面试问题常见

    • 十大经典排序算法
    • 面试常见问题集锦
关于
GitHub (opens new window)
npm

(进入注册为作者充电)

  • 快速入门

  • 后端手册

  • 前端手册

  • 组件文档

  • 数据库分析

  • 集成插件

    • 集成 Docker 实现一键部署
    • 升级 Spring Boot 到 3.x 版本
    • 集成 Ehcache 实现本地缓存切换
    • 集成 WebSocket 实现实时通信
    • 集成 Electron 实现桌面应用程序
    • 集成 Atomikos 实现分布式事务
    • 集成 MinIO 实现分布式文件存储
    • 集成 Easy-ES 实现分布式全文检索
    • 使用 `localStorage` 代替 `cookie`
    • 使用 Undertow 替代 Tomcat 容器
    • 集成 Actuator 实现优雅关闭应用
      • 1. 引入 Actuator 依赖
      • 2. 配置 Actuator 端点
      • 3. 配置安全访问权限
      • 4. 触发优雅停机
      • 5. 注意事项
    • 集成 AJ-Captcha 实现滑块验证码
    • 集成 Sharding-JDBC 实现分库分表
    • 集成 JustAuth 实现第三方授权登录
    • 集成 `watermark-dom` 实现页面水印
    • 集成 MyBatis-Plus 实现 MyBatis 增强
    • 集成 EasyExcel 实现 Excel 表格增强
    • 集成 Knife4j 实现 Swagger 文档增强
    • 集成 Redisson 实现 Redis 分布式锁
    • 集成 IP2Region 实现离线 IP 地址定位
    • 42集成 JSEncrypt 实现密码加密传输
    • 集成 HttpClient 实现 HTTP 接口增强
    • 集成 Druid 实现数据库密码加密功能
    • 集成 Browscap 实现用户代理解析
    • 集成 Dynamic-DataSource 实现多数据源增强
  • 若依框架
  • 集成插件
scholar
2024-08-31
目录

集成 Actuator 实现优雅关闭应用

# 集成 Actuator 实现优雅关闭应用

在生产环境中,应用需要进行版本更新或维护时,往往需要优雅停机,即等待当前的工作线程完成后再停止应用,以确保数据完整性和业务连续性。Spring Boot 提供的 Actuator 是实现这一功能的一个便捷方式。

# 1. 引入 Actuator 依赖

在 pom.xml 中添加 spring-boot-starter-actuator 依赖,以启用 Actuator 功能:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
1
2
3
4

# 2. 配置 Actuator 端点

为了能够通过 Actuator 实现应用的优雅关闭,需要在配置文件 application.yml 或 application.properties 中启用 shutdown 端点,并设置端点的访问路径和权限。

在 application.yml 中添加以下配置:

management:
  endpoint:
    shutdown:
      enabled: true   # 启用 shutdown 端点
  endpoints:
    web:
      exposure:
        include: "shutdown"   # 公开 shutdown 端点
      base-path: /monitor      # 设置 Actuator 端点的基础路径
1
2
3
4
5
6
7
8
9

上述配置表示 Actuator 的所有端点(包括 shutdown 端点)将通过 /monitor 路径进行访问。

# 3. 配置安全访问权限

为了保证系统安全,只有特定权限的用户才能触发 shutdown 操作。因此,需要在 SecurityConfig.java 中配置 shutdown 端点的访问权限。

在 SecurityConfig.java 中添加如下代码:

import org.springframework.security.config.annotation.web.builders.HttpSecurity;

// 省略其他代码...

@Override
protected void configure(HttpSecurity httpSecurity) throws Exception {
    httpSecurity
        .authorizeRequests()
        .antMatchers("/monitor/shutdown").anonymous() // 允许匿名访问 shutdown 端点
        .and()
        .csrf().disable();  // 关闭 CSRF 保护
}
1
2
3
4
5
6
7
8
9
10
11
12

# 4. 触发优雅停机

完成以上配置后,可以通过 POST 请求触发应用的优雅关闭操作。可以使用 curl 命令进行测试:

curl -X POST http://localhost:8080/monitor/shutdown
1

执行该命令后,Spring Boot 会等待当前正在执行的请求处理完毕,然后优雅地关闭应用。

# 5. 注意事项

  1. 安全性:在生产环境中,应该严格控制 shutdown 端点的访问权限,建议仅允许内部或特定的管理员角色访问。
  2. 超时设置:如果希望在指定时间内强制关闭应用,可以通过 Spring Boot 的 server.shutdown 属性进行设置。

总结

通过引入 Actuator 依赖,并配置 shutdown 端点和安全策略,可以实现 Spring Boot 应用的优雅停机。这种方法能够确保在停止应用时,正在执行的任务能够完成,避免数据丢失和业务中断。

编辑此页 (opens new window)
上次更新: 2024/12/28, 18:32:08
使用 Undertow 替代 Tomcat 容器
集成 AJ-Captcha 实现滑块验证码

← 使用 Undertow 替代 Tomcat 容器 集成 AJ-Captcha 实现滑块验证码→

Theme by Vdoing | Copyright © 2019-2025 程序员scholar
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式