Spring Boot 教程4：Spring Boot 注解

Spring Boot 教程4：Spring Boot 注解

声明

这个系列文章是翻译自https://www.baeldung.com/的系列博客，个人感觉是一个非常不错的Spring Boot 教程。原网站属于一个公司，主要开展有偿培训业务，但提供相关文字教程的免费阅读和下载。因为我并没有在网页找到相关版权描述信息，所以并不能确定是否可以自由翻译和转载，如果有版权问题，请联系我，我会撤下这个系列文章。

原文地址：Spring Boot Annotations | Baeldung

因为版权的关系，本文禁止转载。

---

概述

Spring Boot 通过其自动配置功能使配置Spring变得更容易。

在这个快速教程中，我们将探索来自 org.springframework.boot.autoconfigure 和org.springframework.boot.autoconfigure.condition 包的注释

@SpringBootApplication

我们使用这个注解来标记Spring Boot 应用程序的main class：

@SpringBootApplication
class VehicleFactoryApplication {

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

@SpringBootApplication 封装 @Configuration 、@EnableAutoConfiguration 和 @ComponentScan 注释及其默认属性。

@EnableAutoConfiguration

@EnableAutoConfiguration ，顾名思义，启用自动配置。这意味着Spring Boot 在其classpath上查找自动配置bean并自动应用它们。

注意，我们必须使用这个注释 @Configuration ：

@Configuration
@EnableAutoConfiguration
class VehicleFactoryConfig {}

自动配置条件

通常，当我们编写自定义自动配置时，我们希望Spring有条件地使用它们。我们可以通过本节中的注释来实现这一点。

我们可以将本节中的注释放在 @Configuration 类或 @Bean 方法上。

在接下来的部分中，我们将只介绍每个条件背后的基本概念。欲了解更多信息，请访问这篇文章。

@ConditionalOnClass 和 @ConditionalOnMissingClass

使用这些条件，Spring将仅在注解的参数中的class存在/不存在时使用标记的自动配置 bean：

@Configuration
@ConditionalOnClass(DataSource.class)
class MySQLAutoconfiguration {
    //...
}

@ConditionalOnBean 和 @ConditionalOnMissingBean

当我们想要基于特定bean的存在或不存在来定义条件时，可以使用这些注释：

@Bean
@ConditionalOnBean(name = "dataSource")
LocalContainerEntityManagerFactoryBean entityManagerFactory() {
    // ...
}

@ConditionalOnProperty

有了这个注释，我们可以对属性的值设置条件：

@Bean
@ConditionalOnProperty(
    name = "usemysql", 
    havingValue = "local"
)
DataSource dataSource() {
    // ...
}

@ConditionalOnResource

我们可以让Spring只在存在特定资源时使用定义：

@ConditionalOnResource(resources = "classpath:mysql.properties")
Properties additionalProperties() {
    // ...
}

@ConditionalOnWebApplication 和 @ConditionalOnNotWebApplication

通过这些注释，我们可以根据当前应用程序是否是Web应用程序来创建条件：

@ConditionalOnWebApplication
HealthCheckController healthCheckController() {
    // ...
}

@ConditionalExpression

我们可以在更复杂的情况下使用此注释。当SpEL表达式被求值为true时，Spring将使用标记的定义：

@Bean
@ConditionalOnExpression("${usemysql} && ${mysqlserver == 'local'}")
DataSource dataSource() {
    // ...
}

@Conditional

对于更复杂的条件，我们可以创建一个类来评估自定义条件。我们告诉Spring使用这个自定义条件 @Conditional ：

@Conditional(HibernateCondition.class)
Properties additionalProperties() {
    //...
}

结论

在本文中，我们看到了如何微调自动配置过程并为自定义自动配置bean提供条件的概述。

像往常一样，这些示例可以在GitHub上找到。