第二章Maven的使用

文章目录

  • Maven核心概念坐标
  • Maven实战创建Java项目
    • 实战命令行创建一个Maven版的初始化Java项目
    • 实战Maven中编写代码
    • 实战执行 Maven 的构建命令
  • Maven核心概念:约定的目录结构
    • 各个目录的作用
    • 约定目录结构的意义
    • 约定大于配置
  • Maven实战创建 Maven 版的 Web 工程
    • 实战命令行创建一个Maven版的Web初始化工程
    • 实战创建 Servlet
    • 实战执行 Maven 的构建命令
      • 配置对 servlet-api.jar 包的依赖
    • 实战将 war 包部署到 Tomcat 上运行
  • 实战让 Web 工程依赖 Java 工程
    • 观念
    • 操作
      • 导入依赖
      • 在 Web 工程中,编写测试代码
    • 执行Maven命令

Maven核心概念坐标

数学中的坐标使用 x、y、z 三个『向量』作为空间的坐标系,可以在『空间』中唯一的定位到一个『』。


<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0modelVersion>
    <parent>
        <groupId>cn.com.yusys.yuspgroupId>
        <artifactId>yusp-plus-learningartifactId>
        <version>0.0.1-SNAPSHOTversion>
    parent>
    <groupId>cn.com.yusys.yusp.learninggroupId>
    <artifactId>learning-testartifactId>
    <version>0.0.1-SNAPSHOTversion>
    <name>learning-cust-groupname>
    <description>测试工程description>
    <properties>
        <java.version>1.8java.version>
    properties>
    <dependencies>
        <dependency>
            <groupId>com.aliyun.ossgroupId>
            <artifactId>aliyun-sdk-ossartifactId>
            <version>3.6.0version>
        dependency>
    dependencies>
project>

Maven 中的坐标使用三个『向量』在『Maven 的仓库』中唯一的定位到一个『jar』包。

  • groupId:公司或组织的 id,即公司或组织域名的倒序,通常也会加上项目名称
    • groupId:cn.com.yusys.yusp
    • groupId:om.aliyun.oss
    • groupId:cn.com.yusys.yusp.learning
  • artifactId:一个项目或者是项目中的一个模块的 id,即模块的名称,将来作为 Maven 工程的工程名
    • artifactId:aliyun-sdk-oss
    • artifactId:learning-test
    • artifactId:yusp-plus-learning
  • version:版本号
    • 例如:RELEASE 表示正式版本
      • V3.1.1.20210120.RELEASE
    • 例如:SNAPSHOT 表示快照版本,正在迭代过程中,不稳定的版本
      • version:0.0.1-SNAPSHOT

提示:坐标和仓库中 jar 包的存储路径之间的对应关系,如下

<groupId>com.aliyun.ossgroupId>
<artifactId>aliyun-sdk-ossartifactId>
<version>3.6.0version>

上面坐标对应的 jar 包在 Maven 本地仓库中的位置:

Maven本地仓库根目录\com\aliyun\oss\aliyun-sdk-oss\3.6.0\aliyun-sdk-oss-3.6.0.jar

Maven实战创建Java项目

实战命令行创建一个Maven版的初始化Java项目

创建目录作为后面操作的工作空间

  • 其实就是一个普通的目录,在这个目录下我们要去写代码、开发应用程序——这里不借助IDEA

  • 例如:D:\maven_workSpace

此时我们已经有了三个目录,分别是:
★Maven 核心程序:中军大帐——D:\mysoftware\maven-3.6.3\apache-maven-3.6.3\bin
★Maven 本地仓库:兵营——D:\maven_repository\repository2020
★本地工作空间:战场——D:\maven_workSpace

在工作空间目录下打开命令行窗口

image-20231021234944127

使用命令生成Maven工程

第二章Maven的使用_第1张图片

运行 mvn archetype:generate 命令

  • 生成我们的maven初始化项目
Choose a number or apply filter (format: [groupId:]artifactId, case sensitive contains): 7:【直接回车,使用默认值】

Define value for property 'groupId': com.atguigu.maven

Define value for property 'artifactId': pro01-maven-java

Define value for property 'version' 1.0-SNAPSHOT: :【直接回车,使用默认值】

Define value for property 'package' com.atguigu.maven: :【直接回车,使用默认值】

