springboot自定义Starter的具体流程
程序员文章站
2023-11-18 17:52:52
自定义starter命名规则
注意artifactid的命名规则,spring官方starter通常命名为spring-boot-starter-{name}如 sp...
自定义starter命名规则
注意artifactid的命名规则,spring官方starter通常命名为spring-boot-starter-{name}如 spring-boot-starter-web, spring官方建议非官方starter命名应遵循{name}-spring-boot-starter的格式, 如mybatis-spring-boot-starter。这里创建的项目的artifactid为helloworld-spring-boot-starter
开发starter步骤
- 创建starter项目
- 定义starter需要的配置(properties)类
- 编写自动配置类
- 编写spring.factories文件加载自动配置类
- 编写配置提示文件spring-configuration-metadata.json(不是必须的)
具体流程
创建配置类
@configurationproperties 来定义配置的前缀
@enableconfigurationproperties(influxdbproperties.class) @configurationproperties(prefix = "spring.influxdb") public class influxdbproperties { private string username; public string getdatabase() { return database; } public void setdatabase(string database) { this.database = database; } }
编写自动配置类
- @enableconfigurationproperties配置依赖的属性类
- @conditionalonproperty 配置configuration的加载规则
- value 指的是properties的哪个字段
- havingvalue指的是配置value是什么值的时候加载configuration
- matchifmissing 指的是当value配置的字段没有配置时的默认值
- @bean 配置自动注入的bean
- springboot特有的常见的条件依赖注解有:
- @conditionalonbean,仅在当前上下文中存在某个bean时,才会实例化这个bean。
- @conditionalonclass,某个class位于类路径上,才会实例化这个bean。
- @conditionalonexpression,当表达式为true的时候,才会实例化这个bean。
- @conditionalonmissingbean,仅在当前上下文中不存在某个bean时,才会实例化这个bean。
- @conditionalonmissingclass,某个class在类路径上不存在的时候,才会实例化这个bean。
- @conditionalonnotwebapplication,不是web应用时才会实例化这个bean。
- @autoconfigureafter,在某个bean完成自动配置后实例化这个bean。
- @autoconfigurebefore,在某个bean完成自动配置前实例化这个bean。
@configuration @order(1) @enableconfigurationproperties(influxdbproperties.class) @conditionalonclass(influxdbproperties.class) @conditionalonproperty(prefix = "spring.influxdb", value = "use-influxdb", havingvalue="true" ,matchifmissing = false) public class influxdbautoconfiguration { private string scanentitysuffix = "entity.class"; @bean @conditionalonmissingbean(aiinfluxdbtemplate.class) @order(ordered.highest_precedence) public aiinfluxdbtemplate aiinfluxdbtemplate(influxdbproperties influxdbproperties){ return new aiinfluxdbtemplate(influxdbproperties); } }
编写spring.factories文件
spring boot会默认扫描跟启动类平级的包,如果我们的starter跟启动类不在同一个主包下,需要通过配置spring.factories文件来生效
org.springframework.boot.autoconfigure.enableautoconfiguration=\ com.ai.base.boot.influxdb.influxdbautoconfiguration
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。
下一篇: java 判断list是否为空过程解析
推荐阅读
-
ThinkPad无线不能用无法连接无线网络的具体排查流程图解
-
springboot读取自定义配置文件节点的方法
-
springboot中使用自定义两级缓存的方法
-
SpringBoot入坑笔记之spring-boot-starter-web 配置文件的使用
-
springboot读取自定义配置文件节点的方法
-
SpringBoot入坑笔记之spring-boot-starter-web 配置文件的使用
-
浅谈SpringBoot 中关于自定义异常处理的套路
-
SpringBoot封装自己的Starter的实现方法
-
在SpringBoot下读取自定义properties配置文件的方法
-
项目中SSM增删改查的具体流程