SpringBoot这些常用注解你该知道

时间：2022-11-24 09:13:32

SpringBoot这些常用注解你该知道

@SpringBootApplication

这是 Spring Boot 最最最核心的注解，用在 Spring Boot 主类上，标识这是一个 Spring Boot 应用，用来开启 Spring Boot 的各项能力。

  1. @SpringBootApplication 
  2. public class BaseWebApplication extends SpringBootServletInitializer { 
  3.  
  4.     @Override 
  5.     protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) { 
  6.         return builder.sources(BaseWebApplication.class); 
  7.     } 
  8.  
  9.     public static void main(String[] args) { 
  10.         SpringApplication.run(BaseWebApplication.class, args); 
  11.     } 
  12. } 

@EnableAutoConfiguration

开启自动配置注解，SpringBoot 就能根据当前类路径下的包或者类来配置 Bean。

  1. @Target(ElementType.TYPE) 
  2. @Retention(RetentionPolicy.RUNTIME) 
  3. @Documented 
  4. @Inherited 
  5. @SpringBootConfiguration 
  6. @EnableAutoConfiguration 
  7. @ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class), 
  8.         @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) }) 
  9. public @interface SpringBootApplication { 
  10. }   

 @Configuration

这是 Spring 3.0 添加的一个注解，用来代替 applicationContext.xml 配置文件，通过注解来配置Bean。

  1. @Configuration 
  2. public class WebConfig implements WebMvcConfigurer { 
  3. }   

 @ComponentScan

这是 Spring 3.1 添加的一个注解，用来代替配置文件中的 component-scan 配置，开启组件扫描，即自动扫描包路径下的 @Component 注解进行注册 bean 实例到 context 中。

  1. @ComponentScan(basePackages = {"com.pack.a", "com.jack.b"}) 
  2. public class SqlSessionFactoryConfig { 
  3. } 

 @Conditional

这是 Spring 4.0 添加的新注解，用来标识一个 Spring Bean 或者 Configuration 配置文件，当满足指定的条件才开启配置。

  1. @Bean 
  2. @Conditional({SEEConditional.class}) 
  3. public ServerEndpointExporter serverEndpointExporter (){   
  4.   return new ServerEndpointExporter();   
  5. } 
  6. public class SEEConditional implements Condition { 
  7.  
  8.     @Override 
  9.     public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) { 
  10.         String active = context.getEnvironment().getProperty("app.profiles.active") ; 
  11.         return !"prod".equals(active) ; 
  12.     } 
  13.  
  14. } 

 @ConditionalOnBean

当容器中有指定的 Bean 才开启配置。

@ConditionalOnMissingBean

当容器中没有指定的 Bean 才开启配置。

  1. @ConditionalOnMissingBean({ DataSource.class, XADataSource.class }) 
  2. protected static class EmbeddedConfiguration { 
  3. } 

 @ConditionalOnClass

组合 @Conditional 注解，当容器中有指定的 Class 才开启配置。

  1. @ConditionalOnClass({ RabbitTemplate.class, Channel.class }) 
  2. public class RabbitAutoConfiguration { 
  3. }   

 @ConditionalOnMissingClass

当容器中没有指定的 Class 才开启配置。

@ConditionalOnWebApplication

当前项目类型是 WEB 项目才开启配置。

当前项目有以下 3 种类型。

  1. /** 
  2.  * Any web application will match. 
  3.  */ 
  4. ANY, 
  5. /** 
  6.  * Only servlet-based web application will match. 
  7.  */ 
  8. SERVLET, 
  9. /** 
  10.  * Only reactive-based web application will match. 
  11.  */ 
  12. REACTIVE 

 @ConditionalOnNotWebApplication

当前项目类型不是 WEB 项目才开启配置。

@ConditionalOnProperty

