Spring Boot 自定义 Starter

最新推荐文章于 2024-05-12 23:38:31 发布
最新推荐文章于 2024-05-12 23:38:31 发布
阅读量213 收藏 1
点赞数 1
分类专栏： java 文章标签： spring boot starter 自定义
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weiwosuoai/article/details/86705072
版权

文章首发于个人网站： https://www.exception.site/course/4/chapter/4

前言

Spring Boot 最大的特性可以说就是开箱即用，内部提供的默认自动配置功能，使得我们可以再 “零配置” 的情况下，就能够很方便地运行起应用。

这一切都要归功于启动器 starter, 比如说，想搭建一个 Spring Boot Web 项目，我们只需要添加 spring-boot-starter-web依赖即可，可以在不做一行配置的情况下，启动一个 Tomcat 应用。

下面是我们常用的 starter 启动器：

  • 单元测试: spring-boot-starter-web;
  • 数据库持久层框架 JPA：spring-boot-starter-data-jpa；
  • 安全框架：spring-boot-starter-security;
  • Redis 缓存：spring-boot-starter-data-redis；
  • …

用起来是爽了，但是也有人抱怨不如以前的 SSM 框架那样透明化，虽然配置是烦了点，但是我至少知道我开启了哪些功能，如今用了 Spring Boot 后，出了问题，压根不知道问题根源在哪里，蛋疼！

所以说，了解启动器 starter 默认地自动化配置是如何工作的，还是非常有必要的！本文以手写一个自定义的入门级 starter, 带你了解其工作原理。

实践

需求描述

假设我们有这样一个需求：需要自定义一个女盆友 starter, 她带有一个问候的功能，要如何来实现呢？

新建 maven 项目

为其取名为：girl-friend-spring-boot-starter.

Spring 官方对 starter 的命名是有规范的，只有官方提供的 starter, 才能命名为 spring-boot-starter-{name}, 比如 spring-boot-starter-web; 而对于非官方的，需以 {name}-spring-boot-starter 的格式命名。

添加 spring-boot-autoconfigure 依赖

pom.xml 文件内容如下:

<?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>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>site.exception</groupId>
    <artifactId>girl-friend-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <!-- 自动化配置依赖，自定义 starter 核心依赖包 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
    </dependencies>

</project>

新增功能类

新增下面三个类：

  • GirlFriendServiceProperties(配置类);

  • GirlFriendService (女盆友接口);

  • GirlFriendServiceImpl(女盆友接口实现);

上源码：

GirlFriendServiceProperties.java:

package site.exception;

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

/**
 * @author www.excpetion.site(exception 教程网)
 * @date 2019/1/30
 * @time 11:22
 * @discription
 **/
@ConfigurationProperties(prefix = "spring.girlfriend")
public class GirlFriendServiceProperties {

    /** 默认输出 */
    private String message = "Hi, good morning !";

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

@ConfigurationProperties注解能够自动获取 application.properties 配置文件中前缀为 spring.girlfriend 节点下 message属性的内容，这里我们给了它一个默认值: Hi, good morning !。

GirlFriendService.java:

package site.exception;

/**
 * @author www.excpetion.site(exception 教程网)
 * @date 2019/1/30
 * @time 11:07
 * @discription
 **/
public interface GirlFriendService {
    /**
     * 打招呼
     * @return
     */
    void say();
}

GirlFriendServiceImpl.java:

package site.exception;

import org.springframework.beans.factory.annotation.Autowired;

/**
 * @author www.excpetion.site(exception 教程网)
 * @date 2019/1/30
 * @time 11:07
 * @discription
 **/
public class GirlFriendServiceImpl implements GirlFriendService {

    @Autowired
    private GirlFriendServiceProperties girlFriendServiceProperties;

    /**
     * 打招呼
     *
     */
    @Override
    public void say() {
        String message = girlFriendServiceProperties.getMessage();
        System.out.println("Girl Friend: " + message);
    }
}

GirlFriendServiceImpl 实现了 GirlFriendService 接口的 say() 方法，它会获取 GirlFriendServiceProperties 配置类 message 内容，并打印到控制台。

硬菜：新增自动配置类

创建类 GirlFriendAutoConfiguration.java 来实现自动配置化功能：

package site.exception;

import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author www.excpetion.site(exception 教程网)
 * @date 2019/1/30
 * @time 11:11
 * @discription
 **/
@Configuration
@ConditionalOnClass(GirlFriendService.class)
@EnableConfigurationProperties(GirlFriendServiceProperties.class)
public class GirlFriendAutoConfiguration {

