【问题标题】:Maven: how to include module dependencies into general dependency-jars folderMaven:如何将模块依赖项包含到通用依赖项 jars 文件夹中
【发布时间】:2014-07-27 18:13:06
【问题描述】:

我正在开发一个结构如下的多模块 maven 项目:

SQR
+ pom.xml
+ core
| + src
| + target
| | + dependency-jars
| pom.xml
+ connector
| + src
| pom.xml
+ xmlreader
| + src
| pom.xml
+ xmlwriter
| + src
| pom.xml

SQR 是顶级项目,而核心、连接器、xmlreader、xmlwriter 是模块。目前,核心将所有内容一起构建到带有外部 jar 库的可执行 jar 中。核心使用了几个依赖项,即 log4j、commons。到目前为止,一切都很好。出现问题的模块正在使用特定的依赖项,即 http-client、commons-io。它们都被添加到类路径中,但不会被复制到 core/target/dependency-jars。另一个缺点是我必须在使用依赖项(例如复制依赖项等)时扩展每个模块的 pom.xml。

目前我有以下文件:

SQR/pom.xml:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.sqr</groupId>
    <artifactId>SQR</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>

    <name>SQR</name>
    <url>http://maven.apache.org</url>
    <modules>
        <module>core</module>
        <module>connector</module>
        <module>xmlwriter</module>
        <module>xmlreader</module>
    </modules>
</project>

core/pom.xml:

<?xml version="1.0"?>
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>com.sqr</groupId>
    <artifactId>SQR</artifactId>
    <version>1.0-SNAPSHOT</version>
  </parent>
  <artifactId>core</artifactId>
  <packaging>jar</packaging>
  <name>core</name>
  <url>http://maven.apache.org</url>
  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>
  <dependencies>
    [...]
    <dependency>
        <groupId>org.apache.commons</groupId>
        <artifactId>commons-lang3</artifactId>
        <scope>compile</scope>
    </dependency>
  </dependencies>

  <build>
    <plugins>
        [...]
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-dependency-plugin</artifactId>
            <version>2.5.1</version>
            <executions>
                <execution>
                    <id>copy-dependencies</id>
                    <phase>package</phase>
                    <goals>
                        <goal>copy-dependencies</goal>
                    </goals>
                    <configuration>
                        <includeGroupIds>com.sqr, org.apache.commons</includeGroupIds>
                        <outputDirectory>${project.build.directory}/dependency-jars/</outputDirectory>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
  </build>
</project>

其他模块 pom.xml 文件与上面列出的类似。扩展每个 pom.xml 文件感觉开销很大。是否有解决此问题的最佳实践?或者是否有针对此问题的快速而干净的解决方案?

tl;dr: 我想要一个多模块项目,其中所有模块及其依赖项都构建到单独的 .jar 文件中并链接在一起。如下:

+ dependency-jars
| commons-lang3-3.3.2.jar (used by only xmlwriter)
| connector-1.0-SNAPSHOT.jar
| xmlreader-1.0-SNAPSHOT.jar
| xmlwriter-1.0-SNAPSHOT.jar
| log4j-1.2.17.jar (used by all modules)
core-1.0-SNAPSHOT.jar (being the main entry of the application)

【问题讨论】:

    标签: java maven jakarta-ee maven-3


    【解决方案1】:

    如果您的目标是将连接器、xmlreader 和 xmlwriter jar 及其所有依赖项包含到核心模块的依赖项文件夹中,那么常见的方法是将这三个模块列为核心中的编译依赖项模块 pom.xml,就像核心模块是依赖于较低级别模块(例如域或公共模块)的 Web 模块一样。

    这些模块没有出现在列出的核心模块 pom.xml 的依赖项部分中。添加它们可能无法为您的问题提供 100% 的解决方案,因为正在执行自定义打包,但应该会让您更接近目标。

    编辑:删除

    <includeGroupIds>com.sqr, org.apache.commons</includeGroupIds>
    

    ,则应为连接器、xmlreader、xmlwriter 复制所有传递依赖项。

    【讨论】:

    • 我没有复制/粘贴完整的依赖项列表。但实际上我的 core/pom.xml 对模块 xmlreader/xmlwriter 和连接器有所有 3 个依赖项。但是我仍然需要手动将其他模块的依赖添加到我的 core/pom.xml 中。我想通过打包来自动化这个(我猜..?)。
    • 查看编辑以不限制被复制的传递依赖。
    【解决方案2】:

    您的问题的解决方案似乎是分发。

    以下解决方案将帮助您构建分发工件:

    • boot/core.jar
    • libs/connector.jar
    • libs/xmlwriter.jar
    • libs/xmlreader.jar

    不用担心它听起来很简单!

    1. 创建一个名为 ditrib 的新模块

    2. 在目录:src/main/assembly中创建一个程序集文件:distribution.xml。

    内容应该关闭到这个:

    <assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">`
    
    <id>distrib</id>
    
    <formats>
        <format>jar</format>
    </formats>
    
    <includeBaseDirectory>false</includeBaseDirectory>
    
    <dependencySets>
        <dependencySet>
            <outputDirectory>/boot</outputDirectory>
            <includes>
                <include>${project.groupId}:core</include>
            </includes>
        </dependencySet>
        <dependencySet>
            <outputDirectory>/libs</outputDirectory>
            <includes>
                <include>${project.groupId}:connector</include>
                <include>${project.groupId}:xmlwriter</include>
                <include>${project.groupId}:xmlreader</include>
                <include>*:commons-lang3</include>
                <include>*:log4j</include>
            </includes>
        </dependencySet>
    </dependencySets>
    
    </assembly>
    
    1. 在你的 pom 中,创建分发然后声明:

           <plugin>
              <artifactId>maven-assembly-plugin</artifactId>
              <configuration>
                  <descriptors>
                      <descriptor>src/main/assembly/distrib.xml</descriptor>
                  </descriptors>
                  <finalName>${project.artifactId}-${project.version}</finalName>
                  <appendAssemblyId>false</appendAssemblyId>
              </configuration>
              <executions>
                  <execution>
                      <id>make-assembly</id>
                      <phase>package</phase>
                      <goals>
                          <goal>single</goal>
                      </goals>
                  </execution>
              </executions>
          </plugin>
      

    这将在您的目标文件夹中生成一个名为 *-distrib.jar 的 jar,然后发出:mvn package。

    注意:通常发行版附带一个 config/config.properties 文件,该文件将引导目录中的内容与 libs 目录中的内容粘合起来。此外,如果没有 bin/run.{sh|bat} 文件,发行版也无法完全成熟。

    希望对你有帮助! 干杯!

    【讨论】:

    • 您是否建议使用您建议的文件和内容创建另一个模块,即“发行版”?或者我应该调整核心模块的 pom.xml 吗?谢谢!
    • 是的,我建议添加一个模块
    【解决方案3】:

    看看Maven的Shade Plugin,也许会有帮助。

    http://maven.apache.org/plugins/maven-shade-plugin/

    【讨论】:

    • 是的,虽然我不想创建一个 uber-jar。我想在我的 dependency-jars/ 文件夹中使用单独的 .jar 文件。就像我的帖子中描述的那样。无论如何,谢谢。
    猜你喜欢
    • 2013-04-17
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2016-12-02
    • 2021-03-15
    • 2018-12-19
    • 2020-11-14
    • 1970-01-01
    相关资源
    最近更新 更多