[Java知识库] 搭建Maven环境及其基本知识

开发: C++知识库 Java知识库 JavaScript Python PHP知识库人工智能区块链大数据移动开发嵌入式开发工具数据结构与算法开发测试游戏开发网络协议系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑笔记本显卡显示器固态硬盘硬盘耳机手机 iphone vivo oppo 小米华为单反装机图拉丁

-> Java知识库 -> 搭建Maven环境及其基本知识 -> 正文阅读

[Java知识库]搭建Maven环境及其基本知识

复制有点问题，请访问 http://coderwcb.gitee.io/javaweb/#/

这里写目录标题

一、传统项目开发存在的问题

一个项目做成一个工程，造成工程比较庞大，需要使用多模块来划分项目；
项目中需要的数量众多的Jar包，需要手动下载并引入，并且多个项目需要的Jar包存在重复的问题；
项目中需要的Jar包有版本兼容的问题，需要手动解决；
项目中需要的War包又依赖其它的War包，需要手动解决。

为了解决上述问题，我们引入Maven（读音['me?v(?)n]或['mevn] ）。

二、Maven简介

Maven是Apache软件基金会组织维护的一款自动化构建（build）工具，专注服务于Java平台的项目构建和依赖管理。Maven这个单词的本意是：专家，内行。

Maven是目前最流行的自动化构建工具，对于生产环境下多框架、多模块整合开发有重要作用， Maven 是一款在大型项目开发过程中不可或缺的重要工具。

Maven的主要功能：

Maven可以整合多个项目之间的引用关系，我们可以根据业务和分层需要任意拆分一个项目；
Maven提供规范的管理各个常用War包及其各个版本，并且可以自动下载和引入项目中；
Maven可以根据指定版本自动解决War包版本兼容问题；
Maven可以把War包所依赖的其它War包自动下载并引入项目。

类似的构建工具还有：Ant、Gradle。

构建，从开始到结束有多个步骤，涉及到多个环节的协同工作。

清理：删除以前的编译结果，为重新编译做好准备；
编译：将Java源程序编译为字节码文件；
测试：针对项目中的关键点进行测试，确保项目在迭代开发过程中关键点的正确性；
报告：在每一次测试后以标准的格式记录和展示测试结果；
打包：将一个包含诸多文件的工程封装为一个压缩文件用于安装或部署。Java工程对应Jar包， Web工程对应war包；
安装：在Maven环境下特指将打包的结果（Jar包或war包）安装到本地仓库中；
部署：将打包的结果部署到远程仓库或将war包部署到服务器上运行。

三、搭建Maven环境

3.1、准备工作

由于Maven本身是基于Java开发的，所以要求必须安装JDK。Maven3.3+需要JDK1.7或以上版本才能运行。

验证JDK是否安装并且能正常运行，在DOS窗口中运行下面的命令：

$ javac -version
$ java -version

3.2、下载Maven

下载地址：https://maven.apache.org/download.cgi

选择apache-maven-3.6.3-bin.zip下载。

3.3、解压安装包

使用解压软件将下载的安装包并放置到一个没有中文和空格的目录下。

目录说明：

bin：存放了Maven中的可执行程序，后续我们会使用这些程序；
boot：含有plexus-classworlds类加载器框架，Maven使用该框架加载自己的类库；
conf：存放了Maven的配置文件，后续我们会对里面的setting.xml进行配置；
lib：含有Maven运行时所需要的Java类库。

3.4、配置环境变量

参考JDK环境变量的配置，这里我们需要进行如下操作：

新建环境变量MAVEN_HOME，值：Maven中bin的上一级目录的全路径；
修改Path环境变量，添加：%MAVEN_HOME%\bin。

3.5、验证

在命令行窗口中运行下面的命令:

$ mvn -version

如果出现了版本相关内容的输出，说明Maven配置成功。

