Spring Boot 2.6.2 自动装配之注解源码解析

Spring Boot 2.6.2 是一个快速构建 Spring 应用程序的框架，它提供了许多便利的功能，例如自动配置、嵌入式 Web 服务器和健康检查等。在本文中，我们将详细讲解 Spring Boot 2.6.2 自动装配之注解源码解析。

@SpringBootApplication 注解

在 Spring Boot 应用程序中，我们通常使用 @SpringBootApplication 注解来标记主类。这个注解实际上是一个组合注解，包含了以下三个注解：

• @SpringBootConfiguration：标记当前类为 Spring Boot 配置类。
• @EnableAutoConfiguration：启用 Spring Boot 的自动配置功能。
• @ComponentScan：扫描当前包及其子包中的组件。

以下是一个示例：

@SpringBootApplication
public class MyApp {
    public static void main(String[] args) {
        SpringApplication.run(MyApp.class, args);
    }
}

@EnableAutoConfiguration 注解

@EnableAutoConfiguration 注解是 Spring Boot 自动配置的核心注解，它会根据当前应用程序的依赖项自动配置 Spring 应用程序。它会扫描 classpath 中的 META-INF/spring.factories 文件，加载所有的自动配置类，并将它们应用到当前应用程序中。

以下是一个示例：

@Configuration
@ConditionalOnClass({DataSource.class, EmbeddedDatabaseType.class})
@ConditionalOnMissingBean(DataSource.class)
@ConditionalOnProperty(name = "spring.datasource.type", havingValue = "org.apache.tomcat.jdbc.pool.DataSource", matchIfMissing = true)
public class TomcatDataSourceConfiguration {

    @Bean
    @ConfigurationProperties(prefix = "spring.datasource.tomcat")
    public DataSource dataSource() {
        return new org.apache.tomcat.jdbc.pool.DataSource();
    }

}

在上面的示例中，我们定义了一个 TomcatDataSourceConfiguration 类，它会在应用程序中自动配置一个 Tomcat 数据源。它使用了 @ConditionalOnClass、@ConditionalOnMissingBean 和 @ConditionalOnProperty 注解来控制自动配置的条件。

@Conditional 注解

@Conditional 注解是 Spring Boot 自动配置的条件注解，它可以根据条件来控制自动配置是否生效。以下是一些常用的条件注解：

• @ConditionalOnClass：当 classpath 中存在指定的类时生效。
• @ConditionalOnMissingBean：当容器中不存在指定的 Bean 时生效。
• @ConditionalOnProperty：当指定的属性存在并且值匹配时生效。

以下是一个示例：

@Configuration
@ConditionalOnClass({DataSource.class, EmbeddedDatabaseType.class})
@ConditionalOnMissingBean(DataSource.class)
@ConditionalOnProperty(name = "spring.datasource.type", havingValue = "org.apache.tomcat.jdbc.pool.DataSource", matchIfMissing = true)
public class TomcatDataSourceConfiguration {

    @Bean
    @ConfigurationProperties(prefix = "spring.datasource.tomcat")
    public DataSource dataSource() {
        return new org.apache.tomcat.jdbc.pool.DataSource();
    }

}

在上面的示例中，我们使用了 @ConditionalOnClass、@ConditionalOnMissingBean 和 @ConditionalOnProperty 注解来控制自动配置的条件。

示例一：自定义自动配置

以下是一个示例，演示如何自定义自动配置：

1. 创建一个名为 MyAutoConfiguration 的类。

@Configuration
public class MyAutoConfiguration {

    @Bean
    public MyService myService() {
        return new MyServiceImpl();
    }

}

在上面的示例中，我们定义了一个 MyAutoConfiguration 类，它会在应用程序中自动配置一个 MyService Bean。

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

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.example.MyAutoConfiguration

在上面的示例中，我们将 MyAutoConfiguration 类添加到了自动配置列表中。

1. 在应用程序中使用 MyService Bean。

@RestController
public class MyController {

    @Autowired
    private MyService myService;

    @GetMapping("/")
    public String home() {
        return myService.getMessage();
    }

}

在上面的示例中，我们在 MyController 类中使用了 MyService Bean。

示例二：自定义条件注解

以下是一个示例，演示如何自定义条件注解：

1. 创建一个名为 MyCondition 的注解。

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(MyCondition.class)
public @interface ConditionalOnMyCondition {

    String value() default "";

}

在上面的示例中，我们定义了一个 ConditionalOnMyCondition 注解，它会根据 MyCondition 类的条件来控制自动配置是否生效。

1. 创建一个名为 MyCondition 的类。

public class MyCondition implements Condition {

    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        String value = (String) metadata.getAnnotationAttributes(ConditionalOnMyCondition.class.getName()).get("value");
        return "true".equals(value);
    }

}

在上面的示例中，我们定义了一个 MyCondition 类，它会根据 ConditionalOnMyCondition 注解的 value 属性来控制自动配置是否生效。

1. 在 MyAutoConfiguration 类中使用 ConditionalOnMyCondition 注解。

@Configuration
@ConditionalOnMyCondition("true")
public class MyAutoConfiguration {

    @Bean
    public MyService myService() {
        return new MyServiceImpl();
    }

}

在上面的示例中，我们在 MyAutoConfiguration 类中使用了 ConditionalOnMyCondition 注解，并将 value 属性设置为 true。

结束语

在本文中，我们详细讲解了 Spring Boot 2.6.2 自动装配之注解源码解析，并提供了两个示例。这些技巧可以帮助我们更好地理解 Spring Boot 自动配置的工作原理，并提高开发效率。