一.介绍
从java5.0之后开始支持注解,Spring也是随着更新了2.5版本之后开始舍弃xml配置,更多使用注解来控制spring框架
二、核心注解
@Required
此注解用于bean的setter方法上,表示此属性是必须的,必须在配置阶段注入,否则会抛出BeanInitializationExcepion异常。
@Autowired
此注解用于bean的field、setter方法以及构造方法上,显式地声明依赖,根据type来autowiring
当在field上使用此注解,并且使用属性来传递值时,Spring会自动把值付给此field。也可以将此注解用于私有属性(不推荐)
注意:当在构造方法上使用此注解的时候,需要注意的一点就是一个类中只允许有一个构造方法使用此注解。
@Autowired
private DishService dishService;
最经常的用法是将此注解用于setter上,这样可以在setter方法上添加自定义代码。
@Component
public class User {
private Address address;
@AutoWired
public setAddress(Address address) {
// custom code
this.address=address;
}
}
@Qualifier
此注解是和@Autowired一起使用的。使用此注解可以让你对注入过程有更多的控制
@Qualifier可以被用在单个构造器或者方法的参数上,当上下文有几个相同类型的bean,使用@Autowired则无法区分要绑定的bean,此时可以使用@Qualifier来指定名称
@Component
public class User {
@Autowired
@Qualifier(address1)
private Address address;
}
@Configuration
此注解用在calss上来定义bean。其作用和xml配置文件相同,表示此bean是一个Spring配置,就相当于把这个类放入一个Spring容器中,方便其他类进行调用。此外
此类可以使用@Bean注解来初始化定义bean
@Configuartion
public class SpringCoreConfig {
@Bean
public AdminUser adminUser() {
AdminUser adminUser = new AdminUser();
return adminUser;
}
}
@ComponentScan
此注解一般和@Configuration一起使用,指定Spring扫描注解的package。如果没有指定包,那么默认会扫描此配置类所在的package
@Lazy
此注解使用在Spring的组件类上,默认的,Spring中Bean的依赖一开始就被创建和配置。如果想要延迟初始化一个bean,那么可以在此类上使用@Lazy,表示此bean只有在第一次被使用时才会被创建和初始化。
@Value
此注解使用在字段、构造器参数和方法参数上。@Value可以指定属性取值的表达式,支持通过#{}使用SpringEL来取值,也支持使用${}属性来源中的值注入到bean中。
三、Spring MVC和REST注解
@Controller
此注解使用在class上声明此类是一个Spring controller,是@Component注解的一种具体形式
@RequestMapping
此注解可以用在class和method上,用来映射web请求到某一个handler类上或者handler方法上。
当此注解用在Class上时,就创造了一个url,其所有方法的@RequestMapping都是在此url之上的
@ExceptionHandler
此注解使用在方法级别,声明对Exception的处理逻辑。可以指定目标Exception。、
@PathVariable
此注解使用在请求handler方法的参数上。@RequestMapping可以定义动态路径,如:
@RequestMapping(/users/{uid})
可以使用@PathVariable将路径中的参数绑定到请求方法参数上。
@RequestMapping(/users/{uid})
public String execute(@PathVariable(uid) String uid){
}
@RequestAttribute
此注解用在请求handler方法的参数上,用于将web请求中的属性绑定到方法参数上。
@RequestBody
此注解用在handler方法的参数上,用于将http请求的Body映射绑定到此参数上
HttpMessageConverter负责将对象转换成http请求
@RequestHeader
此注解用在请求handle方法的参数上,用于将http请求头部的值绑定到参数上
@RequestParam
此注解用在请求handler方法的参数上,用于将http请求参数的值绑定到参数上。
@RequestPart
此注解用在请求handler方法的参数上,用于将文件之类的multipart绑定到参数上。
@ResponBody
此注解用在请求handler方法上,和@RequestBody作用类似,用于将方法的返回对象直接输出到http响应中(需要转为json)
@ResponseStatus
此注解用于方法和exception类上,声明此方法或者异常类返回的http状态码。可以在Controller上使用此注解,这样所有的@RequestMapping都会继承。
@ControllerAdvice
此注解用于class上。可以使用此注解来声明一个类统一对所有@RequestMapping方法来做@ExceptionHandler、@InitBinder以及@ModelAttribute处理。
@RestController
此注解用于class上,声明此controller返回的不是一个视图而是一个领域对象。其同时引入了@Controller和@ResponseBody两个注解。
@RestControllerAdvice
此注解用于class上,同时引入了@ControllerAdvice和@ResponseBody两个注解。
@SessionAttribute
此注解用于方法的参数上,用于将session中的属性绑定到参数。
@SessionAttributes
此注解用于type级别,用于将JavaBean对象存储到session中。一般和@ModelAttribute注解一起使用
四、Springboot注解
@EnableAutoConfiguration
此注解通常被用在主应用class上,告诉Spring Boot自动基于当前包添加Bean、对bean的属性进行设置等
@SpringBootApplication
此注解用在Spring Boot项目的应用主类上(此类需要在base package中)。使用了此注解的类首先会让Spring Boot启动对base package以及其sub-pacakage下的类进行component scan
此注解同时添加了以下几个注解:@Configuration、@EnableAutoConfiguration、@ComponentScan
五、Stereotype注解
@Component
此注解使用在class上来声明一个Spring组件,将其加入到应用上下文中
@Repository
此类使用在class声明此类用于访问数据库,一般作为DAO的角色,此注解有自动翻译的特性,例如:当此种component抛出了一个异常,那么会有一个handler来处理此异常,无需使用try-catch块
六、数据访问注解
@Transactional
此注解使用在接口定义、接口中的方法、类定义或者类中的public方法上。需要注意的是此注解并不激活事务行为,它仅仅是一个元数据,会被一些运行时基础设施来消费。(使用事务要用)
七、测试注解
@ContextConfiguration
此注解使用在Class上,声明测试使用的配置文件,此外,也可以指定加载上下文的类。此注解一般需要搭配SpringJUnit4ClassRunner使用。