转载

从零开始用好Maven：从HelloWorld到日常使用

1. Maven简介

Apache Maven 是一个软件项目管理工具。基于项目对象模型（POM）的理念，通过一段核心描述信息来管理项目构建、报告和文档信息。

Maven 是一个意第绪语（犹太人使用的国际语）单词，意思是知识的累加器。它最开始是被用来简化 Jakarta Turbine 项目的构建过程。在 Jakarta Turbine 项目中有几个不同的项目，虽然它们的Ant构建文件差异很小，但是 jar 包都在 CVS 上。于是想要找到一个标准而又简单的项目构建方法，既可以清晰地定义出这个项目由什么构成并发布项目信息，又能在不同项目间共享Jar包。

现在，任何一个基于Java的项目都能使用Maven来构建和管理，使 Java 开发人员的日常工作变得更轻松，让Java项目更容易被理解。

2. Maven使用

2.1 安装

必备条件：已安装JDK

注意事项：Maven 3.3 及更高版本要求 JDK1.7 或者更高版本

2.2 Windows

下载解压缩

  • 打开下载页面： http://maven.apache.org/download.cgi
  • 选择最新的版本，或者到这里 https://archive.apache.org/dist/maven/maven-3/ 找到你中意的版本
  • 下载 apache-maven-{版本号}-bin.zip
  • 找到合适的目录：最好无空格和中文，解压，内容如下
bin/
boot/
conf/
lib/
README.txt
NOTICE
LICENSE

配置环境变量

  • 计算机 > 属性 > 高级系统设置 > 环境变量 > 系统变量
  • 新建 M2_HOME 变量，内容为 {解压路径}/apache-maven-{版本号}
  • 编辑 Path 变量，在内容结尾加上 ;%M2_HOME%/bin;

2.3 Linux

包管理器安装

$ sudo apt install maven

下载安装

apache-maven-{版本号}-bin.tar.gz
export PATH=/opt/apache-maven-{版本号}/bin:$PATH

2.4 验证

Windows 打开 Cmd，Linux 运行 Shell，看到下面信息表示安装成功。

$ mvn -version
Apache Maven 3.3.9 (bb52d8502b132ec0a5a3f4c09453c07478323dc5; 2015-11-11T00:41:47+08:00)
Maven home: D:/software/java/apache-maven-3.3.9
Java version: 1.8.0_191, vendor: Oracle Corporation
Java home: c:/Program Files/java/jdk1.8.0_191/jre
Default locale: zh_CN, platform encoding: GBK
OS name: "windows 7", version: "6.1", arch: "amd64", family: "dos"

2.5 设置Maven

Maven通过 settings.xml 进行配置

完整的参数说明可查看 http://maven.apache.org/ref/3.6.0/maven-settings/settings.html

2.5.1 自定义仓库位置(可选)

Maven 下载的 jar 包默认存储到 ${user.home}/.m2/repository

编辑 {安装路径}/config/settings.xml ，在下面增加一行填入自定义位置： 

<!-- localRepository
   | The path to the local repository maven will use to store artifacts.
   |
   | Default: ${user.home}/.m2/repository
  <localRepository>/path/to/local/repo</localRepository>
  -->
<localRepository>{自定义位置}/repository</localRepository>

Linux 查看安装路径

$ ls -lsa /usr/share/maven
...
 0 lrwxrwxrwx   1 root root    10 12月 10  2015 conf -> /etc/maven

$ ls -lsa /etc/maven
 4 drwxr-xr-x   2 root root  4096 11月 27 11:45 logging
 4 -rw-r--r--   1 root root   222 11月 19  2015 m2.conf
12 -rw-r--r--   1 root root 10216 11月 19  2015 settings.xml
 4 -rw-r--r--   1 root root  3649 11月 19  2015 toolchains.xml

2.5.2 设置国内镜像(可选)

Maven 默认从中央仓库 central 下载

改为国内镜像速度更快

编辑 {安装路径}/config/settings.xml ，在 <mirrors></mirrors> 标签里加入新的镜像： 

<mirrors>
    <mirror>
      <id>alimaven</id>
      <mirrorOf>central</mirrorOf>
      <name>aliyun maven</name>
      <url>https://maven.aliyun.com/repository/central</url>
    </mirror>
