Maven:通过相对路径向jar添加依赖项

我有一个专有的jar,我想把它作为依赖项添加到我的pom中。

但我不想将它添加到存储库中。原因是我想让我常用的maven命令,如mvn compile等,开箱即用。(无需要求开发人员自己将其添加到某个存储库中)。

我希望jar在源代码控制的3rdparty库中,并通过相对路径从pom.xml文件链接到它。

这能做到吗?如何?

368126 次浏览

使用system作用域。${basedir}是你的pom的目录。

<dependency>
<artifactId>..</artifactId>
<groupId>..</groupId>
<scope>system</scope>
<systemPath>${basedir}/lib/dependency.jar</systemPath>
</dependency>

然而,建议您将jar安装在存储库中,而不是提交给SCM——毕竟这是maven试图消除的。

我希望jar在源代码控制的3rdparty库中,并通过相对路径从pom.xml文件链接到它。

如果你真的想要这样(理解,如果你不能使用公司存储库),那么我的建议是使用项目本地的“文件存储库”,并不使用是一个system范围的依赖项。system作用域应该避免,这样的依赖在很多情况下都不能很好地工作(例如在汇编中),它们带来的麻烦多于好处。

因此,相反,在项目本地声明一个存储库:

<repositories>
<repository>
<id>my-local-repo</id>
<url>file://${project.basedir}/my-repo</url>
</repository>
</repositories>

使用install:install-filelocalRepositoryPath参数在其中安装第三方库:

<罢工>

mvn install:install-file -Dfile=<path-to-file> -DgroupId=<myGroup> \
-DartifactId=<myArtifactId> -Dversion=<myVersion> \
-Dpackaging=<myPackaging> -DlocalRepositoryPath=<path>

> < /罢工

更新:在使用插件2.2版本时,install:install-file似乎忽略了localRepositoryPath。但是,它适用于该插件的2.3及更高版本。所以使用插件的完全限定名来指定版本:

mvn org.apache.maven.plugins:maven-install-plugin:2.3.1:install-file \
-Dfile=<path-to-file> -DgroupId=<myGroup> \
-DartifactId=<myArtifactId> -Dversion=<myVersion> \
-Dpackaging=<myPackaging> -DlocalRepositoryPath=<path>

maven-install-plugin documentation

最后,像其他依赖一样声明它(但没有system作用域):

<dependency>
<groupId>your.group.id</groupId>
<artifactId>3rdparty</artifactId>
<version>X.Y.Z</version>
</dependency>

在我看来,这是一个比使用system作用域更好的解决方案,因为你的依赖将被像一个好公民一样对待(例如,它将被包含在一个程序集中等等)。

现在,我必须提到在企业环境中处理这种情况的“正确方法”(这里可能不是这样)是使用企业存储库。

我之前已经写一个模式做这个。

它与Pascal提出的解决方案非常相似,不过它将所有依赖项移动到一个专用的存储库模块中,这样如果是多模块构建,就不必在使用依赖项的所有地方重复它。

这是我之前在我可以将jar添加到maven 2构建类路径而不安装它们吗?的答案之外的另一个方法

这将绕过使用多模块构建时的限制,特别是如果下载的JAR在父项目之外的子项目中被引用。通过将POM和SHA1文件创建为构建的一部分,这也减少了设置工作。它还允许文件驻留在项目中的任何位置,而无需固定名称或遵循maven存储库结构。

这使用了maven-install-plugin。为此,您需要设置一个多模块项目,并拥有一个表示构建的新项目,以便将文件安装到本地存储库中,并确保第一个项目。

你的多模块项目pom.xml看起来像这样:

<packaging>pom</packaging>
<modules>
<!-- The repository module must be first in order to ensure
that the local repository is populated -->
<module>repository</module>
<module>... other modules ...</module>
</modules>

然后,存储库/pom.xml文件将包含用于加载作为项目一部分的jar的定义。下面是pom.xml文件的一些片段。

<artifactId>repository</artifactId>
<packaging>pom</packaging>