    @Bean
    @ConditionalOnMissingBean
    public GirlFriendService girlFriendService() {
        return new GirlFriendServiceImpl();
    }
}

接下来，对上面相关注解说明一下：

  • @Configuration: 标注类为一个配置类，让 spring 去扫描它；
  • @ConditionalOnClass：条件注解，只有在 classpath 路径下存在指定 class 文件时，才会实例化 Bean；
  • @EnableConfigurationProperties：使指定配置类生效；
  • @Bean: 创建一个实例类注入到 Spring Ioc 容器中；
  • @ConditionalOnMissingBean：条件注解，意思是，仅当 Ioc 容器不存在指定类型的 Bean 时，才会创建 Bean。

新增 spring.factories 文件

在 resources 目录下创建名为 META-INF 的目录，并新建文件 spring.factories，内容如下：

# 指定刚刚创建的 GirlFriendAutoConfiguration 的全路径名
org.springframework.boot.autoconfigure.EnableAutoConfiguration=site.exception.GirlFriendAutoConfiguration

Spring Boot 会在启动时，自动会去查找指定文件 /META-INF/spring.factories，若有，就会根据配置的类的全路径去自动化配置。

完成这一步后，一个入门级的 spring-boot-starter 已经开发完成了，看下整体的目录结构：

打包 jar

接下来，就是将 girl-friend-spring-boot-starter 打成 jar 包，放到本地的 maven 仓库中去，在项目根路径下执行 maven 命令： mvn clean install.

C:\dev\idea_workspace_personal\spring-boot-tutorial\girl-friend-spring-boot-starter>mvn clean install
[INFO] Scanning for projects...
[INFO]
[INFO] -----------< site.exception:girl-friend-spring-boot-starter >-----------
[INFO] Building girl-friend-spring-boot-starter 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-clean-plugin:3.1.0:clean (default-clean) @ girl-friend-spring-boot-starter ---
[INFO] Deleting C:\dev\idea_workspace_personal\spring-boot-tutorial\girl-friend-spring-boot-starter\target
[INFO]
[INFO] --- maven-resources-plugin:3.1.0:resources (default-resources) @ girl-friend-spring-boot-starter ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] Copying 0 resource
[INFO] Copying 1 resource
[INFO]
[INFO] --- maven-compiler-plugin:3.8.0:compile (default-compile) @ girl-friend-spring-boot-starter ---
[INFO] Changes detected - recompiling the module!
[INFO] Compiling 4 source files to C:\dev\idea_workspace_personal\spring-boot-tutorial\girl-friend-spring-boot-starter\target\classes
[INFO]
[INFO] --- maven-resources-plugin:3.1.0:testResources (default-testResources) @ girl-friend-spring-boot-starter ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] skip non existing resourceDirectory C:\dev\idea_workspace_personal\spring-boot-tutorial\girl-friend-spring-boot-starter\src\test\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.8.0:testCompile (default-testCompile) @ girl-friend-spring-boot-starter ---
[INFO] Nothing to compile - all classes are up to date
[INFO]
[INFO] --- maven-surefire-plugin:2.22.1:test (default-test) @ girl-friend-spring-boot-starter ---
[INFO] No tests to run.
[INFO]
[INFO] --- maven-jar-plugin:3.1.1:jar (default-jar) @ girl-friend-spring-boot-starter ---
[INFO] Building jar: C:\dev\idea_workspace_personal\spring-boot-tutorial\girl-friend-spring-boot-starter\target\girl-friend-spring-boot-starter-1.0-SNAPSHOT.jar
[INFO]
[INFO] --- maven-install-plugin:2.5.2:install (default-install) @ girl-friend-spring-boot-starter ---
[INFO] Installing C:\dev\idea_workspace_personal\spring-boot-tutorial\girl-friend-spring-boot-starter\target\girl-friend-spring-boot-starter-1.0-SNAPSHOT.jar to C:\User
s\allen\.m2\repository\site\exception\girl-friend-spring-boot-starter\1.0-SNAPSHOT\girl-friend-spring-boot-starter-1.0-SNAPSHOT.jar
[INFO] Installing C:\dev\idea_workspace_personal\spring-boot-tutorial\girl-friend-spring-boot-starter\pom.xml to C:\Users\allen\.m2\repository\site\exception\girl-frien
d-spring-boot-starter\1.0-SNAPSHOT\girl-friend-spring-boot-starter-1.0-SNAPSHOT.pom
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  6.247 s
[INFO] Finished at: 2019-01-30T15:31:03+08:00
[INFO] ------------------------------------------------------------------------

