Maven仓库管理之Nexus

原文链接：http://blog.csdn.net/cuker919/article/details/5922007

 

我分两部分来介绍，首先介绍一下Maven的仓库，然后在说一下如何通过Nexus来建立我们自己的仓库，以及如何使用。

Maven 仓库

    在以前使用Ant的时候，我们会建立一个lib目录在存放我们的jar包，比如项目所依赖的第三方包，每建立一个项目都要建立一个lib，不停的做copy工作，不仅是对于磁盘的浪费，而且也造成了版本管理上的麻烦。而且我们还需要通过提交到svn上来对lib进行管理，但是svn对于这种二进制文件的管理并不出色。 

    Maven仓库的初衷就是为了解决这个问题。 maven仓库是所有常用的第三方依赖包的集中营。这样所有的Maven项目就可以从这个仓库中获取所需要的资源，Maven仓库中对jar通过Group Id, Atifact Id, version 来管理，所以Maven项目可以很方便的进行依赖管理。你不需要自己来管理这个庞大的资源仓库，当然你可以创建一个公司层面的仓库，这个我在这个章节的后面会介绍。

 Maven 仓库的两个概念：本地仓库和远程仓库

     本地仓库是远程仓库的一个缓冲和子集，当你构建Maven项目的时候，首先会从本地仓库查找资源，如果没有，那么Maven会从远程仓库下载到你本地仓库。这样在你下次使用的时候就不需要从远程下载了。如果你所需要的jar包版本在本地仓库没有，而且也不存在于远程仓库，Maven在构建的时候会报错，这种情况可能发生在有些jar包的新版本没有在Maven仓库中及时更新。

    Maven缺省的本地仓库地址为${user.home}/.m2/repository 。也就是说，一个用户会对应的拥有一个本地仓库。当然你可以通过修改${user.home}/.m2/settings.xml 配置这个地址：

<settings>   
...
  <localRepository> D:/java/repository</localRepository>   
  ...
</settings>

 

如果你想让所有的用户使用统一的配置，那么你可以修改${M2_HOME}/conf/setting.xml

 还可以通过在运行时指定目录（不推荐这么做）：

