1.引入依赖
<?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">
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.6.RELEASE</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>com.d4c.study</groupId>
<artifactId>starter-demo-spring-boot-starter</artifactId>
<version>1.0.0.RELEASE</version>
<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-autoconfigure</artifactId>
</dependency>
</dependencies>
</project>
因为是spring Boot启动器,所以要指定parent为:
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.6.RELEASE</version>
</parent>
spring-boot-configuration-processor
spring-boot-configuration-processor的作用是编译时生成 spring-configuration-metadata.json ,此文件主要给IDE使用。如当配置此jar相关配置属性在 application.yml ,你可以用ctlr+鼠标左键点击属性名,IDE会跳转到你配置此属性的类中。
我们日常使用的Spring官方的Starter一般采取spring-boot-starter-{name} 的命名方式,如 spring-boot-starter-web 。
而非官方的Starter,官方建议 artifactId 命名应遵循{name}-spring-boot-starter 的格式。 例如:mybatis-spring-boot-starter 。
spring-boot-autoconfigure
spring-boot-autoconfigure主要是要用到其中的一些注解
2.定义属性类,用于读取,接受配置文件中的值
package com.d4c.starter.autoconfigure;
import org.springframework.boot.context.properties.ConfigurationProperties;
@ConfigurationProperties("simple.string")
public class SimpleProperties {
private String value;
public String getValue() {
return value;
}
public void setValue(String value) {
this.value = value;
}
}
@ConfigurationProperties与@EnableConfigurationProperties配合使用,实现了配置文件的读取,与引入。
3.定义功能实现类
package com.d4c.starter.autoconfigure;
public class StringResolvedBean {
private String config;
public StringResolvedBean(String config) {
this.config = config;
}
public String[] split(String separatorChar) {
return config.split(separatorChar);
}
}
4.自动配置类
package com.d4c.starter.autoconfigure;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
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;
@Configuration
@ConditionalOnClass(StringResolvedBean.class)
@EnableConfigurationProperties(SimpleProperties.class)
public class SimpleStringAutoConfiguration {
@Bean
@ConditionalOnMissingBean
@ConditionalOnProperty(prefix = "simple.string", value = "enabled", havingValue = "true")
StringResolvedBean starterInit(SimpleProperties simpleProperties) {
return new StringResolvedBean(simpleProperties.getValue());
}
}
4.1 有关条件的注解
@ConditionalOnBean:当容器中有指定的Bean的条件下
@ConditionalOnClass:当类路径下有指定的类的条件下
@ConditionalOnExpression:基于SpEL表达式作为判断条件
@ConditionalOnJava:基于JVM版本作为判断条件
@ConditionalOnJndi:在JNDI存在的条件下查找指定的位置
@ConditionalOnMissingBean:当容器中没有指定Bean的情况下
@ConditionalOnMissingClass:当类路径下没有指定的类的条件下
@ConditionalOnNotWebApplication:当前项目不是Web项目的条件下
@ConditionalOnProperty:指定的属性是否有指定的值
@ConditionalOnResource:类路径下是否有指定的资源
@ConditionalOnSingleCandidate:当指定的Bean在容器中只有一个,或者在有多个Bean的情况下,用来指定首选的Bean @ConditionalOnWebApplication:当前项目是Web项目的条件下
5.创建spring.factories
在resources/META-INF/下创建spring.factories文件,并添加如下内容:
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.d4c.starter.autoconfigure.SimpleStringAutoConfiguration
6.项目路径参考
image.png7.打包到本地仓库
#切到项目根目录,执行mvn命令
mvn install
8.其他本地项目就可以maven dependency引入了
<dependency>
<groupId>com.d4c.study</groupId>
<artifactId>starter-demo-spring-boot-starter</artifactId>
<version>1.0.0.RELEASE</version>
</dependency>
application.yml
server:
port: 6011
simple:
string:
enabled: true
value: 12,aa,bb,cc
网友评论