SpringBoot自定义Starter

       在没接触SpringBoot之前，比如我们要操作一个redis缓存数据库，我们搭建一个spring-mvc的maven工程，我们需要在pom文件中引用jedis，还要对jedis进行相关配置，但使用了SpringBoot只需在pom文件写入这段就可以操作redis了

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

好奇的朋友会觉得这东西很神奇，我jedis都没看到它在哪里引用的，这东西怎么实现的呢？接下来我们来自定义一个starter来操作redis

1. 首先我们搭建一个Maven项目工程

 

 

  为了方便后面的操作，我们把这个项目工程的pom->parent修改一下，这个记得加一下

<?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.0.0.RELEASE</version>
    <relativePath></relativePath>
  </parent>

  <modelVersion>4.0.0</modelVersion>

  <groupId>com.autumn.starter</groupId>
  <artifactId>admin-starter</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>pom</packaging>

  <modules>
    <module>admin-starter-redis</module>
  </modules>
  
</project>

   2.项目创建成功后，接下来我们再来创建子模块，我这边取名叫 adminstarter-redis

   4.接下来我们在adminstarter-redis子项目的pom文件中引入东西

<?xml version="1.0"?>
<project
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
	xmlns="http://maven.apache.org/POM/4.0.0"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<modelVersion>4.0.0</modelVersion>

	<groupId>com.autumn.starter</groupId>
	<artifactId>admin-starter-redis</artifactId>
	<version>0.0.1-SNAPSHOT</version>

	<parent>
		<groupId>com.autumn.starter</groupId>
	    <artifactId>admin-starter</artifactId>
	    <version>1.0-SNAPSHOT</version>
	</parent>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<maven.compiler.source>1.8</maven.compiler.source>
		<maven.compiler.target>1.8</maven.compiler.target>
	</properties>

	<dependencies>

		<!-- boot starter -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter</artifactId>
		</dependency>

		<!-- redis -->
		<dependency>
			<groupId>redis.clients</groupId>
			<artifactId>jedis</artifactId>
		</dependency>

	</dependencies>

</project>

  5.adminstarter-redis子项目的pom文件写好后，接下来我们RedisProperties.java 和 RedisAutoConfiguration.java两个类

   

    5-1:RedisProperties这个类主要是用来保存redis配置信息用的，我们因为是案例，我们就定义简单一点

@ConfigurationProperties(prefix = "redis")

public class RedisProperties {

	private String host;
	
	private int port;

	private String password;

	public String getHost() {
		return host;
	}

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

	public int getPort() {
		return port;
	}

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

	public String getPassword() {
		return password;
	}

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

   5-2:RedisAutoConfiguration类定义如下

  

@Configuration //开启配置
@ConditionalOnClass(Jedis.class)
@EnableConfigurationProperties(RedisProperties.class) //开启使用映射实体对象
@ConditionalOnProperty//存在对应配置信息时初始化该配置类
        (
                prefix = "redis",//存在配置前缀redis
                value = "enabled",//开启
                matchIfMissing = true//缺失检查
        )
public class RedisAutoConfiguration {

    @Bean
    @ConditionalOnMissingBean
    public Jedis jedis(RedisProperties redisProperties) {
        Jedis jedis = new Jedis(redisProperties.getHost(), redisProperties.getPort());
        jedis.auth(redisProperties.getPassword());
        return jedis;
    }

}

  6:接下来我们在resources工程中添加META-INF/spring.factories，如果发现adminstarter-redis没有resources目录的话，手动创建一个

 7：接下来创建META-INF/spring.factories文件，并在文件中指定加载类

8：在spring.factories文件中配置启动加载类

org.springframework.boot.autoconfigure.EnableAutoConfiguration=org.admin.starter.redis.RedisAutoConfiguration

 9：好了一个starter定义完成了，接下来我们测试一下，同样在项目中建立一个子项目来测试我们的starter

 11：测试环境搭建好后，后在配置文件配置redis信息

#redis 
redis.host= #
redis.port=6379
redis.password= #

 

 

12：然后我们创建一个测试类

@SpringBootTest(classes = AdminStarterApplication.class)
@RunWith(SpringRunner.class)
public class RedisTestUtil {

	@Autowired
	private Jedis jedis;

	@Test
	public void writeStringTest() {
		jedis.set("chenshimin", UUID.randomUUID().toString());
		String value = jedis.get("chenshimin");
		System.out.println(value);
	}
}