mvn clean install -Dmaven.repo.local=/home/juven/myrepo/

 

    当我们创建一个简单的Maven项目后(只需要在pom.xml配置好依赖项)，运行mvn clean install就可以把项目构建好，maven会自动从中央仓库下载所需的依赖项(即jar包）。这个中央仓库定义在${M2_HOME}/lib/maven-2.0.10-uber.jar 里面。你可以在里面找到/org/apache/maven/project/pom-4.0.0.xml这个文件，在这个文件里面定义了中央仓库的地址：

<repositories>   
  <repository>   
    <id> central</id>   
    <name> Maven Repository Switchboard</name>   
    <layout> default</layout>   
    <url>http://repo1.maven.org/maven2</url>   
    <snapshots>   
      <enabled> false</enabled>   
    </snapshots>   
  </repository>   
</repositories>

 

在 POM 中配置远程仓库

       当某个依赖项存在于第三方的公共仓库时，我们需要配置其他远程仓库呢。下面是在pom.xml里面配置一个远程仓库的例子：

<repositories>  
    <repository>
        // 其他远程仓库
    </repository> 
    <repository>   
      <id> maven-net-cn</id>   
      <name> Maven China Mirror</name>   
      <url> http://maven.net.cn/content/groups/public/</url>   
      <releases>   
        <enabled> true</enabled>   
      </releases>   
      <snapshots>   
        <enabled> false</enabled>   
      </snapshots>   
    </repository>   
  </repositories>   
  <pluginRepositories>   
    <pluginRepository>
      // 其他maven插件仓库
    </pluginRepository>
    <pluginRepository>   
      <id> maven-net-cn</id>   
      <name> Maven China Mirror</name>   
      <url> http://maven.net.cn/content/groups/public/</url>   
      <releases>   
        <enabled> true</enabled>   
      </releases>   
      <snapshots>   
        <enabled> false</enabled>   
      </snapshots>        
    </pluginRepository>   
  </pluginRepositories>

    这里我们可以看到，允许配置多个repository和 plugin repository，其中<releases><enabled>true</enabled></releases>告诉Maven可以从这个仓库下载releases版本的构件，而<snapshots><enabled>false</enabled></snapshots>告诉Maven不要从这个仓库下载snapshot版本的构件。

 

Maven在使用第三方构件和插件时是分开来配置的,所以如果我们也希望插件的下载也通过我们的本地仓库来下载,那么我们就需要配置pluginRepository.

 

之所以不允许从某些仓库下载snapshot版本，是因为snapshot版本不稳定，但是某些snapshot版本，比如公司内部正在开发的项目, 是必须的

 

至于<pluginRepositories>，这是配置Maven从什么地方下载插件构件，Maven的所有行为都是通过插件来完成的。 <pluginRepository>的配置与<repository>类似，这里就不多说了。     

 在 settings.xml 中配置远程仓库

     pom.xml的作用范围限于一个项目， 但一个公司/组织通常不只开发一个项目，那么为了避免重复配置，那么我们可以把一些公共配置放在${MAVEN_HOME}/conf/setting.xml(或${user.home}/.m2/setting.xml中。下面是在setting.xml中配置一个远程仓库的例子.

<settings>   
  <profiles> 
    <profile>
       <!-- 其他profile -->
    </profile>
    <profile>   
      <id>myProfiel</id>   
      <!--  在这里加入<repositories>及<pluginRepositories>  --> 
    </profile>   
  </profiles>   
   
  <!-- 声明哪些profile被激活，或根据某些条件激活 --> 
  <activeProfiles>   
    <activeProfile>myProfiel</activeProfile>   
  </activeProfiles>   
  
</settings>

 

     这里通过<activeProfile>元素来激活这个profile，这样我们就可以全局的使用这个配置，不再需要为每个POM做重复的配置了（也可以针对特定的条件激活，比如某些profile只有在使用JDK 1.4时才生效)。

     在实际的操作过程中，setting.xml最好不要配置远程仓库，最好能够通过nexus建立公司或者组织自己的仓库，然后把地址指向自己的仓库，后面我会介绍为什么要这么做以及怎么做。 

配置maven仓库镜像

    当你连接中央仓库时速度很慢，或有些国外的第三方仓库无法被访问时，你可以在setting.xml中为这些仓库指定一个镜像来加快下载依赖项的速度。下面是一个配置镜像的例子

<settings>   
  ...  
  <mirrors>   
     <mirror>   
      <!-- 其他镜像库 -->
    </mirror>
    <mirror>   
      <id> maven-net-cn</id>   
      <name> Maven China Mirror</name>   
      <url> http://maven.net.cn/content/groups/public/</url>   
      <mirrorOf>central</mirrorOf>   
    </mirror>   
  </mirrors>   
   ...
</settings>

这里的 <mirrorOf>必须指定某个<repository>的Id. 如果想为所有的仓库做镜像， 那么可以改为：<mirrorOf>*</mirrorOf>

 

利用 Nexus 来构建企业级 Maven 仓库

Nexus简介

    Nexus是一个Maven仓库管理器，用来搭建私有仓库服务器。建立公司/组织的私有仓库的的好处是便于管理，节省公网带宽，利用内网下载依赖项速度快，还有一个非常有用的功能就是能有效管理内部项目的SNAPSHOT版本，实现各个模块间的共享.

安装 Nexus

    可以从http://nexus.sonatype.org/downloads/ 获取最新版本的nexus，本文以1.3.4为例进行说明。

    Nexus提供了两种安装方式，内嵌Jetty的捆绑包（bundle）和WAR包。前者解压后即可单独运行，只要系统中安装了JRE， 后者需要一个Servlet容器来运行.

使用捆绑包安装

    如果你使用Windows，那么下载nexus-webapp-1.3. 4-bundle.zip，并将其解压至任意目录，如D:/tools，然后转到D:\tools\nexus-webapp-1.3.4\bin\jsw\indows-x86-32 ，双击运行Nexus.bat。 如果你是在linux下安装，那么就下载nexus-webapp-1.3. 4 -bundle.tar.gz，解压后运行nexus.sh。nexus还支持solaris,macos等操作系统。
    当你在控制台看到“Started SelectChannelConnector@0.0.0.0:8081”之后，说明Nexus启动成功了。 打开浏览器，访问http://127.0.0.1:8081/nexus，使用管理员的帐号(admin)和密码(admin123)登录， 会看到如下的页面：

在这里可以进行管理仓库，配置Nexus系统，管理任务，管理用户，角色，权限，查看系统的RSS源，管理及查看系统日志等操作。

 使用War包安装

     下载WAR包，然后将其发布到servlet容器中即可 

      到此我们已经安装好Nexus,下面介绍一下Nexus常用的功能和使用方法。

配置中央仓库

     在左边菜单栏里选择Repositories, 会看到如下的界面：

其中右边栏上半部分列出当前nexus管理的repository，黑体字是类型为group的repository. 这里简单介绍下几种repository的类型:

• hosted，本地仓库。通常我们会部署自己的构件到这一类型的仓库。比如公司/组织开发的项目
• proxy，代理仓库，它们被用来代理远程的公共仓库，如maven中央仓库或一些第三方公共仓库。
• group，仓库组，用来合并多个hosted/proxy仓库，当你的项目希望在多个repository使用依赖项时，无需引用多个仓库了，只需要引用一个类型为group的repository即可。

Maven central是Maven的中央仓库，点击它并选择configuration标签栏，我们会看到下面的页面：

这里有几个配置项是经常用到的：

• Override local storage location:  该选项允许配置 Nexus本地仓库的存放地址，用来覆盖其默认的存放地址
• Remote storage location: 该选项允许配置远程仓库的地址。一般为了提高代理速度，你可以将其修改为国内的镜像地址。默认值是http://repo1.maven.org/maven2/
• Download remote indexes: 该选项配置是否下载远程索引文件。 建议配置为true，这样我们便可以通过nexus的搜索功能来搜索我们需要的依赖项。

 

 添加代理仓库(proxy)

     nexus默认提供了Maven central这个代理仓库，如果你需要添加其他代理仓库，那么可以点击左边栏页面上的Repositories链接，然后在右边栏页面上依次点击add -> add proxy repository, 随后出现以下页面：

     根据提示填写相关信息保存即可。
    

管理本地仓库(hosted)

    Nexus预定义了三种本地仓库，分别是Releases, Snapshots, 3rd Party. 下面分别介绍一下这三种类型仓库的作用

• Releases:  存放稳定版本的构件。比如我们完成了一个版本的下数组件的开发,就可以把它发布到这里。
• Snapshots: 存放快照版本的构件。 比如一个下数组件在完成所有开发和测试工作之前，是不应该发布到release仓库的，但可能其他项目只需用到这个组件的某些接口，只要这些接口完成了开发并通过测试，就可以拿来使用, 从而实现多个项目并行开发。
• 3rd Party:  存放其他第三方构件。你可能会问， 不是有中央仓库和其他第三方公共仓库来管理这些依赖项了吗？没错。但由于某些开源项目出现的时间比maven要早，因此他们大都没有采用maven方式进行构建。 其他还包括包括一些非开源或使用maven 1.x构建的组件. 我们可以把这类组件通通添加到这里。
  
  创建本地仓库的方法很简单。点击Repository面板上方的Add按钮，然后选择Hosted Repository，然后在下方的配置面板中输入相关信息。 注意根据自己的需要选择本地仓库的类型

 

 仓库组(group)

      通过前面介绍我们了解到, 可以建立多个代理仓库和本地仓库. 但如果没有仓库组的概念，那么当需要引用这些仓库时, 就需要将他们逐个添加到pom.xml或setting.xml. 仓库组是为了简化仓库的引用而提出的。有了仓库组的概念, 我们可以把仓库根据不同目的进行分组，比如把常用的归到一组或根据访问权限分组， 然后直接声明引用某个仓库组即可. 下面是pom.xml中声明引用一个nexus仓库组的例子：  

<repositories>
     <repository>
        <id>nexus-public</id>                                               <url>http://127.0.0.1:8081/nexus/content/groups/public/</url>
        <releases>
            <enabled>true</enabled>
        </releases>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
     </repository>
</repositories>

 可以看到声明引用一个仓库组和一个普通的远程仓库，配置的写法完全一样。

maven本身没有仓库组的概念

       Nexus中预设了2个仓库组， 分别是public repositories和public snapshot repositories. 如图:

public repository默认包含本地仓库的Releases, snapshots和3rd party以及代理仓库的Maven Central. 你可以在Configuration配置页添加其他仓库到这个仓库组。 如果需要，你还可以创建一个仓库组,方法是点击 Add->Repository Group, 当New Repository Group界面后,填入ID, name 等相关信息, 然后在右边Available Repositories 栏里可以选择你要添加的仓库到你新建的仓库组. 

  

通过 Nexus 搜索构件

      在开发过程中过程中，我们往往只记得某个构件的大致名字，这时我们可以通过nexus提供的构件搜索功能查询该构件的完整配置信息(groupId,artifactId,version)．如果通过nexus搜不到某个的构件，那说明这个构件不在当前nexus所登记的仓库中，可能需要添加额外的代理仓库或手工上传某个构件。

     在使用nexus的搜索功能之前，必须先让nexus所登记的仓库建立索引文件, Nexus默认是不为每个仓库建立索引文件的,因为建立像中央仓库这样的索引文件需要耗费比较大的网络带宽和事件,仅索引文件就要几十兆. 要开启中央仓库的索引文件下载功能需要在Maven Central的配置页中， 把Download Remote Indexes改为true. 如图:

     这样设置之后, Nexus会自动从远程中央仓库下载索引文件, 为了检验索引文件自动下载是否生效,可以切换到Browse标签页，如图：

如果出现类似于以上文件夹,那说明索引文件已经建立成功.

    下面我们试一下搜索功能,  搜索栏输入testing, 查询结果如下：

这是模糊查询的结果，当然如果你知道更多信息，比如版本号等，你可以使用高级搜索，点击高级搜索后，右边界面会提供集中搜索方式：keyword, classname, GAV, checksum

比如我们这里选择GAV模式. 假设我只知道artifact的名字（如testng）和版本号（如5.8）, 其他的我不知道, 那么就在artifact 和 version处分别输入testng 和 5.8 , 搜索结果如下:

如果你不知道知道构件的名称, 只知道classname, 那么你也可以通过class name 的方式搜索,这里就不再赘述。

当你选中某项搜索结果， 页面的下方会出现这个构件的详细信息, 并且会列出这个构件的Maven依赖配置, 你可以直接拷贝到你的pom文件中使用,这是个非常实用的功能:

在 Maven 中使用Nexus

    到此我们介绍了如何安装和使用Nexus以及其基本配置, 那么如何在Maven来使用Nexus本地仓库呢？其实和配置远程仓库的方法一样。下面是在settings.xml中添加了一个nexus本地仓库的例子：

<profiles>
   ...
   <profile>
       <id>dev</id>
       <repositories>
            <repository>
                <id>nexus</id>                
                <url>http://127.0.0.1:8081/nexus/content/groups/public/</url>
                <releases>
                    <enabled>true</enabled>
                </releases>
                <snapshots>
                    <enabled>true</enabled>
                </snapshots>
             </repository>
        </repositories>           
        <pluginRepositories>
              <pluginRepository>
                  <id>nexus</id>
                  <url>http://127.0.0.1:8081/nexus/content/groups/public</url>
                  <releases>
                      <enabled>true</enabled>
                  </releases>
                  <snapshots>
                      <enabled>true</enabled>
                   </snapshots>
               </pluginRepository>
         </pluginRepositories>
     </profile>
   ...
</profiles>

<activeProfiles>
       <activeProfile>dev</activeProfile>
</activeProfiles>

你也可以在pom.xml中声明引用某个nexus仓库。

构件部署

     有些时候我们需要部署构件到Nexus的3rd party, 比如我们在中央仓库找不到我们需要的构件, 我们可以通过Nexus的UI界面来上传构件:

点击左边菜单栏的 Repositories, 然后点击右边界面的3rd party, 选择界面下方的Artifact Upload, 这个时候出现以下界面:

上传构件需要两个步骤,一个是定义文件的上传,再就是构件的实体文件.第一部分定义文件可以是POM文件, 这也是比较推荐的方式, 如果没有pom文件,可以选择以参数的形式输入。第二部分是上传构件的实体文件。这里简单说一下Classifier和Extension, 这两个都是选填项. Classifier用来区别同功能的构件用于不同的场景, 比如这个构件是分别针对JDK14和JDK15做了2个功能一样的Jar, 这个时候你就需要指定这个构件的Classifier为JDK14还是JDK15. Extension是指扩展名,如果不提供,那么会自动取这个构件的Packaging Type作为扩展名, 比如ear, jar, war 等等. (Packaging Type是在第一步中通过pom文件或者手工输入得到的)

     刚才说了3rd party的部署, 对于releases 和 snapshots的部署也是一样的操作过程.

     一般我们会通过UI 界面来部署一些缺失的构件。对于自己开发的构件还有另一种简单的部署方式， 即通过命令mvn deploy进行部署。但使用这种部署方式需要在pom.xml中添加一些配置，比如：

<project>   
    …   
    <distributionManagement>   
        <repository>   
            <id>nexus-releases</id>   
	     <name>Nexus Release Repository</name>   
	     <url>http://127.0.0.1:8081/nexus/content/repositories/releases/</url>
        </repository>
        <snapshotRepository>
            <id>nexus-snapshots</id>
            <name>Nexus Snapshot Repository</name>
            <url>http://127.0.0.1:8081/nexus/content/repositories/snapshots/</url>
        </snapshotRepository>   
    </distributionManagement>   
    …   
</project>

 

这里告诉Maven当我要发布release版本或者snapshot版本时，把构建好的成品上传到哪个服务器地址。

最后还要在setting.xml里面配置一个有部署权限的Nexus的帐号和密码

<settings>   
  …   
    <servers>   
      <server>   
        <id> nexus-releases</id>   
    <username>admin</username>   
    <password>admin123</password>   
  </server>   
  <server>   
    <id> nexus-snapshots</id>   
    <username>admin</username>   
    <password>admin123</password>   
  </server>      
</servers>   
…   
</settings>

 

至此 我们就可以通过命令mvn deploy来发布我们项目到本地仓库了. 

这里我们使用了admin来进行部署，一般建议使用一个具有部署权限的账号执行部署操作。

 

 

补充

 

1、 发现配置了nexus仓库组之后，下载构件抛异常

0-10-3 下午05时09分43秒: Build error for /com.newyulong.iptv.domain.entity/pom.xml; org.apache.maven.plugin.PluginResolutionException: Plugin org.apache.maven.plugins:maven-resources-plugin:2.4.1 or one of its dependencies could not be resolved: Missing:
----------
1) org.apache.maven.plugins:maven-resources-plugin:maven-plugin:2.4.1

  Try downloading the file manually from the project website.

  Then, install it using the command: 
      mvn install:install-file -DgroupId=org.apache.maven.plugins -DartifactId=maven-resources-plugin -Dversion=2.4.1 -Dpackaging=maven-plugin -Dfile=/path/to/file

  Alternatively, if you host your own repository you can deploy the file there: 
      mvn deploy:deploy-file -DgroupId=org.apache.maven.plugins -DartifactId=maven-resources-plugin -Dversion=2.4.1 -Dpackaging=maven-plugin -Dfile=/path/to/file -Durl=[url] -DrepositoryId=[id]

----------
1 required artifact is missing.

for artifact: 
  org.apache.maven.plugins:maven-resources-plugin:maven-plugin:2.4.1

from the specified remote repositories:
  Nexus (http://localhost:8181/nexus/content/groups/public , releases=true, snapshots=false)

 这里的主要原因是配置nexus里面的Public Repositories 顺序和条件出错，导致不能下载构件。比如这个public repositories：

这个是正确的配置顺序。其中左边的是正在使用的定义好的仓库，右边的是候选的仓库。在这个例子中，nexus下载构件的顺序是Releases -->Snapshots --> 3rd party --> Maven Central。

 

     好多公司处于安全考虑，要求使用用代理访问公网，而nexus经常需要往maven repository中心下载东西，因此需要给nexus的仓库设置代理。