生成具有不同/过滤类的多个 jar 的 Maven 最佳实践？

Posted 2023-02-27

【中文标题】生成具有不同/过滤类的多个 jar 的 Maven 最佳实践？

【英文标题】：Maven best practice for generating multiple jars with different/filtered classes?

【发布时间】：2011-01-26 07:28:04

【问题描述】：

我开发了一个用于各种项目的 Java 实用程序库（类似于 Apache Commons）。 除了胖客户端之外，我还将它用于移动客户端（带有 J9 Foundation 配置文件的 PDA）。 随着时间的推移，作为单个项目开始的库分布在多个包中。结果，我最终获得了很多功能，而并非所有项目都真正需要这些功能。

由于这个库也在一些移动/PDA 项目中使用，我需要一种方法来仅收集使用的类并生成实际的专用 jar。

目前在使用这个库的项目中，我有 Ant jar 任务，它们生成（从实用程序项目）专用 jar 文件（例如：my-util-1.0-pda.jar、my-util-1.0-rcp .jar) 使用包含/排除 jar 任务功能。由于生成的 jar 文件的大小限制，对于移动项目，这主要是需要的。

现在迁移到 Maven 我只是想知道是否有任何最佳实践可以达到类似的目标。我考虑以下几种情况：

[1] - 除了主 jar 工件 (my-lib-1.0.jar) 也在 my-lib 项目中生成使用 Maven Jar 插件或 Maven 程序集插件过滤/包含的分类器（例如：my-lib-1.0-pda.jar）的单独/专用工件。我对这种方法不太满意，因为它污染了图书馆消费者的需求（过滤器）。

[2] - 为所有专门的客户/项目创建额外的 Maven 项目，这将“包装”“my-lib”并生成过滤后的 jar 工件（例如：my -lib-wrapper-pda-1.0 ...等）。因此，这些包装器项目将包括过滤（以生成过滤后的工件）并且将仅依赖于“my-lib”项目，而客户端项目将依赖于 my-lib-wrapper-xxx-1.0 而不是 my-lib-1.0。这种方法可能看起来有问题，因为即使这样会使“my-lib”项目完好无损（没有额外的分类器和工件），基本上会使项目数量增加一倍，因为对于每个客户项目我都会有一个库，只是为了收集需要的“my-util”库中的类（“my-pda-app”项目需要一个“my-lib-wrapper-for-my-pda-app”项目/依赖项）。

[3] - 在每个使用该库的客户端项目中（例如：my-pda-app）添加一些专门的 Maven 插件来修剪（在生成final artifact/package) 不需要的类（例如：maven-assembly-plugin、maven-jar-plugin、proguard-maven-plugin）。

以“Maven 方式”解决此类问题的最佳实践是什么？

【参考方案1】：

为了模块化，Maven 的一般规则是“每个 POM 一个主要工件”，不应该打破这个约定的原因（一般而言）在 How to Create Two JARs from One Project (...and why you shouldn’t) 博客文章中得到了很好的解释。然而，也有合理的例外（例如，一个 EJB 项目产生一个 EJB JAR 和一个只有接口的客户端 EJB JAR）。话虽如此：

提到的blog post（另请查看Using Maven When You Can't Use the Conventions）解释了如何使用单独的配置文件或JAR 插件 实现选项1。如果您决定实施此解决方案，请记住这应该是一个例外，并且它可能会使依赖项管理变得更加棘手（并且，正如您所提到的，使用“客户端过滤逻辑”污染项目）。以防万一，我会在这里使用几个 JAR 插件执行。

选项 2 与 选项 1 IMO 没有太大区别（除了它将事物分开）：基本上，拥有 N 个其他包装/过滤项目与拥有非常相似一个项目中的 N 个过滤规则。如果过滤有意义，我更喜欢选项 1。

我根本不喜欢选项 3，因为我认为图书馆的客户不应该负责“修剪”不需要的东西。首先，客户项目不一定具有所需的知识（要修剪什么），其次，这可能会与其他插件产生很大的混乱。

但是如果胖客户端不使用整个 my-lib（就像服务器端代码需要整个 EJB JAR） ，那么过滤不是处理您的情况的正确“行家方式”。正确的方法是选项 4：将所有常见的东西放在一个项目中（生成 my-lib-core-1.0.jar）和特定项目中的特定部分（这将生成my-lib-pda-1.0.jar 等）。然后，客户将依赖核心工件和专用工件。

【讨论】：

这里主要关注的是 PDA/移动客户端（受限大小/内存）而不是胖客户端或服务器，因为实际的 lib/jar 大小没有问题（例如，您可以使用单个来自 apache-commons-xxx 的类，但仍然获得完整的 jar）。我正在寻找的是一个 Maven 最佳实践，可以从一个更大的项目中删除/过滤所需的类到一个特定的应用程序中。这看起来更像是一个混淆器任务，它也支持修剪，但仍然不知道这如何适合 Maven 环境。我还是更喜欢把它放到客户端/消费者端/项目（选项 3）

@jaguard 我理解约束，maven 最佳实践是选项 4（不确定为什么会出现问题）。如果你真的不想实现它，那么我认为选项 1 是最好的第二选择。选项 3 将 IMO 导致许多问题（如我所写）。