Confirm properties configuration: groupId: com.atguigu.maven artifactId: pro01-maven-java version: 1.0-SNAPSHOT package: com.atguigu.maven Y: :【直接回车,表示确认。如果前面有输入错误,想要重新输入,则输入 N 再回车。】
  • package表示Java的代码的基本包路径

调整

Maven 默认生成的工程,对 junit 依赖的是较低的 3.8.1 版本,我们可以改成较适合的 4.12 版本。

自动生成的 App.java 和 AppTest.java 可以删除。



<dependencies>
  
  <dependency>
    
    <groupId>junitgroupId>
    <artifactId>junitartifactId>
    <version>4.12version>
    
    
    <scope>testscope>
  dependency>
dependencies>

自动生成的 pom.xml 解读

  
  <groupId>com.lsc.mavengroupId>
  <artifactId>pro01-maven-javaartifactId>
  <version>1.0-SNAPSHOTversion>
  
  
  
  
  
  <packaging>jarpackaging>

  <name>pro01-maven-javaname>
  <url>http://maven.apache.orgurl>

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

  
  <dependencies>
  
    <dependency>
    
      <groupId>junitgroupId>
      <artifactId>junitartifactId>
      <version>4.12version>
    
      <scope>testscope>
    dependency>
  dependencies>
  • 这里把com.atguigu.maven改成com.lsc.maven

实战Maven中编写代码

主体程序

第二章Maven的使用_第2张图片

主体程序指的是被测试的程序,同时也是将来在项目中真正要使用的程序。

package com.atguigu.maven;
  
public class Calculator {
  
  public int sum(int i, int j){
    return i + j;
  }
  
}

测试程序

第二章Maven的使用_第3张图片

package com.atguigu.maven;
  
import org.junit.Test;
import com.atguigu.maven.Calculator;
  
// 静态导入的效果是将Assert类中的静态资源导入当前类
// 这样一来,在当前类中就可以直接使用Assert类中的静态资源,不需要写类名
import static org.junit.Assert.*;
public class CalculatorTest{
  @Test
  public void testSum(){
    
    // 1.创建Calculator对象
    Calculator calculator = new Calculator();
    
    // 2.调用Calculator对象的方法,获取到程序运行实际的结果
    int actualResult = calculator.sum(5, 3);
    
    // 3.声明一个变量,表示程序运行期待的结果
    int expectedResult = 8;
    
    // 4.使用断言来判断实际结果和期待结果是否一致
    // 如果一致:测试通过,不会抛出异常
    // 如果不一致:抛出异常,测试失败
    assertEquals(expectedResult, actualResult);
    
  }
}

实战执行 Maven 的构建命令

要求

运行 Maven 中和构建操作相关的命令时,必须进入到 pom.xml 所在的目录。如果没有在 pom.xml 所在的目录运行 Maven 的构建命令,那么会看到下面的错误信息:

The goal you specified requires a project to execute but there is no POM in this directory

mvn -v 命令和构建操作无关,只要正确配置了 PATH,在任何目录下执行都可以。而构建相关的命令要在 pom.xml 所在目录下运行——操作哪个工程,就进入这个工程的 pom.xml 目录。

清理操作

mvn clean

效果:删除 target 目录

编译操作

  • 主程序编译:mvn compile

  • 测试程序编译:mvn test-compile

主体程序编译结果存放的目录:target/classes

测试程序编译结果存放的目录:target/test-classes

测试操作

mvn test

测试的报告存放的目录:target/surefire-reports

打包操作

mvn package

打包的结果——jar 包,存放的目录:target

安装操作

mvn install

[INFO] Installing D:\maven-workspace\space201026\pro01-maven-java\target\pro01-maven-java-1.0-SNAPSHOT.jar to D:\maven-rep1026\com\atguigu\maven\pro01-maven-java\1.0-SNAPSHOT\pro01-maven-java-1.0-SNAPSHOT.jar
[INFO] Installing D:\maven-workspace\space201026\pro01-maven-java\pom.xml to D:\maven-rep1026\com\atguigu\maven\pro01-maven-java\1.0-SNAPSHOT\pro01-maven-java-1.0-SNAPSHOT.pom

安装的效果是将本地构建过程中生成的 jar 包存入 Maven 本地仓库。这个 jar 包在 Maven 仓库中的路径是根据它的坐标生成的。

坐标信息如下:

com.lsc.maven
pro01-maven-java
1.0-SNAPSHOT

在 Maven 仓库中生成的路径如下:

