写点什么

手写一个简单的 SpringBoot Starter

用户头像
赵镇
关注
发布于: 4 小时前

现在各种自定义的 starter 屡见不鲜,也许就需要自己来自定义一个 starter 了。学习一下 starter 的构建必备

starter-定义

首先需要自顶一个配置 bean


package com.zhao.starter;
import org.springframework.boot.context.properties.ConfigurationProperties;import org.springframework.boot.context.properties.EnableConfigurationProperties;
@EnableConfigurationProperties(StarterBean.class)@ConfigurationProperties(prefix = "starterbean")public class StarterBean {
private String id; private String name;
public String getId() { return id; }
public void setId(String id) { this.id = id; }
public String getName() { return name; }
public void setName(String name) { this.name = name; }
@Override public String toString() { return "StarterBean{" + "id='" + id + '\'' + ", name='" + name + '\'' + '}'; }}
复制代码


然后需要通过 Springboot 自动注入的注解,以及 Spring spi 的 spring.factories 将配置 bean 加入自动配置的管理


@Configuration@ConditionalOnClasspublic class StartBeanAutoConfiguration {    static {        System.out.println("custom auto configuration init ");    }    @Bean    public StarterBean starterBean(){        return  new StarterBean();    }}
复制代码


资源目录下新建 META-INF 文件夹下 spring.factories 文件,


org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.zhao.starter.StartBeanAutoConfiguration
复制代码


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"         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>
<groupId>com.zhao</groupId> <artifactId>starter-demo</artifactId> <version>1.0-SNAPSHOT</version> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-autoconfigure</artifactId> <version>2.2.2.RELEASE</version> </dependency> </dependencies>
</project>
复制代码


使用 maven install 之后就可以在新建项目时使用了。

starter 使用测试

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"         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>
<groupId>com.zhao</groupId> <artifactId>starter-use-demo</artifactId> <version>1.0-SNAPSHOT</version> <dependencies> <dependency> <groupId>com.zhao</groupId> <artifactId>starter-demo</artifactId> <version>1.0-SNAPSHOT</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <version>2.2.2.RELEASE</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <version>2.2.2.RELEASE</version> <scope>test</scope> </dependency> </dependencies>
</project>
复制代码


启动类


@SpringBootApplicationpublic class StarterUseApplication {    public static void main(String[] args) {        SpringApplication.run(StarterUseApplication.class,args);    }}
复制代码


配置 starter 需要的 bean 的配置


starterbean.id=test123starterbean.name=zhaozhen
复制代码


测试类


@RunWith(SpringRunner.class)@SpringBootTest(classes = StarterUseApplication.class)public class StarterUseTest {    @Autowired    StarterBean starterBean;    @Test    public void starUse(){        System.out.println(starterBean);    }}
复制代码


测试结果,正常使用



用户头像

赵镇

关注

还未添加个人签名 2017.12.20 加入

还未添加个人简介

评论

发布
暂无评论
手写一个简单的SpringBoot Starter