spring常用注解标签总结

1：@Component等

名称	@Component/@Controller/@Service/@Repository
类型	类注解
位置	类定义上方
作用	设置该类为spring管理的bean
属性	value（默认）：定义bean的id

说明:

• @Component注解如果不起名称，会有一个默认值就是当前类名首字母小写，所以也可以按照名称获取

2：@Configuration

名称	@Configuration
类型	类注解
位置	类定义上方
作用	设置该类为spring配置类
属性	value（默认）：定义bean的id

说明 

   在配置类上添加包扫描注解@ComponentScan替换<context:component-scan base-package=""/>

• @Configuration注解用于设定当前类为配置类

• @ComponentScan注解用于设定扫描路径，此注解只能添加一次，多个数据请用数组格式

  @ComponentScan({com.fly.service","com.fly.dao"})

• 读取Spring核心配置文件初始化容器对象切换为读取Java配置类初始化容器对象

  //加载配置文件初始化容器
  ApplicationContext ctx = new ClassPathXmlApplicationContext("applicationContext.xml");
  //加载配置类初始化容器
  ApplicationContext ctx = new AnnotationConfigApplicationContext(SpringConfig.class); 

3：@ComponentScan

名称	@ComponentScan
类型	类注解
位置	类定义上方
作用	设置spring配置类扫描路径，用于加载使用注解格式定义的bean
属性	value（默认）：扫描路径，此路径可以逐层向下扫描

4：@Scope

名称	@Scope
类型	类注解
位置	类定义上方
作用	设置该类创建对象的作用范围 可用于设置创建出的bean是否为单例对象
属性	value（默认）：定义bean作用范围， ==默认值singleton（单例），可选值prototype（非单例）==

5：@PostConstruct

名称	@PostConstruct
类型	方法注解
位置	方法上
作用	设置该方法为初始化方法
属性	无

6：@PreDestroy

名称	@PreDestroy
类型	方法注解
位置	方法上
作用	设置该方法为销毁方法
属性	无

7：@Autowired

名称	@Autowired
类型	属性注解 或 方法注解（了解） 或 方法形参注解（了解）
位置	属性定义上方 或 标准set方法上方 或 类set方法上方 或 方法形参前面
作用	为引用类型属性设置值
属性	required：true/false，定义该属性是否允许为null

注意:

• @Autowired可以写在属性上，也可也写在setter方法上，最简单的处理方式是写在属性上并将setter方法删除掉

• 为什么setter方法可以删除呢?

  • 自动装配基于反射设计创建对象并通过暴力反射为私有属性进行设值

  • 普通反射只能获取public修饰的内容

  • 暴力反射除了获取public修饰的内容还可以获取private修改的内容

  • 所以此处无需提供setter方法

8：@Qualifier

名称	@Qualifier
类型	属性注解 或 方法注解（了解）
位置	属性定义上方 或 标准set方法上方 或 类set方法上方
作用	为引用类型属性指定注入的beanId
属性	value（默认）：设置注入的beanId

当根据类型在容器中找到多个bean,注入参数的属性名又和容器中bean的名称不一致，这个时候就需要使用到@Qualifier来指定注入哪个名称的bean对象。  

@Qualifier注解后的值就是需要注入的bean的名称。

==注意:@Qualifier不能独立使用，必须和@Autowired一起使用==

9：@Value

名称	@Value
类型	属性注解 或 方法注解（了解）
位置	属性定义上方 或 标准set方法上方 或 类set方法上方
作用	为 基本数据类型 或 字符串类型 属性设置值
属性	value（默认）：要注入的属性值

10：@PropertySource

名称	@PropertySource
类型	类注解
位置	类定义上方
作用	加载properties文件中的属性值
属性	value（默认）：设置加载的properties文件对应的文件名或文件名组成的数组

注意:

• 如果读取的properties配置文件有多个，可以使用@PropertySource的属性来指定多个

  @PropertySource({"jdbc.properties","xxx.properties"})

• @PropertySource注解属性中不支持使用通配符*,运行会报错

  @PropertySource({"*.properties"})

• @PropertySource注解属性中可以把classpath:加上,代表从当前项目的根路径找文件

  @PropertySource({"classpath:jdbc.properties"})

11：@Bean

名称	@Bean
类型	方法注解
位置	方法定义上方
作用	设置该方法的返回值作为spring管理的bean
属性	value（默认）：定义bean的id

12：@Import

名称	@Import
类型	类注解
位置	类定义上方
作用	导入配置类
属性	value（默认）：定义导入的配置类类名， 当配置类有多个时使用数组格式一次性导入多个配置类

注意:

• 扫描注解可以移除

• @Import参数需要的是一个数组，可以引入多个配置类。

• @Import注解在配置类中只能写一次，下面的方式是==不允许的==

  @Configuration
  //@ComponentScan("com.fly.config")
  @Import(JdbcConfig.class)
  @Import(Xxx.class)
  public class SpringConfig {
      
  }

 13:总结

功能	XML配置	注解
定义Bean	bean标签 id属性 class属性	@Component @Controller @Service @Repository @ComponentScan
设置依赖注入	setter注入（set方法)   引用/简单（构造器注入（构造方法）） 引用/简单(自动装配)	@Autowired @Qualifier @Value
配置第三方bean	bean标签 静态工厂、实例工厂、FactoryBean	@Bean
作用范围	scope属性	@Scope
生命周期	标准接口 init-method destroy-method	@PostConstructor @PreDestroy

14:@RequestMapping

名称	@RequestMapping
类型	类注解或方法注解
位置	SpringMVC控制器类或方法定义上方
作用	设置当前控制器方法请求访问路径
相关属性	value(默认)，请求访问路径

15:@ResponseBody

名称	@ResponseBody
类型	类注解或方法注解
位置	SpringMVC控制器类或方法定义上方
作用	设置当前控制器方法响应内容为当前返回值，无需解析

16：@RequestParam

名称	@RequestParam
类型	形参注解
位置	SpringMVC控制器方法形参定义前面
作用	绑定请求参数与处理器方法形参间的关系
相关参数	required：是否为必传参数 defaultValue：参数默认值

17：@RequestBody

名称	@RequestBody
类型	==形参注解==
位置	SpringMVC控制器方法形参定义前面
作用	将请求中请求体所包含的数据传递给请求参数，此注解一个处理器方法只能使用一次

18:@RequestBody与@RequestParam区别

• 区别

  • @RequestParam用于接收url地址传参，表单传参【application/x-www-form-urlencoded】

  • @RequestBody用于接收json数据【application/json】

• 应用

  • 后期开发中，发送json格式数据为主，@RequestBody应用较广

  • 如果发送非json格式数据，选用@RequestParam接收请求参数

19：@DateTimeFormat

名称	@DateTimeFormat
类型	==形参注解==
位置	SpringMVC控制器方法形参前面
作用	设定日期时间型数据格式
相关属性	pattern：指定日期时间格式字符串

20:@ResponseBody

名称	@ResponseBody
类型	==方法\类注解==
位置	SpringMVC控制器方法定义上方和控制类上
作用	设置当前控制器返回值作为响应体, 写在类上，该类的所有方法都有该注解功能
相关属性	pattern：指定日期时间格式字符串

说明:

• 该注解可以写在类上或者方法上

• 写在类上就是该类下的所有方法都有@ReponseBody功能

• 当方法上有@ReponseBody注解后

  • 方法的返回值为字符串，会将其作为文本内容直接响应给前端

  • 方法的返回值为对象，会将对象转换成JSON响应给前端

此处又使用到了类型转换，内部还是通过Converter接口的实现类完成的，所以Converter除了前面所说的功能外，它还可以实现:

• 对象转Json数据(POJO -> json)

• 集合转Json数据(Collection -> json)

21：@PathVariable

名称	@PathVariable
类型	==形参注解==
位置	SpringMVC控制器方法形参定义前面
作用	绑定路径参数与处理器方法形参间的关系，要求路径参数名与形参名一一对应

22：@RestController

名称	@RestController
类型	==类注解==
位置	基于SpringMVC的RESTful开发控制器类定义上方
作用	设置当前控制器类为RESTful风格， 等同于@Controller与@ResponseBody两个注解组合功能

23：@GetMapping @PostMapping @PutMapping @DeleteMapping

名称	@GetMapping @PostMapping @PutMapping @DeleteMapping
类型	==方法注解==
位置	基于SpringMVC的RESTful开发控制器方法定义上方
作用	设置当前控制器方法请求访问路径与请求动作，每种对应一个请求动作， 例如@GetMapping对应GET请求
相关属性	value（默认）：请求访问路径

24：@RestControllerAdvice

名称	@RestControllerAdvice
类型	==类注解==
位置	Rest风格开发的控制器增强类定义上方
作用	为Rest风格开发的控制器类做增强

说明:此注解自带@ResponseBody注解与@Component注解，具备对应的功能

25：@ExceptionHandler

名称	@ExceptionHandler
类型	==方法注解==
位置	专用于异常处理的控制器方法上方
作用	设置指定异常的处理方案，功能等同于控制器方法， 出现异常后终止原始控制器执行,并转入当前方法执行

说明：此类方法可以根据处理的异常不同，制作多个方法分别处理对应的异常