springboot中的常用注解

springboot中的常用注解

1、@SpringBootApplication

这个注解是Spring Boot最核心的注解，用在 Spring Boot的主类上，标识这是一个 Spring Boot 应用，用来开启 Spring Boot 的各项能力。实际上这个注解是@SpringBootConfiguration（底层@Configuration注解）,@EnableAutoConfiguration,@ComponentScan三个注解的组合。由于这些注解一般都是一起使用，所以Spring Boot提供了一个统一的注解@SpringBootApplication。

1.1 、@SpringBootConfiguration

底层@Configuration注解，代表当前是一个配置类

1.2、 @ComponentScan

组件扫描。让spring Boot扫描到Configuration类并把它加入到程序上下文。

@ComponentScan注解默认就会装配标识了@Controller，@Service，@Repository，@Component注解的类到spring容器中。

1.3、 @EnableAutoConfiguration

主要@AutoConfigurationPackage 和@Import(AutoConfigurationImportSelector.class)注解

@AutoConfigurationPackage注解的主要作用就是将主程序类所在包及所有子包下的组件到扫描到spring容器中。

@Import(AutoConfigurationImportSelector.class)注解，将AutoConfigurationImportSelector这个类导入到spring容器中，AutoConfigurationImportSelector可以帮助springboot应用将所有符合条件的@Configuration配置都加载到当前SpringBoot创建并使用的IoC容器(ApplicationContext)中

如：当前类路径下有 Mybatis 这个 JAR 包，MybatisAutoConfiguration 注解就能根据相关参数来配置 Mybatis 的各个 Spring Bean。

@EnableAutoConfiguration实现的关键在于引入了AutoConfigurationImportSelector，其核心逻辑为selectImports方法，逻辑大致如下：

●　从配置文件META-INF/spring.factories加载所有可能用到的自动配置类；

●　去重，并将exclude和excludeName属性携带的类排除；

●　过滤，将满足条件（@Conditional）的自动配置类返回；

2、@Configuration

用于定义配置类，指出该类是 Bean 配置的信息源，相当于传统的xml配置文件，一般加在主类上。如果有些第三方库需要用到xml文件，建议仍然通过@Configuration类作为项目的配置主类——可以使用@ImportResource注解加载xml配置文件。

@Configuration(proxyBeanMethods = true)、【Full 保证每个@Bean方法被调用多少次返回的组件都是单实例的】
@Configuration(proxyBeanMethods = false)【lite 每个@Bean方法被调用多少次返回的组件都是新创建的】

Full模式和Lite模式是针对spring配置而言的，和xml配置无关。

何时为Lite模式：

1.类上有@Component注解

2.类上有@ComponentScan注解

3.类上有@Import注解

4.类上有@ImportResource注解

5.类上没有任何注解，但是类中存在@Bean方法

6.类上有@Configuration(proxyBeanMethods = false)注解

Lite总结：运行时不用生成CGLIB子类，提高运行性能，降低启动时间，可以作为普通类使用。但是不能声明@Bean之间的依赖

何时为Full模式：

1.标注有@Configuration或者@Configuration(proxyBeanMethods = true)的类被称为Full模式的配置类。

Full模式总结：单例模式能有效避免Lite模式下的错误。性能没有Lite模式好

3、@Bean

相当于XML中的,放在方法的上面，而不是类，意思是产生一个bean,并交给spring管理。

4、@Repository

用于标注数据访问组件，即DAO组件。

使用@Repository注解可以确保DAO或者repositories提供异常转译，这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置，同时也不需要为它们提供XML配置项。

5、@Service

一般用于修饰service层(业务层)的组件,

6、@Component

泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。

7、@RestController

用于标注控制层组件(如struts中的action)，表示这是个控制器bean,并且是将函数的返回值直 接填入HTTP响应体中,是REST风格的控制器；它是@Controller和@ResponseBody的合集。

@Controller一般用于修饰web层（控制层）的组件

8、@ResponseBody

表示该方法的返回结果直接写入HTTP response body中

一般在异步获取数据时使用，在使用@RequestMapping后，返回值通常解析为跳转路径，加上@responsebody后返回结果不会被解析为跳转路径，而是直接写入HTTP response body中。比如异步获取json数据，加上@responsebody后，会直接返回json数据。

9、@AutoWired

byType方式。把配置好的Bean拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。

当加上（required=false）时，就算找不到bean也不报错。

10、@Qualifier

当有多个同一类型的Bean时，可以用@Qualifier(“name”)来指定。与@Autowired配合使用

11、@Resource(name=“name”,type=“type”)

没有括号内内容的话，默认byName。与@Autowired干类似的事。

12、@RequestMapping

RequestMapping是一个用来处理请求地址映射的注解；提供路由信息，负责URL到Controller中的具体函数的映射，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。

13、@RequestParam

用在方法的参数前面。例：

public Result<Map<String, Object>> get(@RequestParam(value = "id") Long id,
                                       @RequestParam(value = "deviceId",required = false) Long deviceId) {
        Map<String, Object> data = alarmConfigService.getInfo(id,deviceId);
        return new Result<Map<String, Object>>().ok(data);
}

14、@Profiles

Spring Profiles提供了一种隔离应用程序配置的方式，并让这些配置只能在特定的环境下生效。

任何@Component或@Configuration都能被@Profile标记，从而限制加载它的时机。

比如：正式环境生效

@Configuration
@Profile("prod")
public class ProductionConfiguration {
  // ...
}

15、@ConfigurationProperties

Spring Boot可使用注解的方式将自定义的properties文件映射到实体bean中，比如config.properties文件。

@Data
@ConfigurationProperties("rocketmq.consumer")
public class RocketMQConsumerProperties extends RocketMQProperties {
  ``private boolean enabled = ``true``;
  ``private String consumerGroup;
  ``private MessageModel messageModel = MessageModel.CLUSTERING;
  ``private ConsumeFromWhere consumeFromWhere = ConsumeFromWhere.CONSUME_FROM_LAST_OFFSET;
  ``private int consumeThreadMin = 20;
  ``private int consumeThreadMax = 64;
  ``private int consumeConcurrentlyMaxSpan = 2000;
  ``private int pullThresholdForQueue = 1000;
  ``private int pullInterval = 0;
  ``private int consumeMessageBatchMaxSize = 1;
  ``private int pullBatchSize = 32;
}

16、@Value

@Value(“#{}”) 表示SpEl表达式通常用来获取bean的属性，或者调用bean的某个方法。当然还有可以表示常量

@Value(“${xxxx}”)注解从配置文件读取值的用法

@Value("${uploadUrl}")
private String uploadUrl; // 真实路径