Spring Boot 注解大全(实时更新中)

@PropertySource 用于从某些地方加载 *.properties 文件内容,并将其中的属性加载到 IoC 容器中,便于填充一些 bean 定义属性的占位符(placeholder),当然,这需要 PropertySourcesPlaceholderConfigurer 的配合。

如果我们使用 Java 8 或者更高版本开发,那么,我们可以并行声明多个 @PropertySource:

@Configuration@PropertySource(“classpath:1.properties”)@PropertySource(“classpath:2.properties”)@PropertySource(“…”)public class XConfiguration{ …}

如果我们使用低于 Java 8 版本的 Java 开发 Spring 应用,又想声明多个 @PropertySource,则需要借助 @PropertySources 的帮助了,代码如下所示:

@PropertySources({ @PropertySource(“classpath:1.properties”), @PropertySource(“classpath:2.properties”), …})public class XConfiguration{ …}

[](()@Import 与 @ImportResource


在 XML 形式的配置中,我们通过 的形式将多个分开的容器配置合到一个配置中,在 JavaConfig 形式的配置中,我们则使用 @Import 这个 Annotation 完成同样目的:

@Configuration@Import(MockConfiguration.class)public class XConfiguration { …}

@Import 只负责引入 JavaConfig 形式定义的 IoC 容器配置,如果有一些遗留的配置或者遗留系统需要以 XML 形式来配置(比如 dubbo 框架),我们依然可以通过 @ImportResource 将它们一起合并到当前 JavaConfig 配置的容器中。

[](()@ConditionalOnXXX 基于条件的自动配置


基于条件的自动配置来源于 Spring 框架中“基于条件的配置”这一特性。在 Spring 框架中,我们可以使用 @Conditional 这个 Annotation 配合 @Configuration 或者 @Bean 等 Annotation 来干预一个配置或者 bean 定义是否能够生效,其最终实现的效果或者语义类似于如下伪代码:

if(符合 @Conditional 规定的条件){

加载当前配置(enable current Configuration)或者注册当前bean定义;

}

要实现基于条件的配置,我们只要通过 @Conditional 指定自己的 Condition 实现类就可以了(可以应用于类型 Type 的标注或者方法 Method 的标注):

@Conditional({MyCondition1.class, MyCondition2.class, …})

最主要的是,@Conditional 可以作为一个 Meta Annotation 用来标注其他 Annotation 实现类,从而构建各色的复合 Annotation,比如 Spr 《一线大厂Java面试题解析+后端开发学习笔记+最新架构讲解视频+实战项目源码讲义》无偿开源 威信搜索公众号【编程进阶路】 ingBoot的 autoconfigure 模块就基于这一优良的革命传统,实现了一批 Annotation(位于 org.springframework.boot.autoconfigure.condition 包下),条件注解如下:

  • @ConditionalOnBean:当容器里有指定的 Bean 的条件下。

  • @ConditionalOnClass:当类路径下有指定的类的条件下。

  • @ConditionalOnExpression:基于 SpEL 表达式作为判断条件。

  • @ConditionalOnJava:基于 JVM 版本作为判断条件。

  • @ConditionalOnJndi:在 JNDI 存在的条件下查找指定的位置。

  • @ConditionalOnMissingBean:当容器里没有指定 Bean 的情况下。

  • @ConditionalOnMissingClass:当类路径下没有指定的类的条件下。

  • @ConditionalOnNotWebApplication:当前项目不是 Web 项目的条件下。

  • @ConditionalOnProperty:指定的属性是否有指定的值。

  • @ConditionalOnResource:类路径是否有指定的值。

  • @ConditionalOnSingleCandidate:当指定 Bean 在容器中只有一个,或者虽然有多个但是指定首选的 Bean。

  • @ConditionalOnWebApplication:当前项目是 Web 项目的条件下。

有了这些复合 Annotation 的配合,我们就可以结合 @EnableAuto-Configurationn 实现基于条件的自动配置了。

### Spring Boot 注解使用指南 在 Spring Boot 中,注解是实现自动配置和组件管理的核心机制。通过合理的注解使用,可以简化配置、提高代码可读性,并提升开发效率。以下是一些关键注解及其用途。 #### 核心组件注解 Spring Boot 提供了一系列注解,用于标记类为 Spring 容器中的组件,并赋予其特定的语义角色。这些注解包括: - `@Component`:通用的组件注解,用于标记一个类为 Spring 的组件,使其能够被自动扫描并注册为 Spring 容器中的 Bean。 - `@Service`:用于标记业务逻辑层的服务类,通常用于服务层组件。 - `@Repository`:用于标记数据访问层的 DAO 类,通常用于与数据库交互的组件。 - `@Controller`:用于标记 Web 层的控制器类,通常用于返回视图名称。 - `@RestController`:结合了 `@Controller` 和 `@ResponseBody`,用于直接返回 JSON 数据的 REST 控制器[^3]。 ```java import org.springframework.stereotype.Component; @Component public class MyComponent { // 业务逻辑 } ``` ```java import org.springframework.stereotype.Service; @Service public class MyService { // 业务逻辑 } ``` ```java import org.springframework.stereotype.Repository; @Repository public class MyRepository { // 数据访问逻辑 } ``` ```java import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; @RestController public class HelloController { @GetMapping("/hello") public String sayHello() { return "Hello, Spring Boot!"; } } ``` #### 自动配置相关注解 Spring Boot 的自动配置机制依赖于条件注解来决定是否应用某个配置。常见的条件注解包括: - `@ConditionalOnClass`:只有在类路径上存在指定类时,才启用该配置。 - `@ConditionalOnProperty`:只有在指定的属性存在并具有特定值时,才启用该配置[^2]。 ```java import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.context.annotation.Configuration; @Configuration @ConditionalOnClass(name = "com.example.SomeClass") public class MyAutoConfiguration { // 自动配置逻辑 } ``` ```java import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; import org.springframework.context.annotation.Configuration; @Configuration @ConditionalOnProperty(name = "my.feature.enabled", havingValue = "true") public class MyFeatureConfiguration { // 特性启用时的配置逻辑 } ``` #### 应用启动注解 `@SpringBootApplication` 是 Spring Boot 应用的主注解,它结合了 `@EnableAutoConfiguration` 和 `@ComponentScan`。如果不想使用 `@SpringBootApplication`,可以分别使用这两个注解来定义相同的行为[^1]。 ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.Configuration; @Configuration @EnableAutoConfiguration @ComponentScan public class MyApplication { public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } } ``` #### 调试自动配置 Spring Boot 的自动配置定义在 `spring-boot-autoconfigure` 包下的 `META-INF/spring.factories` 文件中。可以通过查看该文件了解 Spring Boot 是如何加载自动配置类的[^2]。 ###
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值