springboot自定义starter方法及注解实例

 更新时间:2022年08月03日 14:43:53   作者:索码理  
这篇文章主要为大家介绍了springboot自定义starter方法详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

SpringBoot starter

用了springboot 那么久了居然都还没自定义过starter,想想都觉得羞愧,所以今天来玩一下。

SpringBoot中的starter是一种非常重要的机制,能够抛弃以前繁杂的配置,将其统一集成进starter,应用者只需要在maven中引入starter依赖,SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置。starter让我们摆脱了各种依赖库的处理,需要配置各种信息的困扰。

SpringBoot会自动通过classpath路径下的类发现需要的Bean,并注册进IOC容器。SpringBoot提供了针对日常企业应用研发各种场景的spring-boot-starter依赖模块。所有这些依赖模块都遵循着约定成俗的默认配置,并允许我们调整这些配置,即遵循“约定大于配置”的理念。

自定义starter

日常工作中有时有一些独立于业务之外的功能或模块,可能这个项目在用,另一个项目也要用,如果每次都重新集成的话就会很麻烦,这时我们只要把这些功能或模块封装成一个个starter的话,在使用的时候引入进去就很方便了。

自定义starter步骤

其实自定义starter很简单,大致需要以下5步:

  • 新建两个模块,命名规范: springboot自带的starter命名规范为spring-boot-starter-xxx, 自定义的starter命名规范为xxx-spring-boot-starter

 xxx-spring-boot-autoconfigure:自动配置核心代码

 xxx-spring-boot-starter:管理依赖

如果不需要将自动配置代码和依赖项管理分离开来,则可以将它们组合到一个模块中。只不过springboot

官方建议将两个模块分开。

  • 2. 引入spring-boot-autoconfigure依赖
  • 3. 创建自定义的XXXProperties 类: 这个类的属性根据需要是要出现在配置文件中的。
  • 4. 创建自定义的XXXAutoConfiguration类:这个类要配置自动配置时的一些逻辑,同时也要让XXXProperties 类生效。
  • 5. 创建自定义的spring.factories文件:在resources/META-INF创建一个spring.factories文件和spring-configuration-metadata.json,spring-configuration-metadata.json文件是用于在填写配置文件时的智能提示,可要可不要,有的话提示起来更友好。spring.factories用于导入自动配置类,必须要有

实现

我这里为了方便就只创建一个模块了,

  • 创建一个模块,命名为spring-boot-starter-myStarter,对应pom文件
	<groupId>com.example</groupId>
	<artifactId>spring-boot-starter-myStarter</artifactId>
	<version>1.0</version>
	<name>my-starter</name>
  • 引入spring-boot-autoconfigure依赖 我这里使用的spring-boot-autoconfigure版本是2.6.2
	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-autoconfigure</artifactId>
			<version>2.6.2</version>
		</dependency>
	</dependencies>
  • 创建自定义的XXXProperties 类
@ConfigurationProperties(prefix = "com.arron")
public class MyStarterProperties {
    private String name;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}

再创建一个MyStarterConfig用于读取MyStarterProperties 里的属性

public class MyStarterConfig {
    private MyStarterProperties myStarterProperties;
    private String name;
    public MyStarterConfig(MyStarterProperties myStarterProperties) {
        this.myStarterProperties = myStarterProperties;
    }
    public String getName() {
        return myStarterProperties.getName();
    }
    public void setName(String name) {
        this.name = name;
    }
}
  • 创建自定义的XXXAutoConfiguration类
@Configuration
// EnableConfigurationProperties value数组中的配置类起作用
@EnableConfigurationProperties(value = {MyStarterProperties.class})
public class MyStarterAutoConfiguration {
    @Autowired
    private MyStarterProperties myStarterProperties;
    @Bean
    @ConditionalOnMissingBean(MyStarterConfig.class)
    public MyStarterConfig myStarterConfig(){
        return new MyStarterConfig(myStarterProperties);
    }
}
  • 在resources/META-INF创建一个spring.factories文件

spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.example.myStarter.MyStarterAutoConfiguration

spring-configuration-metadata.json

{
  "group": [
    {
      "name": "com.arron",
      "type": "com.example.myStarter.MyStarterProperties",
      "sourceType": "com.example.myStarter.MyStarterProperties"
    }
  ],
  "properties": [
    {
      "name": "com.arron.name",
      "type": "java.lang.String",
      "description": "my start name",
      "sourceType": "com.example.myStarter.MyStarterProperties",
      "defaultValue": "MyStarterProperties name"
    }
  ]
}

