SpringBoot自定义Starter

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


	org.springframework.boot
	spring-boot-starter-data-redis

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

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

 SpringBoot自定义Starter_第1张图片

 SpringBoot自定义Starter_第2张图片

SpringBoot自定义Starter_第3张图片

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




  
    org.springframework.boot
    spring-boot-starter-parent
    2.0.0.RELEASE
    
  

  4.0.0

  com.autumn.starter
  admin-starter
  1.0-SNAPSHOT
  pom

  
    admin-starter-redis
  
  

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

SpringBoot自定义Starter_第4张图片

SpringBoot自定义Starter_第5张图片

SpringBoot自定义Starter_第6张图片

SpringBoot自定义Starter_第7张图片

SpringBoot自定义Starter_第8张图片

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



	4.0.0

	com.autumn.starter
	admin-starter-redis
	0.0.1-SNAPSHOT

	
		com.autumn.starter
	    admin-starter
	    1.0-SNAPSHOT
	

	
		UTF-8
		1.8
		1.8
	

	

		
		
			org.springframework.boot
			spring-boot-starter
		

		
		
			redis.clients
			jedis
		

	


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

SpringBoot自定义Starter_第9张图片   

    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目录的话,手动创建一个

SpringBoot自定义Starter_第10张图片

SpringBoot自定义Starter_第11张图片

SpringBoot自定义Starter_第12张图片

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

SpringBoot自定义Starter_第13张图片

SpringBoot自定义Starter_第14张图片

SpringBoot自定义Starter_第15张图片

SpringBoot自定义Starter_第16张图片

SpringBoot自定义Starter_第17张图片

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

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

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

SpringBoot自定义Starter_第18张图片

 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);
	}
}

 

 

 

你可能感兴趣的:(SpringBoot)