Spring Boot的自动装配原理以及自定义starter

德哥很ok
107 阅读5分钟

Spring Boot的自动装配是Spring Boot框架中的一个重要特性，它可以自动配置应用程序所需的所有组件和依赖项，从而简化了应用程序的开发和部署过程。这个特性的实现主要是通过Spring Boot的自动配置机制来实现的。下面，我将详细介绍Spring Boot的自动装配原理，并讲解如何开发自定义starter。

948122eae559479c9eaf15cce575b0ff_tplv-obj (1).jpg

Spring Boot的自动装配原理

在Spring Boot中，自动装配是通过条件化配置实现的。条件化配置是指根据应用程序的环境和配置来选择是否需要自动配置某个组件。这个机制的实现依赖于Spring Framework的注解和SPI机制。

Spring Boot中的自动配置主要是通过@Configuration注解实现的，@Configuration注解用于指示Spring容器使用一个类作为配置类，类中的@Bean方法可以用来定义Spring组件。

Spring Boot的自动配置机制通过在classpath中查找META-INF/spring.factories文件来实现。该文件中定义了Spring Boot应用程序所需的所有自动配置类。当应用程序启动时，Spring Boot框架会自动加载并运行这些自动配置类。

在加载自动配置类的过程中，Spring Boot框架会对每个@Configuration注解的类进行解析，并通过条件判断决定是否需要执行该类中的@Bean方法。如果条件满足，则会自动创建该组件，并将其加入到Spring容器中。

Spring Boot的自动配置条件主要由以下几种类型组成：

  1. 配置文件中的属性
  2. 环境变量
  3. 类型安全配置
  4. 类的存在性
  5. Bean的存在性

开发自定义starter

Spring Boot提供了很多已经集成好的starter，如spring-boot-starter-web、spring-boot-starter-data-jpa等，我们也可以开发自定义的starter来集成自己的组件和依赖项。

开发自定义starter的步骤如下：

  1. 创建一个maven项目，命名为xxxx-spring-boot-starter，其中xxxx为组件的名称。
  2. 在项目的pom.xml文件中添加spring-boot-starter-parent依赖，以及spring-boot-starter依赖，用于引入Spring Boot框架和相关组件。
  3. 创建一个自动配置类，该类需要使用@Configuration和@EnableConfigurationProperties注解，并在其中定义需要自动配置的组件。
  4. 在src/main/resources/META-INF/spring.factories文件中添加自动配置类的全限定名。
  5. 创建一个AutoConfigure类，用于提供默认配置。
  6. 创建一个properties文件，用于配置组件的属性。
  7. 发布starter。

下面是一个自定义starter的示例代码：

  • pom.xml
xmlCopy code
<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.example</groupId>
  <artifactId>my-spring-boot-starter</artifactId>
  <version>1.0.0</version>
  • 自动配置类
javaCopy code
@Configuration
@EnableConfigurationProperties(MyProperties.class)
@ConditionalOnClass(MyService.class)
public class MyAutoConfiguration {

    @Autowired
    private MyProperties properties;

    @Bean
    @ConditionalOnMissingBean
    public MyService myService() {
        return new MyService(properties.getMessage());
    }
}

在这个自动配置类中，我们定义了一个MyService组件，并根据MyProperties中的配置信息来创建该组件。@ConditionalOnClass注解用于判断MyService类是否存在，如果不存在则该自动配置类不会生效。@EnableConfigurationProperties注解用于启用MyProperties类中的属性注入。

  • 自动配置类的全限定名添加到spring.factories中

在src/main/resources/META-INF/spring.factories文件中添加以下内容：

Copy code
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.example.my.MyAutoConfiguration
  • AutoConfigure类
javaCopy code
@Configuration
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE)
@ConditionalOnClass(MyService.class)
@EnableConfigurationProperties(MyProperties.class)
public class MyAutoConfigure {

    @Autowired
    private MyProperties properties;

    @Bean
    @ConditionalOnMissingBean
    public MyService myService() {
        return new MyService(properties.getMessage());
    }
}

AutoConfigure类提供了默认配置，并定义了MyService组件的创建。@AutoConfigureOrder注解用于指定自动配置类的加载顺序，@ConditionalOnClass注解用于判断MyService类是否存在，@EnableConfigurationProperties注解用于启用MyProperties类中的属性注入。

  • properties文件

