Maven项目管理

文章目录

  • Maven项目管理
    • 项目结构
    • 依赖导入
    • 依赖
      • 依赖作用域
      • 可选依赖
      • 排除依赖
    • 继承关系
    • 常用命令
    • 测试项目
    • 打包项目

Maven项目管理

Maven 翻译为"专家"、“内行”,是 Apache 下的一个纯 Java 开发的开源项目。

基于项目对象模型(缩写:POM)概念,Maven利用一个中央信息片断能管理一个项目的构建、报告和文档等步骤。

Maven 是一个项目管理工具,可以对 Java 项目进行构建、依赖管理。

Maven 也可被用于构建和管理各种项目,例如 C#,Ruby,Scala 和其他语言编写的项目。

通过Maven,可以帮助我们做:

  • 项目的自动构建,包括代码的编译、测试、打包、安装、部署等操作。
  • 依赖管理,项目使用到哪些依赖,可以快速完成导入。

Maven也需要安装环境,IDEA已经自带了Maven环境

项目结构

POM文件是整个Maven项目的配置文件,使用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.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0modelVersion>

    <groupId>org.examplegroupId>
    <artifactId>MavenTestartifactId>
    <version>1.0-SNAPSHOTversion>

    <properties>
        <maven.compiler.source>8maven.compiler.source>
        <maven.compiler.target>8maven.compiler.target>
    properties>

project>

aven的配置文件是以project为根节点,而modelVersion定义了当前模型的版本

groupIdartifactIdversion这三个元素合在一起,用于唯一区别每个项目

  • groupId 一般用于指定组名称,命名规则一般和包名一致,比如我们这里使用的是org.example,一个组下面可以有很多个项目。
  • artifactId 一般用于指定项目在当前组中的唯一名称,也就是说在组中用于区分于其他项目的标记。
  • version 代表项目版本,随着我们项目的开发和改进,版本号也会不断更新(SNAPSHOT代表快照,一般表示这是一个处于开发中的项目)

properties中一般都是一些变量和选项的配置,这里指定了JDK的源代码和编译版本为1.8

依赖导入

创建一个dependencies节点:

<dependencies>
    //里面填写的就是所有的依赖
dependencies>

Maven项目的依赖管理流程:

Maven项目管理_第1张图片

一个项目依赖一般是存储在中央仓库中,也有可能存储在一些其他的远程仓库(私服),几乎所有的依赖都被放到了中央仓库中

远程仓库中下载之后 ,会暂时存储在本地仓库,本地存在一个.m2文件夹,这就是Maven本地仓库文件夹

依赖

依赖作用域

依赖还可以添加以下属性:

  • type:依赖的类型,对于项目坐标定义的packaging。其默认值为jar
  • scope:依赖的范围
  • optional:标记依赖是否可选
  • exclusions:用来排除传递性依赖

scope属性:

  • compile :为默认的依赖有效范围。此种依赖,在编译、运行、测试时均有效。

  • provided :在编译、测试时有效,但是在运行时无效,也就是说,项目在运行时,不需要此依赖

    比如Lombok,只需要在编译阶段使用它,编译完成后,实际上已经转换为对应的代码了,因此Lombok不需要在项目运行时也存在。

  • runtime :在运行、测试时有效,但是在编译代码时无效。

    如果需要自己写一个JDBC实现,那么肯定要用到JDK为我们指定的接口,但是实际上在运行时是不用自带JDK的依赖,因此只保留我们自己写的内容即可。

  • test :只在测试时有效

    例如:JUnit只会在测试阶段使用JUnit,而实际项目运行时就用不到测试了

  • system:作用域和provided是一样的,但是它不是从远程仓库获取,而是直接导入本地Jar包

<dependency>
     <groupId>javax.jntmgroupId>
     <artifactId>lbwnbartifactId>
     <version>2.0version>
     <scope>systemscope>
     <systemPath>C://学习资料/4K高清无码/test.jarsystemPath>
dependency>

Maven还提供了一个resource文件夹,可以将一些静态资源,比如配置文件,放入到这个文件夹中,项目在打包时会将资源文件夹中文件一起打包的Jar中,比如Mybatis的配置文件

可选依赖

给依赖添加optional标签表示此依赖是可选的,默认在导入依赖时,不会导入可选的依赖:

<optional>trueoptional>

可选依赖可以让使用此项目作为依赖的项目默认不使用可选依赖

排除依赖

对于那种不是可选依赖,导入此项目不希望使用此依赖该,可以通过排除依赖来防止添加不必要的依赖:

<dependency>
    <groupId>org.junit.jupitergroupId>
    <artifactId>junit-jupiterartifactId>
    <version>5.8.1version>
    <scope>testscope>
    <exclusions>
        <exclusion>
            <groupId>org.junit.jupitergroupId>
            <artifactId>junit-jupiter-engineartifactId>
        exclusion>
    exclusions>
dependency>

继承关系

一个Maven项目可以继承自另一个Maven项目,比如多个子项目都需要父项目的依赖,我们就可以使用继承关系来快速配置。

新建一个模块,来创建一个子项目:


<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">
    <parent>
        <artifactId>MavenTestartifactId>
        <groupId>org.examplegroupId>
        <version>1.0-SNAPSHOTversion>
    parent>
    <modelVersion>4.0.0modelVersion>

    <artifactId>ChildModelartifactId>

    <properties>
        <maven.compiler.source>8maven.compiler.source>
        <maven.compiler.target>8maven.compiler.target>
    properties>

