Spring Boot starter入门

最新推荐文章于 2024-06-18 10:20:54 发布
最新推荐文章于 2024-06-18 10:20:54 发布
阅读量130 收藏
点赞数
文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_45859203/article/details/126420825
版权

Spring Boot starter入门

starter

1、SpringBoot starter机制

SpringBoot中的starter是一种非常重要的机制，能够抛弃以前繁杂的配置，将其统一集成进starter，应用者只需要在maven中引入starter依赖，SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置。starter让我们摆脱了各种依赖库的处理，需要配置各种信息的困扰。SpringBoot会自动通过classpath路径下的类发现需要的Bean，并注册进IOC容器。SpringBoot提供了针对日常企业应用研发各种场景的spring-boot-starter依赖模块。所有这些依赖模块都遵循着约定成俗的默认配置，并允许我们调整这些配置，即遵循“约定大于配置”的理念。

2、为什么要自定义starter

在我们的日常开发工作中，经常会有一些独立于业务之外的配置模块，我们经常将其放到一个特定的包下，然后如果另一个工程需要复用这块功能的时候，需要将代码硬拷贝到另一个工程，重新集成一遍，麻烦至极。如果我们将这些可独立于业务代码之外的功配置模块封装成一个个starter，复用的时候只需要将其在pom中引用依赖即可，SpringBoot为我们完成自动装配，简直不要太爽。

并不是所有的 starter 都是由 Spring Boot 官方提供的，也有部分 starter 是第三方技术厂商提供的，例如 druid-spring-boot-starter 和 mybatis-spring-boot-starter 等等。当然也存在个别第三方技术，Spring Boot 官方没提供 starter，第三方技术厂商也没有提供 starter。

3.怎么使用Spring Boot starter

以 spring-boot-starter-web 为例，它能够为提供 Web 开发场景所需要的几乎所有依赖，因此在使用 Spring Boot 开发 Web 项目时，只需要引入该 Starter 即可，而不需要额外导入 Web 服务器和其他的 Web 依赖。

在 pom.xml 中引入 spring-boot-starter-web，示例代码如下。

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!--SpringBoot父项目依赖管理-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.5</version>
        <relativePath/>
    </parent>
    ....
    <dependencies>
        <!--导入 spring-boot-starter-web-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        ...
    </dependencies>
    ...
</project>

在以上 pom.xml 的配置中，引入依赖 spring-boot-starter-web 时，并没有指明其版本（version），但在依赖树中，我们却看到所有的依赖都具有版本信息， 那么这些版本信息是在哪里控制的呢？

这些版本信息是由 spring-boot-starter-parent（版本仲裁中心） 统一控制的。

spring-boot-starter-parent

spring-boot-starter-parent 是所有 Spring Boot 项目的父级依赖，它被称为 Spring Boot 的版本仲裁中心，可以对项目内的部分常用依赖进行统一管理。

<!--SpringBoot父项目依赖管理-->
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.4.5</version>
    <relativePath/>
</parent>

Spring Boot 项目可以通过继承 spring-boot-starter-parent 来获得一些合理的默认配置，它主要提供了以下特性：

  • 默认 JDK 版本（Java 8）
  • 默认字符集（UTF-8）
  • 依赖管理功能
  • 资源过滤
  • 默认插件配置
  • 识别 application.properties 和 application.yml 类型的配置文件

查看 spring-boot-starter- parent 的底层代码，可以发现其有一个父级依赖 spring-boot-dependencies。

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-dependencies</artifactId>
    <version>2.4.5</version>
</parent>

spring-boot-dependencies 的底层代码如下。

