通过maven使用本地jar包

本文介绍了如何在Maven项目中使用本地jar包,包括快照版本和非快照版本的不同处理方式,以及如何修改maven-metadata.xml文件来确保正确的版本被使用。
        Maven 作为当下流行的构建工具,在开发中得到了广泛的使用,开发人员可以方便的通过Maven将依赖的jar包从私服上拉取到本地。但日常开发中,经常会遇到需要使用本地jar包的情况:
        jar包提供方开发还在进行中,版本还没稳定,还不具备上传至私服的条件,因此系统间的开发合作可能是通过本地打个jar包,然后将jar文件发送给依赖方,依赖方使用这个本地jar包进行开发。
        下面分几种常见情景,分别介绍怎么通过maven使用本地jar包:
  1. 服务提供方P(provider)和依赖方C(consumer)两个系统都是同一个开发人员开发
    这种情况是最简单的,只要在系统A上,通过maven 的 install命名,将jar包构建至本地仓库,系统B就能正常使用这个新构建的jar包了。
  1. P和C在不同开发人员中,但是jar包是非快照版本(非SNAPSHOT)
    这种情况也较简单,根据pom文件的groupId,artifactId和version在本地仓库中找到相应的目录(没有的话,就新建),将P提供的jar包放置于此,并将jar包内的pom.xml文件拿出,重命名为何jar包一样的名字,后缀用 .pom结尾,就好了。
  1. P和C在不同开发人员中,jar包是快照版本
    对于快照版本的jar包,如果jar包的版本号,私服没有,这比较简单,和情况2一样处理就行。但是如果私服有这个版本号,情况就有点特殊了,原理分析如下:
    maven对于快照版本,P每次上传jar包,maven都会为它打上一个时间戳,同时将最新的版本信息记录在 maven-metadata.xml文件中。
    文件内容一般如下:
    <?xml version="1.0" encoding="UTF-8"?>
    <metadata modelVersion="1.1.0">
      <groupId>com.jd.stock.engine2</groupId>
      <artifactId>stock-engine2-test-export</artifactId>
      <version>1.1.3-SNAPSHOT</version>
      <versioning>
        <snapshot>
          <timestamp>20171228.022230</timestamp>
          <buildNumber>1</buildNumber>
        </snapshot>
        <lastUpdated>20180129020057</lastUpdated>
        <snapshotVersions>
          <snapshotVersion>
            <extension>jar</extension>
            <value>1.1.3-20171228.022230-1</value>
            <updated>20171228022230</updated>
          </snapshotVersion>
          <snapshotVersion>
            <extension>pom</extension>
            <value>1.1.3-20171228.022230-1</value>
            <updated>20171228022230</updated>
          </snapshotVersion>
        </snapshotVersions>
      </versioning>
    </metadata>
    当C重新获取依赖时,maven会首先去私服将maven-metadata.xml下载到本地,和本地的maven-metadata-local.xml文件进行比较,主要是对比更新时间(lastUpdated)的先后:(1) 如果远端下载配置文件的时间新,则去远端下载最新的jar包和pom文件至本地仓库,然后复制一份重命名为 SNAPSHOT结尾的jar包和pom文件。(2) 如果本地文件的时间新,则停止jar包的下载,以本地文件内记录的jar包信息为准,在本地仓库中进行查找。
        因此这类情况,使用本地jar包方式如下:

  1. 在本地仓库响应的目录中(根据groupId等信息,前文有说明),将maven-metadata.xml文件重命名为maven-metadata-local.xml,对文件进行修改,将lastUpdated时间后延,将jar和pom的<value>值参考本地jar包进行更改,本例中改为 1.1.3-SNAPSHOT;
  2. 清空其他所有文件,放入jar包,名字记得以SNAPSHOT结尾,不带时间戳的。
  3. 将jar包内的配置文件拿出,和jar包放在同一目录中,和jar包一样的名字, .pom结尾。
远端下下来的配置如上图,修改后的配置文件如下:

<?xml version="1.0" encoding="UTF-8"?>
<metadata modelVersion="1.1.0">
  <groupId>com.jd.stock.engine2</groupId>
  <artifactId>stock-engine2-test-export</artifactId>
  <version>1.1.3-SNAPSHOT</version>
  <versioning>
    <snapshot>
      <timestamp>20171228.022230</timestamp>
      <buildNumber>1</buildNumber>
    </snapshot>
    <lastUpdated>20180308020057</lastUpdated>
    <snapshotVersions>
      <snapshotVersion>
        <extension>jar</extension>
        <value>1.1.3-SNAPSHOT</value>
        <updated>20171228022230</updated>
      </snapshotVersion>
      <snapshotVersion>
        <extension>pom</extension>
        <value>1.1.3-SNAPSHOT</value>
        <updated>20171228022230</updated>
      </snapshotVersion>
    </snapshotVersions>
  </versioning>
</metadata>

本地仓库目录结构如下:


使用Maven本地jar进行打,可按以下步骤操作: ### 1. 安装本地jar本地Maven本地jar未在Maven中央仓或其他远程仓中,需先将其安装到本地Maven。可使用`mvn install:install-file`命令,示例如下: ```bash mvn install:install-file -Dfile=path/to/your/local/jar/file.jar -DgroupId=com.yourcompany -DartifactId=your-artifact -Dversion=1.0 -Dpackaging=jar ``` - `-Dfile`:指定本地jar的路径。 - `-DgroupId`、`-DartifactId`、`-Dversion`:定义该jarMaven中的坐标。 - `-Dpackaging`:指定打类型,一般为`jar`。 ### 2. 在项目的`pom.xml`文件中添加依赖 在项目的`pom.xml`文件里添加对本地jar的依赖,示例如下: ```xml <dependencies> <dependency> <groupId>com.yourcompany</groupId> <artifactId>your-artifact</artifactId> <version>1.0</version> </dependency> </dependencies> ``` 要保证`<groupId>`、`<artifactId>`和`<version>`与安装本地jar时设置的一致。 ### 3. 打项目 在项目根目录下执行以下Maven命令进行打: ```bash mvn package ``` 此命令会将项目及其依赖打成一个可执行的jar,一般位于`target`目录下。 ### 4. 含依赖的打(可选) 若希望将项目依赖的所有jar含在一个单独的可执行jar中,可使用Maven Shade Plugin或Maven Assembly Plugin。 #### 使用Maven Shade Plugin 在`pom.xml`文件中添加以下插件配置: ```xml <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-shade-plugin</artifactId> <version>3.2.4</version> <executions> <execution> <phase>package</phase> <goals> <goal>shade</goal> </goals> <configuration> <transformers> <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"> <mainClass>com.yourcompany.MainClass</mainClass> </transformer> </transformers> </configuration> </execution> </executions> </plugin> </plugins> </build> ``` 然后执行`mvn package`命令,会在`target`目录下生成一个含所有依赖的可执行jar。 #### 使用Maven Assembly Plugin 在`pom.xml`文件中添加以下插件配置: ```xml <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-assembly-plugin</artifactId> <version>3.3.0</version> <configuration> <descriptorRefs> <descriptorRef>jar-with-dependencies</descriptorRef> </descriptorRefs> <archive> <manifest> <mainClass>com.yourcompany.MainClass</mainClass> </manifest> </archive> </configuration> <executions> <execution> <id>make-assembly</id> <phase>package</phase> <goals> <goal>single</goal> </goals> </execution> </executions> </plugin> </plugins> </build> ``` 执行`mvn assembly:single`命令,会在`target`目录下生成一个含所有依赖的可执行jar
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值