</mirrors>

3. 使用

3.1 快速上手

3.1.1 新建示例项目

命令行不是必须的，但这个过程能有助于理解在 IDE 中的操作。

命令行新建项目

Windows 打开 Cmd，Linux 运行 Shell，执行下面指令。

mvn archetype:generate -DgroupId=org.tyh.mvn.quickstart -DartifactId=mvn-quickstart -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.3 -DinteractiveMode=false

执行成功可以看到下面字样：

[INFO] BUILD SUCCESS

POM.xml 包含了命令中的信息

<groupId>org.tyh.mvn.quickstart</groupId>
<artifactId>mvn-quickstart</artifactId>
<version>1.0-SNAPSHOT</version>
<name>mvn-quickstart</name>

目录结构

quickstart 项目的结构如下：

src/main/java
src/main/webapp
src/test/java
pom.xml

注意：配置文件，如 log4j.properties 需要新建 src/main/resources 目录。这样编译时会打包到生成的 jar 中。 

mvn-quickstart
│  pom.xml
│  
└─src
    ├─main
    │  └─java
    │      └─org
    │          └─tyh
    │              └─mvn
    │                  └─quickstart
    │                          App.java
    │                          
    └─test
        └─java
            └─org
                └─tyh
                    └─mvn
                        └─quickstart
                                AppTest.java

提示：生成目录结构，Windows 在 Cmd 中输入 tree /f ，Linux 安装 tree 程序后可直接输入 tree 。

有关目录结构完整介绍可以查看

http://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html

3.1.2 构建项目

Windows 打开 Cmd，Linux 运行 Shell，执行下面指令。

mvn package

执行成功可以看到下面字样：

[INFO] BUILD SUCCESS

查看生成结果，在项目中新增了 target 目录，里面主要关注以下文件： 

target/classes/org/tyh/mvn/quickstart/App.class
target/test-classes/org/tyh/mvn/quickstart/AppTest.class
target/mvn-quickstart-1.0-SNAPSHOT.jar

mvn-quickstart
│  pom.xml
│ 
└─target
    │  mvn-quickstart-1.0-SNAPSHOT.jar
    │  
    ├─classes
    │  └─org
    │      └─tyh
    │          └─mvn
    │              └─quickstart
    │                      App.class
    │                      
    ├─generated-sources
    │  └─annotations
    ├─generated-test-sources
    │  └─test-annotations
    ├─maven-archiver
    │      pom.properties
    │      
    ├─maven-status
    │  └─maven-compiler-plugin
    │      ├─compile
    │      │  └─default-compile
    │      │          createdFiles.lst
    │      │          inputFiles.lst
    │      │          
    │      └─testCompile
    │          └─default-testCompile
    │                  createdFiles.lst
    │                  inputFiles.lst
    │                  
    ├─surefire-reports
    │      org.tyh.mvn.quickstart.AppTest.txt
    │      TEST-org.tyh.mvn.quickstart.AppTest.xml
    │      
    └─test-classes
        └─org
            └─tyh
                └─mvn
                    └─quickstart
                            AppTest.class

3.1.3 运行

Windows 打开 Cmd，Linux 运行 Shell，执行下面指令。

java -cp target/mvn-quickstart-1.0-SNAPSHOT.jar org.tyh.mvn.quickstart.App
Hello World!

执行测试：

mvn test

执行成功可以看到下面的结果：

[INFO] -------------------------------------------------------
[INFO]  T E S T S
[INFO] -------------------------------------------------------
[INFO] Running org.tyh.mvn.quickstart.AppTest
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.133 s - in org.tyh.mvn.quickstart.AppTest
[INFO]
[INFO] Results:
[INFO]
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

3.2 新增依赖

3.2.1 搜索Maven

为项目添加一个依赖，比如 Apache Commons Lang 和 Slf4j 日志 。

搜索

搜索时可采用高级搜索， g:{groupId} a:{artifactId} 。例如 g:log4j a:log4j 就会列出 log4j 的最新版本。

  • Maven central 仓库： https://search.maven.org/
  • Aliyun 镜像仓库： http://maven.aliyun.com/mvn/search
  • 其他搜索仓库
    • https://repository.apache.org
    • https://mvnrepository.com

