本文正在参加「Java主题月 - Java 开发实战」,详情查看
活动链接
我是陈皮,一个在互联网 Coding 的 ITer,微信搜索「
陈皮的JavaLib
」第一时间阅读最新文章,回复【
资料
】,即可获得我精心整理的技术资料,电子书籍,一线大厂面试资料和优秀简历模板。
1 Maven 简介
Maven 是 Apache 组织下的一个纯 Java 开发的开源项目。基于项目对象模型(POM)概念,Maven 是一个项目管理工具,提供对 Java 项目进行构建、打包、部署、依赖管理以及项目信息管理等功能。当然,Maven 也可用于构建和管理其他语言项目,例如 C#,Ruby,Scala 等。
我们平时开发一个项目,做的事情就是搭建项目框架,写代码,单元测试,编译构建,生成文档,打包部署等等工作。其实程序员更应该将精力用在写代码上,而其他比较固定的繁琐步骤不应该我们每次去处理。使用 Maven 就可以将这些步骤进行自动化管理,节省了开发时间,提高开发效率。
Maven 有一个生命周期,当我们运行一些 Maven 命令的时候,Maven 会执行一系列的有序的步骤,例如清除,编译,测试,打包等等,直到到达指定的生命周期。
Maven 官网地址:
maven.apache.org/
2 构建工具
Maven 不是唯一的项目构建,管理工具,下面介绍主要的三个构建工具,推荐使用 Maven 和 Gradle。
Ant:比较早的 Java 构建工具,对工程构建过程控制比较灵活,但是使用的 xml 脚本格式文件比较大,逐渐很少人使用了。
Maven:改善了 Ant 的缺点,可以从网上下载依赖,也是使用 xml 格式配置文件,更加专注依赖管理,目前大多数公司使用。
Gradle:结合 Ant 的灵活和 Maven 生命周期管理的优点,不再使用 xml 格式配置文件,而是使用 DSL 脚本格式,使用 groovy 语言编写,更加灵活,是比较新型的构建工具,目前在一些初创互联网公司使用比较多,以后可能会成为主流。
3 Maven 安装与配置
因为 Maven 是用 Java 开发的,所以首先要安装 JDK,推荐使用 JDK1.8 以上版本。以下是我使用的 JDK 版本。
C:\Users\Administrator>java -version
java version "1.8.0_144"
Java(TM) SE Runtime Environment (build 1.8.0_144-b01)
Java HotSpot(TM) 64-Bit Server VM (build 25.144-b01, mixed mode)
下载 Maven 安装包,可以在官网下载,目前最高版本是 3.8.1:maven.apache.org/download.cg…
其他历史版本下载地址:archive.apache.org/dist/maven/…,目前我使用的是 3.6.3 版本。
下载完后解压到你想解压的目录(最好不要使用中文和空格的目录)
然后在系统环境变量中配置 MAVEN_HOME,值是你解压到的 Maven 目录;再将 bin 目录配置到 path 环境变量中。
MAVEN_HOME:D:\devTools\apache-maven-3.6.3(解压所在目录)
PATH:%MAVEN_HOME%\bin
验证是否安装成功,打开cmd窗口,输入 mvn -v,出现如下信息则安装成功。
C:\Users\Administrator>mvn -v
Apache Maven 3.6.3 (cecedd343002696d0abb50b32b541b8a6ba2883f)
Maven home: D:\devTools\apache-maven-3.6.3\bin\..
Java version: 1.8.0_144, vendor: Oracle Corporation, runtime: C:\Program Files\Java\jdk1.8.0_144\jre
Default locale: zh_CN, platform encoding: GBK
OS name: "windows 10", version: "10.0", arch: "amd64", family: "windows"
修改 Maven 配置(可选),主要是修改资源下载地址,因为默认下载地址是 Google,下载速度会很慢,可以修改国内的例如阿里云的。其次是修改下载资源的存放位置,如果不修改,默认是 c 盘用户目录下的 .m2 路径中。
Maven 配置文件在解压后的 conf 目录下,settings.xml 文件。修改资源下载地址为阿里云,以及修改资源库存放位置。
<localRepository>D:\MavenRepository</localRepository>
<mirror>
<id>alimaven</id>
<name>aliyun maven</name>
<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
<mirrorOf>central</mirrorOf>
</mirror>
4 IDEA,Eclipse 配置 Maven
4.1 IDEA 配置 Maven
IDEA 配置 Maven,有两种方式,一种是针对本项目,只对此项目有效;一种是全局配置,针对所有新项目生效,一般我们会配置全局性的。
针对单项目配置
路径:File | Settings | Build, Execution, Deployment | Build Tools | Maven。
路径:File | Other Settings | Settings for New Projects | Build, Execution, Deployment | Build Tools | Maven。
4.2 Eclipse 配置 Maven
路径:Window | Preferences | Maven | User Settings
5 依赖管理
Maven 其中一个核心特性就是依赖管理。我们开发的项目基本会使用外部依赖,或者我们需要处理多模块项目的模块之间的依赖,这些依赖关系非常复杂,管理起来比较困难。使用 Maven 管理依赖能大大降低难度。
Maven 对于依赖管理一个特点是可传递性依赖发现,比如我们项目依赖于 A,A 又依赖于 B,如果我们手动添加的话,需要将 A 和 B 两个依赖都下载引入项目。而使用 Maven 来构建项目的话,我们只需要显示引入依赖 A,Maven 会通过读取项目文件(pom.xml),找出它们项目之间的依赖关系,将 A 和 B 都引入进来。
Maven 使用坐标管理依赖,坐标包含三个标识信息,通过坐标可以唯一标识一个依赖。任何基于 Maven 构建的项目都必须定义这三个信息,包括我们自己开发的项目。可以在 mvnrepository.com/ 查找依赖。
group:定义当前项目所属组织或公司的唯一标识,一般为组织或者公司名称域名倒写(也可以是域名倒写+项目名),例如 com.alibaba
artifactId:项目的唯一 ID,一般是实际项目名称或者实际项目的一个模块名称(如果项目比较大,会划分多模块,例如 spring-core,spring-bean),例如 fastjson
version:项目的版本号,例如 1.2.76
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.76</version>
</dependency>
Maven 对于依赖管理有以下基本原则:
依赖管理:可传递性依赖发现,Maven 会通过读取项目文件(pom.xml),找出项目之间的依赖关系,然后将需要的所有依赖引入进来。
依赖调节:当一个依赖的不同版本在依赖树里的深度是一样时,第一个被声明的依赖将会被使用。
依赖范围:可以指定依赖的使用范围,即项目在构建过程每个阶段所包含的依赖。
依赖排除:任何可传递的依赖都可以通过 "exclusion" 元素被排除在外。例如,A 依赖 B, B 依赖 C,A 可以标记 C 为 "被排除的"。
依赖可选:任何可传递的依赖可以通过 "optional" 元素 标记为可选的。例如,A 依赖 B, B 依赖 C。B 可以标记 C 为可选的, 这样 A 就可以不再使用 C。
依赖的范围可选项如下:
compile:编译范围,也是默认的依赖范围。使用此范围的依赖,在编译,测试,运行时三种 classpath 都有效。
provided:已提供范围。使用此范围的依赖,在编译,测试 classpath 中有效,在运行时 classpath 无效。例如 servlet-api 依赖,编译和测试需要此依赖,但是在运行时不需要,因为容器已经提供了。
test:测试范围。该范围表明相关依赖只在测试编译阶段和执行阶段。
runtime:运行时范围。在测试和运行时有效,编译期无效。例如 JDBC 驱动实现,在项目编译时只需要 JDK 提供的 JDBC 接口,只有在测试和运行时才真正需要 JDBC 接口的实现类,即 具体的 JDBC 驱动。
system:系统范围。此依赖范围和 provided 一样,但是它必须显示通过 systemPath 指定依赖文件的路径。这种依赖不是由 Maven 中央仓库解析的,一般是本地的某个路径下的依赖。
optional:表明依赖是可选的。
exclusions:用来排除传递性依赖。
这里讲下依赖范围为 system 的情况,项目如何引入外部依赖。首先将下载好的外部依赖,放入到项目已经创建好的文件夹里(例如 libs)。
在项目的 pom.xml 文件中添加依赖
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.75</version>
<scope>system</scope>
<systemPath>${basedir}\libs\fastjson-1.2.75.jar</systemPath>
</dependency>
6 Maven 仓库
基于 Maven 构建的项目,项目需要的依赖首先会在本地仓库中查找,如果没有找到则会从远程仓库下载到本地仓库。如果这两者都没有找到,Maven 就会报错。
远程仓库可以分为中央仓库,其他公共库以及私服。
中央仓库是 Maven 默认的远程仓库。地址:repo.maven.apache.org
其他公共库一般是中央仓库的镜像加速库,因为中央仓库在国外,在国内下载会比较慢,所以有些组织或者公司会创建其他公共库供大家使用,例如阿里云仓库。
私服一般是在局域网内设立的一个私有的仓库服务,供内部开发人员使用。它代理了外部远程仓库,内部用户下载依赖的时候会先到私服上查找,如果没有才从外部远程仓库下载,并缓存在私服。能节省带宽和加快下载速度,并且公司内部的依赖也能放在私服上供公司其他人下载使用。
每个用户在自己电脑上会有个本地仓库,存放所有下载过的依赖包,Windows 环境下,位置一般在用户目录的 .m2/repository 目录下。
7 Maven 项目结构
基于约定大于配置的原则,Maven 制定了一套标准的项目目录结构,规定了哪些文件需要放在哪些目录下,解决了在不同 IDE 开发工具中带来的项目目录结构不一致的问题。
${basedir}:根目录,pom.xml 文件以及项目所有的子目录
${basedir}/src/main/java:项目的 java 源代码
${basedir}/src/main/resources:项目的资源文件,例如 application.yml,xml 文件等
${basedir}/src/test/java:存放项目的 java 测试源代码
${basedir}/src/test/resources:存放项目测试要用的资源文件
${basedir}/target:编译打包输出目录
${basedir}/target/classes:编译输出目录
${basedir}/target/test-classes:测试编译输出目录
8 插件机制
Maven 可以添加插件,插件其实就是一些 jar 文件,执行 Maven 命令时,真正完成功能的就是插件。例如项目使用 Tomcat 服务器,我们可以引入一些 Tomcat 相关的插件。使用 springboot 框架,可以用引入 spring-boot 相关的 maven 插件。
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
9 Maven 命令
Maven 提供了许多命令,来帮助构建,管理项目。不过现在许多 IDE 开发工具提供了将这些命令图形化的功能,只要点击相应的按钮也可执行相应的命令。
Maven 的命令格式:mvn [plugin-name]:[goal-name],即执行 plugin-name 插件的 goal-name 目标。
mvn -version:显示 Maven 版本信息
mvn clean:清理项目编译产生的临时文件,一般是模块下的 target 目录
mvn compile:编译源代码
mvn package:打包项目,一般会在模块下的 target 目录下生成 jar 或者 war 文件
mvn test:执行测试用例
mvn install:打包项目的 jar 或者 war 到本地仓库,供其他模块使用
mvn deploy:打包项目的 jar 或者 war 到远程仓库,供其他人员下载使用
mvn site:生成项目相关信息的网站
mvn eclipse:eclipse:将项目转化为 eclipse 项目
mvn dependency:tree:打印项目的整个依赖树
mvn archetype:generate:创建普通 maven 项目
mvn tomcat7:run:在 tomcat 容器中运行 web 项目
mvn jetty:run:在 jetty 容器中运行 web 项目
Maven 命令可以带参数,例如 mvn package -Dmaven.test.skip=true 会在打包的时候跳过单元测试。
Maven 有以下三个标准的生命周期
clean:清理项目产生的临时文件
default(也叫 build):关于项目构建,打包,部署等的处理
site:项目站点文档创建的处理
执行某个 maven 命令时,会先执行这个命令前的所有命令,例如执行 mvn package 生成可执行 jar,会依次执行 pre-clean,clean,...,test,package等命令。
10 使用 IDEA 创建简单 Maven 项目
首先通过 IDEA 工具创建一个 Maven 项目,选择 JDK,选择 Maven 模板。
项目根目录下有个 pom.xml 文件,一些常用标签介绍如下:
modelVersion:指定当前 pom 模型的版本,对于 maven2 和 maven3 来说,只能填写 4.0.0
groupId:定义项目的所属组或者公司,一般是公司域名的倒写
artifactId:项目在所属组的唯一ID
version:项目版本号
name:项目名称,可选
description:对项目的描述,可选
properties:定义一些属性变量
dependencies:定义项目使用到的依赖
packaging:项目打包的类型,默认是 jar,可选值有 jar,war,rar,ear,ejb,pom等等
build:与构建相关的配置,例如设置编译插件的 JDK 版本
<?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.chenpi</groupId>
<artifactId>maven-demo</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>maven-demo</name>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
<scope>test</scope>
</dependency>
</dependencies>
<build>
</build>
</project>
在剪辑器的右边,有个 Maven 菜单栏,这里有 Maven 相关命令可以直接双击执行,还有插件列表,项目依赖列表。
11 使用 Maven 构建多模块项目
如果一个项目比较大时,会拆分成多个模块进行开发,例如一个项目的 dao,service,controller 层被拆分到不同模块中;Spring 框架中的 spring-core,spring-bean,spring-webmvc 等模块。
基于Maven 构建的项目,一般会定义一个 parent POM 作为一组子 module 的聚合 POM。在 parent POM 中使用 <modules> 标签来定义它的一组子模块。虽然在 parent POM 中不会有什么实际构建产出,但是我们可以在 parent POM 中定义一些共同构建配置,依赖等,并且可以被子模块继承。
首先创建父模块,创建一个不使用模板的 maven 项目。
子模块间依赖处理,因为 maven-controller 模块依赖 maven-service 模块,maven-service 模块依赖 maven-dao 模块。
我们需要在 maven-controller 模块的 pom.xml 文件中依赖 maven-service 模块;
<dependency>
<groupId>com.chenpi</groupId>
<artifactId>maven-service</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
我们需要在 maven-service 模块的 pom.xml 文件中依赖 maven-dao 模块;
<dependency>
<groupId>com.chenpi</groupId>
<artifactId>maven-dao</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
12 pom.xml 文件标签大全详解
pom.xml 文件标签数量比较多,在这引用菜鸟教程的标签解释。
<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.0http://maven.apache.org/maven-v4_0_0.xsd">
<parent>
<artifactId />
<groupId />
<version />
<relativePath />
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>asia.banseon</groupId>
<artifactId>banseon-maven2</artifactId>
<packaging>jar</packaging>
<version>1.0-SNAPSHOT</version>
<name>banseon-maven</name>
<url>http://www.baidu.com/banseon</url>
<description>A maven project to study maven.</description>
<prerequisites>
<maven />
</prerequisites>
<issueManagement>
<system>jira</system>
<url>http://jira.baidu.com/banseon</url>
</issueManagement>
<ciManagement>
<system />
<url />
<notifiers>
<notifier>
<type />
<sendOnError />
<sendOnFailure />
<sendOnSuccess />
<sendOnWarning />
<address />
<configuration />
</notifier>
</notifiers>
</ciManagement>
<inceptionYear />
<mailingLists>
<mailingList>
<name>Demo</name>
<post>banseon@126.com</post>
<subscribe>banseon@126.com</subscribe>
<unsubscribe>banseon@126.com</unsubscribe>
<archive>http:/hi.baidu.com/banseon/demo/dev/</archive>
</mailingList>
</mailingLists>
<developers>
<developer>
<id>HELLO WORLD</id>
<name>banseon</name>
<email>banseon@126.com</email>
<url />
<roles>
<role>Project Manager</role>
<role>Architect</role>
</roles>
<organization>demo</organization>
<organizationUrl>http://hi.baidu.com/banseon</organizationUrl>
<properties>
<dept>No</dept>
</properties>
<timezone>-5</timezone>
</developer>
</developers>
<contributors>
<contributor>
<name />
<email />
<url />
<organization />
<organizationUrl />
<roles />
<timezone />
<properties />
</contributor>
</contributors>
<licenses>
<license>
<name>Apache 2</name>
<url>http://www.baidu.com/banseon/LICENSE-2.0.txt</url>
<distribution>repo</distribution>
<comments>A business-friendly OSS license</comments>
</license>
</licenses>
<connection>
scm:svn:http://svn.baidu.com/banseon/maven/banseon/banseon-maven2-trunk(dao-trunk)
</connection>
<developerConnection>
scm:svn:http://svn.baidu.com/banseon/maven/banseon/dao-trunk
</developerConnection>
<tag />
<url>http://svn.baidu.com/banseon</url>
</scm>
<organization>
<name>demo</name>
<url>http://www.baidu.com/banseon</url>
</organization>
<build>
<sourceDirectory />
<scriptSourceDirectory />
<testSourceDirectory />
<outputDirectory />
<testOutputDirectory />
<extensions
>
<extension>
<groupId />
<artifactId />
<version />
</extension>
</extensions>
<defaultGoal />
<resources>
<resource>
<targetPath />
<filtering />
<directory />
<includes />
<excludes />
</resource>
</resources>
<testResources>
<testResource>
<targetPath />
<filtering />
<directory />
<includes />
<excludes />
</testResource>
</testResources>
<directory />
<finalName />
<filters />
<pluginManagement>
<plugins>
<plugin>
<groupId />
<artifactId />
<version />
<extensions />
<executions>
<execution>
<phase />
<goals />
<inherited />
<configuration />
</execution>
</executions>
<dependencies>
<dependency>
......
</dependency>
</dependencies>
<inherited />
<configuration />
</plugin>
</plugins>
</pluginManagement>
<plugins>
<plugin>
<groupId />
<artifactId />
<version />
<extensions />
<executions>
<execution>
<phase />
<goals />
<inherited />
<configuration />
</execution>
</executions>
<dependencies>
<dependency>
......
</dependency>
</dependencies>
<goals />
<inherited />
<configuration />
</plugin>
</plugins>
</build>
<profiles>
<profile>
<activation>
<activeByDefault />
<jdk />
<name>Windows XP</name>
<family>Windows</family>
<arch>x86</arch>
<version>5.1.2600</version>
<property>
<name>mavenVersion</name>
<value>2.0.3</value>
</property>
<exists>/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/
</exists>
<missing>/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/
</missing>
</file>
</activation>
<build>
<defaultGoal />
<resources>
<resource>
<targetPath />
<filtering />
<directory />
<includes />
<excludes />
</resource>
</resources>
<testResources>
<testResource>
<targetPath />
<filtering />
<directory />
<includes />
<excludes />
</testResource>
</testResources>
<directory />
<finalName />
<filters />
<pluginManagement>
<plugins>
<plugin>
<groupId />
<artifactId />
<version />
<extensions />
<executions>
<execution>
<phase
/>
<goals />
<inherited />
<configuration />
</execution>
</executions>
<dependencies>
<dependency>
......
</dependency>
</dependencies>
<goals />
<inherited />
<configuration />
</plugin>
</plugins>
</pluginManagement>
<plugins>
<plugin>
<groupId />
<artifactId />
<version />
<extensions />
<executions>
<execution>
<phase />
<goals />
<inherited />
<configuration />
</execution>
</executions>
<dependencies>
<dependency>
......
</dependency>
</dependencies>
<goals />
<inherited />
<configuration />
</plugin>
</plugins>
</build>
<modules />
<repositories>
<repository>
<releases>
<enabled />
<updatePolicy />
<checksumPolicy />
</releases>
<snapshots>
<enabled />
<updatePolicy />
<checksumPolicy />
</snapshots>
<name />
<url />
<layout />
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<releases>
<enabled />
<updatePolicy />
<checksumPolicy />
</releases>
<snapshots>
<enabled />
<updatePolicy />
<checksumPolicy />
</snapshots>
<name />
<url />
<layout />
</pluginRepository>
</pluginRepositories>
<dependencies>
<dependency>
......
</dependency>
</dependencies>
<reports />
<reporting>
......
</reporting>
<dependencyManagement>
<dependencies>
<dependency>
......
</dependency>
</dependencies>
</dependencyManagement>
<distributionManagement>
......
</distributionManagement>
<properties />
</profile>
</profiles>
<modules />
<repositories>
<repository>
<releases>
<enabled />
<updatePolicy />
<checksumPolicy />
</releases>
<snapshots>
<enabled />
<updatePolicy />
<checksumPolicy />
</snapshots>
<id>banseon-repository-proxy</id>
<name>banseon-repository-proxy</name>
<url>http://192.168.1.169:9999/repository/</url>
<layout>default</layout>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
......
</pluginRepository>
</pluginRepositories>
<dependencies>
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-artifact</artifactId>
<version>3.8.1</version>
<type>jar</type>
<classifier></classifier>
<scope>test</scope>
<systemPath></systemPath>
<exclusions>
<exclusion>
<artifactId>spring-core</artifactId>
<groupId>org.springframework</groupId>
</exclusion>
</exclusions>
<optional>true</optional>
</dependency>
</dependencies>
<reports></reports>
<reporting>
<excludeDefaults />
<outputDirectory />
<plugins>
<plugin>
<groupId />
<artifactId />
<version />
<inherited />
<configuration />
<reportSets>
<reportSet>
<configuration />
<inherited />
<reports />
</reportSet>
</reportSets>
</plugin>
</plugins>
</reporting>
<dependencyManagement>
<dependencies>
<dependency>
......
</dependency>
</dependencies>
</dependencyManagement>
<distributionManagement>
<repository>
<uniqueVersion />
<id>banseon-maven2</id>
<name>banseon maven2</name>
<url>file://${basedir}/target/deploy</url>
<layout />
</repository>
<snapshotRepository>
<uniqueVersion />
<id>banseon-maven2</id>
<name>Banseon-maven2 Snapshot Repository</name>
<url>scp://svn.baidu.com/banseon:/usr/local/maven-snapshot</url>
<layout />
</snapshotRepository>
<id>banseon-site</id>
<name>business api website</name>
scp://svn.baidu.com/banseon:/var/www/localhost/banseon-web
</url>
</site>
<downloadUrl />
<relocation>
<groupId />
<artifactId />
<version />
<message />
</relocation>
<status />
</distributionManagement>
<properties />
</project>