在src/main/resources/application.properties文件中添加以下内容：

Copy code
my.message=Hello World

这里我们定义了一个my.message属性，用于配置MyService组件中的消息。

  • 发布starter

将项目打包成jar文件，上传到maven中央仓库或私有仓库中，就可以供其他开发者使用了。

以上是一个简单的自定义starter的示例，项目开发中可以将Redis、RocketMQ等依赖封装成一个starter，并接入自己的Spring Boot项目中，需要按照以下步骤操作：

编写自动配置类

首先需要编写自动配置类，该类用于配置Redis或RocketMQ等依赖的参数，如连接地址、端口、超时时间等。自动配置类通常继承自Spring Boot提供的AutoConfiguration类，并使用@Configuration注解标注。

以Redis为例，示例代码如下：

javaCopy code
@Configuration
@ConditionalOnClass(RedisTemplate.class)
@EnableConfigurationProperties(MyRedisProperties.class)
public class MyRedisAutoConfiguration {

    private final MyRedisProperties myRedisProperties;

    public MyRedisAutoConfiguration(MyRedisProperties myRedisProperties) {
        this.myRedisProperties = myRedisProperties;
    }

    @Bean
    public RedisConnectionFactory redisConnectionFactory() {
        RedisStandaloneConfiguration config = new RedisStandaloneConfiguration();
        config.setHostName(myRedisProperties.getHost());
        config.setPort(myRedisProperties.getPort());
        config.setPassword(myRedisProperties.getPassword());
        config.setDatabase(myRedisProperties.getDatabase());
        return new LettuceConnectionFactory(config);
    }

    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
        RedisTemplate<String, Object> template = new RedisTemplate<>();
        template.setConnectionFactory(redisConnectionFactory);
        template.setKeySerializer(new StringRedisSerializer());
        template.setValueSerializer(new GenericJackson2JsonRedisSerializer());
        template.afterPropertiesSet();
        return template;
    }
}

编写properties文件

接下来需要编写配置文件，该文件用于配置Redis或RocketMQ等依赖的属性，如连接地址、端口、超时时间等。配置文件通常使用.properties或.yml文件格式，示例代码如下：

Copy code
my.redis.host=localhost
my.redis.port=6379
my.redis.timeout=5000
my.redis.password=
my.redis.database=0

将自动配置类和properties文件打包成jar包

将自动配置类和properties文件打包成jar包，以供其他项目使用。可以使用Maven或Gradle等构建工具进行打包。

在其他项目中引入自定义starter

在其他Spring Boot项目的pom.xml文件中，添加自定义starter的依赖项：

xmlCopy code
<dependency>
    <groupId>com.example</groupId>
    <artifactId>my-redis-spring-boot-starter</artifactId>
    <version>1.0.0</version>
</dependency>

在其他项目中使用自定义starter

在其他项目中，只需要按照自定义starter的配置文件中的属性名进行配置即可。Spring Boot会自动使用自定义starter中的自动配置类，并根据配置文件中的属性进行配置。示例代码如下：

javaCopy code
@RestController
public class MyController {

    private final RedisTemplate<String, Object> redisTemplate;

    public MyController(RedisTemplate<String, Object> redisTemplate) {
        this.redisTemplate = redisTemplate;
    }

    @GetMapping("/redis")
    public void redisTest() {
        redisTemplate.opsForValue().set("test", "Hello World");
        String value = (String) redisTemplate.opsForValue().get("test");
        System.out.println(value);
    }
}

上述代码中，通过在构造函数中注入RedisTemplate实例，即可使用Redis的相关功能。在启动项目时，Spring Boot会自动使用自定义starter中的自动配置类，配置RedisTemplate实例的相关参数。

自定义starter的开发流程就是这样，可以根据自己的实际需求，将需要的依赖进行封装，并开发自动配置类和配置文件，最终将其打包成jar包，供其他项目使用。需要注意的是，在开发自定义starter时，应遵循Spring Boot的约定大于配置的原则，并且要充分测试自动配置类的正确性和可用性，以确保自定义starter可以在不同的环境中正确地使用。

avatar
文章
阅读
粉丝