深入理解微服务Maven父子项目构造以及项目打包部署

Posted 2023-03-30 屿丶斐然

一、问题背景

       随着微服务项目的越来越流行，更多的公司开始使用微服务来搭建自己的业务系统。微服务很好地解耦了业务，每一个服务只提供特定的功能，真正的做到了各司其职，互不干扰，同时微服务间可以互相通信，可以更好的互相协调并完成一条完整的业务逻辑。对于微服务来说，众多的子服意味着需要搭建很多子服务系统，这些子服务系统多而杂，给项目的打包编译以及开发带来了不小的挑战，但maven父子项目的出现很好的解决了这一弊端。

二、概念介绍

2.1 什么是maven父子项目

       顾名思义，maven父子项目是一个有一个父项目，父项目下面又有很多子项目的maven工程，当然，子项目下面还可以添加子项目，从而形成一个树形的结构。那么，这么做有什么好处呢？有以下两点：①依赖传递②打包方便

2.2 父子项目依赖关系

       (1) 所有的子项目依赖从父项目传递下来，子项目的pom文件不必重复添加依赖，直接使用父项目依赖的jar包即可。
举个栗子：父项目A的pom文件中依赖了fastjson2的依赖

<!-- https://mvnrepository.com/artifact/com.alibaba.fastjson2/fastjson2 -->
<dependency>
    <groupId>com.alibaba.fastjson2</groupId>
    <artifactId>fastjson2</artifactId>
    <version>2.0.15</version>
</dependency>

       那么作为子项目B，在其pom中不加fastjson2的依赖就可以直接使用fastjson2中的所有API方法了。当然，也可以不用父项目中的依赖，直接添加fastjson2的任何版本依赖，那么这时代码中使用的就是B项目中的依赖了。
       (2) 为了更好的管理jar包版本，可以在父项目pom文件中使用<dependencyManagement></dependencyManagement>标签将jar包管理起来，同时使用<properties></properties>将版本号管理起来。如下图：


使用dependencyManagement管理起来的jar包不会被父项目依赖，只是起到了一个版本管理的作用，当子项目需要使用依赖的时候需要添加依赖的groupId和artifactId，此时不需要指定version，自动从父类获取版本信息。

2.3 父子项目打包编译

       微服务子模块较多，如果把每一个项目来一遍打包编译不仅繁琐还浪费时间和精力，使用maven父子项目的结构，直接在父项目上运行打包命令，此时子项目会挨个打包编译，只需要等待一会儿，所有子项目的打包编译就完成了，非常方便。

2.3.1 胖包与瘦包

       胖包就是打成的jar包中包含了所有的依赖，而瘦包则是将项目中的源码打进jar包。瘦包没有指定主类，需要在使用时自行指定。胖包的体积往往特别大，少则八百十兆多则能达到2-3G，不仅占存储空间还给运维增加了成本，而瘦包体积小，往往只有几十kb，小巧轻便，运维也方便。

三、实战操作

3.1 创建maven父子工程

这里以idea为开发工具进行演示。

1. 创建一个maven父工程
   
2. 一般情况下，父工程中不需要写代码，故删除src文件
   
3. 创建两个子工程，右键父工程，new→Module
   
   4.至此，我们创建了两个子工程
   
4. 修改父工程pom文件，使用modules标签将子项目引入，同时修改packaging标签为pom
   
5. 子工程pom文件添加parent标签指明父工程，同时修改packaging标签为jar或者war，你会发现，子工程里面没有groupId，因为他们共用父工程的groupId。
   
   到目前为止，我们已经成功的创建出maven父子工程了

3.2 胖瘦包打包

1. 子工程pom引入maven-compiler-plugin 编译插件；
2. 子工程pom引入maven-assembly-plugin插件，可个性化定制打包结构；

    <build>
        <!--jar包的首名称-->
        <finalName>son1</finalName>
        <plugins>
            <plugin>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>2.3.2</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
            <plugin>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>2.4</version>
                <configuration>
                    <descriptorRefs>
                        <descriptorRef>jar-with-dependencies</descriptorRef>
                    </descriptorRefs>
                    <archive>
                        <manifest>
                            <mainClass>com.king.Son1SpringApplication</mainClass><!--这里改成自己的启动位置（主类位置）-->
                        </manifest>
                    </archive>
                </configuration>
                <executions>
                    <execution>
                        <id>make-assembly</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

