导读

maven是我们常用的一个项目构建工具,了解它的配置文件对我们来说非常的有必要,这里对maven的项目结构、父子模块的配置、使用本地jar及打包等做一个简单的的说明。

maven项目结构

Project
 |—src
 |—|---main
 |—|---|—java 存放java代码
 |—|---|—resources 存放配置文件
 |—|---|—webapp web应用的目录 WEB-INF、css、js等
 |—|---test 存放测试代码
 |—|---|—java
 |—|---|—resources
 |—pom.xml maven依赖
 |—target target是存放项目构建后的文件和目录,jar包、war包、编译的class文件等,target里的所有内容都是maven构建的时候生成的
小理解

maven的结构其实就是一种约定的规则,为什么我们非要遵守这个规则呢?这是因为maven是一个自动化构建工具,只有遵守约定,maven在自动化构建过程中才能找到对应的文件,才能知道怎么处理对应的不同文件。

java目录里面要放我们的java源文件(.java后缀的文件),构建时,这些文件需要先编译成.class文件,然后放到编译结果对应的目录下。

resources目录里面放其它的资源文件,构建时,这些文件是不需要编译的,直接复制到编译结果对应的目录下。

java目录下也可以放其它的文件,但是构建时,默认是不会放到编译结果里面的,我们可以通过一些配置达到这一目的(下面配置文件的讲解中有对应的配置)。同样的,这些其它文件是不需要编译的,直接复制到编译结果对应的目录下

父子模块Maven

父模块pom
<?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.test</groupId>
    <artifactId>test</artifactId>
    <packaging>pom</packaging>
    <version>1.0</version>
    
    <!--父模块中声明的子模块-->
    
    <modules>
        <module>zuul-server</module>
        <module>eureka-server</module>
    </modules>
    
    <!--相当于自定义属性,在后面可通过${property}来引用-->
    
    <properties>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <spring-boot.version>2.3.1.RELEASE</spring-boot.version>
        <spring-boot.version>2.3.1.RELEASE</spring-boot.version>
        <spring-cloud.version>Hoxton.SR5</spring-cloud.version>
    </properties>
    
<!--父模块中的包依赖管理,这里只是声明,做一些相关配置,在子模块中只需要依赖就可以用到父模块中的配置-->

    <dependencyManagement>
        <dependencies>
        
        <!--在使用spring boot来构建项目时,spring boot项目会有默认的父类,并且只能有一个父亲,在这种情况下自己组建父子模块会有问题,所以在父类中可以通过这种方式将spring boot原来继承父类中的包导入进来,,只能在<dependencyManagement>中使用-->
        
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>

            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>

        </dependencies>
    </dependencyManagement>
    
<!--父模块的依赖,子模块直接可以继承-->

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

    </dependencies>

<!--maven构建相关配置-->

    <build>
        <!--项目打包后的名字-->
        <finalName>${project.artifactId}-${project.version}</finalName>
        <!--类似</dependencyManagement>,只做声明-->
        <pluginManagement>
            <plugins>
                <!--编译插件-->
                <plugin>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <version>3.8.1</version>
                    <!--配置源|目标的编译jdk版本-->
                    <configuration>
                        <source>${java.version}</source>
                        <target>${java.version}</target>
                    </configuration>
                </plugin>
                <!--打包插件-->
                <plugin>
                    <artifactId>maven-jar-plugin</artifactId>
                    <version>3.2.0</version>
                </plugin>
                <!--包依赖相关插件-->
                <plugin>
                    <artifactId>maven-dependency-plugin</artifactId>
                    <version>3.1.2</version>
                    <executions>
                        <!--在打包时复制第三方插件(pom.xml中的依赖)到${project.build.directory}/lib中-->
                        <execution>
                            <id>copy-dependencies</id>
                            <!--哪个阶段执行-->
                            <phase>package</phase>
                            <goals>
                            <!--执行的具体任务-->
                                <goal>copy-dependencies</goal>
                            </goals>
                            <configuration>
                            <!--打的包放到哪个路径-->
                                <outputDirectory>${project.build.directory}/lib</outputDirectory>
                            </configuration>
                        </execution>
                    </executions>
                </plugin>
                <!--junit用到的插件-->
                <plugin>
                    <artifactId>maven-surefire-plugin</artifactId>
                    <version>2.22.2</version>
                    <configuration>
                        <skipTests>true</skipTests>
                    </configuration>
                </plugin>
            </plugins>
        </pluginManagement>
        