注意：类似 slf4j 这样依赖其他实现的包，需要查看官方文档，确认需要配合使用的 jar 包。否则会出 现编译通过，运行报错 的情况。

3.2.2 加入依赖项

<dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
      <scope>test</scope>
    </dependency>

    <!--Slf4j(slf4j-log4j12)-->
    <!--添加后，会同时引入 log4j 和 slf4j-api-->
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-log4j12</artifactId>
      <version>1.8.0-beta2</version>
    </dependency>

    <!--Apache Commons Lang (commons-lang3)-->
    <dependency>
      <groupId>org.apache.commons</groupId>
      <artifactId>commons-lang3</artifactId>
      <version>3.8.1</version>
    </dependency>
</dependencies>

3.2.3 验证

修改 App 类，加入 Log 和 测试代码： 

package org.tyh.mvn.quickstart;

import org.apache.commons.lang3.ArrayUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * ArrayUtils Demo
 *
 */
public class App 
{
    public static void main( String[] args )
    {
        Logger logger = LoggerFactory.getLogger(App.class);

		float[] farr = {1.1f, 1.2f, 1.3f};
		logger.info(ArrayUtils.toString(farr));

		farr = ArrayUtils.removeElements(farr, 1.1f);
		logger.info(ArrayUtils.toString(farr));
    }
}

执行程序之前，要找到依赖的 jar 文件所在的目录。默认是在 {用户主目录}/.m2/ 目录 下，利用 dependency:copy 插件 可以拷贝到 target/dependency 目录： 

mvn dependency:copy-dependencies

查看结果：

├─dependency
│      commons-lang3-3.8.1.jar
│      hamcrest-core-1.3.jar
│      junit-4.11.jar
│      log4j-1.2.17.jar
│      slf4j-api-1.8.0-beta2.jar
│      slf4j-log4j12-1.8.0-beta2.jar

在命令行运行时，用 -cp 加入依赖的 jar 所在目录： 

