Skip to content

04-devtools.md

Latest commit

 

History

History
207 lines (156 loc) · 7.15 KB

04-devtools.md

File metadata and controls

207 lines (156 loc) · 7.15 KB
Raw

开发工具链 - Maven/Gradle、DevTools 与 Actuator

先看框架承担哪部分职责

构建与观测：Maven/Gradle 保证依赖和构建可重复，DevTools 帮开发反馈，Actuator 提供运行状态入口。可观测端点也需要访问边界。

最小练习与预期结果：从新目录构建并启动应用，检查健康状态；配置缺失时应有明确错误，不能依赖 IDE 隐式参数。

具体 API 与安装版本以模块基线和本篇官方来源为准。先完成这条数据路径，再展开后面的高级配置；框架名称变化后，输入边界、状态归属和失败处理仍是需要理解的机制。

文档简介: 打磨 Java 日常开发体验：构建工具选型与常用命令、DevTools 热重载提速本地迭代、Actuator 生产端点速览

目标读者: 刚回归 Java、想快速搭顺手的开发工作流的学习者

前置知识: 已完成 环境搭建 与 Spring Boot 入门

文档信息（用途、难度与维护记录）

📚 文档元数据

属性 内容
模块 08-java-revisited
象限 操作指南
难度 ⭐
标签 #Maven #Gradle #DevTools #Actuator
更新日期 2026年9月

🎯 学习目标

完成本文档后，你将能够：

  • 在 Maven 与 Gradle 之间做出选型，并掌握日常高频命令
  • 用 DevTools + LiveReload 实现"保存即生效"
  • 暴露 Actuator 端点并配置健康检查

🛠️ 一、构建工具：Maven 与 Gradle

选型速查

维度 Maven Gradle
配置格式 pom.xml（XML） build.gradle(.kts)
学习曲线 平缓、约定优先 灵活、需要理解构建模型
增量构建 无 有（缓存 + 增量编译，快）
生态 最广泛 Android/Kotlin 领域标配

团队没有历史包袱时：Spring Boot 4.x 两者都一等公民，追求构建速度选 Gradle Kotlin DSL，追求稳定可读选 Maven。

Maven 高频命令

mvn clean verify          # 清理 + 编译 + 测试 + 集成验证（CI 最常用）
mvn test -Dtest=BookServiceTest        # 只跑一个测试类
mvn dependency:tree -Dincludes=org.slf4j   # 排查依赖冲突（谁是传递来源）
mvn versions:display-dependency-updates  # 检查可升级版本
mvn -o package            # 离线模式：CI 里跳过远程仓库检查

Gradle 高频任务

./gradlew build           # 完整构建（含测试）
./gradlew test --tests "com.devquest.BookServiceTest"   # 过滤测试
./gradlew bootRun         # 直接启动 Spring Boot 应用
./gradlew dependencies --configuration runtimeClasspath # 查看依赖树

版本对齐：Spring Boot BOM

<!-- Maven：parent 方式统一管理依赖版本，子依赖无需写版本号 -->
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>4.1.1</version>
</parent>
// Gradle Kotlin DSL：插件方式等价
plugins {
    java
    id("org.springframework.boot") version "4.1.1"
    id("io.spring.dependency-management") version "1.1.7"
}

🛠️ 二、DevTools 热重载

引入

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-devtools</artifactId>
    <scope>runtime</scope>
    <optional>true</optional> <!-- 不传递给依赖本模块的项目，不打进 fat jar -->
</dependency>

工作原理

  • 重启（Restart）：classpath 变化时用"快速重启类加载器"重启应用上下文，比冷启动快数倍
  • 自动触发：IDE 构建（IDEA Ctrl+F9 / Eclipse 自动编译）即触发
  • LiveReload：静态资源变化时通知浏览器插件自动刷新（⚠️ Boot 4.1 起已标记废弃，新项目建议依赖 IDE 自动构建 + 触发文件）
  • 禁用缓存：自动为模板引擎（Thymeleaf 等）关闭生产缓存
spring:
  devtools:
    restart:
      additional-paths: src/main/resources   # 额外监听目录
    livereload:
      enabled: true

手动触发（IDEA 无自动构建时）

spring:
  devtools:
    restart:
      trigger-file: .reloadtrigger  # 仅该文件变化才重启，可配合脚本 touch

边界认知

  • DevTools 只做类加载器级重启，不是 JRebel 式的真正热替换；大量 Bean 状态会重建
  • 生产环境自动失效：fat jar 启动时 DevTools 不加载
  • 大项目重启仍需数秒，重度热更需求再考虑商业工具

🛠️ 三、Actuator 生产端点

引入与暴露

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
management:
  endpoints:
    web:
      exposure:
        include: health,info,metrics,env,conditions
  endpoint:
    health:
      show-details: when_authorized   # 健康详情不随便暴露

常用端点

端点 用途
/actuator/health 存活/就绪探针（K8s liveness/readiness 数据源）
/actuator/metrics JVM、HTTP、连接池指标
/actuator/env 环境变量与配置（注意脱敏）
/actuator/conditions 自动配置评估报告（排查 Bean 为什么没装配）

自定义健康检查

@Component
public class PaymentChannelHealthIndicator extends AbstractHealthIndicator {

    @Override
    protected void doHealthCheck(Health.Builder builder) {
        boolean reachable = pingPaymentGateway(); // 合成示例：探测第三方依赖
        if (reachable) {
            builder.up().withDetail("channel", "primary");
        } else {
            builder.down().withDetail("channel", "unreachable");
        }
    }
}

🎨 最佳实践

BOM 管理其覆盖范围内的兼容依赖，不在 BOM 中的库仍需明确版本和升级策略。统一检查命令要确认实际启用了单元、集成和静态检查，不能仅凭命令叫 verify 就假定所有检查已执行。

管理端点只暴露运维需要的范围，控制访问并检查错误与详情是否泄漏内部数据。开发工具不应无意进入生产启动路径；最终检查构建产物和运行配置，而不只看依赖声明。

🚀 下一步

🔗 相关文档

本模块

阅读导航

本模块理解地图 · 完整目录与版本 · 通用术语