project>

IDEA默认给我们添加了一个parent节点,表示此Maven项目是父Maven项目的子项目,子项目直接继承父项目的groupId,子项目会直接继承父项目的所有依赖,除非依赖添加了optional标签

还可以让父Maven项目统一管理所有的依赖,包括版本号等,子项目可以选取需要的作为依赖,而版本全由父项目管理

dependencies全部放入dependencyManagement节点,这样父项目就完全作为依赖统一管理:

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.projectlombokgroupId>
            <artifactId>lombokartifactId>
            <version>1.18.22version>
            <scope>providedscope>
        dependency>
        <dependency>
            <groupId>org.junit.jupitergroupId>
            <artifactId>junit-jupiterartifactId>
            <version>5.8.1version>
            <scope>testscope>
        dependency>
        <dependency>
            <groupId>mysqlgroupId>
            <artifactId>mysql-connector-javaartifactId>
            <version>8.0.27version>
        dependency>
        <dependency>
            <groupId>org.mybatisgroupId>
            <artifactId>mybatisartifactId>
            <version>3.5.7version>
        dependency>
    dependencies>
dependencyManagement>

子项目需要什么再拿什么即可,同时子项目无需指定版本,所有的版本全部由父项目决定:

<dependencies>
    <dependency>
        <groupId>org.projectlombokgroupId>
        <artifactId>lombokartifactId>
        <scope>providedscope>
    dependency>
dependencies>

父项目如果还存在dependencies节点的话,里面的内依赖依然是直接继承

常用命令

Maven板块中,每个Maven项目都有一个生命周期,实际上这些是Maven的一些插件,每个插件都有各自的功能:

  • clean命令,执行后会清理整个target文件夹,在之后编写Springboot项目时可以解决一些缓存没更新的问题

  • validate命令可以验证项目的可用性

  • compile命令可以将项目编译为.class文件

  • install命令可以将当前项目安装到本地仓库,以供其他项目导入作为依赖使用

  • verify命令可以按顺序执行每个默认生命周期阶段(validatecompilepackage等)

  • test命令,可以一键测试所有位于test目录下的测试案例

  • deploy命令用于发布项目到本地仓库和远程仓库

  • site命令用于生成当前项目的发布站点

测试项目

使用test命令的要求:

  • 测试类的名称必须是以Test结尾,比如MainTest
  • 测试方法上必须标注@Test注解

由于JUnit5比较新,需要重新配置插件升级到高版本,才能完美的兼容Junit5:

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.pluginsgroupId>
            <artifactId>maven-surefire-pluginartifactId>
            
            <version>2.22.0version>
        plugin>
    plugins>
build>

常见测试注解:

注:在JUnit5中@Before被废弃

  • @BeforeAll:一次性开启所有测试案例只会执行一次 (方法必须是static)
  • @BeforeEach:一次性开启所有测试案例每个案例开始之前都会执行一次
  • @DisplayName:自定义测试名称
  • @RepeatedTest:自动执行多次测试

打包项目

项目在编写完成之后,要么作为Jar依赖,供其他模型使用,要么就作为一个可以执行的程序,在控制台运行。

直接执行package命令就可以直接对项目的代码进行打包,生成jar文件。

如果需要打包一个可执行文件,那么不仅需要将自己编写的类打包到Jar中,同时还需要将依赖也一并打包到Jar中。

使用另一个插件来实现一起打包:

<plugin>
    <artifactId>maven-assembly-pluginartifactId>
    <version>3.1.0version>
    <configuration>
        <descriptorRefs>
            <descriptorRef>jar-with-dependenciesdescriptorRef>
        descriptorRefs>
        <archive>
            <manifest>
                <addClasspath>trueaddClasspath>
                <mainClass>com.test.MainmainClass>
            manifest>
        archive>
    configuration>
    <executions>
        <execution>
            <id>make-assemblyid>
            <phase>packagephase>
            <goals>
                <goal>singlegoal>
            goals>
        execution>
    executions>
plugin>

在打包之前也会执行一次test命令,来保证项目能够正常运行,当测试出现问题时,打包将无法完成

也可以手动跳过,选择执行Maven目标来手动执行Maven命令,输入mvn package -Dmaven.test.skip=true来以跳过测试的方式进行打包。

最后得到Jar文件,在同级目录下输入java -jar xxxx.jar来运行我们打包好的Jar可执行程序

多模块下父项目存在一个packing打包类型标签,所有的父级项目的packing都为pom,packing默认是jar类型,如果不作配置,maven会将该项目打成jar包。

作为父级项目,通过modules标签将项目的所有子项目引用进来,在build父级项目时,会根据子模块的相互依赖关系整理一个build顺序,然后依次build。

执行Maven命令,输入mvn package -Dmaven.test.skip=true来以跳过测试的方式进行打包。

最后得到Jar文件,在同级目录下输入java -jar xxxx.jar来运行我们打包好的Jar可执行程序

多模块下父项目存在一个packing打包类型标签,所有的父级项目的packing都为pom,packing默认是jar类型,如果不作配置,maven会将该项目打成jar包。

作为父级项目,通过modules标签将项目的所有子项目引用进来,在build父级项目时,会根据子模块的相互依赖关系整理一个build顺序,然后依次build。

你可能感兴趣的:(JavaWeb,maven,java)