pom打包可以防止执行任何测试、编译或生成任何jar文件。xml的主体位于使用maven-install-plugin的构建部分。

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-install-plugin</artifactId>
<executions>
<execution>
<id>com.ibm.db2:db2jcc</id>
<phase>verify</phase>
<goals>
<goal>install-file</goal>
</goals>
<configuration>
<groupId>com.ibm.db2</groupId>
<artifactId>db2jcc</artifactId>
<version>9.0.0</version>
<packaging>jar</packaging>
<file>${basedir}/src/jars/db2jcc.jar</file>
<createChecksum>true</createChecksum>
<generatePom>true</generatePom>
</configuration>
</execution>
<execution>...</execution>
</executions>
</plugin>
</plugins>
</build>

要安装多个文件,只需添加更多的执行。

我们切换到gradle,这在gradle中工作得更好;)。我们只是指定一个文件夹,我们可以将罐子放入这样的临时情况。我们仍然在典型的依赖管理部分中定义了大多数jar。与maven相同)。这只是我们定义的另一个依赖项。

所以基本上现在我们可以将任何jar放到lib目录中进行临时测试,如果它不是maven中的某个存储库的话。

这是对Pascal发布的解决方案的一个小补充

当我遵循这条路线时,我在安装ojdbc jar时在maven中得到了一个错误。

[INFO] --- maven-install-plugin:2.5.1:install-file (default-cli) @ validator ---
[INFO] pom.xml not found in ojdbc14.jar

添加-DpomFile后,问题得到解决。

$ mvn install:install-file -Dfile=./lib/ojdbc14.jar -DgroupId=ojdbc \
-DartifactId=ojdbc -Dversion=14 -Dpackaging=jar -DlocalRepositoryPath=./repo \
-DpomFile=~/.m2/repository/ojdbc/ojdbc/14/ojdbc-14.pom

基本上,把这个添加到pom.xml:

...


<repositories>
<repository>
<id>lib_id</id>
<url>file://${project.basedir}/lib</url>
</repository>
</repositories>


...


<dependencies>
...
<dependency>
<groupId>com.mylibrary</groupId>
<artifactId>mylibraryname</artifactId>
<version>1.0.0</version>
</dependency>
...
</dependencies>
你可以使用eclipse生成一个可运行的Jar: 导出/Runable Jar文件

这对我很有用: 假设我有这个依赖项

<dependency>
<groupId>com.company.app</groupId>
<artifactId>my-library</artifactId>
<version>1.0</version>
<scope>system</scope>
<systemPath>${project.basedir}/lib/my-library.jar</systemPath>
</dependency>

然后,手动添加系统依赖项的类路径,如下所示

<Class-Path>libs/my-library-1.0.jar</Class-Path>

完整的配置:

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>2.4</version>
<configuration>
<archive>
<manifestEntries>
<Build-Jdk>${jdk.version}</Build-Jdk>
<Implementation-Title>${project.name}</Implementation-Title>
<Implementation-Version>${project.version}</Implementation-Version>
<Specification-Title>${project.name} Library</Specification-Title>
<Specification-Version>${project.version}</Specification-Version>
<Class-Path>libs/my-library-1.0.jar</Class-Path>
</manifestEntries>
<manifest>
<addClasspath>true</addClasspath>
<mainClass>com.company.app.MainClass</mainClass>
<classpathPrefix>libs/</classpathPrefix>
</manifest>
</archive>
</configuration>
</plugin>
<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>
<outputDirectory>${project.build.directory}/libs/</outputDirectory>
</configuration>
</execution>
</executions>
</plugin>

我也遇到了同样的问题,它只需要删除DlocalRepositoryPath参数,并在Dfile参数中从当前位置定义正确的路径即可:

mvn install:install-file -Dfile=./repo/com/tridion/cd_core/1.0/cd_core-1.0.jar -DgroupId=com.tridion -DartifactId=cd_core -Dversion=1.0 -Dpackaging=jar

注意:Apache Maven 3.8.6