Apache Maven 3.6.3 (cecedd343002696d0abb50b32b541b8a6ba2883f)
Maven home: C:\DevApp\Maven\apache-maven-3.6.3\bin\..
Java version: 1.8.0_261, vendor: Oracle Corporation, runtime: C:\DevApp\Java\jdk1.8.0_261\jre
Default locale: zh_CN, platform encoding: GBK
OS name: "windows 10", version: "10.0", arch: "amd64", family: "windows"

3.6、配置Maven

上面的安装过程并不能满足我们的需求，我们还要对Maven进行配置。以下的配置均在conf目录下的setting.xml文件中进行。

这些都不需要记，用到的时候直接拷贝就可以。

3.6.1、配置本地仓库位置

在生活中，仓库是用来存放东西的，在Maven中，仓库是用来存放Jar包的，配置本地仓库是用来配置Jar包在本地的存放位置。

配置方式：

<localRepository>本地仓库位置，没有中文和空格的目录</localRepository>

案例：

<localRepository>C:/DevApp/Maven/repository</localRepository>

3.6.2、配置远程仓库位置

本地仓库不可能存放所有的Jar包，对于本地没有的Jar包，需要从远程仓库镜像下载。

默认的远程仓库，在国内下载十分缓慢，我们有必要配置一个速度更快的仓库。

在国内，我们一般使用阿里云的镜像，配置如下：

<!-- 阿里云仓库 -->
<mirror>
   <id>alimaven</id>
   <name>aliyun maven</name>
   <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
   <mirrorOf>central</mirrorOf>
</mirror>

3.6.3、配置Maven默认的JDK

Maven默认的JDK是1.5版本的，我们需要将JDK版本修改成1.8版本的，配置如下：

<profiles>
    <profile>
        <id>jdk-1.8</id>
        <activation>
            <activeByDefault>true</activeByDefault>
            <jdk>1.8</jdk>
        </activation>
        
        <properties>
            <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>
</profiles>

<!-- 让增加的 profile生效 -->
<activeProfiles>
    <activeProfile>jdk-1.8</activeProfile>
</activeProfiles>

四、Maven的核心概念

4.1、Maven工程约定目录结构

demo(Maven工程的根目录，目录名可以自定义)
|-- pom.xml(Maven工程的核心配置文件)
|-- src(存放源码的目录)
    |-- main(主程序，简单来说就是我们写的非测试代码)
    |   |-- java(主程序的Java代码)
    |   |-- resources(主程序的配置文件，xml文件，properties文件等)
    |-- test(测试程序)
        |-- java(测试程序的Java代码)
        |-- resources(测试程序的配置文件，xml文件，properties文件等)

下面我们通过案例体会一下Maven的使用（了解就可以，真正用的时候我们还是用IDE），步骤如下：

按照上面的目录结构将所有的文件夹都创建好，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>org.codeaction</groupId>    <artifactId>demo</artifactId>    <version>1.0.0</version>    <properties>        <java.version>1.8</java.version>        <resource.delimiter>@</resource.delimiter>        <maven.compiler.source>${java.version}</maven.compiler.source>        <maven.compiler.target>${java.version}</maven.compiler.target>        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>    </properties></project>

在main/java目录下新建包com.qfedu.demo，并在包下新建文件MyApp.java，代码如下：

package com.qfedu.demo;public class MyApp {    public int add(int a, int b) {        return a + b;    }}

在main/resources目录下创建配置文件conf.properties，里面不需要有内容；
进入pom.xml所在的目录，也就是demo目录，打开dos窗口，执行mvn compile，这个命令目的是编译程序;
执行完成命令后，demo目录下生成了target目录，main/java下的java文件编译后生成的class文件在target/classes目录中，main/resources目录下的配置文件，也出现在了target/classes目录中。

4.2、POM文件

Project Object Model，项目对象模型。Maven把一个项目的结构和内容抽象成一个模型，在xml文件中进行声明，以方便进行构建和描述， pom.xml是Maven的灵魂。所以， Maven环境搭建好之后，所有的学习和操作都是关于pom.xml的。