java -cp .;dependency/*;mvn-quickstart-1.0-SNAPSHOT.jar org.tyh.mvn.quickstart.App

注意：编译前需要加入 log4j.properties 到 src/main/resources 目录。下面是一个 Windows 下的 log4j.properties 。 

# Root logger option
log4j.rootLogger=INFO, file, stdout

# Direct log messages to a log file
log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.File=C://temp//logging.log
log4j.appender.file.MaxFileSize=10MB
log4j.appender.file.MaxBackupIndex=10
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n

# Direct log messages to stdout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n

3.3 IDE中使用

3.3.1 Eclipse

新建项目

  1. 新建 Maven 项目
    • File > New > Project
    • 选择 Maven Project (目录报错及解决办法*)
    • （可选）项目类型 maven-archetype-simple 或其他类型
    • 输入 Group Id, Artifact Id, Name，Finish
  2. 添加依赖 
    pom.xml
  3. 编码
    • 编写 Java 代码，调试
  4. 构建
    • 项目 右键菜单 > Run As > Maven build
    • 第一次运行会提示输入 Maven build 的目标：Goal 里填写 package 进行构建 （支持的常用命令可以在这里找到 Maven in 5 Minutes：Maven Phases ）

导入项目

pom.xml

3.3.2 Idea

  1. 新建 Maven 项目
    • File > New > Project
    • 选择 Maven
    • （可选）项目类型 maven-archetype-simple 或其他类型
    • 输入 Group Id, Artifact Id
    • 输入项目名称，Finish
  2. 添加依赖 
    pom.xml
  3. 编码
    • 编写 Java 代码，调试
  4. 构建 
    pom.xml

4. 常见问题与办法

4.1 如何设置编译支持的 JDK 版本？

全局指定

下面的脚本指定编译版本兼容 JDK 1.7

<project>
  ...
  <properties>
    <maven.compiler.source>1.7</maven.compiler.source>
    <maven.compiler.target>1.7</maven.compiler.target>
  </properties>
  ...
</project>

指定插件

在不改变全局兼容性的情况下，可以在插件中指定。例如，下面的脚本指定了 maven-compiler-plugin 编译的版本兼容 JDK 1.7。

<project>
  ...
  <build>
  ...
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.3</version>
        <configuration>
          <source>1.7</source>
          <target>1.7</target>
        </configuration>
      </plugin>
    </plugins>
  ...
  </build>
  ...
</project>

4.2 如何指定自己的目录结构？

可以通过设置 <build> 节点下 <sourceDirectory> , <resources> 参数指定。

4.3 在 pom 文件中配置了依赖，编译时还会报错。

下载的 jar 文件可能有问题。

mvn clean
mvn package

4.4 [WARNING] File encoding has not been set, using platform encoding UTF-8, i.e. build is platform dependent!

POM 文件中没有指定编译时编码格式，可加入下面属性指定为 UTF-8。

<properties>
	<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

类似的问题：[WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources, i.e. build is platform dependent!

4.5 Invalid project description. … overlaps the workspace …

Eclipse 新建 Maven 项目时，可能会报告此错误。解决办法两种：

  1. 选择 workspace 以外的目录作为项目目录；
  2. 新建 Java Project，然后转为 Maven 项目：右键菜单 Config -> Convert to Maven Project

4.6 Warning:java: 源值1.5已过时, 将在未来所有发行版中删除

Idea 在 Maven Build 时发出警告，在 pom.xml 中加入以下内容： 

<build>
    <sourceDirectory>src</sourceDirectory>
    <plugins>
        <plugin>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.8.0</version>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
            </configuration>
        </plugin>
    </plugins>
</build>

关于作者：唐尤华

从零开始用好Maven：从HelloWorld到日常使用

我喜欢程序员，他们单纯、固执、容易体会到成就感；面对压力，能够挑灯夜战不眠不休；面对困难，能够迎难而上挑战自我。他们也会感到困惑与傍徨，但每个程序员的心中都有一个比尔盖茨或是乔布斯的梦想“用智慧开创属于自己的事业”。我想说的是，其实我是一个程序员。（新浪微博： @唐尤华 ）

查看唐尤华的更多文章 >>

原文  http://www.importnew.com/30864.html
正文到此结束
所属分类： Java 编程技术

热门推荐

相关文章

阿里云首购8折
说给你听

本文目录
随机标签
书籍教程
springboot-demo Java入门教程 bootstrap3 CSS Apache基础教程 php ionic 教程 Python mysql教程 eclipse Ubuntu VPS系统配置 AngularJS 教程 MongoDB教程 Struts2教程 Redis教程 Spring教程 Git教程 Jenkins进阶系列 openfire参考指南 Java设计模式 HBase教程 Maven教程 hibernate教程 Docker 教程 memcached教程 Quartz指南 Hive教程 Ant教程 ANTLR教程 SpringCloud java实例教程 springcloud-demo XStream教程 Hazelcast教程 Elastic-Job-Lite 深入浅出MyBatis SVN教程 ibaties教程 rabittmq教程 solr教程 Hadoop教程 WebService CXF学习 JPA教程 ActiveMQ中文指南 java-demo Java内存模型 dubbo教程 python3-demo Linux入门视频教程
近期评论
  1. 1 Spring Cloud Consul实现选举机制
  2. 2 Spring Boot集成ShedLock实现分布式定时任务
  3. 3 利用oss进行数据库和网站图片备份
  4. 4 Spring Cloud Stream实现数据流处理
  5. 5 Python3访问MySQL数据库快速入门Demo
  6. 6 Github开源项目作者可以免费申请 JetBrains 全家桶
  7. 7 Spring Cloud Vault快速入门Demo
  8. 8 Spring Cloud Gateway快速入门Demo
  9. 9 Spring Cloud Contract快速入门Demo
  10. 10 Spring Cloud Consul快速入门Demo
网站信息
  • 文章总数：82,714 篇
  • 文件总数：284,287 个
  • 标签总数：2,393 个
  • 分类总数：85 个
  • 留言数量：2,560 条
  • 在线人数：628 人
  • 运行天数：4,409天
  • 最后更新：2024年11月22日01点
Loading...

其他链接

关于本站

本站定位：个人技术类博客

本站作用：写博客、记日志、闲聊扯淡鼓捣技术。

问题交流

[HBLOG]公众号 HBLOG HBLOG