
Maven 构建不只是 mvn install:几项实用配置技巧
来源标题:Beyond Mvn Install: Maven Practices That Pay Off
多数 Maven 构建源于复制旧项目的 pom.xml 后便不再维护。文章基于 Jackcess、UCanAccess 等开源项目,介绍只需几行 XML 就能让构建更快失败、更易维护的 Maven 特性,示例均在 Maven 3.9 上运行。
以下正文由 AI 翻译自 Hacker News 最新(原文版权归原站所有),可能存在偏差,重要内容请以原文为准。
大多数 Maven 构建都是从一份又一份的复制粘贴开始的。有人把旧项目的 pom.xml 粘到新项目里,改几个版本号,从此就再也不碰这个构建,直到它出问题为止。这样做虽然能用,但错过了很多东西。Maven 有不少特性,可以让构建更快失败、更容易维护、用起来更舒服,而其中大部分只需要几行 XML。
本文中的示例并非临时编造。它们来自我维护的开源项目,主要是 Jackcess(一个用于 Microsoft Access 文件的纯 Java 库)和 UCanAccess(构建在它之上的 JDBC 驱动),以及我较新的项目 IBAN Commons 和 figlet Maven plugin。每一个示例都是因为解决了实际问题才被保留下来。UCanAccess 本身曾是 foojay 上一篇文章的主题。
所有示例都在 Maven 3.9 上运行。撰写本文时,Maven 4 仍处于 release candidate 阶段,而 Jackcess 的构建在它上面无需改动即可通过。
在介绍各项具体技巧之前,先说说大部分构建配置从何而来。手动把每个插件都接好虽然有教育意义,但并不是唯一的方式。basepom 是一组 parent POM,开箱即提供一套精心挑选的构建配置:Enforcer、依赖分析、重复类查找器、SpotBugs、代码覆盖率,而在 basepom-oss 版本中还有 license header 以及发布到 Maven Central 所需的一切。
所有插件版本都被固定并保持更新,默认值也很合理。Checkstyle 和 PMD 也已接好,只要你提供自己的规则集,就可以通过一个属性启用它们。
<parent> <groupId>org.basepom</groupId> <artifactId>basepom-oss</artifactId> <version>71</version> </parent>我最喜欢的一点是,它可以通过属性以非常一致的方式控制。每一项检查都有自己的开关,比如 basepom.check.skip-spotbugs,而且这些开关是分组的,所以 basepom.check.skip-basic、basepom.check.skip-extended 和 basepom.check.skip-all 可以一次性关掉一整类检查。BasePOM Users Guide 记录了所有这些属性。
Jackcess 和 UCanAccess 都用 basepom-oss 作为 parent,因此它们的 POM 明显更短:只包含与 basepom 默认值不同的部分。这就是为什么下面有几个示例设置的是 basepom. 属性,而不是配置插件。这些技巧在没有 basepom 的情况下同样有效,只是你需要自己写出插件配置。IBAN Commons 正是这么做的,它把整个构建都放在一个多模块的 parent POM 里。如果你要启动一个新项目,又不想从零开始搭建构建,basepom 确实值得仔细看看。
在项目目录下不带任何参数输入 mvn,Maven 会给你这个错误:“No goals have been specified for this build”。在 build 段中定义单个 defaultGoal 元素,告诉 Maven 在无参数调用时该做什么:
<build> <defaultGoal>clean verify</defaultGoal> ... </build>我的每个项目都有这一行,它省下的不只是几次按键。它记录下了标准的构建方式。一个新贡献者克隆仓库并运行 mvn,得到的正是 CI 服务器运行的构建,包括测试、静态分析以及绑定到 verify 之前生命周期的所有其他内容。
选择 verify 而不是 install 是有意为之。verify 会运行直到并包括各项检查在内的所有阶段,但不会把产物复制到本地仓库。~/.m2 里不会有东西在你背后被改动,你机器上的其他项目也不会悄悄拿到一个半成品的 snapshot。在多模块构建中,reactor 本来就会在模块之间互相解析,所以只有当一个独立项目需要消费结果时才需要 install。如果是这种情况,就明确说出来:mvn install。
彻底默认构建的另一面是它需要时间。有时你只是想马上得到一个 jar,好在另一个项目里试试东西。与其记住半打 -D...skip 标志,不如把它们打包进一个 profile:
<profile> <id>fast</id> <!-- profile to skip time-consuming steps --> <properties> <!-- skip _compiling_ the tests, not just running them --> <maven.test.skip>true</maven.test.skip> <basepom.javadoc.skip>true</basepom.javadoc.skip> <basepom.check.skip-extended>true</basepom.check.skip-extended> <basepom.check.skip-checkstyle>true</basepom.check.skip-checkstyle> <basepom.check.skip-pmd>true</basepom.check.skip-pmd> <basepom.check.skip-license>true</basepom.check.skip-license> <cyclonedx.skip>true</cyclonedx.skip> </properties> </profile>注意两个测试开关之间的区别。skipTests 只是跳过运行测试,而 maven.test.skip 连编译都不做,这也省下了花在测试源码及其依赖上的时间。对于快速通道来说,后者才是你想要的,它也使得 skipTests 变得多余。
值得检查一下这样的 profile 是否真的跳过了它声称要跳过的内容。Jackcess 中这个 profile 的第一个版本设置的是标准的 maven.javadoc.skip,而 basepom 会忽略它,改用自己 basepom.javadoc.skip;它还依赖 skip-extended,而后者并不覆盖 Checkstyle 和 PMD。构建是变快了,但 Javadoc 和两项检查仍然在运行。只要快速看一眼构建日志(被跳过的插件会在日志里说明),就能发现这个问题。
现在 mvn -Pfast 能在通常时间的一小部分内产出一个 jar。对 Jackcess 来说,这意味着 27 秒而不是将近两分钟。完整构建仍然是默认行为,快捷方式需要你主动要求。
(原文较长,此处译出前 6000 字,完整内容请点「打开原文」。)
正文由 探How 从来源站点 RSS 同步,内容未经改写;遇到排版缺失或需要图片、视频时请以原文为准。