pom文件中的常用标签：

modelVersion：Maven模型的版本，对于Maven2和Maven3来说，它只能是 4.0.0；
groupId：组织 id，一般是公司域名的倒写；
artifactId：项目名称，也是模块名称，对应 groupId 中项目中的子项目；
version：项目的版本号；
packaging：项目打包的类型，可以使 jar、 war、 rar、 ear、 pom，默认是 Jar；
dependencies和dependency：Maven的一个重要作用就是管理Jar包，为了一个项目可以构建或运行，项目中不可避免的，会依赖很多其他的Jar包，在Maven中，这些Jar就被称为依赖，使用标签dependency来配置。而这种依赖的配置正是通过坐标来定位的，由此我们也不难看出，Maven把所有的Jar包也都视为项目存在了；
properties：定义属性；
build：表示与构建相关的配置；
parent：在Maven中，如果多个模块都需要声明相同的配置，例如： groupId、version、有相同的依赖、或者相同的组件配置等，也有类似Java的继承机制，用parent声明要继承的父工程的 pom 配置；
modules：在Maven的多模块开发中，为了统一构建整个项目的所有模块，可以提供一个额外的模块，该模块打包方式为pom，并且在其中使用modules聚合的其它模块，这样通过本模块就可以一键自动识别模块间的依赖关系来构建所有模块，叫Maven的聚合；
groupId、artifactId、version三个元素生成了一个Maven项目的基本坐标，在众多的Maven项目中可以唯一定位到某一个项目。坐标也决定着将来项目在仓库中的路径及名称。
parent、modules在多模块项目中使用，暂时可以不用了解。

4.3、仓库

4.3.1、仓库是什么

仓库是存放东西的，Maven中的仓库是用来存放Jar包的，Maven的仓库可以存放：

Maven的插件，本质上也是一些Jar，这些Jar可以完成一定的功能；
自己开发的项目的模块，最终也可以打成Jar包放在仓库中；
第三方框架或工具的Jar包，比如：MySQL、Spring的Jar包。

4.3.2、分类

本地仓库，存在于当前电脑上，默认存放在用户目录/.m2/repository，为本机上所有的Maven工程服务，我们也可以通过Maven的配置文件conf/setting.xml修改本地仓库所在的目录，在之前我们已经修改了本地仓库的位置。

远程仓库，不在本机上，通过网路才能使用，多台电脑可以通过网络使用。分类：

中央仓库：通过Internet访问，为全世界所有Maven工程服务；
中央仓库的镜像：架设在不同位置，欧洲，美洲，亚洲等每个洲都有若干的服务器，为中央仓库分担流量。减轻中央仓库的访问，下载的压力。所在洲的用户首先访问的是本洲的镜像服务器；
私服：在局域网环境中部署的服务器，为当前局域网范围内的所有Maven工程服务。公司中常常使用这种方式。

在之前我们已经修改了远程仓库的配置，将远程仓库修改成了阿里云的镜像。

4.3.3、Maven对仓库的使用

首先查找本地仓库—>私服（如果配置了私服）—>镜像仓库—>中央仓库

如果所有的仓库都没有，那么构建失败。

4.4、Maven的生命周期及相关命令

Maven的生命周期就是Maven构建项目的过程，包括：清理，编译，测试，报告，打包，安装，部署。

Maven提供一个项目构建的模型，把编译、测试、打包、部署等都对应成一个个的生命周期阶段，并对每一个阶段提供相应的命令，程序员只需要掌握一小堆命令，就可以完成项目的构建过程。