D:\maven_repository\repository2020\com\lsc\maven\pro01-maven-java\1.0-SNAPSHOT\pro01-maven-java-1.0-SNAPSHOT.jar

另外,安装操作还会将 pom.xml 文件转换为 XXX.pom 文件一起存入本地仓库。所以我们在 Maven 的本地仓库中想看一个 jar 包原始的 pom.xml 文件时,查看对应 XXX.pom 文件即可,它们是名字发生了改变,本质上是同一个文件。

 D:\maven_workSpace\pro01-maven-java\pom.xml to D:\maven_repository\repository2020\com\lsc\maven\pro01-maven-java\1.0-SNAPSHOT\pro01-maven-java-1.0-SNAPSHOT.pom

Maven核心概念:约定的目录结构

各个目录的作用

第二章Maven的使用_第4张图片

另外还有一个 target 目录专门存放构建操作输出的结果。

约定目录结构的意义

Maven 为了让构建过程能够尽可能自动化完成,所以必须约定目录结构的作用。例如:Maven 执行编译操作,必须先去 Java 源程序目录读取 Java 源代码,然后执行编译,最后把编译结果存放在 target 目录。

约定大于配置

Maven 对于目录结构这个问题,没有采用配置的方式,而是基于约定。这样会让我们在开发过程中非常方便。如果每次创建 Maven 工程后,还需要针对各个目录的位置进行详细的配置,那肯定非常麻烦。

目前开发领域的技术发展趋势就是:约定大于配置,配置大于编码。

Maven实战创建 Maven 版的 Web 工程

说明

使用 mvn archetype:generate 命令生成 Web 工程时,需要使用一个专门的 archetype。这个专门生成 Web 工程骨架的 archetype 可以参照官网看到它的用法:

第二章Maven的使用_第5张图片

参数 archetypeGroupId、archetypeArtifactId、archetypeVersion 用来指定现在使用的 maven-archetype-webapp 的坐标。

实战命令行创建一个Maven版的Web初始化工程

注意:如果在上一个工程的目录下执行 mvn archetype:generate 命令,那么 Maven 会报错:不能在一个非 pom 的工程下再创建其他工程。所以不要再刚才创建的工程里再创建新的工程,请回到工作空间根目录来操作。

然后运行生成工程的命令:

mvn archetype:generate -DarchetypeGroupId=org.apache.maven.archetypes -DarchetypeArtifactId=maven-archetype-webapp -DarchetypeVersion=1.4

下面的操作按照提示执行:

Define value for property 'groupId': com.atguigu.maven 
Define value for property 'artifactId': pro02-maven-web 
Define value for property 'version' 1.0-SNAPSHOT: :【直接回车,使用默认值】
Define value for property 'package' com.atguigu.maven: :【直接回车,使用默认值】
Confirm properties configuration: groupId: com.atguigu.maven artifactId: pro02-maven-web version: 1.0-SNAPSHOT package: com.atguigu.maven Y: :【直接回车,表示确认】

生成的pom.xml

确认打包的方式是war包形式

war

生成的Web工程的目录结构

第二章Maven的使用_第6张图片

  • webapp 目录下有 index.jsp

  • WEB-INF 目录下有 web.xml

实战创建 Servlet

在 main 目录下创建 java 目录

第二章Maven的使用_第7张图片

在 java 目录下创建 Servlet 类所在的包的目录

第二章Maven的使用_第8张图片

在包下创建 Servlet 类

package com.atguigu.maven;
  
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.ServletException;
import java.io.IOException;
  
public class HelloServlet extends HttpServlet{
  
  protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    
    response.getWriter().write("hello maven web");
    
  }
  
}

在 web.xml 中注册 Servlet

  
    helloServlet
    com.atguigu.maven.HelloServlet
  
  
    helloServlet
    /helloServlet
  

在 index.jsp 页面编写超链接



Hello World!

Access Servlet

JSP全称是 Java Server Page,和 Thymeleaf 一样,是服务器端页面渲染技术。这里我们不必关心 JSP 语法细节,编写一个超链接标签即可。

实战执行 Maven 的构建命令

编译

此时直接执行 mvn compile 命令出错:

程序包 javax.servlet.http 不存在

程序包 javax.servlet 不存在

找不到符号

符号: 类 HttpServlet

……

上面的错误信息说明:我们的 Web 工程用到了 HttpServlet 这个类,而 HttpServlet 这个类属于 servlet-api.jar 这个 jar 包。此时我们说,Web 工程需要依赖 servlet-api.jar 包。