新建一个 Spring Boot Web 项目，引用自定 starter

新创建一个 Spring Boot Web 项目，在 pom.xml 文件中加入自定义的 starter 依赖：

<!-- Girl Friend starter -->
<dependency>
    <groupId>site.exception</groupId>
    <artifactId>girl-friend-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

在 Applicaiton 启动类中，自动注入 GirlFriendService 实例，并调用 say() 方法:

package site.exception.springboothello;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import site.exception.GirlFriendService;

@SpringBootApplication
public class SpringBootHelloApplication implements CommandLineRunner {

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

	@Autowired
	private GirlFriendService girlFriendService;

	@Override
	public void run(String... args) throws Exception {
		// 调用打招呼方法
		girlFriendService.say();
	}
}

启动项目，看看在零配置的情况下，它的输出：

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::        (v2.1.2.RELEASE)

2019-01-30 15:40:48.308  INFO 25320 --- [  restartedMain] s.e.s.SpringBootHelloApplication         : Starting SpringBootHelloApplication on DESKTOP-RL6P6LA with PID 25320 (C:\dev\idea_workspace_personal\spring-boot-tutorial\spring-boot-hello\target\classes started by allen in C:\dev\idea_workspace_personal\spring-boot-tutorial)
2019-01-30 15:40:48.314  INFO 25320 --- [  restartedMain] s.e.s.SpringBootHelloApplication         : No active profile set, falling back to default profiles: default
2019-01-30 15:40:48.457  INFO 25320 --- [  restartedMain] .e.DevToolsPropertyDefaultsPostProcessor : Devtools property defaults active! Set 'spring.devtools.add-properties' to 'false' to disable
2019-01-30 15:40:48.458  INFO 25320 --- [  restartedMain] .e.DevToolsPropertyDefaultsPostProcessor : For additional web related logging consider setting the 'logging.level.web' property to 'DEBUG'
2019-01-30 15:40:51.299  INFO 25320 --- [  restartedMain] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8080 (http)
2019-01-30 15:40:51.372  INFO 25320 --- [  restartedMain] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2019-01-30 15:40:51.373  INFO 25320 --- [  restartedMain] org.apache.catalina.core.StandardEngine  : Starting Servlet engine: [Apache Tomcat/9.0.14]
2019-01-30 15:40:51.387  INFO 25320 --- [  restartedMain] o.a.catalina.core.AprLifecycleListener   : The APR based Apache Tomcat Native library which allows optimal performance in production environments was not found on the java.library.path: [C:\dev\java\jdk1.8\bin;C:\WINDOWS\Sun\Java\bin;C:\WINDOWS\system32;C:\WINDOWS;C:\dev\java\jdk1.8\bin;C:\dev\java\jdk1.8\jre\bin;C:\Program Files (x86)\Common Files\Oracle\Java\javapath;C:\WINDOWS\system32;C:\WINDOWS;C:\WINDOWS\System32\Wbem;C:\WINDOWS\System32\WindowsPowerShell\v1.0\;C:\WINDOWS\System32\OpenSSH\;C:\Program Files (x86)\pycSafefile\x64;C:\dev\java\apache-maven-3.6.0\bin;D:\dev\redis\;C:\dev\git\cmd;C:\Users\allen\AppData\Local\Microsoft\WindowsApps;;C:\Program Files\Docker Toolbox;.]
2019-01-30 15:40:51.628  INFO 25320 --- [  restartedMain] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2019-01-30 15:40:51.629  INFO 25320 --- [  restartedMain] o.s.web.context.ContextLoader            : Root WebApplicationContext: initialization completed in 3171 ms
2019-01-30 15:40:51.921  INFO 25320 --- [  restartedMain] o.s.s.concurrent.ThreadPoolTaskExecutor  : Initializing ExecutorService 'applicationTaskExecutor'
2019-01-30 15:40:52.142  INFO 25320 --- [  restartedMain] o.s.b.d.a.OptionalLiveReloadServer       : LiveReload server is running on port 35729
2019-01-30 15:40:52.204  INFO 25320 --- [  restartedMain] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2019-01-30 15:40:52.207  INFO 25320 --- [  restartedMain] s.e.s.SpringBootHelloApplication         : Started SpringBootHelloApplication in 4.56 seconds (JVM running for 6.523)
Girl Friend: Hi, good morning !