mvn clean：清理（会删除原来编译和测试的目录，即 target 目录，但是已经 install 到仓库里的包不会删除）；
mvn compile：编译主程序（会在当前目录下生成一个 target，里边存放编译主程序之后生成的字节码文件）；
mvn test-compile：编译测试程序（会在当前目录下生成一个 target，里边存放编译测试程序之后生成的字节码文件）；
mvn test：测试（会生成一个目录surefire-reports，保存测试结果）；
mvn package：打包主程序（会编译、编译测试、测试、并且按照 pom.xml 配置把主程序打包生成 Jar包或者war包）；
mvn install：安装主程序（会把本工程打包，并且按照本工程的坐标保存到本地仓库中）；
mvn deploy：部署主程序（会把本工程打包，按照本工程的坐标保存到本地库中，并且还会保存到私服仓库中。还会自动把项目部署到 web 容器中)。

五、Maven在IDEA中的使用

5.1、Idea关联Maven

在全局设置中进行如下操作：

选择本地Maven版本；
选择本地Maven的配置文件；
选择本地仓储的位置。

5.2、创建普通Maven项目

5.2.1、新建项目

在新建项目界面，选择Maven并选择SDK的版本。

在这里插入图片描述

为项目命名，选择项目存放位置，设置项目的GAV坐标

5.2.2、导入依赖

这里以导入MySQL驱动举例

5.2.2.1、查找依赖

网址：https://mvnrepository.com/

进入网站后，搜索mysql

进入上图中的链接，出现线图所示的界面，该界面罗列了MySQL驱动所有版本

按照上图的示例，选择5.1.47，出现如下图所示界面

5.2.2.2、导入依赖到项目中

将上面查到的MySQL驱动的GAV坐标拷贝到项目的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.qfedu</groupId>    <artifactId>mvntest</artifactId>    <version>1.0.0</version>    <properties>        <maven.compiler.source>8</maven.compiler.source>        <maven.compiler.target>8</maven.compiler.target>    </properties>    <dependencies>        <!-- MySQL驱动坐标 -->        <dependency>            <groupId>mysql</groupId>            <artifactId>mysql-connector-java</artifactId>            <version>5.1.47</version>            <!-- 关于scope后续会讲到 -->            <scope>runtime</scope>        </dependency>    </dependencies></project>

5.2.2.3、同步依赖

引入坐标后，同步依赖，确认导入。

单击pom.xml右上角的图标，同步依赖，Idea2020无法自动同步，只能手动同步依赖。

手动同步依赖之后，右上角的图标消失。

5.2.3、测试

在src/main下新建Java类，运行main方法测试。