<?xml version="1.0" encoding="UTF-8"?>
<project 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"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-dependencies</artifactId>
    <version>2.4.5</version>
    <packaging>pom</packaging>
    ....
    <properties>
        <activemq.version>5.16.1</activemq.version>
        <antlr2.version>2.7.7</antlr2.version>
        <appengine-sdk.version>1.9.88</appengine-sdk.version>
        <artemis.version>2.15.0</artemis.version>
        <aspectj.version>1.9.6</aspectj.version>
        <assertj.version>3.18.1</assertj.version>
        <atomikos.version>4.0.6</atomikos.version>
        ....
    </properties>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.apache.activemq</groupId>
                <artifactId>activemq-amqp</artifactId>
                <version>${activemq.version}</version>
            </dependency>
            <dependency>
                <groupId>org.apache.activemq</groupId>
                <artifactId>activemq-blueprint</artifactId>
                <version>${activemq.version}</version>
            </dependency>
            ...
        </dependencies>
    </dependencyManagement>
    <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.codehaus.mojo</groupId>
                    <artifactId>build-helper-maven-plugin</artifactId>
                    <version>${build-helper-maven-plugin.version}</version>
                </plugin>
                <plugin>
                    <groupId>org.flywaydb</groupId>
                    <artifactId>flyway-maven-plugin</artifactId>
                    <version>${flyway.version}</version>
                </plugin>
                ...
            </plugins>
        </pluginManagement>
    </build>
</project>

以上配置中，部分元素说明如下：

  • dependencyManagement ：负责管理依赖；
  • pluginManagement：负责管理插件；
  • properties：负责定义依赖或插件的版本号。

自定义starter

1、如何自定义starter

启动器starter只是用来做依赖管理
需要专门写一个类似spring-boot-autoconfigure的配置模块
用的时候只需要引入启动器starter，就可以使用自动配置了

相关注解

@Configuration  //指定这个类是一个配置类
@ConditionalOnXXX  //指定条件成立的情况下自动配置类生效
@AutoConfigureOrder  //指定自动配置类的顺序
@Bean  //向容器中添加组件
@ConfigurationProperties  //结合相关xxxProperties来绑定相关的配置
@EnableConfigurationProperties  //让xxxProperties生效加入到容器中

2、自定义starter的命名规则

SpringBoot提供的starter以spring-boot-starter-xxx的方式命名的。官方建议自定义的starter使用xxx-spring-boot-starter命名规则。以区分SpringBoot生态提供的starter。

3、starter的实现方法

新建一个工程

命名为demo-spring-boot-starter

  • 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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.2</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.zhang</groupId>
    <artifactId>demo-spring-boot-starter</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo-spring-boot-starter</name>
    <description>demo-spring-boot-starter</description>
    <properties>
        <java.version>8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

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

</project>
定义一个实体类映射配置信息
@ConfigurationProperties(prefix = "demo")

它可以把相同前缀的配置信息通过配置项名称映射成实体类，比如我们这里指定 prefix = “demo” 这样，我们就能将以demo为前缀的配置项拿到了。ps：其实这个注解很强大，它不但能映射成String或基本类型的变量。还可以映射为List，Map等数据结构。

package com.demo.starter.properties;

import org.springframework.boot.context.properties.ConfigurationProperties;

import java.time.LocalDateTime;

/**
 * @Author: ZQ
 * @Description: 配置信息实体
 * @DateTime: 2022/8/16 15:55
 **/
@ConfigurationProperties(prefix = "demo.msg")
public class DemoProperties {
    
    public String msg;

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }
}
定义一个Service
package com.demo.starter.service;

import java.time.LocalDateTime;

/**
 * @Author: ZQ
 * @Description: 定义一个带时间戳的消息Service
 * @DateTime: 2022/8/16 15:57
 **/
public class DemoService {
    public String msg;

    public DemoService(String msg) {
        this.msg = msg;
    }

    public String showMsg(){
        return "[" + LocalDateTime.now + "] " + this.msg;
    }
}
定义一个配置类

这里，我们将DemoService类定义为一个Bean，交给Ioc容器。

▲ @Configuration 注解就不多说了。

▲ @EnableConfigurationProperties 注解。该注解是用来开启对3步骤中 @ConfigurationProperties 注解配置Bean的支持。也就是@EnableConfigurationProperties注解告诉Spring Boot 能支持@ConfigurationProperties。

当然了，也可以在 @ConfigurationProperties 注解的类上添加 @Configuration 或者 @Component 注解

▲ @ConditionalOnProperty 注解控制 @Configuration 是否生效。简单来说也就是我们可以通过在yml配置文件中控制 @Configuration 注解的配置类是否生效。