打包测试

找到如图maven,点击install,安装到本地

然后新建一个项目导包进行测试,创建项目过程就不介绍了。

  • 引入依赖
	<dependency>
       <groupId>com.example</groupId>
       <artifactId>spring-boot-starter-myStarter</artifactId>
       <version>1.0</version>
   </dependency>
  • 配置文件添加属性:
com:
  arron:
    name: myname
  • 单元测试:
@RunWith(SpringRunner.class)
@SpringBootTest
class RabbitmqApplicationTests {
    @Autowired
    private MyStarterConfig myStarterConfig;
    @Test
    public void testMyStarter(){
        String name = myStarterConfig.getName();
        System.out.println(name);
    }
}

控制台输出:

myname

至此,一个简单自定义的springboot starter就完成了。

注解解释

下面这些注解在自定义starter是可能会用到。

  • @Conditional:按照一定的条件进行判断,满足条件给容器注册bean
  • @ConditionalOnMissingBean:给定的在bean不存在时,则实例化当前Bean
  • @ConditionalOnProperty:配置文件中满足定义的属性则创建bean,否则不创建
  • @ConditionalOnBean:给定的在bean存在时,则实例化当前Bean
  • @ConditionalOnClass: 当给定的类名在类路径上存在,则实例化当前Bean
  • @ConditionalOnMissingClass :当给定的类名在类路径上不存在,则实例化当前Bean

以上就是springboot自定义starter方法详解的详细内容,更多关于springboot自定义starter的资料请关注脚本之家其它相关文章!

相关文章

  • maven打包失败踩坑的解决方式详解

    maven打包失败踩坑的解决方式详解

    最近因为新项目有很多自定义的jar包,而且占内存很多,就直接拷贝过来,新开了一个maven仓库,用的时候没有问题,但是打包一直编译不通过,下面这篇文章主要给大家介绍了关于maven打包失败踩坑的解决方式,需要的朋友可以参考下
    2023-05-05
  • Hystrix Turbine聚合监控的实现详解

    Hystrix Turbine聚合监控的实现详解

    微服务架构下,⼀个微服务往往部署多个实例,如果每次只能查看单个实例的监控,就需要经常切换很不⽅便,在这样的场景下,我们可以使⽤ Hystrix Turbine 进⾏聚合监控,它可以把相关微服务的监控数据聚合在⼀起,便于查看
    2022-09-09
  • Java Web请求与响应实例详解

    Java Web请求与响应实例详解

    这篇文章主要介绍了Java Web请求与响应实例详解的相关资料,需要的朋友可以参考下
    2016-05-05
  • ZooKeeper入门教程三分布式锁实现及完整运行源码

    ZooKeeper入门教程三分布式锁实现及完整运行源码

    本文是ZooKeeper入门系列教程,分布式锁有多种实现方式,比如通过数据库、redis都可实现。作为分布式协同工具ZooKeeper,当然也有着标准的实现方式。本文介绍在zookeeper中如何实现排他锁
    2022-01-01
  • Java面试之如何实现10亿数据判重

    Java面试之如何实现10亿数据判重

    当数据量比较大时,使用常规的方式来判重就不行了,所以这篇文章小编主要来和大家介绍一下Java实现10亿数据判重的相关方法,希望对大家有所帮助
    2024-02-02
  • Java中Base64加密解密举例详解

    Java中Base64加密解密举例详解

    Base64编码是我们程序开发中经常使用到的编码方法,它是一种基于用64个可打印字符来表示二进制数据的表示方法,这篇文章主要给大家介绍了关于Java中Base64加密解密的相关资料,需要的朋友可以参考下
    2024-05-05
  • Java实现合并两个word文档内容

    Java实现合并两个word文档内容

    这篇文章主要为大家详细介绍了如何使用Java实现合并两个word文档内容,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2024-11-11
  • Java的Object类九个方法技巧

    Java的Object类九个方法技巧

    这篇文章主要介绍了Java的Object类九个方法技巧,Java的Object 类的完整路径是java.lang.Object ,是所有类的父类编译,下文相关资料,需要的朋友可以参考一下
    2022-04-04
  • Java数组操作的10大方法

    Java数组操作的10大方法

    下面是精心整理的Java数组操作的10大方法,大部分代码都来自Stack Overflow,需要的朋友可以参考下
    2014-09-09
  • IDEA中查看类继承图和类源码的骚操作

    IDEA中查看类继承图和类源码的骚操作

    这篇文章主要介绍了IDEA中查看类继承图和类源码的骚操作,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-02-02

最新评论