package com.qfedu.test;import java.sql.Connection;import java.sql.DriverManager;import java.sql.PreparedStatement;import java.sql.ResultSet;public class MyTest {    public static void main(String[] args) throws Exception {        //四大参数        String driverName = "com.mysql.jdbc.Driver";        String url = "jdbc:mysql://localhost:3306/mydbjdbc?useSSL=false";        String username = "root";        String password = "root";        //SQL语句        String sql = "select * from user";        //加载驱动        Class.forName(driverName);        //获取连接        Connection connection = DriverManager.getConnection(url, username, password);        //获取PreparedStatement        PreparedStatement statement = connection.prepareStatement(sql);        //发送SQL        ResultSet rSet = statement.executeQuery();        //处理结果        while(rSet.next()) {            String u = rSet.getString("username");            String p = rSet.getString("password");            System.out.println(u + ":" + p);        }        //释放资源        rSet.close();        statement.close();        connection.close();    }}

5.3、创建及部署Web项目

创建Maven版本的web项目，可以基于普通Maven项目进行。

5.3.1、修改打包方式

在pom.xml中设置packaging

5.3.2、引入web开发相关依赖

这里需要引入JSP和Servlet依赖

<!-- servlet --><dependency>    <groupId>javax.servlet</groupId>    <artifactId>javax.servlet-api</artifactId>    <version>3.1.0</version>    <scope>provided</scope></dependency><!-- jsp --><dependency>    <groupId>javax.servlet.jsp</groupId>    <artifactId>javax.servlet.jsp-api</artifactId>    <version>2.3.3</version>    <scope>provided</scope></dependency><!-- jstl --><dependency>    <groupId>jstl</groupId>    <artifactId>jstl</artifactId>    <version>1.2</version></dependency>

5.3.3、修改项目结构

此时项目中没有存放web资源及配置文件的目录，按照下图的操作创建web.xml，注意路径的写法（需要补全相关内容）。

创建存放web资源的目录，这里按照图示操作，不需要修改任何内容，最后单击OK就可以了。

完成上述操作，项目src/main目录下会产生webapp目录，这个目录和之前JavaWeb阶段的web目录作用和地位是一样的。这个目录中包括WEB-INF目录，WEB-INF中包括web.xml文件。后续开发过程中的JSP文件都放在这个目录下。

之前我们在这个目录下创建lib目录，用来存放Jar包，由于我们现在创建的是Maven工程，导入Jar包直接在pom.xml中导入就可以了。

5.3.4、编写代码

新建Servlet代码如下

package com.qfedu.servlet;import javax.servlet.*;import javax.servlet.http.*;import javax.servlet.annotation.*;import java.io.IOException;@WebServlet(name = "TestServlet", value = "/TestServlet")public class TestServlet extends HttpServlet {    @Override    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {        response.getWriter().println("<p>Hello World</p>");    }    @Override    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {    }}

5.3.5、部署Web项目

在Tomcat中部署项目，整个过程和JavaWeb阶段中部署项目过程完全相同。

5.3.6、测试

启动Tomcat，访问Servle测试。

六、依赖作用范围

6.1、什么是依赖作用范围

Jar包生效的时间段，即Jar的生命周期

6.2、如何设置

在pom.xml中设置依赖时使用scope设置

<!-- MySQL驱动坐标 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.47</version>
    <scope>runtime</scope>
</dependency>
<!-- servlet -->
<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>3.1.0</version>
    <scope>provided</scope>
</dependency>
<!-- jsp -->
<dependency>
    <groupId>javax.servlet.jsp</groupId>
    <artifactId>javax.servlet.jsp-api</artifactId>
    <version>2.3.3</version>
    <scope>provided</scope>
</dependency>

6.3、依赖作用范围详解

compile ：为默认的依赖有效范围。如果在定义依赖关系的时候，没有明确指定依赖有效范围的话，则默认采用该依赖有效范围。此种依赖，在编译、运行、测试时均有效。

provided ：在编译、测试时有效，但是在运行时无效。provided意味着打包的时候可以不用包进去，别的设施(Web Container)会提供。事实上该依赖理论上可以参与编译，测试，运行等周期。例如：servlet-api，运行项目时，容器已经提供，就不需要Maven重复地引入一遍了。

runtime ：在运行、测试时有效，但是在编译代码时无效。说实话在终端的项目（非开源，企业内部系统）中，和compile区别不是很大。例如：JDBC驱动实现，项目代码编译只需要JDK提供的JDBC接口，只有在测试或运行项目时才需要实现上述接口的具体JDBC驱动。

test ：只在测试时有效，包括测试代码的编译，执行。例如：Junit。

system ：在编译、测试时有效，但是在运行时无效。和provided的区别是，使用system范围的依赖时必须通过systemPath元素显式地指定依赖文件的路径。由于此类依赖不是通过Maven仓库解析的，而且往往与本机系统绑定，可能造成构建的不可移植，因此应该谨慎使用。

七、常见问题

Idea中Maven项目依赖出现红色波浪线。

在这里插入图片描述

原因：网络原因导致下载资源到一半没成功

如何解决：单击Idea Maven窗口上方的刷新按钮

如果还不能解决，可以在Windows下新建如下内容的.bat文件，运行，再单击刷新按钮。

注意REPOSITORY_PATH的值。

set REPOSITORY_PATH=本地仓库的绝对路径
rem 正在搜索...
for /f "delims=" %%i in ('dir /b /s "%REPOSITORY_PATH%\*lastUpdated*"') do (
    del /s /q %%i
)
rem 搜索完毕
pause