脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → SpringBoot自定义starter

使用SpringBoot自定义starter的完整步骤

 更新时间：2020年10月25日 16:18:36   作者：耶亚希  
这篇文章主要给大家介绍了关于使用SpringBoot自定义starter的完整步骤，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

前言

使用过SpringBoot的都应该知道，一个SpringBoot 项目就是由一个一个 Starter 组成的，一个 Starter 代表该项目的 SpringBoot 启动依赖，除了官方已有的 Starter，我们可以根据自己的需要自定义新的Starter。

一、自定义SpringBoot Starter

自定义Starter，首选需要实现自动化配置，而要实现自动化配置需要满足以下两个条件：

(1)能够自动配置项目所需要的配置信息，也就是自动加载依赖环境；

(2)能够根据项目提供的信息自动生成Bean，并且注册到Bean管理容器中；

要实现自动化配置需要在项目的pom.xml文件中引入如下依赖：

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-autoconfigure</artifactId>
 <version>2.1.4.RELEASE</version>
</dependency>

根据需要自定义Starter的实现过程大致如下（以我定义的Starter为例）：

工程目录结构：

在这里插入图片描述

1、引入项目的配置依赖

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-autoconfigure</artifactId>
 <version>2.1.4.RELEASE</version>
</dependency>

2、创建xxxService类，完成相关的操作逻辑

代码：StringService.java

public class StringService {

 private String str1;

 private String str2;

 private String default_str;

 public String getStr1() {
  return str1;
 }

 public void setStr1(String str1) {
  this.str1 = str1;
 }

 public String getStr2() {
  return str2;
 }

 public void setStr2(String str2) {
  this.str2 = str2;
 }

 public String getDefault_str() {
  return default_str;
 }

 public void setDefault_str(String default_str) {
  this.default_str = default_str;
 }

 public String addStr(){
  if(str1 != null){
   if(str2 != null){
    return str1 + "，" + str2;
   }
   return str1;
  }
  return default_str;
 }

}

3、 定义xxxProperties类，属性配置类，完成属性配置相关的操作，比如设置属性前缀，用于在application.properties中配置

代码：StringProperties.java

//指定项目在属性文件中配置的前缀为str，即可以在属性文件中通过 str.str1=springboot，就可以改变属性类字段 str1 的值了
@SuppressWarnings("ConfigurationProperties")
@ConfigurationProperties(prefix = "str")
public class StringProperties {

 public static final String DEFAULT_STR1 = "I know, you need me";

 public static final String DEFAULT_STR2 = "but I also need you";

 private String str1 = DEFAULT_STR1;

 private String str2 = DEFAULT_STR2;

 public String getStr1() {
  return str1;
 }

 public void setStr1(String str1) {
  this.str1 = str1;
 }

 public String getStr2() {
  return str2;
 }

 public void setStr2(String str2) {
  this.str2 = str2;
 }
}

4、定义xxxConfigurationProperties类，自动配置类，用于完成Bean创建等工作

代码：StringAutoConfiguration.java

// 定义 java 配置类
@Configuration
//引入StringService
@ConditionalOnClass({StringService.class})
// 将 application.properties 的相关的属性字段与该类一一对应，并生成 Bean
@EnableConfigurationProperties(StringProperties.class)
public class StringAutoConfiguration {

 // 注入属性类
 @Autowired
 private StringProperties stringProperties;

 @Bean
 // 当容器没有这个 Bean 的时候才创建这个 Bean
 @ConditionalOnMissingBean(StringService.class)
 public StringService helloworldService() {
  StringService stringService = new StringService();
  stringService.setStr1(stringProperties.getStr1());
  stringService.setStr2(stringProperties.getStr2());
  return stringService;
 }

}

5、在resources下创建目录META-INF，在 META-INF 目录下创建 spring.factories，在SpringBoot启动时会根据此文件来加载项目的自动化配置类

代码：spring.factories

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.lhf.springboot.config.StringAutoConfiguration

6、到这里自定义Starter就定义完成了，只需在其他项目中引入即可使用。

二、其他项目中使用自定义的Starter

