从ant到maven -- maven pom例子（初级）

最近将项目从ant改成了maven，改的过程中，遇到一些问题，主要是想实现的功能不好找。maven官方文档，可能由于英文每看懂的原因，经常配完了不起作用，尤其是一些插件。

 

先介绍一下我的项目，总共有两个，一个是jar的项目，一个是web项目。web项目引用jar项目，并且向外部提供webservice。就是说需要向外界打包相关的service的接口。公司内部假设了maven的私服。因此我们会将jar的项目打包发送到私服上面，并且在web项目中配制maven私服仓库，依赖这个jar项目。

 

需求大概就是这样了，接下来，先看一下配制好的pom的具体内容吧。

 

jar项目：

 

<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/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.phpxiaoxin</groupId>
  <artifactId>jar-for-web</artifactId>
  <packaging>jar</packaging>
  <version>1.0</version>
  <name>myjar</name>
  <url>http://maven.apache.org</url>
  <distributionManagement>
    <repository>
      <id>com.phpxiaoxin</id>
      <name>phpxiaoxin</name>
      <url>scp://10.10.10.10/home/maven/repository</url>
    </repository>
  </distributionManagement>
  <build>
      <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <configuration>
                <source>1.6</source>
                <target>1.6</target>
                <encoding>utf-8</encoding>
            </configuration>
        </plugin>
          <plugin>
            <inherited>true</inherited>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-source-plugin</artifactId>
            <executions>
                <execution>
                    <id>attach-sources</id>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
      </plugins>
  </build>
</project>

 

web项目：

