SpringBoot中如何自定义starter及其使用
本文主要讲解关于SpringBoot中如何自定义starter及其使用相关内容,让我们来一起学习下吧!
下面以创建一个连接redis的插件为例:
1.创建自动配置类RedissonAutoConfiguration
创建自动配置类,在类中配置一个需要用到的bean:RedissonClient,将该对象注入到容器中
package com.bobo.redisson; import org.redisson.Redisson; import org.redisson.api.RedissonClient; import org.redisson.config.Config; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @ConditionalOnClass(Redisson.class) // 条件注解 @EnableConfigurationProperties(RedissonProperties.class) @Configuration public class RedissonAutoConfiguration { /** * RedissonClient:操作Redis的核心对象 * 将该对象注入到容器中 * 需要连接Redis 服务, host port * @return */ @Bean public RedissonClient redissonClient(RedissonProperties redissonProperties){ Config config = new Config(); String prefix = "redis://"; if(redissonProperties.isSsl()){ prefix = "rediss://"; } config.useSingleServer() .setAddress(prefix+redissonProperties.getHost()+":"+redissonProperties.getPort()) .setTimeout(redissonProperties.getTimeout()); return Redisson.create(config); } }
2.在spring.factories文件中添加自动装配类
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.bobo.redisson.RedissonAutoConfiguration
3.添加yml/poperties配置文件提示
在META-INF下的additional-spring-configuration-metadata.json
文件中添加
{ "properties": [{ "name": "bobo.redisson.host", "type": "java.lang.String", "description": "Redis的服务地址", "defaultValue": "localhost" },{ "name": "bobo.redisson.port", "type": "java.lang.Integer", "description": "Redis的服务端口", "defaultValue": 6379 }] }
配置了这个json后,在配置文件中配置对应的属性时,会有提示。
说明:这个步骤可以没有,只是为了方便开发,对开发者更友好,增强易用性。
4.使用starter
在另一个需要用到RedissionClient的项目中,引入对应的jar包依赖
<dependency> <groupId>com.bobo.redission</groupId> <artifactId>redisson-spring-boot-starter</artifactId> <version>1.0-SNAPSHOT</version> </dependency>
在application.properties文件中就可以配置对应的redis连接参数了,而且配置过程中会有对应的提示。
server.port=8090 bobo.redisson.host=192.168.56.100 bobo.redisson.port=6379 bobo.redisson.ssl=false
在需要引用RedissionClient的地方依赖注入bean对象,就可以使用了。
@RestController public class UserController { @Autowired private RedissonClient redissonClient; @GetMapping("/query") public String query(){ return "key的个数="+redissonClient.getKeys().count()+""; } }
以上就是关于SpringBoot中如何自定义starter及其使用相关的全部内容,希望对你有帮助。欢迎持续关注潘子夜个人博客(www.frpkj.com),学习愉快哦!