第二章Maven的使用_第9张图片

配置对 servlet-api.jar 包的依赖

对于不知道详细信息的依赖可以到https://mvnrepository.com/网站查询。使用关键词搜索,然后在搜索结果列表中选择适合的使用。

第二章Maven的使用_第10张图片

比如,我们找到的 servlet-api 的依赖信息:



    javax.servlet
    javax.servlet-api
    3.1.0
    provided

这样就可以把上面的信息加入 pom.xml。重新执行 mvn compile 命令。

将 Web 工程打包为 war 包

运行 mvn package 命令,生成 war 包的位置如下图所示:

第二章Maven的使用_第11张图片

实战将 war 包部署到 Tomcat 上运行

将 war 包复制到 Tomcat/webapps 目录下

第二章Maven的使用_第12张图片

启动 Tomcat:

第二章Maven的使用_第13张图片

第二章Maven的使用_第14张图片

通过浏览器尝试访问:http://localhost:8080/pro02-maven-web/index.jsp

实战让 Web 工程依赖 Java 工程

观念

明确一个意识:从来只有 Web 工程依赖 Java 工程,没有反过来 Java 工程依赖 Web 工程。本质上来说,Web 工程依赖的 Java 工程其实就是 Web 工程里导入的 jar 包。最终 Java 工程会变成 jar 包,放在 Web 工程的 WEB-INF/lib 目录下。

操作

导入依赖

在 pro02-maven-web 工程的 pom.xml 中,找到 dependencies 标签,在 dependencies 标签中做如下配置:




  com.atguigu.maven
  pro01-maven-java
  1.0-SNAPSHOT

在 Web 工程中,编写测试代码

证明在Web工程中可以使用Java工程中创建的那个类:Calculator

补充创建目录

pro02-maven-web\src\test\java\com\atguigu\maven

可以使用mkdir命令:

mkdir src\test\java\com\atguigu\maven

确认 Web 工程依赖了 junit


   junit
   junit
   4.12
   test

创建测试类

把 Java 工程的 CalculatorTest.java 类复制到 pro02-maven-wb\src\test\java\com\atguigu\maven 目录下

执行Maven命令

测试命令

mvn test

说明:测试操作中会提前自动执行编译操作,测试成功就说明编译也是成功的。

打包命令

mvn package

第二章Maven的使用_第15张图片

通过查看 war 包内的结构,我们看到被 Web 工程依赖的 Java 工程确实是会变成 Web 工程的 WEB-INF/lib 目录下的 jar 包。

第二章Maven的使用_第16张图片

查看当前 Web 工程所依赖的 jar 包的列表

mvn dependency:list

[INFO] The following files have been resolved:
[INFO] org.hamcrest:hamcrest-core:jar:1.3:test
[INFO] javax.servlet:javax.servlet-api:jar:3.1.0:provided
[INFO] com.atguigu.maven:pro01-maven-java:jar:1.0-SNAPSHOT:compile
[INFO] junit:junit:jar:4.12:test

说明:javax.servlet:javax.servlet-api:jar:3.1.0:provided 格式显示的是一个 jar 包的坐标信息。格式是:

groupId:artifactId:打包方式:version:依赖的范围

这样的格式虽然和我们 XML 配置文件中坐标的格式不同,但是本质上还是坐标信息,大家需要能够认识这样的格式,将来从 Maven 命令的日志或错误信息中看到这样格式的信息,就能够识别出来这是坐标。进而根据坐标到Maven 仓库找到对应的jar包,用这样的方式解决我们遇到的报错的情况。

以树形结构查看当前 Web 工程的依赖信息

mvn dependency:tree

[INFO] com.atguigu.maven:pro02-maven-web:war:1.0-SNAPSHOT
[INFO] +- junit:junit:jar:4.12:test
[INFO] | \- org.hamcrest:hamcrest-core:jar:1.3:test
[INFO] +- javax.servlet:javax.servlet-api:jar:3.1.0:provided
[INFO] \- com.atguigu.maven:pro01-maven-java:jar:1.0-SNAPSHOT:compile

我们在 pom.xml 中并没有依赖 hamcrest-core,但是它却被加入了我们依赖的列表。原因是:junit 依赖了hamcrest-core,然后基于依赖的传递性,hamcrest-core 被传递到我们的工程了。

你可能感兴趣的:(Maven学习,maven,python,java)