<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/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.phpxiaoxin</groupId>
    <artifactId>myweb</artifactId>
    <packaging>war</packaging>
    <version>1.0-SNAPSHOT</version>
    <name>myweb</name>
    <url>http://www.phpxiaoxin.com</url>
    <properties>
        <spring.version>2.5.6.SEC01</spring.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>com.phpxiaoxin</groupId>
            <artifactId>jar-for-web</artifactId>
            <version>1.0</version>
            <scope>compile</scope>
        </dependency>
        <dependency>
            <groupId>com.phpxiaoxin</groupId>
            <artifactId>dependency-SNAPSHOT</artifactId>
            <version>1.4.3-SNAPSHOT</version>
            <scope>compile</scope>
      </dependency>
      <dependency>
            <groupId>net.sf.json-lib</groupId>
            <artifactId>json-lib</artifactId>
            <classifier>jdk15</classifier>
            <version>2.2.1</version>
            <scope>compile</scope>
      </dependency>
      <dependency>
            <groupId>org.acegisecurity</groupId>
            <artifactId>acegi-security</artifactId>
            <version>1.0.6</version>
            <scope>compile</scope>
            <exclusions>
            <exclusion>
                <groupId>org.springframework</groupId>
                <artifactId>spring-support</artifactId>
            </exclusion>
            <exclusion>
                <groupId>org.springframework</groupId>
                <artifactId>spring-jdbc</artifactId>
            </exclusion>
            <exclusion>
                <groupId>org.springframework</groupId>
            </exclusion>
            </exclusions>
      </dependency>
      <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>${spring.version}</version>
        <scope>compile</scope>
      </dependency>
    </dependencies>
    <profiles>
        <profile>
            <id>production</id>
            <build>
                <resources>
                    <resource>
                        <directory>src/main/profiles/production</directory>
                    </resource>
                    <resource>
                        <directory>src/main/resources</directory>
                    </resource>
                </resources>
            </build>
        </profile>
        <profile>
            <id>development</id>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
            <build>
                <resources>
                    <resource>
                        <directory>src/main/profiles/development</directory>
                    </resource>
                    <resource>
                        <directory>src/main/resources</directory>
                    </resource>
                </resources>
            </build>
        </profile>
    <repositories>
        <repository>
            <id>com.phpxiaoxin</id>
            <name>10.10.10.10/maven2</name>
            <url>http://10.10.10.10/maven2</url>
            <layout>default</layout>
        </repository>
    </repositories>
    <build>
        <!--<testSourceDirectory>src/main/test/unittest</testSourceDirectory>-->
        <finalName>dswitch2-dcorp-adapter</finalName>
        <plugins>
            <!--jar:jar remote-service.jar-->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>2.2</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <jarName>remote-service</jarName>
                    <includes>
                        <include>**/remote/**</include>
                    </includes>
                </configuration>
            </plugin>
            <!--source:jar remote-service-source.jar-->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-source-plugin</artifactId>
                <version>2.1.1</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <finalName>remote-service</finalName>
                    <includes>
                        <include>**/remote/**</include>
                    </includes>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.6</source>
                    <target>1.6</target>
                    <encoding>utf-8</encoding>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.mortbay.jetty</groupId>
                <artifactId>maven-jetty-plugin</artifactId>
                <version>6.1.9</version>
                <configuration>
                    <contextPath>/myweb</contextPath>
                    <connectors>
                        <connector implementation="org.mortbay.jetty.nio.SelectChannelConnector">
                            <port>8080</port>
                            <maxIdleTime>60000</maxIdleTime>
                        </connector>
                    </connectors>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

 

下面是项目的目录结构(图片略做处理，大家应该可以看明白)：

 

接下来按照我从ant到maven的改造顺序，一点一点的介绍一下：

首先还是首先说jar项目吧：

 

创建jar的项目，命令：

mvn archetype:create -DgroupId=com.phpxiaoxin -DartifactId=jar-for-web

 然后就会得到一个jar-for-web的目录，并且得到一个pom.xml的文件和src等默认目录

其中pom中得四个标签是比较重要得，一个是

<groupId>  标识项目的组的id

<artifactId> 标识项目在组中的唯一id

<packaging> 打包类型（jar／war／pom）

<version>  这个版本一般根据项目的开发情况定。

档其他人需要依赖你的项目的时候，就需要知道这些信息，而在maven仓库中的路径为：

http://10.10.10.10/maven2/groupId/artifactId/version/artifactId-version.packaging

 

现在就可以将以前得代码转移到src／main／java下了。这个目录也是maven得默认得类得根目录。

将以前得src下得java代码转移到java目录以后执行：

mvn clean install

 发现代码编译不过去，仔细一看，原来是maven默认使用jdk 1.3编译，所以需要添加“maven-compiler-plugin”，并且配制其jdk版本为你需要得版本，我这边是1.6,具体例子可从上面的jar的pom中找到。

 

这样运行maven clean install后jar包完成，但是有class的jar，没有source的jar包，因此添加“maven-source-plugin”，支持source的jar包。

 

最后就师需要将打好的jar包发布（deploy）到自己架设的maven服务器上了。于是做了一下的配制：

 

<distributionManagement>
    <repository>
      <id>com.phpxiaoxin</id>
      <name>phpxiaoxin</name>
      <url>scp://10.10.10.10/home/maven/repository</url>
    </repository>
  </distributionManagement>

其中使用了ssh copy的方式将jar包传到maven私人服务器上，如果要发布到公共服务器上好像需要提交申请。需要说明的师这里的id标签里面的com.phpxiaoxin在maven的setting.xml(maven/conf/目录下)文件里面是有对应的，因为上传是需要用户名和密码的，因此需要修改maven的配制文件在servers中增加如下配制：

 

  <servers>
    <server>
      <id>com.phpxiaoxin</id>
      <username>mvn</username>
      <password>mvn</password>
    </server>
  </servers>

 

一切ok了后，执行maven clean install 就会自动打包相应的jar包，并且通过scp将文件deploy到maven仓库。

 

之后你就会在下面的目录找到你的jar包

http://10.10.10.10/maven2/com/phpxiaoxin/jar-for-web/1.0/

jar-for-web-1.0.jar

jar-for-web-1.0-source.jar

....

 

当然如果你向将某个jar包通过命令的方式发布到maven仓库，可以通过下面的命令实现：

 

mvn -e deploy:deploy-file -DgroupId=com.phpxiaoxin -DartifactId=jar-for-web -Dversion=1.0 -Dpackaging=jar -Dfile=target/jar-for-web.jar -DrepositoryId=com.derbysoft -Durl=scp://10.10.10.10/home/maven/repository 

 

当然你可能没有架设maven私服，你可以发布到本地仓库，可以使用下面的命令：

 

mvn install:install-file -Dfile=target/jar-forweb.jar -DgroupId=com.phpxiaoxin -DartifactId=jar-for-web -Dversion=1.0 -Dpackaging=jar -DgeneratePom=true 

 

这样jar项目就ok了,下面说一下web项目的改造。首先是创建一个web项目的命令：

 

mvn archetype:create -DgroupId=com.phpxiaoxin -DartifactId=myweb -DarchetypeArtifactId=maven-archetype-webapp  

 

会创建一个myweb的目录，生成的目录除了jar类似的外，还有特殊的src/main/resources(存放配制文件)和src／main／webapp（web目录）

 

ok现在在src/main下创建java目录作为java代码的根目录，并且将原来项目的java源代码copy进去。并且将web目录的内容copy到webapp中。test的单元测试copy到test目录。

 

接下来我们要做的第一件事情是在“repositories”标签里面配制添加我们maven私服的仓库地址：

http://10.10.10.10/maven2

 

然后我们添加jar包依赖，最常见的依赖是这样：

    <dependency>
      <groupId>org.dbunit</groupId>
      <artifactId>dbunit</artifactId>
      <version>2.2</version>
      <scope>test</scope>
    </dependency>

 

scop范围分为test/compile/provide/system等，可根据不同的需要添加不同的范围，默认是compile

 

dependency可能会出现“exclusions”标签，该标签是排除依赖项目中依赖其他项目的jar包，比如：acegi-security会依赖spring的1.2版本，但问题是，我项目本身也需要依赖spring，而且版本是2.5.6，于是我必须将acegi中的spring的依赖移除掉，否则执行maven install后会有多个版本的jar在lib，目录下，并且部署以后很可能会导致class not found的错误。

 

在spring-mvc的依赖中你会发现，version中引入了“${spring.version}”，你可能会猜想他是一个变量，是的他的确是，而这个变量的定义则是在“properties”标签中。当然这个变量不仅能在version中引用，在pom的任何地方都可以，并且maven也定义了一些变量供你调用，但是我这边没有用到，因此不详细介绍了。需要的话，下面有maven的中文手册，可以读一下。

 

还有“classifier”标签，在依赖“json-lib”的时候使用到，这个是因为json-lib使用了不同的jdk版本编译同样的代码，产生了不同jdk版本的jar包，其jar的名字形式是：artifactId-version-classifier.jar，如果有兴趣可以自己根据配制找一下json-lib的jar包，看看其真正的名字。

 

另外你可能发现了在dependency-SNAPSHOT的“version”标签的值是1.4.3-SNAPSHOT，但是如果你真的到对应的maven仓库目录会发现其名字并不是dependency-SNAPSHOT－1.4.3-SNAPSHOT.jar，二可能是dependency-SNAPSHOT－1.4.3-20100112.050314-1.jar,其实这个很正常SNAPSHOT就是快照，档项目改动后发布另外一个快照的时候，这种依赖就会同步更新带最新的快照，对于开发阶段，这个很有用。当然如果到了生产环境，最好不要引用SNAPSHOT的版本。

 

依赖就说到这里，下面说一下profile。maven的Profile能让你为一个特殊的环境自定义一个特殊的构建,每个profile对应一个id，执行mvn install -P profileId 就可以调用不同的profile。这里我使用了profle实现了不同环境，不同property配制的管理。从图片中可以看到我将profile文件夹放到了src/main/profile中。包含了production，demo，developerment等等，每个文件夹中都有相同名字的property文件和内容，只是属性值不一样，如：开发环境：pictureServer=http://10.20.20.20/picture/ 而demo环境则是pictureServer=http://218.56.133.99/picture/

上面那样配制profile之后，deploy的时候在，profile里面的build的配制就会叠加覆盖原来的build的配制，这里是配制了两个resource的目录。

实现不同环境的配制还有一种替换变量的方式，但是同事说那种方法不可靠，大家可以试一下，maven中文资料里面就是这种方式，实现的多环境配制。

 

下面说一下如何打webservice的包，这里是通过插件实现的：maven-jar-plugin，并且配制：

<include>**/remote/**</include>

将remote的包包含进来就可以了。也有exclude可以排除某些包。然后配合上maven-source-plugin完成webservice的打包。其中的execution配制使得这个plugin将在jar的生命周期种执行。

 

最后的“maven-jetty-plugin”可以通过mvn jetty:run 的方式让项目跑起来。

 

mvn dependency:sources 这个可以下载依赖的source包

 

如果你向详细了解maven的资料可以察看maven的文档

maven-definitive-guide http://xizhenyin.iteye.com/blog/609409

这里有一些快速的命令和目录的解释说明可以参考：

MAVEN 使用帮助： http://www.iteye.com/topic/207653

最后有点没有介绍就是maven和ant的结合，来完成一些复杂的任务，大家可以参考这个文章：

使用maven ant task实现非标准打包_java开发工具：http://www.bcbbs.net/html/45237.html