1、在新项目中引入自定义Starter依赖配置

创建一个新的SpringBoot项目，在项目的pom.xml文件中引入自定义SpringBoot Starter的依赖配置如下：

<!--引入自定义Starter-->
<dependency>
 <groupId>com.lhf.springboot</groupId>
 <artifactId>spring-boot-starter-string</artifactId>
 <version>0.0.1-SNAPSHOT</version>
</dependency>

2、编写一个简单的Controller

@RestController
public class StringController {

  @Autowired
 private StringService stringService; //引入自定义Starter中的StringService

 @RequestMapping("/")
  public String addString(){
  return stringService.addStr();
 }
}

3、编写属性配置文件，内容如下：

#配置自定义的属性信息
str.str1=为什么我的眼里常含泪水
str.str2=那是因为我对你爱的深沉

4、启动项目进行访问，效果如图：

在这里插入图片描述
在这里插入图片描述

结语：

到此这篇关于使用SpringBoot自定义starter的文章就介绍到这了,更多相关SpringBoot自定义starter内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • Java Arrays工具类用法详解

    Java Arrays工具类用法详解

    这篇文章主要介绍了Java Arrays工具类用法,结合实例形式分析了java Arrays工具类针对数组元素修改、复制、排序等操作使用技巧与相关注意事项,需要的朋友可以参考下
    2019-05-05
  • SpringBoot application.yml配置文件使用及说明

    SpringBoot application.yml配置文件使用及说明

    本文详细介绍了SpringBoot application.yml 配置文件的使用和配置项,包括创建 application.yml 文件、配置数据源、数据库、缓存、邮件服务等,适合希望深入了解SpringBoot配置文件的开发者阅读
    2025-12-12
  • Java中@InitBinder注解的使用原理详解

    Java中@InitBinder注解的使用原理详解

    这篇文章主要介绍了Java中@InitBinder注解的使用原理详解,在Java中,@InitBinder 注解是用于标记一个方法,该方法将在控制器(Controller)处理请求之前被调用,用于进行一些数据绑定和预处理的操作,需要的朋友可以参考下
    2023-10-10
  • java求最大公约数与最小公倍数的方法示例

    java求最大公约数与最小公倍数的方法示例

    这篇文章主要介绍了java求最大公约数与最小公倍数的方法,涉及java数值运算的相关操作技巧,并附带分析了eclipse环境下设置运行输入参数的相关操作技巧,需要的朋友可以参考下
    2017-11-11
  • jedispool连redis高并发卡死的问题

    jedispool连redis高并发卡死的问题

    本篇文章主要介绍了jedispool连redis高并发卡死的问题，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2018-03-03
  • java使用内存数据库ssdb的步骤

    java使用内存数据库ssdb的步骤

    这篇文章主要介绍了java使用内存数据库ssdb的步骤，帮助大家更好的理解和使用Java，感兴趣的朋友可以了解下
    2020-12-12
  • 详解java实现简单扫码登录功能(模仿微信网页版扫码)

    详解java实现简单扫码登录功能(模仿微信网页版扫码)

    这篇文章主要介绍了java实现简单扫码登录功能(模仿微信网页版扫码)，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2019-05-05
  • 使用IDEA搭建SSM框架的详细教程(spring + springMVC +MyBatis)

    使用IDEA搭建SSM框架的详细教程(spring + springMVC +MyBatis)

    这篇文章主要介绍了使用IDEA搭建SSM框架的详细教程 spring + springMVC +MyBatis,本文通过图文并茂的形式给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2020-05-05
  • Java设计模式之Adapter适配器模式

    Java设计模式之Adapter适配器模式

    这篇文章主要为大家详细介绍了Java设计模式之Adapter适配器模式，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2018-03-03
  • Java集合WeakHashMap源码分析

    Java集合WeakHashMap源码分析

    这篇文章主要介绍了Java集合WeakHashMap源码分析,和HashMap一样,WeakHashMap 也是一个散列表,它存储的内容也是键值对(key-value)映射,而且键和值都可以是null,需要的朋友可以参考下
    2023-09-09

最新评论