SpringBoot中自定义starter实现

前言

📢 本篇博客主要分享在SpringBoot中如何自定义starter，实现我们的通用组件、架构，供其它项目使用

下面通过模拟实现redis的功能来自定义start

一、实现自定义starter

1、新建SpringBoot项目，引入依赖

<dependencies>
    
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-autoconfigure</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-configuration-processor</artifactId>
        <optional>true</optional>
    </dependency>
</dependencies>

2、定义属性类

@ConfigurationProperties(prefix = "forlan.redis")
public class ForlanRedisProperties {

	private int database = 0;
	private String host = "localhost";
	private String password;
	private int port = 6379;

	public int getDatabase() {
		return database;
	}

	public void setDatabase(int database) {
		this.database = database;
	}

	public String getHost() {
		return host;
	}

	public void setHost(String host) {
		this.host = host;
	}

	public String getPassword() {
		return password;
	}

	public void setPassword(String password) {
		this.password = password;
	}

	public int getPort() {
		return port;
	}

	public void setPort(int port) {
		this.port = port;
	}
}

3、定义配置类（重点）

@Configuration
@ConditionalOnClass(value = Jedis.class)
@EnableConfigurationProperties(ForlanRedisProperties.class)
public class ForlanAutoConfiguration {

	@Bean
	@ConditionalOnMissingBean
	public Jedis jedis(ForlanRedisProperties forlanRedisProperties) {
		Jedis jedis = new Jedis(forlanRedisProperties.getHost(), forlanRedisProperties.getPort());
		if (StringUtils.isNotBlank(forlanRedisProperties.getPassword())) {
			jedis.auth(forlanRedisProperties.getPassword());
		}
		jedis.select(forlanRedisProperties.getDatabase());
		return jedis;
	}
}

4、定义spring.factories

在resources目录META-INF新建

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
cn.forlan.spring.autoconfigure.ForlanAutoConfiguration

二、使用

1、引入自定义start

<dependencies>
    <!--自定义start-->
    <dependency>
        <groupId>cn.forlan</groupId>
        <artifactId>forlan-redis-start</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>
</dependencies>

2、配置属性文件

#forlan_redis
forlan.redis.database=1
forlan.redis.host=127.0.0.1
forlan.redis.password=
forlan.redis.port=6379

3、测试

SpringBootTest(classes = ForlanTestApplication.class)
@RunWith(SpringRunner.class)
public class RedisTest {

	@Autowired
	private Jedis jedis;

	@Test
	public void testRedis() {
		jedis.set("forlan-redis-start", "测试自定义组件");
	}
}

我们可以查看下redis，发现我们代码set的forlan-redis-start和值已经缓存到redis，到这里就结束了，说明自定义starter没有什么问题

本地:1>get forlan-redis-start
"测试自定义组件"