3. 右键父工程maven package打包，可以看到一共生成了两个jar包，一个带依赖的一个不带依赖的，这就是胖包和瘦包。
   

四、总结

       maven父子工程可以给我们的子系统管理、开发带来便捷，提高我们的开发效率，在以后的工作中希望大家能多使用这种工程结构。好了，本篇博文就写到这里，本人水平有限，如发现错误之处，还请各位大佬多多指正。😊😊😊

SpringBoot + Maven父子模块项目

项目

编辑器Eclipse，使用maven的父子模块功能新建一个项目student，分为3个模块：student-web, student-setting, student-util。其中student-web打包为war包，作为一个项目，student-setting, student-util打包为jar包，作为依赖引入到student-web。并且student-setting模块需要使用student-util提供的工具类

• student-web： 项目启动类和一些配置文件
• student-setting: 增删改查
• student-util: 存放一些工具类，供student-setting等模块使用

1.创建父project

1.1 创建student项目

File -> New -> Maven Project -> maven-archetype-quickstart

 

1.2 修改父亲项目的结构：删除src和target目录，只留下pom.xml文件

删除前

删除后

 

1.3 修改父亲项目的pom.xml文件

• 把打包方式修改为pom: <packaging>pom</packaging>
• 引入SpringBoot相关配置，把项目配置为SpringBoot项目: 添加<parent></parent>
• 把依赖放入： <dependencyManagement></dependencyManagement>

完整的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.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <!-- parent -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.0</version>
        <relativePath /> <!-- lookup parent from repository -->
    </parent>

    <!-- project -->
    <groupId>com.demo.student</groupId>
    <artifactId>student</artifactId>
    <name>student</name>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>pom</packaging>

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

    <!-- dependencyManagement -->
    <dependencyManagement>
        <dependencies>

        </dependencies>
    </dependencyManagement>
</project>

2.创建student-web模块

2.1 创建student-web 模块

File -> New -> Maven Module -> maven-archetype-quickstart

这是整个项目的启动类和配置文件，这里注意web模块的package, 定义最外层的package, 要把启动类放在最外层的package, 因为springboot扫描组件时，会扫描启动类所在的package和它的子package

 

 

2.2 查看 各层级 pom.xml文件 

student-web/pom.xml, 里面定义了<parent></parent>

    <parent>
        <groupId>com.demo.student</groupId>
        <artifactId>student</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>

 student-web 项目创建成功后，可以看到student/pom.xml文件会多了如下配置信息

<modules>
    <module>student-web</module>
</modules>

2.3 配置 各层级 pom.xml文件 

• 配置student-web/pom.xml 文件：添加配置 <packaging>war</packaging>， 把student-web定义为项目启动模块

student-web/pom.xml， 添加

<packaging>war</packaging>

2.4 创建项目启动类

student-web/pom.xml 添加依赖

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

添加启动类

package com.demo.student;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration;
import org.springframework.scheduling.annotation.EnableScheduling;

@EnableScheduling
@SpringBootApplication(exclude = { DataSourceAutoConfiguration.class, DataSourceTransactionManagerAutoConfiguration.class })
public class StudentApplication {

    public static void main(String[] args) {
        SpringApplication.run(StudentApplication.class, args);
    }
}

3.创建student-setting模块

3.1 创建student-setting模块

File -> New -> Maven Module -> maven-archetype-quickstart

 3.2 查看 各层级 pom.xml文件 

• student-setting/pom.xml 有<parent>节点
• student/pom.xml 文件多了<module>

看下student-setting/pom.xml

    <parent>
        <groupId>com.demo.student</groupId>
        <artifactId>student</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>

 student-setting 模块创建成功后，再看下student/pom.xml  。 这里可以手动调整下顺序

<modules>
     <module>student-setting</module>
     <module>student-web</module>
</modules>

3.3 配置 各层级 pom.xml文件 

因为student-setting 打包成jar包，所以把它作为依赖包交给student父亲管理，并且在student-web 项目中引入依赖

• 配置student-setting/pom.xml 文件： 添加配置 <packaging>jar</packaging>， 把student-setting 打包为一个jar包，作为依赖被student父亲项目管理，然后被其它模块引用.
• 在student/pom.xml添加管理依赖
• 在student-web/pom 引入依赖

