史上最全Spring常见注解
从JDK5开始,Java增加对元数据的⽀持，也就是注解。Spring做为Java⽣态中的领军框架，从Spring2.5版本后也开始⽀持注解。相⽐起之前使⽤xml来配置Spring框架，使⽤注解提供了更多的控制Spring框架的⽅式。
Spring的注解⾮常多，相信很多注解⼤家都没有使⽤过。本⽂就尽量全⾯地概括介绍⼀下Spring中常⽤的注解。
⼀. 核⼼注解
@Required
此注解⽤于bean的setter⽅法上。表⽰此属性是必须的，必须在配置阶段注⼊，否则会抛出BeanInitializationExcepion。
@Autowired
此注解⽤于bean的field、setter⽅法以及构造⽅法上，显式地声明依赖。根据type来autowiring。
当在field上使⽤此注解，并且使⽤属性来传递值时，Spring会⾃动把值赋给此field。也可以将此注解⽤于私有属性(不推荐)，如下。
@Component
public class User {
@Autowired
private Address address;
}
最经常的⽤法是将此注解⽤于settter上，这样可以在setter⽅法中添加⾃定义代码。如下：
@Component
public class User {
private Address address;
@AutoWired
public setAddress(Address address){
// custom code
this.address=address;
}
}
当在构造⽅法上使⽤此注解的时候，需要注意的⼀点就是⼀个类中只允许有⼀个构造⽅法使⽤此注解。此外，在Spring4.3后，如果⼀个类仅仅只有⼀个构造⽅法，那么即使不使⽤此注解，那么Spring也会⾃动注⼊相关的bean。如下：
@Component
public class User {
private Address address;
public User(Address address){
this.address=address;
}
}
<bean id="user"class="xx.User"/>
@Qualifier
此注解是和@Autowired⼀起使⽤的。使⽤此注解可以让你对注⼊的过程有更多的控制。
``@Qualifier可以被⽤在单个构造器或者⽅法的参数上。当上下⽂有⼏个相同类型的bean, 使⽤@Autowired则⽆法区分要绑定的bean，此时可以使⽤@Qualifier`来指定名称。
@Component
public class User {
@Autowired
@Qualifier("address1")
private Address address;
...
}
@Configuration
此注解⽤在class上来定义bean。其作⽤和xml配置⽂件相同，表⽰此bean是⼀个Spring配置。此外，此类可以使⽤@Bean注解来初始化定义bean。
@Configuration
此注解⽤在class上来定义bean。其作⽤和xml配置⽂件相同，表⽰此bean是⼀个Spring配置。此外，此类可以使⽤@Bean注解来初始化定义bean。
@ComponentScan
此注解⼀般和@Configuration注解⼀起使⽤，指定Spring扫描注解的package。如果没有指定包，那么默认会扫描此配置类所在的package。
@Lazy
此注解使⽤在Spring的组件类上。默认的，Spring中Bean的依赖⼀开始就被创建和配置。如果想要延迟初始化⼀个bean，那么可以在此类上使⽤Lazy注解，表⽰此bean只有在第⼀次被使⽤的时候才会被创建和初始化。此注解也可以使⽤在被@Configuration注解的类上，表⽰其中所有被@Bean注解的⽅法都会延迟初始化。
@Value
此注解使⽤在字段、构造器参数和⽅法参数上。@Value可以指定属性取值的表达式，⽀持通过#{}使⽤SpringEL来取值，也⽀持使⽤${}来将属性来源中(Properties⽂件、本地环境变量、系统属性等)的值注⼊到bean的属性中。此注解值的注⼊发⽣在AutowiredAnnotationBeanPostProcessor类中。
**
⼆. Stereotype注解
**
@Component
此注解使⽤在class上来声明⼀个Spring组件(Bean), 将其加⼊到应⽤上下⽂中。
@Controller
此注解使⽤在class上声明此类是⼀个Spring controller，是@Component注解的⼀种具体形式。
@Service
此注解使⽤在class上，声明此类是⼀个服务类，执⾏业务逻辑、计算、调⽤内部api等。是@Component注解的⼀种具体形式。
@Repository
此类使⽤在class上声明此类⽤于访问数据库，⼀般作为DAO的⾓⾊。
此注解有⾃动翻译的特性，例如：当此种component抛出了⼀个异常，那么会有⼀个handler来处理此异常，⽆需使⽤try-catch块。
**
三. Spring Boot注解
**
@EnableAutoConfiguration
此注解通常被⽤在主应⽤class上，告诉Spring Boot⾃动基于当前包添加Bean、对bean的属性进⾏设置等。
@SpringBootApplication
此注解⽤在Spring Boot项⽬的应⽤主类上（此类需要在base package中）。使⽤了此注解的类⾸先会让Spring Boot启动对base package以及其sub-pacakage下的类进⾏componentScan。
此注解同时添加了以下⼏个注解：
@Configuration
@EnableAutoConfiguration
@ComponentScan
**
四. Spring MVC和REST注解
**
@Controller
上⽂已经提到过此注解。
@RequestMapping
此注解可以⽤在class和method上，⽤来映射web请求到某⼀个handler类或者handler⽅法上。当此注解⽤在Class上时，就创造了⼀个基础url，其所有的⽅法上的@RequestMapping都是在此url之上的。
可以使⽤其method属性来限制请求匹配的http method。
@Controller
@RequestMapping("/users")
public class UserController {
@RequestMapping(method = RequestMethod.GET)
public String getUserList(){
return"users";
}
}
此外，Spring4.3之后引⼊了⼀系列@RequestMapping的变种。如下：
@GetMapping
@PostMapping
@PutMapping
@PatchMapping
@DeleteMapping
分别对应了相应method的RequestMapping配置。
@CookieValue
此注解⽤在@RequestMapping声明的⽅法的参数上，可以把HTTP cookie中相应名称的cookie绑定上去。
@ReuestMapping("/cookieValue")
public void getCookieValue(@CookieValue("JSESSIONID") String cookie){
}
cookie即http请求中name为JSESSIONID的cookie值。
@CrossOrigin
此注解⽤在class和method上⽤来⽀持跨域请求，是Spring 4.2后引⼊的。
@CrossOrigin(maxAge =3600)
@RestController
@RequestMapping("/users")
public class AccountController {
@CrossOrigin(origins ="xx")
@RequestMapping("/login")
public Result userLogin(){
// ...
}
}
@ExceptionHandler
此注解使⽤在⽅法级别，声明对Exception的处理逻辑。可以指定⽬标Exception。
@InitBinder
此注解使⽤在⽅法上，声明对WebDataBinder的初始化(绑定请求参数到JavaBean上的DataBinder)。在controller上使⽤此注解可以⾃定义请求参数的绑定。
@MatrixVariable
此注解使⽤在请求handler⽅法的参数上，Spring可以注⼊matrix url中相关的值。这⾥的矩阵变量可以出现在url中的任何地⽅，变量之间⽤；分隔。如下：
@RequestMapping(value ="/pets/{petId}")
public void findPet(@PathVariable String petId,@MatrixVariable int q){
// petId == 42
// q == 11
}
需要注意的是默认Spring mvc是不⽀持矩阵变量的，需要开启。
<mvc:annotation-driven enable-matrix-variables="true"/>
注解配置则需要如下开启：
@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {
@Override
public void configurePathMatch(PathMatchConfigurer configurer){
UrlPathHelper urlPathHelper =new UrlPathHelper();
urlPathHelper.setRemoveSemicolonContent(false);
configurer.setUrlPathHelper(urlPathHelper);
}
}
@PathVariable
@RequestMapping("/users/{uid}")
可以使⽤@PathVariable将路径中的参数绑定到请求⽅法参数上。
@RequestMapping("/users/{uid}")
public String execute(@PathVariable("uid") String uid){
}
@RequestAttribute
此注解⽤在请求handler⽅法的参数上，⽤于将web请求中的属性(request attributes，是服务器放⼊的属性值)绑定到⽅法参数上。
@RequestBodyspring系列框架有哪些
此注解⽤在请求handler⽅法的参数上，⽤于将http请求的Body映射绑定到此参数上。HttpMessageConverter负责将对象转换为http请求。
@RequestHeader
此注解⽤在请求handler⽅法的参数上，⽤于将http请求头部的值绑定到参数上。
@RequestParam
此注解⽤在请求handler⽅法的参数上，⽤于将http请求参数的值绑定到参数上。
@RequestPart
此注解⽤在请求handler⽅法的参数上，⽤于将⽂件之类的multipart绑定到参数上。
@ResponseBody
此注解⽤在请求handler⽅法上。和@RequestBody作⽤类似，⽤于将⽅法的返回对象直接输出到http响应中。
@ResponseStatus
此注解⽤于⽅法和exception类上，声明此⽅法或者异常类返回的http状态码。可以在Controller上使⽤此注解，这样所有的
@RequestMapping都会继承。
@ControllerAdvice
此注解⽤于class上。前⾯说过可以对每⼀个controller声明⼀个ExceptionMethod。这⾥可以使⽤
@ControllerAdvice来声明⼀个类来统⼀对所有
@RequestMapping⽅法来做
@ExceptionHandler @InitBinder以及 @ModelAttribute`处理。
@RestController
此注解⽤于class上，声明此controller返回的不是⼀个视图⽽是⼀个领域对象。其同时引⼊了
@Controller和@ResponseBody两个注解。
@RestControllerAdvice
此注解⽤于class上，同时引⼊了@ControllerAdvice和@ResponseBody两个注解。
@SessionAttribute
此注解⽤于⽅法的参数上，⽤于将session中的属性绑定到参数。
@SessionAttributes
此注解⽤于type级别，⽤于将JavaBean对象存储到session中。⼀般和@ModelAttribute注解⼀起使⽤。如下：
@ModelAttribute("user")
public PUser getUser(){}
// controller和上⾯的代码在同⼀controller中
@Controller
@SeesionAttributes(value ="user", types ={
User.class
})
public class UserController {}
**
五. 数据访问注解

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。