• Spring Boot 第三篇:理解 spring-boot-starter-parent


    基于 maven 的 Spring Boot 项目,我们通常会指定 spring-boot-starter-parent 作为当前项目 pom 的 parent,大多数人都知道这可以用于依赖管理,以便引入依赖时可以省略版本号,这篇我们聊点不一样的。

    maven 中的继承

    spring-boot-starter-parent 作为 maven pom 中的 parent,我们需要先了解下 maven pom 中的 parent 有什么作用。

    我们经常在多个项目中引入相同的依赖,如 Spring MVC 相关依赖。

        
            
                org.springframework.boot
                spring-boot-starter-web
                2.2.7.RELEASE
            
        
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7

    对于相同的部分,作为程序员的我们下意识的会将其提取到公共的部分,maven 提供了类似 Java 的继承机制,只要将依赖加入到 parent,继承 parent 的项目会自动引入 parent 中的依赖。

    定义如下的 parent:

    
    
        4.0.0
    
        com.zzuhkp
        project-parent
        1.0-SNAPSHOT
        pom
    
        
            
                org.springframework.boot
                spring-boot-starter-web
                2.2.7.RELEASE
            
        
    
    
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19

    这里定义了一个名为 project-parent 的 maven 项目,并引入了 spring-boot-starter-web,再创建一个子项目。

    
    
        4.0.0
    
        
            com.zzuhkp
            project-parent
            1.0-SNAPSHOT
            ../pom.xml
        
    
        com.zzuhkp
        spring-boot-child1
        1.0-SNAPSHOT
    
    
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17

    子项目 spring-boot-child1 项目中仅引入了上面我们定义的 parent,以相同的方式定义一个子项目 spring-boot-child2,借助 idea 内置 maven 支持功能,查看各项目的依赖情况。
    在这里插入图片描述可以看到,两个子项目都成功引入了 parent 中引入的依赖。不过可能不是所有的子项目都想要依赖 parent 中的依赖,maven 还支持在 parent 中定义依赖,子项目可以有选择性的引入 parent 的依赖。修改 parent 定义如下。

    
    
        4.0.0
    
        com.zzuhkp
        project-parent
        1.0-SNAPSHOT
        pom
    
        
            
                
                    org.springframework.boot
                    spring-boot-starter-web
                    2.2.7.RELEASE
                
            
        
    
    
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21

    和原始版本相比,这里唯一的变化是将 dependencies 元素移到了 dependencyManagement 元素内部。修改 spring-boot-child1 项目如下。

    
    
        4.0.0
    
        
            com.zzuhkp
            project-parent
            1.0-SNAPSHOT
            ../pom.xml
        
    
        com.zzuhkp
        spring-boot-child1
        1.0-SNAPSHOT
    
        
            
                org.springframework.boot
                spring-boot-starter-web
            
        
    
    
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24

    与原始版本不同的是这里添加了 spring-boot-starter-web 依赖,由于 parent dependencyManagement 已经定义了依赖的 version,因此子项目直接进行了继承从而可以省略。再借助 idea 看下依赖。
    在这里插入图片描述这时 parent 和 spring-boot-child2 中的依赖都已经不见了,只有我们显式在 spring-boot-child1 中定义的依赖还在。

    上面只是介绍了 maven dependencies 依赖与 dependencyManagement 依赖版本的继承,还有很多其他可以继承的元素,就不具体介绍了,我们重点关注的可以继承的元素如下。

    • groupId:项目组ID,项目坐标元素之一。
    • version:项目版本号,项目坐标元素之一。
    • properties:maven 属性信息,可以在其他标签中引入。
    • dependencies:项目依赖描述。
    • dependencyManagement:项目依赖管理描述。
    • build:构建相关配置,如源码目录、输出目录、插件等。

    spring-boot-starter-parent

    spring-boot-starter-parent 只用来作为其他 maven 项目的 parent,因此它除了 pom 文件并没有什么有效的内容,要理解 spring-boot-starter-parent,还得看它的 pom 文件定义。由于 pom 文件内容过长,下面我们分别进行介绍它主要引入的功能。

    1. 依赖版本管理

    spring-boot-starter-parent 自身并没有定义 dependencyManagement,依赖管理依托于它的 parent spring-boot-dependencies,见下图。
    在这里插入图片描述spring-boot-dependencies 内部定义了很多依赖,这样我们就不用关心依赖的版本了。
    在这里插入图片描述依赖管理是我们用的最多的功能,示例代码如下。

    
    
        4.0.0
    
        
            2.2.7.RELEASE
            spring-boot-starter-parent
            org.springframework.boot
        
    
        com.zzuhkp
        project-parent
        1.0-SNAPSHOT
        jar
    
        
            
                org.springframework.boot
                spring-boot-starter-web
            
        
    
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23

    2. 属性配置

    spring-boot-starter-parent 添加了一些默认的配置,如指定了使用的 JDK 版本号为 1.8,编译时使用 UTF-8 编码方式。
    在这里插入图片描述

    3. 资源过滤

    spring-boot-starter-parent 指定了编译资源文件时将 **/application*.properties**/application*.yml**/application*.yaml 中的 maven 占位符替换为具体的属性值。具体如下。
    在这里插入图片描述如果没有引入 spring-boot-starter-parent,需要在 application.properties 文件中使用 maven 占位符时切记要手动配置 resource

    4. 插件配置

    spring-boot-starter-parent 内置了不少插件配置,我们重点关注 maven-compiler-pluginspring-boot-maven-plugin

    对于 maven-compiler-pluginspring-boot-starter-parent 主要配置了 parameters 参数,以便将方法参数名写入 class 文件。
    在这里插入图片描述对于 spring-boot-maven-plugin 插件,spring-boot-starter-parent 为其配置了 repackage 目标。
    在这里插入图片描述spring-boot-maven-plugin 插件 repackage 目标默认绑定 maven 声明周期中的 package 阶段,这样当打包后这个插件就会进一步将所有依赖的 jar 包以及当前项目的代码打包到一个 jar 包中,从而支持 jar -jar 启动 Spring Boot 项目。

    spring-boot-starter-parent 指定 spring-boot-maven-plugin 插件目标后,当我们的项目指定了 parent 为 spring-boot-starter-parent 后,就可以省略插件目标配置了。

        
            org.springframework.boot
            spring-boot-starter-parent
            2.2.7.RELEASE
        
        
        
            
                
                    org.springframework.boot
                    spring-boot-maven-plugin
                
            
        
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14

    spring-boot-dependencies

    spring-boot-dependenciesspring-boot-starter-parent 的好兄弟,由于 maven 只支持单继承,如果项目本身已经指定了其他 parent,则只能用 spring-boot-dependencies 进行依赖管理。

        
            
                
                    org.springframework.boot
                    spring-boot-dependencies
                    2.2.7.RELEASE
                    pom
                    import
                
            
        
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11

    加入上面的代码就可以注解引入 spring-boot-dependencies 中定义的依赖不用指定版本号了。

        
            
                org.springframework.boot
                spring-boot-starter-web
            
        
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6

    依赖版本升级

    spring-boot-starter-parentspring-boot-dependencies 都进行了依赖管理,如果依赖中存在漏洞我们就需要紧急进行修复,它们之间的升级方式有所不同。

    对于 spring-boot-starter-parent 而言,我们可以直接在 properties 中指定依赖的版本。以前段时间暴露出来的 log4j 2 漏洞为例,为了升级 log4j 2 版本号,我们可以在自己的项目中进行如下配置。

        
            org.springframework.boot
            spring-boot-starter-parent
            2.2.7.RELEASE
        
    
        
            2.17.2
        
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9

    指定 log4j2.version 属性是因为在 spring-boot-dependenciesloj4j 2 的坐标使用了这个属性值作为版本号,如下。
    在这里插入图片描述对于 spring-boot-dependencies,如果要进行依赖升级,配置属性是不行的,需要在 spring-boot-dependencies 前面加上要升级的依赖的坐标,示例如下。

        
            
                
                    org.apache.logging.log4j
                    log4j-to-slf4j
                    2.17.2
                
                
                    org.springframework.boot
                    spring-boot-dependencies
                    2.2.7.RELEASE
                    pom
                    import
                
            
        
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16

    如果要升级的依赖不是 spring-boot-starter-parentspring-boot-dependencies 管理的依赖,还可以直接把它加到 dependencies 标签下,这样依据最短路径原则,我们直接配置的依赖会覆盖间接引入的依赖,示例如下。

        
            
                org.apache.logging.log4j
                log4j-core
                2.17.2
            
        
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7

    总结

    本文从 maven 中的继承开始讲起,然后介绍 spring-boot-starter-parent 与替代它的 spring-boot-dependencies,最后还介绍了 Spring Boot 项目的依赖版本升级。

    在介绍 spring-boot-starter-parent 的时候我们提到了一个插件 spring-boot-maven-plugin 可以将项目打成可执行的 jar 包,这个插件除了打包,还具有在开发环境运行 Spring Boot 的项目的功能,下篇会重点介绍这个插件如何运行 Spring Boot 项目的。

    如果本文对你产生了少许帮助,不妨动动小手点个赞支持一下,同时也欢迎留言讨论。

  • 相关阅读:
    反复重购,资金严重浪费?企业资产需要这样管理
    缓存穿透、缓存击穿、缓存雪崩
    第 45 届ICPC亚洲区域赛(济南)C Stone Game【题解】
    python+excel自动生成小学加减乘除计算题
    9.OpenFeign服务接口调用
    手写 Promise
    【echarts入门】:vue项目中应用echarts
    记一次 .NET 某医疗住院系统 崩溃分析
    2022就业季|Spring认证教你,如何使用 Spring 构建 REST 服务
    No version of NDK matched the requested version xxx 问题解决
  • 原文地址:https://blog.csdn.net/m0_67391401/article/details/126040695