当前位置 博文首页 > 小黄鸡的博客:springboot高级功能(十一)聚合工程讲解与部署

    小黄鸡的博客:springboot高级功能(十一)聚合工程讲解与部署

    作者:[db:作者] 时间:2021-08-15 19:26

    5分钟带你玩转springboot()聚合工程讲解与部署创建

    聚合工程优势

    • 组件化管理通用功能,动态的添加功能。

    • 统一管理jar包的版本号

    • 提高复用性

    创建聚合工程

    1.首先创建一个springboot项目 然后删除src文件夹?

    2.创建子工程

    选择spring boot项目 然后继续 创建项目。如果是工具,配置,组件化的项目(不需要启动)可以继续删除启动类和resources文件夹

    3.修改父工程和子工程pom文件

    然后聚合工程就搭建好了 这里最重点是pom文件的配置和标签 下文就开始介绍

    父工程pom详解

    ps:这里以若依开源项目为例 结构如下 我们主要讲解红框里面的配置 父工程包括ruoyi-auth,ruoyi-gateway,ruoyi-visual,ruoyi-modules,ruoyi-api,ruoyi-common子项目

    父工程包括了

    <?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.ruoyi</groupId>
        <artifactId>ruoyi</artifactId>
        <version>2.5.0</version>
    
        <name>ruoyi</name>
        <url>http://www.ruoyi.vip</url>
        <description>若依微服务系统</description>
    
        <properties>
            <ruoyi.version>2.5.0</ruoyi.version>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <java.version>1.8</java.version>
            <spring-boot.version>2.3.7.RELEASE</spring-boot.version>
            <spring-cloud.version>Hoxton.SR9</spring-cloud.version>
            <spring-cloud-alibaba.version>2.2.5.RELEASE</spring-cloud-alibaba.version>
    		<spring-boot-admin.version>2.3.1</spring-boot-admin.version>
            <spring-boot.mybatis>2.1.4</spring-boot.mybatis>
            <swagger.fox.version>2.9.2</swagger.fox.version>
            <swagger.core.version>1.5.24</swagger.core.version>
            <tobato.version>1.26.5</tobato.version>
            <kaptcha.version>2.3.2</kaptcha.version>
            <pagehelper.boot.version>1.3.0</pagehelper.boot.version>
            <druid.version>1.2.4</druid.version>
            <dynamic-ds.version>3.2.1</dynamic-ds.version>
            <commons.io.version>2.5</commons.io.version>
            <commons.fileupload.version>1.3.3</commons.fileupload.version>
            <velocity.version>1.7</velocity.version>
            <fastjson.version>1.2.75</fastjson.version>
            <minio.version>8.0.3</minio.version>
    		<poi.version>4.1.2</poi.version>
            <common-pool.version>2.6.2</common-pool.version>
        </properties>
    
        <!-- 依赖声明 -->
        <dependencyManagement>
            <dependencies>
    
                <!-- SpringCloud 微服务 -->
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>${spring-cloud.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
    
    			<!-- SpringCloud Alibaba 微服务 -->
                <dependency>
                    <groupId>com.alibaba.cloud</groupId>
                    <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                    <version>${spring-cloud-alibaba.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
    
                <!-- SpringBoot 依赖配置 -->
                <dependency>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-dependencies</artifactId>
                    <version>${spring-boot.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
    			
                <!--  SpringBoot 监控客户端 -->
                <dependency>
                    <groupId>de.codecentric</groupId>
                    <artifactId>spring-boot-admin-starter-client</artifactId>
                    <version>${spring-boot-admin.version}</version>
                </dependency>
    			
                <!-- FastDFS 分布式文件系统 -->
                <dependency>
                    <groupId>com.github.tobato</groupId>
                    <artifactId>fastdfs-client</artifactId>
                    <version>${tobato.version}</version>
                </dependency>
    			
                <!-- Mybatis 依赖配置 -->
                <dependency>
                    <groupId>org.mybatis.spring.boot</groupId>
                    <artifactId>mybatis-spring-boot-starter</artifactId>
                    <version>${spring-boot.mybatis}</version>
                </dependency>
    			
                <!-- Swagger 依赖配置 -->
                <dependency>
                    <groupId>io.swagger</groupId>
                    <artifactId>swagger-models</artifactId>
                    <version>${swagger.core.version}</version>
                </dependency>
                <dependency>
                    <groupId>io.swagger</groupId>
                    <artifactId>swagger-annotations</artifactId>
                    <version>${swagger.core.version}</version>
                </dependency>
    
                <!-- 验证码 -->
                <dependency>
                    <groupId>com.github.penggle</groupId>
                    <artifactId>kaptcha</artifactId>
                    <version>${kaptcha.version}</version>
                </dependency>
    
                <!-- pagehelper 分页插件 -->
                <dependency>
                    <groupId>com.github.pagehelper</groupId>
                    <artifactId>pagehelper-spring-boot-starter</artifactId>
                    <version>${pagehelper.boot.version}</version>
                </dependency>
    
                <!-- io常用工具类 -->
                <dependency>
                    <groupId>commons-io</groupId>
                    <artifactId>commons-io</artifactId>
                    <version>${commons.io.version}</version>
                </dependency>
    
                <!-- excel工具 -->
                <dependency>
                    <groupId>org.apache.poi</groupId>
                    <artifactId>poi-ooxml</artifactId>
                    <version>${poi.version}</version>
                </dependency>
    
                <!-- 文件上传工具类 -->
                <dependency>
                    <groupId>commons-fileupload</groupId>
                    <artifactId>commons-fileupload</artifactId>
                    <version>${commons.fileupload.version}</version>
                </dependency>
    
                <!-- 代码生成使用模板 -->
                <dependency>
                    <groupId>org.apache.velocity</groupId>
                    <artifactId>velocity</artifactId>
                    <version>${velocity.version}</version>
                    <exclusions>
                        <exclusion>
                            <groupId>commons-collections</groupId>
                            <artifactId>commons-collections</artifactId>
                        </exclusion>
                    </exclusions>
                </dependency>
    
                <!-- JSON 解析器和生成器 -->
                <dependency>
                    <groupId>com.alibaba</groupId>
                    <artifactId>fastjson</artifactId>
                    <version>${fastjson.version}</version>
                </dependency>
                
                <!-- 公共资源池 -->
                <dependency>
                    <groupId>org.apache.commons</groupId>
                    <artifactId>commons-pool2</artifactId>
                    <version>${common-pool.version}</version>
                </dependency>
    
                <!-- 核心模块 -->
    	        <dependency>
                    <groupId>com.ruoyi</groupId>
                    <artifactId>ruoyi-common-core</artifactId>
                    <version>${ruoyi.version}</version>
                </dependency>
    			
                <!-- 接口模块 -->
                <dependency>
                    <groupId>com.ruoyi</groupId>
                    <artifactId>ruoyi-common-swagger</artifactId>
                    <version>${ruoyi.version}</version>
                </dependency>
    	        
                <!-- 安全模块 -->
                <dependency>
                    <groupId>com.ruoyi</groupId>
                    <artifactId>ruoyi-common-security</artifactId>
                    <version>${ruoyi.version}</version>
                </dependency>
    	        
                <!-- 权限范围 -->
                <dependency>
                    <groupId>com.ruoyi</groupId>
                    <artifactId>ruoyi-common-datascope</artifactId>
                    <version>${ruoyi.version}</version>
                </dependency>
                
                <!-- 多数据源 -->
                <dependency>
                    <groupId>com.ruoyi</groupId>
                    <artifactId>ruoyi-common-datasource</artifactId>
                    <version>${ruoyi.version}</version>
                </dependency>
    			
                <!-- 日志记录 -->
                <dependency>
                    <groupId>com.ruoyi</groupId>
                    <artifactId>ruoyi-common-log</artifactId>
                    <version>${ruoyi.version}</version>
                </dependency>
    			
                <!-- 缓存服务 -->
                <dependency>
                    <groupId>com.ruoyi</groupId>
                    <artifactId>ruoyi-common-redis</artifactId>
                    <version>${ruoyi.version}</version>
                </dependency>
    			
                <!-- 系统接口 -->
                <dependency>
                    <groupId>com.ruoyi</groupId>
                    <artifactId>ruoyi-api-system</artifactId>
                    <version>${ruoyi.version}</version>
                </dependency>
    			
            </dependencies>
        </dependencyManagement>
    
        <modules>
    		<module>ruoyi-auth</module>
    		<module>ruoyi-gateway</module>
    		<module>ruoyi-visual</module>
    		<module>ruoyi-modules</module>
    		<module>ruoyi-api</module>
    		<module>ruoyi-common</module>
        </modules>
        <packaging>pom</packaging>
    
        <dependencies>
            <!-- swagger -->
            <dependency>
                <groupId>io.swagger</groupId>
                <artifactId>swagger-annotations</artifactId>
                <version>1.5.10</version>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <configuration>
                        <source>${java.version}</source>
                        <target>${java.version}</target>
                        <encoding>${project.build.sourceEncoding}</encoding>
                    </configuration>
                </plugin>
            </plugins>
        </build>
    
    </project>

    <name><url><description>都是非必须 字面意思

    <groupId>:域 例如com

    <artifactId>:公司名??groupid和artifactId被统称为“坐标”是为了保证项目唯一性而提出的

    <version>:项目的版本号

    <properties>:属性的占位符 如java中的常量

    <dependencyManagement>:在我们项目顶层的POM文件中,我们会看到dependencyManagement元素。通过它元素来管理jar包的版本,让子项目中引用一个依赖而不用显示的列出版本号。Maven会沿着父子层次向上走,直到找到一个拥有dependencyManagement元素的项目,然后它就会使用在这个dependencyManagement元素中指定的版本号。

    白话说 如果父工程有<dependencyManagement> 且groupId和artifactId相同 那么子工程不需要指定版本号 直接使用父工程版本号

    例如 当子工程有?groupId为org.springframework.cloud时 引用当前父工程指定版本

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

    <modules>:指当前父工程包含的子工程 如果这里不引入 那么 刷新父工程pom时 子工程不会下载jar包

    ?<build>:打包配置

    <packaging>pom</packaging>在聚合工程中 一定要配置 指的是在引入其他工程时 直接引入代码,否则就会打成jar包 这样就会报错了

    ruoyi-modules子工程配置

    <?xml version="1.0" encoding="UTF-8"?>
    <project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <parent>
            <groupId>com.ruoyi</groupId>
            <artifactId>ruoyi</artifactId>
            <version>2.5.0</version>
        </parent>
        <modelVersion>4.0.0</modelVersion>
    
        <modules>
            <module>ruoyi-system</module>
            <module>ruoyi-gen</module>
            <module>ruoyi-job</module>
            <module>ruoyi-file</module>
        </modules>
    
        <artifactId>ruoyi-modules</artifactId>
        <packaging>pom</packaging>
    
        <description>
            ruoyi-modules业务模块
        </description>
    
    </project>
    

    这里主要配置是

    <parent>:内容就是父工程的<groupId><artifactId><version>

    <modules>:指该工程包含ruoyi-system,ruoyi-gen,ruoyi-job,ruoyi-file子工程

    ruoyi-system子项目配置

    <?xml version="1.0" encoding="UTF-8"?>
    <project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xmlns="http://maven.apache.org/POM/4.0.0"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <parent>
            <groupId>com.ruoyi</groupId>
            <artifactId>ruoyi-modules</artifactId>
            <version>2.5.0</version>
        </parent>
        <modelVersion>4.0.0</modelVersion>
    	
        <artifactId>ruoyi-modules-system</artifactId>
    
        <description>
            ruoyi-modules-system系统模块
        </description>
    	
        <dependencies>
        	
        	<!-- SpringCloud Alibaba Nacos -->
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            </dependency>
            
            <!-- SpringCloud Alibaba Nacos Config -->
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
            </dependency>
            
        	<!-- SpringCloud Alibaba Sentinel -->
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
            </dependency>
            
        	<!-- SpringBoot Actuator -->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-actuator</artifactId>
            </dependency>
    		
            <!-- Swagger UI -->
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>${swagger.fox.version}</version>
            </dependency>
    		
            <!-- Mysql Connector -->
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
            </dependency>
            
            <!-- RuoYi Common DataSource -->
            <dependency>
                <groupId>com.ruoyi</groupId>
                <artifactId>ruoyi-common-datasource</artifactId>
            </dependency>
            
            <!-- RuoYi Common DataScope -->
            <dependency>
                <groupId>com.ruoyi</groupId>
                <artifactId>ruoyi-common-datascope</artifactId>
            </dependency>
            
            <!-- RuoYi Common Log -->
            <dependency>
                <groupId>com.ruoyi</groupId>
                <artifactId>ruoyi-common-log</artifactId>
            </dependency>
            
            <!-- RuoYi Common Swagger -->
            <dependency>
                <groupId>com.ruoyi</groupId>
                <artifactId>ruoyi-common-swagger</artifactId>
            </dependency>
    
        </dependencies>
    
        <build>
            <finalName>${project.artifactId}</finalName>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <executions>
                        <execution>
                            <goals>
                                <goal>repackage</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
            </plugins>
        </build>
       
    </project>

    <parent>:配置父工程ruoyi-modules的<groupId><artifactId><version>

    <dependencies>:本项目的依赖

    如果想引入其他工程,只需要加入:

            <!-- RuoYi Common DataScope -->
            <dependency>
                <groupId>com.ruoyi</groupId>
                <artifactId>ruoyi-common-datascope</artifactId>
            </dependency>
            
            <!-- RuoYi Common Log -->
            <dependency>
                <groupId>com.ruoyi</groupId>
                <artifactId>ruoyi-common-log</artifactId>
            </dependency>
            
            <!-- RuoYi Common Swagger -->
            <dependency>
                <groupId>com.ruoyi</groupId>
                <artifactId>ruoyi-common-swagger</artifactId>
            </dependency>

    ?

    cs