当指定的属性有指定的值时才开启配置。

  1. @Bean 
  2. @ConditionalOnProperty(prefix = "spring.rabbitmq", name = "dynamic", matchIfMissing = true) 
  3. public AmqpAdmin amqpAdmin(ConnectionFactory connectionFactory) { 
  4.   return new RabbitAdmin(connectionFactory); 
  5. } 

 @ConditionalOnExpression

当 SpEL 表达式为 true 时才开启配置。

@ConditionalOnJava

当运行的 Java JVM 在指定的版本范围时才开启配置。

@ConditionalOnResource

当类路径下有指定的资源才开启配置。

@ConditionalOnJndi

当指定的 JNDI 存在时才开启配置。

@ConditionalOnSingleCandidate

当指定的 class 在容器中只有一个 Bean，或者同时有多个但为首选时才开启配置。

@ConfigurationProperties

用来加载额外的配置(如 .properties 文件)，可用在 @Configuration 注解类，或者 @Bean 注解方法上面。

  1. @Bean 
  2. @ConfigurationProperties(prefix = DataSourceProperties.PREFIX) 
  3. public DataSource dataSource() { 
  4.      DataSourceBuilder factory = DataSourceBuilder 
  5.                     .create(this.properties.getClassLoader()) 
  6.                     .driverClassName(this.properties.getDriverClassName()) 
  7.                     .url(this.properties.getUrl()).username(this.properties.getUsername()) 
  8.                     .password(this.properties.getPassword()); 
  9.             if (this.properties.getType() != null) { 
  10.                 factory.type(this.properties.getType()); 
  11.             } 
  12.             return factory.build(); 
  13. } 

 @EnableConfigurationProperties

配合 @ConfigurationProperties 注解使用，用来开启对 @ConfigurationProperties 注解配置 Bean 的支持。

  1. @Configuration 
  2. @ConditionalOnClass({ DataSource.class, EmbeddedDatabaseType.class }) 
  3. @EnableConfigurationProperties(DataSourceProperties.class) 
  4. public class DataSourceAutoConfiguration { 
  5. }   

 @AutoConfigureAfter

用在自动配置类上面，表示该自动配置类需要在另外指定的自动配置类配置完之后。

如 Mybatis 的自动配置类，需要在数据源自动配置类之后。

  1. @AutoConfigureAfter({ DataSourceAutoConfiguration.class, MybatisLanguageDriverAutoConfiguration.class }) 
  2. public class MybatisAutoConfiguration implements InitializingBean { 
  3. }   

 @AutoConfigureBefore

表示该自动配置类需要在另外指定的自动配置类配置之前。

@Import

这是 Spring 3.0 添加的新注解，用来导入一个或者多个 @Configuration 注解修饰的类，这在 SpringBoot 里面应用很多。

  1. @Import(CachingConfigurationSelector.class) 
  2. public @interface EnableCaching { 
  3. }   

 @ImportResource

这是 Spring 3.0 添加的新注解，用来导入一个或者多个 Spring 配置文件，这对 Spring Boot 兼容老项目非常有用，因为有些配置无法通过 Java Config 的形式来配置就只能用这个注解来导入。

  1. @ImportResource({ "classpath:spring/application-*.xml" }) 
  2. @SpringBootApplication 
  3. public class AppApplication { 
  4. }   

 @RestController

该注解是@ResponseBody + @Controller的组合。返回的内容是return 的内容，无法返回jsp或html页面等视图文件。

  1. @RestController 
  2. @RequestMapping("/users") 
  3. public class UsersController { 
  4. }   

 @RequestMapping

映射请求路径。

@GetMapping

映射Get请求

@PostMapping

映射post请求

@PatchMapping

映射method为patch的请求。一般用于个别属性的修改操作

@PutMapping

创建新的资源或替换请求负载目标资源的表示。Put幂等，POST不是

@DeleteMapping

删除资源

@RequestBody

指示接口参数接受的是该请求的主体内容。

@PathVariable

接受请求路径中的占位符的值。

原文地址：https://www.toutiao.com/i6943161298247139853/

标签：

相关文章