student-setting/pom.xml : 配置打包方式

<packaging>jar</packaging>

student/pom.xml： 管理依赖

    <properties>
        <student.version>0.0.1-SNAPSHOT</student.version>
    </properties>

    <dependency>
        <groupId>com.demo.student</groupId>
        <artifactId>student-setting</artifactId>
        <version>${student.version}</version>
    </dependency>

student-web/pom.xml： 添加依赖

        <dependency>
            <groupId>com.demo.student</groupId>
            <artifactId>student-setting</artifactId>
        </dependency>

 3.4 测试：

在student-setting/pom.xml添加依赖

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

student-setting项目 添加测试类

package com.demo.student.setting;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api/setting")
public class StudentSettingController {
    @GetMapping("/save")
    public String save() {
        System.out.println("This is student-setting save function");
        return "This is student-setting save function";
    }
}

启动student-web项目，访问http://localhost:8080/api/setting/save 

4.创建student-util模块

4.1 创建student-util 模块

File -> New -> Maven Module -> maven-archetype-quickstart

 

4.2 查看各层级pom.xml

student/pom.xml 多了如下配置

    <modules>
        <module>student-util</module>
        <module>student-setting</module>
        <module>student-web</module>
    </modules>

student-util/pom.xml 有如下<parent>配置

  <parent>
    <groupId>com.demo.student</groupId>
    <artifactId>student</artifactId>
    <version>0.0.1-SNAPSHOT</version>
  </parent>

4.3 修改各层级pom.xml 配置

因为student-utils 需要打包成jar包，所以把它作为依赖包交给student父亲管理，并且在student-web 项目中引入依赖

• 配置student-utils/pom.xml 文件： 添加配置 <packaging>jar</packaging>， 把student-utils 打包为一个jar包，作为依赖被student父亲项目管理，然后被其它模块引用.
• 在student/pom.xml添加管理依赖
• 在student-web/pom 引入依赖

student-util/pom.xml 添加

<packaging>jar</packaging>

 student/pom.xml 添加

            <dependency>
                <groupId>com.demo.student</groupId>
                <artifactId>student-util</artifactId>
                <version>${student.version}</version>
            </dependency>

student-web/pom.xml 添加

        <dependency>
            <groupId>com.demo.student</groupId>
            <artifactId>student-util</artifactId>
        </dependency>

4.4 测试 

student-util 模块 添加一个工具类DateUtil

package com.demo.student.util;

import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;

public class DateUtil {

    public static String yesterday() {
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyyMMdd");
        Calendar calendar = Calendar.getInstance();
        calendar.setTime(new Date());
        calendar.add(Calendar.DAY_OF_YEAR, -1);
        String yesterday = simpleDateFormat.format(calendar.getTime());
        return yesterday;
    }

    public static String today() {
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyyMMdd");
        String yesterday = simpleDateFormat.format(new Date());
        return yesterday;
    }

}

student-setting/pom.xml 添加依赖， 就可以把student-util模块引入到student-setting模块 ，这样在student-setting模块可以使用这个工具类DateUtil，

        <dependency>
            <groupId>com.demo.student</groupId>
            <artifactId>student-util</artifactId>
        </dependency>

修改StudentSettingController

package com.demo.student.setting;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.demo.student.util.DateUtil;

@RestController
@RequestMapping("/api/setting")
public class StudentSettingController {
    @GetMapping("/save")
    public String save() {
        System.out.println("This is student-setting save function");
        String today = DateUtil.today();
        String yesterday = DateUtil.yesterday();
        return "This is student-setting save function today is " + today + " yesterday is " + yesterday;
    }
}

测试

启动student-web项目，访问http://localhost:8080/api/setting/save 

 

5.编译运行 

student/pom.xml 配置plugin

    <build>
        <pluginManagement>
            <plugins>

                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>

student-web/pom.xml 配置plugin

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>

        </plugins>
    </build>

在student/pom.xml同级目录打开cmd，执行命令mvn clean package -Dmaven.test.skip=true，最后的编译过程如下，打好的war包在  student\\student-web\\target\\ 文件夹内

在 student\\student-web\\target\\  cmd 执行 java -jar student-web-0.0.1-SNAPSHOT.war

 访问 http://localhost:8080/api/setting/save