可以看到，在没做任何配置的情况下，输出的是默认打招呼信息：Hi, good morning !，接下来，我们手动配置一下新的打招呼内容，看看是否能自动获取到。

在 application.properties 文件中配置如下：

spring.girlfriend.message=I LOVE YOU

重启项目，验证一下，是否输出的还是默认信息：

正确打印我们自己配置的：I LOVE YOU。

GitHub 源码地址

https://github.com/weiwosuoai/spring-boot-tutorial

总结

此文中，我们学习了如何自定义入门级 spring-boot-starter，这仅仅是个开始，能做的远不止于此，这里也只是抛砖引玉而已，希望您阅读愉快！

欢迎关注公众号: 小哈学Java

在这里插入图片描述

犬小哈
关注
专栏目录
Spring Boot自定义starter
洛卡JAVA架构师每日分享Java架构师知识
06-06 513
starter 是 SpringBoot 中一种非常重要的机制，它可以繁杂的配置统一集成到 starter 中，我们只需要通过 maven 将 starter 依赖引入到项目中，SpringBoot 就能自动扫描并加载相应的默认配置。starter 的出现让开发人员从繁琐的框架配置中解放出来，将更多的精力专注于业务逻辑的开发，极大的提高了开发效率。 在一些特殊情况下，我们也可以将一些通用功能封装成自定义的 starter 进行使用，本节我们将为您详细介绍如何自定义 starter。 命名规范 SpringB
Java spi学习与Spring Boot自定义starter、开箱即用starter
最新发布
07-30
Java spi学习与Spring Boot自定义starter、开箱即用starter
快速开发一个自定义Spring Boot Starter，并使用它
zwmnhao1980的博客
08-03 650
众所周知(不知道？点此)，Spring Boot由众多Starter组成，随着版本的推移Starter家族成员也与日俱增。在传统Maven项目中通常将一些层、组件拆分为模块来管理，以便相互依赖复用，在Spring Boot项目中我们则可以创建自定义Spring Boot Starter来达成该目的。 Spring Boot Starter 可用来简化依赖，如：spring-boot-starte...
Spring Boot 自定义starter
weixin_34364135的博客
03-28 148
创建一个用maven构建的springboot项目 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" ...
Spring Boot自动装配原理，SpringBootStarter
qq_44073614的博客
10-20 2892
Spring Boot Starter Spring Boot 大大简化了项目初始搭建以及开发过程，而这些都是通过Spring Boot 提供的starter来完成的。 starter介绍 springboot在配置上相比spring要简单许多，其核心在于spring-boot-starter，在使用spring boot来搭建一个项目时，只需要引入官方提供的starter，就可以直接使用，免去了各种配置。starter简单来讲就是引入了一些相关的依赖和一些初始化的配置 Spring 官方提供了很多star
08_springboot2.x自定义starter
含江君
10-07 338
概述 starter：启动器 1、这个场景需要使用到的依赖是什么？ 2、如何编写自动配置 规则： @Configuration //指定这个类是一个配置类 @ConditionalOnXXX //在指定条件成立的情况下自动配置类生效 @AutoConfigureAfter //指定自动配置类的顺序 @Bean //给容器中添加组件 @ConfigurationPropertie结合相关xx...
Spring Boot 自定义starter启动器(demo).zip
04-05
Spring Boot 自定义starter启动器 Demo 部分，用于记录使用。该demo 配套教程 https://blog.csdn.net/lzb348110175/article/details/105330274。
[SpringBoot] Spring Boot Starter
沫洺的博客
10-08 554
初识Spring Boot Starter
Spring Boot starter（启动器）
weixin_49140482的博客
03-28 1408
Spring Boot将所有的功能场景都抽取出来，做成一个个的starters（启动器），只需要在项目里面引入这些starter，相关场景的所有依赖都会导入进来。要用什么功能就导入什么场景的启动器。
Spring Boot starter
qq_44194174的博客
12-07 1403
Spring Boot starter Spring Boot大大简化了项目初始搭建以及开发过程spring boot 在配置上相比spring要简单许多, 其核心在于spring-boot-starter, 在使用spring boot来搭建一个项目时, 只需要引入官方提供的starter, 就可以直接使用, 免去了各种配置。starter简单来讲就是引入了一些相关依赖和一些初始化的配置。 Spring官方提供了很多starter，第三方也可以定义starter。为了加以区分，starter从名称上进行了
【Spring Boot】Spring Boot 中的 Starter
书山有路，学海无涯。记录成长，追逐梦想
05-12 4695
Spring Boot 为了简化配置，提供了非常多的 Starter。它先打包好与常用模块相关的所有 JAR 包，并完成自动配置，然后组装成 Starter（如把 Web 相关的 Spring MVC、容器等打包好后组装成 spring-boot-starter-web）。这使得在开发业务代码时不需要过多关注框架的配置，只需关注业务逻辑即可。
spring-boot之starter
高新富的博客
04-20 8570
spring-boot之starter
springboot之starter
塞北的荒烟的博客
12-13 411
一、mybatis整合starter 1、pom依赖 2、指定自动装配文件位置 3、根据配置文件属性进行装配 4、获取配置文件进行属性绑定 5、springboot启动时加载springFactory 二、自定义starter 1、starter是一个集成接合器，完成两件事： ①引入相关的jar； ②自动配置； springboot规范： ①starter.jar 完成引入相关的jar ②autoConfigure.jar 完成自动配置 2、starter命名规范 spring提供的star
从零开始开发一个Spring Boot Starter
yxwb1253587469的博客
05-06 1891
原文地址：添加链接描述，添加链接描述 一.Spring Boot Starter简介 Starter是Spring Boot中的一个非常重要的概念，Starter相当于模块，它能将模块所需的依赖整合起来并对模块内的Bean根据环境（ 条件）进行自动配置。使用者只需要依赖相应功能的Starter，无需做过多的配置和依赖，Spring Boot就能自动扫描并加载相应的模块。 例如在Maven的依赖中加...
SpringBoot中的Starter
pan_junbiao的博客
03-25 1004
1、了解Starter SpringBoot为了简化配置，提供了非常多的Starter。它先打包好与常用模块相关的所有JAR包，并完成自动配置，然后组装成Starter（如把Web相关的SpringMVC、容器等打包好后组装成 spring-boot-starter-web）。这使得在开发业务代码时不需要过多关注框架的配置，只需要关注业务逻辑即可。 SpringBoot提供了很多开箱即用的St...
介绍 Spring Boot Starter
neweastsun的专栏
12-08 1231
介绍 Spring Boot Starter 依赖管理是任何复杂项目中的关键部分。手工实现显然是不明智的，你花时间越多，则在项目的其他重要部分时间越少。Spring Boot Starter致力于完美解决这个问题。Starter POM是包括在应用中的一组便利依赖描述。可以一站式获得所有Spring和相关技术库，无需寻找相同的代码，拷贝、粘贴需要载入的依赖描述。 Spring Boot 有超过30...
Spring Boot 自定义Starter实战教程
创建Spring Boot自定义starter是通过组合依赖、配置类和`spring.factories`文件来实现的，它能帮助开发者快速集成和使用特定功能，降低项目的复杂性。这个过程需要理解Spring Boot的自动配置机制，以及如何编写可被...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值