<!--对资源文件做自定义配置,如果不配置就按照maven默认的处理方式走,这样有时候我们的一些资源文件不会打入包内-->

        <resources>
            <resource>
                <directory>src/main/java</directory>
                <!--将自定义的一些资源文件打入包-->
                <includes>
                    <include>com/test/**/dao/**Mapper.xml</include>
                </includes>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.*</include>
                </includes>
            </resource>
        </resources>
    </build>

</project>
子模块pom
<?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">
   <!--继承父模块-->
   <parent>
        <artifactId>test</artifactId>
        <groupId>com.test</groupId>
        <version>1.0</version>
    </parent>

    <modelVersion>4.0.0</modelVersion>
<!--子模块基本信息-->
    <groupId>com.son</groupId>
    <artifactId>son</artifactId>
    <version>1.0-SNAPSHOT</version>
    <!--子模块自定义属性-->
    <properties>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>
    <!--子模块依赖-->
    <dependencies>
        <dependency>
            <groupId>io.github.yedaxia</groupId>
            <artifactId>japidocs</artifactId>
            <version>1.4.2</version>
        </dependency>
    </dependencies>
<!--子模块构建插件-->
    <build>
    <!--打包名-->
        <finalName>${project.artifactId}-${project.version}</finalName>
        <plugins>
        <!--定义打jar包的一些基本配置-->
            <plugin>
                <artifactId>maven-jar-plugin</artifactId>
                <configuration>
                    <archive>
                        <!--生成的jar中,不包含pom.xml和pom.properties-->
                        <addMavenDescriptor>false</addMavenDescriptor>
                        <!--这的配置会出现在jar包中的META-INF的MANIFEST.MF文件中,这是一个元数据文件,记录该Jar文件的很多信息-->
                        <manifest>
                            <!--是否要把第三方jar放到manifest的classpath中,简单点说就是打的jar包不包含第三方jar-->
                            <addClasspath>true</addClasspath>
                            <!--生成的manifest中classpath的前缀,要把第三方jar放到lib下,所以classpath的前缀是lib/-->
                            <classpathPrefix>lib/</classpathPrefix>

                            <!--应用的main class,可执行jar包需要指定主类-->
                            <mainClass>com.test.billing.MainApplication</mainClass>
                        </manifest>
                    </archive>

                    <!--过滤掉不希望包含在jar中的文件-->
                    <excludes>
                        <!-- 排除掉application.yml,配置文件外置 -->
                        <exclude>/config/application*.yml</exclude>
                    </excludes>
                </configuration>
            </plugin>
            <!--子模块声明,这些在父模块做过一些配置,子模块可直接使用-->
            <plugin>
                <artifactId>maven-compiler-plugin</artifactId>
            </plugin>
            <plugin>
                <artifactId>maven-surefire-plugin</artifactId>
            </plugin>
            <plugin>
                <artifactId>maven-dependency-plugin</artifactId>
            </plugin>
             <!-- springboot的maven打包插件-->
             <plugin>
		        <groupId>org.springframework.boot</groupId>
		        <artifactId>spring-boot-maven-plugin</artifactId>
		        <configuration>
		         <!-- maven中也有的一个配置项,默认为false,默认情况下Maven使用运行自己的 jdk (maven 是需要依赖 jdk 存在的) 来进行 compiler项目, 如果不想使用这个默认的 jvm,就可以通过 fork 来实现(fork置为true在编译时会新开辟一个JVM来编译指定的项目)。fork 需要消耗更多的资源,以及花费更多的时间进行编译,所以如果开发机器性能不高,也应该尽量避免使用这种方式-->
		        <fork>true</fork>
		        <!-- 配置启动主类-->
		        <!--<mainClass>com.sitech.crmbcc.DisasterRecoveryApplication</mainClass>-->
		        <!--<layout>ZIP</layout>-->
		       </configuration>
		        <executions>
		        <execution>
		        <goals>
		        <goal>repackage</goal>
		       </goals>
		       </execution>
		       </executions>
       		</plugin>
        </plugins>
    </build>
</project>

引入本地jar包

  1. 在项目根目录下新建lib文件夹,放入要引入的jar;
  2. 在pom文件中添加如下信息:
pom需要做的更改
<dependencies>
	<!-- 外部jar -->
		<dependency>
            <groupId>didi</groupId>
            <artifactId>didi</artifactId>
            <version>x.x</version>
            <scope>system</scope>
            <systemPath>${project.basedir}/lib/xxx.jar</systemPath>
        </dependency>
    </dependencies>
    <!-- 构建信息, 供打包时使用 -->
    <build>
        <resources>
            <resource>
                <directory>lib</directory>
                <targetPath>/BOOT-INF/lib/</targetPath>
                <includes>
                    <include>**/*.jar</include>
                </includes>
            </resource>
        </resources>

打包部署运行

war包

1、普通的maven项目一般打war包,然后放在tomcat上运行,默认打包的目录就是webapp,拆开*.war后里面包含:WEB-INF、META-INF以及你在webapp下放的文件。

2、META-INF是项目的原数据信息,一般不需要我们做其他…。

3、WEB-INF下有classes、lib、web.xml。

4、src/main/java、src/main/resources打包后都在web-inf/classes里面。

5、lib里放的都是项目需要的其他jar包。

jar包

SpringBoot项目一般情况下会打jar包,会在target目录下生成一个对应的jar包。对于上边配置了父子模块的配置来说,打出的jar包不包含配置文件,第三方jar会放到target/lib下,当我们运行时,需要拷贝jar、lib 、配置文件到一个目录,然后就能正常运行。