Maven是一个强大的软件开发工程管理工具,Java工程师一定都很熟悉。平时工作中几乎天天都在用。但是用得久了就会发现一个问题,对于Maven的很多细节和深层原理并说不清楚,还是一知半解的水平。这主要是因为平时都是在IDE中使用Maven,IDE已经对Maven的各种细节做了高度封装,只需要你会点几下按钮就可以用起来了,根本不需要搞懂那些复杂的细节。
直到有一天,因为种种原因,不能使用IDE了,只能用纯文本编辑器写代码,这个时候不就傻眼了吗?所以本文从一个Hello World说起,开始探索Maven的使用细节,力求达到不依赖任何IDE,也能开始熟练地使用Maven。
1. HelloMaven项目
首先创建一个名为HelloMaven
的目录,这也是我们的Maven工程名称。
目标
目标是通过Hello World项目,把Maven用起来,熟悉Maven的基本生命周期,并生成一个可以用的工程jar包。
Maven的配置
我是在Mac上开发的,Mac上Maven的配置可以详见这一篇文章: Mac配置基本编程开发环境
项目结构
项目目录结构如下:
m2foxdeMacBook-Pro:HelloMaven m2fox$ pwd
/Users/m2fox/hack/tmp/maven/HelloMaven
m2foxdeMacBook-Pro:HelloMaven m2fox$ tree
.
|____pom.xml
|____src
| |____test
| | |____java
| | | |____com
| | | | |____m2fox
| | | | | |____HelloTest.java
| |____main
| | |____java
| | | |____com
| | | | |____m2fox
| | | | | |____Hello.java
-
pom.xml
:maven配置文件 -
src/test
:单元测试代码目录 -
src/main
:代码目录
编写代码
该项目只有3个文件:Hello.java
、HelloTest.java
和pom.xml
,三个文件的内容分别如下:
-
Hello.java
:
package com.m2fox;
public class Hello {
public String hi() {
return "hello, maven world!";
}
}
非常简单,只有一个名为hi
的方法,返回一个字符串。
-
HelloTest.java
:
package com.m2fox;
import org.junit.*;
import org.junit.Assert.*;
public class HelloTest {
@Test
public void hiTest() {
Assert.assertEquals("hello, maven world!", new Hello().hi());
}
}
这个测试类使用了JUnit,对Hello.java
中的hi
方法进行单元测试。
-
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.m2fox</groupId>
<artifactId>HelloMaven</artifactId>
<version>0.0.1-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.10</version>
</dependency>
</dependencies>
</project>
pom.xml
主要由两部分组成,一部分是由groupId
、artifactId
和version
三个标签组成的当前项目的唯一定位坐标,另一部分dependencies
是外部依赖配置,这里只依赖了junit包,版本是4.10。
注:开头的modelVersion
描述这个POM文件是遵从哪个版本的项目描述符,固定写为4.0.0
。
编译、运行、打包
-
编译:完成上述代码后,开始编译上面的代码:切换到
pom.xml
所在的路径,这就是项目的根路径,执行命令:mvn compile
进行编译,如果没有报错,则表明编译成功。这时在项目的根路径会发现多了一个target
目录,里面就是编译生成的class文件。 -
测试:下面我们执行单元测试,看上面写的代码有没有问题:
mvn test
,如果没有报错,则说明单元测试通过。 -
打包:我们把这个项目打成一个jar包,从而可以供其他人使用:
mvn package
,执行完后,会发现在项目根路径下的target
目录中生成了一个名为HelloMaven-0.0.1-SNAPSHOT.jar
的jar包。
2. AnotherProj项目
下面我们建一个新的名为AnotherProj的目录,来开发另一个项目。
目标
我们想尝试在AnotherProj项目中引用HelloMaven-0.0.1-SNAPSHOT.jar
。
项目结构
项目结构如下:
m2foxdeMacBook-Pro:AnotherProj m2fox$ pwd
/Users/m2fox/hack/tmp/maven/AnotherProj
m2foxdeMacBook-Pro:AnotherProj m2fox$ tree
.
|____pom.xml
|____lib
| |____HelloMaven-0.0.1-SNAPSHOT.jar
|____src
| |____test
| | |____java
| | | |____com
| | | | |____another
| | | | | |____BusinessTest.java
| |____main
| | |____java
| | | |____com
| | | | |____another
| | | | | |____Business.java
这里要注意的是,在项目根路径下的lib
目录下放了HelloMaven-0.0.1-SNAPSHOT.jar
这个jar包,代码中要引用到。
代码内容
-
Business.java
:
package com.another;
import com.m2fox.Hello;
public class Business {
public String callHelloMavenHi () {
return "call: " + new Hello().hi();
}
}
这个文件中,导入了com.m2fox.Hello
类,它来自于外部jar包HelloMaven-0.0.1-SNAPSHOT.jar
。
-
BusinessTest.java
:
package com.another;
import org.junit.*;
import org.junit.Assert.*;
public class BusinessTest {
@Test
public void callHelloMavenHiTest() {
Assert.assertEquals("call: hello, maven world!", new Business().callHelloMavenHi());
}
}
-
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.another</groupId>
<artifactId>AnotherProj</artifactId>
<version>0.0.1-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.10</version>
</dependency>
<dependency>
<groupId>com.m2fox</groupId>
<artifactId>HelloMaven</artifactId>
<version>0.0.1-SNAPSHOT</version>
<scope>system</scope>
<systemPath>${project.basedir}/lib/HelloMaven-0.0.1-SNAPSHOT.jar</systemPath>
</dependency>
</dependencies>
</project>
在pom.xml
中引用本地外部jar包的关键是这两行配置:
<scope>system</scope>
<systemPath>${project.basedir}/lib/HelloMaven-0.0.1-SNAPSHOT.jar</systemPath>
其中project.basedir
这个变量的值就是项目的根路径。
编译、测试
执行mvn compile
、mvn test
,可以看到编译没有问题,测试用例通过。
3. Maven基本用法
Maven的全局配置文件位置
一般在这个路径:/usr/local/Cellar/maven/3.6.2/libexec/conf/settings.xml
指定JDK版本号和编码
- 全局指定:在maven的settings.xml文件中加入:
<profile>
<id>jdk-1.8</id>
<activation>
<jdk>1.8</jdk>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<maven.compiler.encoding>UTF-8</maven.compiler.encoding>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
<maven.compiler.compilerVersion>1.8</maven.compiler.compilerVersion>
</properties>
</profile>
- 当前项目指定:在pom.xml文件中加入:
<build>
<plugins>
<!-- 指定jdk -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>1.8</source>
<target>1.8</target>
<encoding>UTF-8</encoding>
</configuration>
</plugin>
</plugins>
</build>
如何运行一个包含有main方法的类?
先用mvn compile
命令编译工程,然后执行:
- 传递命令行参数执行:
mvn exec:java -Dexec.mainClass="com.proj.Main" -Dexec.args="arg0 arg1 arg2"
上面代码执行com.proj.Main
类中的main方法,并传了3个命令行参数。
- 指定运行时class_path运行:
mvn exec:java -Dexec.mainClass="com.proj.Main" -Dexec.classpathScope=runtime
如何在pom.xml中批量指定版本号?
比如有多个包要指定同一个flink的版本号,不想写很多次,怎么办呢?可以这样:
- 先在pom.xml中定义一个表示版本号的属性变量
flink.version
:
<properties>
<flink.version>1.9.2</flink.version>
</properties>
- 然后在依赖中这样引用这个属性变量即可:
<dependencies>
<dependency>
<groupId>org.apache.flink</groupId>
<artifactId>flink-core</artifactId>
<version>${flink.version}</version>
</dependency>
<dependency>
<groupId>org.apache.flink</groupId>
<artifactId>flink-streaming-java_2.12</artifactId>
<version>${flink.version}</version>
<scope>provided</scope>
</dependency>
如何找到一个三方件的maven依赖坐标?
- 如果知道包名,直接去这里搜即可:https://mvnrepository.com
- 如果不知道包名,但知道用到的某一个类的类名,可以先找到这个类所在的项目的Github仓库,然后在仓库内按类名搜索,搜到包名,然后再去https://mvnrepository.com搜索即可。
怎么打包jar包并把所有依赖的三方jar包都打在一起?
- 在pom.xml文件中先加入如下配置:
<build>
<plugins>
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<configuration>
<archive>
<manifest>
<mainClass>com.allen.capturewebdata.Main</mainClass>
</manifest>
</archive>
<descriptorRefs>
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
</configuration>
</plugin>
</plugins>
</build>
- 然后执行命令:
mvn assembly:assembly
- 即可在target目录生成一个名为
xxx-0.0.1-SNAPSHOT-jar-with-dependencies.jar
的jar包,它包含了所有依赖的三方jar包。
4. 总结
本文通过两个非常简单的demo项目,展示了mvn的基本用法,以及在项目中引用本地jar包的方法。此外,还总结了一些Maven其他的基本用法。
网友评论