package com.demo.starter.config;

import com.demo.starter.properties.DemoProperties;
import com.demo.starter.service.DemoService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @Author: ZQ
 * @Description: 配置类
 * @DateTime: 2022/8/16 16:07
 **/
@Configuration
@ConditionalOnWebApplication 
@EnableConfigurationProperties(DemoProperties.class)
public class DemoConfig {
    @Autowired
    private DemoProperties demoProperties;

    @Bean
    public DemoService demoService(){
        return new DemoService(demoProperties.getMsg());
    }
}
最重要的

在resources文件夹下新建META-INF文件夹，然后创建spring.factories文件

在该文件中加入如下配置，该配置指定上步骤中定义的配置类为自动装配的配置。

开启自动配置

# -------starter自动装配---------
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.demo.starter.config.DemoConfig

在demo-spring-boot-starter工程中执行mvn clean install 一个自定义的starter新鲜出炉。

测试

新建测试工程

引入starter依赖

<dependency>
    <groupId>com.demo</groupId>
    <artifactId>demo-spring-boot-starter</artifactId>
    <version>0.0.1-RELEASE</version>
</dependency>

配置文件

demo.msg=test

写个测试类

直接 @Autowired
sakura_058
关注
springboot构建自己的starter
牛奋lch
02-13 1万+
前言 下面我们来通过示例来构建自己的starter pom并完成自动配置，以此来更深入的理解spring boot的工作原理。 需求 该starter提供PersonService，并实现自动配置PersonService 一、新建一个Maven工程 工程pom依赖如下： <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns
SpringBoot的启动器——Spring-boot-starter介绍和常见启动器
Admans的专栏
05-09 1790
​ Ø spring-boot-starter-jpa：支持 spring 以 jpa方式操作数据库的 jar 包的集合。​ Ø spring-boot-starter-redis：支持 redis 键值存储的数据库操作。：支持全栈式的 web 开发，包括了 tomcat 和 springMVC 等 jar包。​ Ø 相关依赖的自动导入。​ Ø 相关环境的自动配置。
带你认识Spring Boot Starter
最新发布
夏壹分享
06-18 1086
Spring Boot Starter 是一组便捷的依赖描述符，它们封装了特定技术或功能的所有必要依赖项和配置，使开发者能够快速将这些功能集成到 Spring Boot 项目中。每个 Starter 都对应一个功能或技术栈，通过引入相应的 Starter，开发者无需手动配置和管理多个相关依赖项，就能轻松启用该功能。
spring-boot之starter
高新富的博客
04-20 8522
spring-boot之starter
【Spring Boot】Spring Boot 中的 Starter
书山有路，学海无涯。记录成长，追逐梦想
05-12 3746
Spring Boot 为了简化配置，提供了非常多的 Starter。它先打包好与常用模块相关的所有 JAR 包，并完成自动配置，然后组装成 Starter（如把 Web 相关的 Spring MVC、容器等打包好后组装成 spring-boot-starter-web）。这使得在开发业务代码时不需要过多关注框架的配置，只需关注业务逻辑即可。
spring-boot-starter-mybatis:Spring Boot MyBatis入门
05-14
这是MyBatis的非官方Spring Boot Starter 与官方相反，它遵循其他Spring Boot数据存储库的约定并实现适当的Spring Data接口。 这种方法的优点是在切换持久层上几乎无需花费任何努力。 问题跟踪 Maven依赖 ...
web3j-spring-boot-starter：用于web3j的Spring Boot Starter
01-30
web3j Spring Boot Starter 通过Spring的依赖注入将web3j集成到您的Spring Boot应用程序中。 入门 提供示例应用程序 要使用，请创建一个新的 ，并包括以下依赖项： Maven： < groupId>org.web3j < artifactId>...
【Java架构师入门到精通】Spring Boot starter入门
m0_54988612的博客
03-11 143
传统的 Spring 项目想要运行，不仅需要导入各种依赖，还要对各种 XML 配置文件进行配置，十分繁琐，但 Spring Boot 项目在创建完成后，即使不编写任何代码，不进行任何配置也能够直接运行，这都要归功于 Spring Boot 的 starter 机制。本节我们将对 stater 进行介绍。 starter Spring Boot 将日常企业应用研发中的各种场景都抽取出来，做成一个个的 starter（启动器），starter 中整合了该场景下各种可能用到的依赖，用户只需要在 Maven 中引入
spring-boot-starter-minio:用于Spring Boot的Minio启动器
05-07
Spring Boot Starter Minio Spring Boot Starter，它可以连接到Minio存储桶，以保存，获取和删除对象。 入门者还为执行器嵌入了指标和运行状况检查。 快速开始 只需将依赖项添加到现有的Spring Boot项目中即可。 ...
【SpringBoot】Starter的使用与案例讲解
万维网连五洲，二进制写尽天下事，喜欢结识新伙伴寻找志同道合的朋友，欢迎一起探讨学习
12-15 4563
SpringBoot中的starter是一种非常重要的机制(自动化配置)，能够抛弃以前繁杂的配置，将其统一集成进starter，应用者只需要在maven中引入starter依赖，SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置。
【Spring Boot starter】 全面深入了解
vdssdf的博客
07-03 914
spring boot 在配置上相比spring要简单许多, 其核心在于spring-boot-starter, 在使用spring boot来搭建一个项目时, 只需要引入官方提供的starter, 就可以直接使用, 免去了各种配置。starter简单来讲就是引入了一些相关依赖和一些初始化的配置。Spring官方提供了很多starter，第三方也可以定义starter。
spring boot - crawler-spring-boot-starter - 一个简单快捷的爬虫框架（网页爬取，文章遍历）
我的博客
11-05 849
crawler-spring-boot-starter 相比于python爬虫，java爬虫框架要不就是如nutch这般太过重量级，要不就如webcollector一样，因为内置了BerkeleyDB， 所以会经常报一些莫名其妙的错误。为了解决这些问题，本人在开发搜索引擎的过程中编写了一个简单便捷的基于spring boot 的爬虫框架，此框架简单纯净，不内置任何数据库，而且线程利用率...
SpringBoot + screw 一键生成数据库文档，告别CV大法，解放生产力
阿超学习笔记的博客
04-12 2223
提升工作效率神奇
Spring boot 集成screw 一键自动生成数据文档
TechnicianWang的博客
03-19 316
Spring boot 集成screw 一键自动生成数据文档
【SpringBoot】SpringBoot Starter 作用及原理
DreamSun的博客
06-16 6263
有没有在入行后直接基于 SpringBoot 开发项目，没有 spring、servlet 开发经历的?有没有用 SpringBoot 开发项目，但是第一次听说 Starter 或者听过却不知道是干嘛的?有没有知道 Starter 是干嘛的，但不知其原理的?有没有想了解 Starter 原理或想自己实现一个 Starter 提供别人使用的?如果有以上情况的，希望通过本文可以帮助你了解 Starter。
springboot+screw 轻松生成数据库设计文档
阿木木AEcru的博客
02-26 2247
SpringBoot+screw简单生成数据库设计文档，screw（螺丝钉）简洁好用的数据库表结构文档生成工具，支撑MySQL、PostgreSQL、SqlServer、MariaDB、Oracle等主流数据库
彻底搞懂 SpringBoot 中的 starter 机制
磊哥聊Java
10-08 1312
前言我们都知道，Spring的功能非常强大，但也有些弊端。比如：我们需要手动去配置大量的参数，没有默认值，需要我们管理大量的jar包和它们的依赖。为了提升Spring项目的开发效率，简化一些配置，Spring官方引入了SpringBoot。当然，引入SpringBoot还有其他原因，在这里就不过多描述了。本文重点跟大家一起聊聊SpringBoot的starter机制，因为它太重要了。1 为什么要用...
Spring Boot Starter详解：企业常用组件与快速入门
"本文将盘点企业中最常用的Spring Boot Starter，介绍Spring Boot框架的核心优势，并通过一个简单的示例展示如何运行Spring Boot应用。" Spring Boot是Spring生态中的一个重要组成部分，由Pivotal团队开发，旨在...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值