spring boot中如何自定义一个starter？

我们可以通过创建一个简单的 Redis Starter 来演示自定义 Spring Boot Starter 的过程。这个 Starter 将自动配置一个 Redis 客户端，使得引入 Starter 后可以方便地使用 Redis 服务。 ### 1. 创建一个新的 Maven 项目 创建一个新的 Maven 项目，命名为 `my-redis-starter`。在 `pom.xml` 中加入以下依赖： ```xml <project xmlns="http://maven.apache.org/POM/4.0.0" ...> <modelVersion>4.0.0</modelVersion> <groupId>com.example</groupId> <artifactId>my-redis-starter</artifactId> <version>0.0.1-SNAPSHOT</version> <dependencies> <!-- 基础依赖 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-autoconfigure</artifactId> <version>${spring-boot.version}</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <!-- Redis 客户端 --> <dependency> <groupId>redis.clients</groupId> <artifactId>jedis</artifactId> <version>4.3.1</version> </dependency> </dependencies> </project> ``` ### 2. 编写 Redis 配置属性类 为了使 Starter 更加灵活，我们定义一个 `RedisProperties` 类来配置 Redis 相关的属性： ```java package com.example.redisstarter; import org.springframework.boot.context.properties.ConfigurationProperties; @ConfigurationProperties(prefix = "custom.redis") public class RedisProperties { private String host = "localhost"; private int port = 6379; 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; } } ``` ### 3. 创建自动配置类 在自动配置类 `RedisAutoConfiguration` 中配置 Jedis 连接 Redis 的客户端实例： ```java package com.example.redisstarter; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import redis.clients.jedis.Jedis; @Configuration @EnableConfigurationProperties(RedisProperties.class) public class RedisAutoConfiguration { private final RedisProperties redisProperties; public RedisAutoConfiguration(RedisProperties redisProperties) { this.redisProperties = redisProperties; } @Bean @ConditionalOnMissingBean public Jedis jedisClient() { return new Jedis(redisProperties.getHost(), redisProperties.getPort()); } } ``` 在 `RedisAutoConfiguration` 中，我们使用了 `@EnableConfigurationProperties` 来启用 `RedisProperties`。然后定义一个 `jedisClient` Bean，该 Bean 会自动连接到配置的 Redis 服务器。 ### 4. 注册 `spring.factories` 创建 `resources/META-INF/spring.factories` 文件，将自动配置类注册进去，这样 Spring Boot 启动时可以自动加载这个配置： ```properties org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ com.example.redisstarter.RedisAutoConfiguration ``` ### 5. 使用自定义 Redis Starter 现在，在需要使用此 Starter 的项目中引入依赖，并进行配置： ```xml <dependency> <groupId>com.example</groupId> <artifactId>my-redis-starter</artifactId> <version>0.0.1-SNAPSHOT</version> </dependency> ``` 在应用的 `application.yml` 或 `application.properties` 文件中配置 Redis 的连接信息： ```yaml custom: redis: host: "localhost" port: 6379 ``` 然后，在项目代码中可以直接注入 `Jedis` 来使用 Redis： ```java import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.CommandLineRunner; import org.springframework.stereotype.Component; import redis.clients.jedis.Jedis; @Component public class RedisDemoApplication implements CommandLineRunner { @Autowired private Jedis jedis; @Override public void run(String... args) { // 测试连接 Redis jedis.set("spring-boot-starter", "Hello from custom Redis Starter"); System.out.println("Redis Value: " + jedis.get("spring-boot-starter")); } } ``` ### 总结 通过以上步骤，我们实现了一个简单的 Redis Starter，帮助项目自动配置 Jedis 客户端来连接 Redis。