美文网首页
Spring最常用的7大类注解,史上最强整理!

Spring最常用的7大类注解,史上最强整理!

作者: Java架构师CAT | 来源:发表于2019-11-20 13:13 被阅读0次

随着技术的更新迭代,Java5.0开始支持注解。而作为java中的领军框架spring,

自从更新了2.5版本之后也开始慢慢舍弃xml配置,更多使用注解来控制spring

框架。而spring的的注解那么多,可能做java很多年,都用不上。这里按照类

型总结了这7种最常用的注解。

核心注解

@Required此注解用于bean的setter方法上。表示此属性是必须的,必须在配

置阶段注入,否则会抛出BeanInitializationExcepion。@Autowired此注解用

于bean的field、setter方法以及构造方法上,显式地声明依赖。根据type

来autowiring。当在field上使用此注解,并且使用属性来传递值时,Spring

会自动把值赋给此field。也可以将此注解用于私有属性(不推荐),如下。

@Component

publicclassUser{

@Autowired

privateAddressaddress;

}

最经常的用法是将此注解用于settter上,这样可以在setter方法中添加自定

义代码。如下:

@Component

publicclassUser{

privateAddressaddress;

@AutoWired

publicsetAddress(Addressaddress){

//customcode

this.address=address;

}

}

当在构造方法上使用此注解的时候,需要注意的一点就是一个类中只允许有一个

构造方法使用此注解。

此外,在Spring4.3后,如果一个类仅仅只有一个构造方法,那么即使不使用此

注解,那么Spring也会自动注入相关的bean。如下:

@Component

publicclassUser{

privateAddressaddress;

publicUser(Addressaddress){

this.address=address;

}

}

<beanid="user"class="xx.User"/>

@Qualifier

此注解是和@Autowired一起使用的。使用此注解可以让你对注入的过程有更多

的控制。@Qualifier可以被用在单个构造器或者方法的参数上。当上下文有几

个相同类型的bean,使用@Autowired则无法区分要绑定的bean,此时可以使用

@Qualifier来指定名称。

@Component

publicclassUser{

@Autowired

@Qualifier("address1")

privateAddressaddress;

...

}

@Configuration

此注解用在class上来定义bean。其作用和xml配置文件相同,表示此bean是

一个Spring配置。此外,此类可以使用@Bean注解来初始化定义bean。

@Configuartion

publicclassSpringCoreConfig{

@Bean

publicAdminUseradminUser(){

AdminUseradminUser=newAdminUser();

returnadminUser;

}

}

@ComponentScan

此注解一般和@Configuration注解一起使用,指定Spring扫描注解的package。

如果没有指定包,那么默认会扫描此配置类所在的package。@Lazy此注解使用

在Spring的组件类上。默认的,Spring中Bean的依赖一开始就被创建和配置。

如果想要延迟初始化一个bean,那么可以在此类上使用Lazy注解,表示此bean

只有在第一次被使用的时候才会被创建和初始化。此注解也可以使用在被

@Configuration注解的类上,表示其中所有被@Bean注解的方法都会延迟初始

化。@Value此注解使用在字段、构造器参数和方法参数上。@Value可以指定属

性取值的表达式,支持通过#{}使用SpringEL来取值,也支持使用${}来将属性

来源中(Properties文件、本地环境变量、系统属性等)的值注入到bean的属性

中。推荐大家看下:Java必须掌握的12种Spring常用注解,这篇也是必看

了。

此注解值的注入发生在AutowiredAnnotationBeanPostProcessor类中。

SpringMVC和REST注解

@Controller此注解使用在class上声明此类是一个Springcontroller,是

@Component注解的一种具体形式。

@RequestMapping此注解可以用在class和method上,用来映射web请求到某

一个handler类或者handler方法上。当此注解用在Class上时,就创造了一个

基础url,其所有的方法上的@RequestMapping都是在此url之上的。可以使用

其method属性来限制请求匹配的httpmethod。

@Controller

@RequestMapping("/users")

publicclassUserController{

@RequestMapping(method=RequestMethod.GET)

publicStringgetUserList(){

return"users";

}

}

这篇也推荐大家看下:SpringMVC常用注解。此外,Spring4.3之后引入

了一系列@RequestMapping的变种。如下:

@GetMapping@PostMapping@PutMapping@PatchMappin

g@DeleteMapping

分别对应了相应method的RequestMapping配置。

@CookieValue此注解用在@RequestMapping声明的方法的参数上,可以把HTTP

cookie中相应名称的cookie绑定上去。

@ReuestMapping("/cookieValue")

publicvoidgetCookieValue(@CookieValue("JSESSIONID")Stringcookie){

}

cookie即http请求中name为JSESSIONID的cookie值。@CrossOrigin此注解

用在class和method上用来支持跨域请求,是Spring4.2后引入的。

@CrossOrigin(maxAge=3600)

@RestController

@RequestMapping("/users")

publicclassAccountController{

@CrossOrigin(origins="http://xx.com")

@RequestMapping("/login")

publicResultuserLogin(){

//...

}

}

@ExceptionHandler

此注解使用在方法级别,声明对Exception的处理逻辑。可以指定目标

Exception。@InitBinder此注解使用在方法上,声明对WebDataBinder的初始

化(绑定请求参数到JavaBean上的DataBinder)。在controller上使用此注解

可以自定义请求参数的绑定。@MatrixVariable此注解使用在请求handler方法

的参数上,Spring可以注入matrixurl中相关的值。这里的矩阵变量可以出现

在url中的任何地方,变量之间用;分隔。如下:

//GET/pets/42;q=11;r=22

@RequestMapping(value="/pets/{petId}")

publicvoidfindPet(@PathVariableStringpetId,@MatrixVariableintq){

//petId==42

//q==11

}

需要注意的是默认Springmvc是不支持矩阵变量的,需要开启。

<mvc:annotation-drivenenable-matrix-variables="true"/>

注解配置则需要如下开启:

@Configuration

publicclassWebConfigextendsWebMvcConfigurerAdapter{

@Override

publicvoidconfigurePathMatch(PathMatchConfigurerconfigurer){

UrlPathHelperurlPathHelper=newUrlPathHelper();

urlPathHelper.setRemoveSemicolonContent(false);

configurer.setUrlPathHelper(urlPathHelper);

}

}

@PathVariable

此注解使用在请求handler方法的参数上。@RequestMapping可以定义动态路径,

如:

@RequestMapping("/users/{uid}")

可以使用@PathVariable将路径中的参数绑定到请求方法参数上。

@RequestMapping("/users/{uid}")

publicStringexecute(@PathVariable("uid")Stringuid){

}

@RequestAttribute

此注解用在请求handler方法的参数上,用于将web请求中的属性(request

attributes,是服务器放入的属性值)绑定到方法参数上。@RequestBody此注

解用在请求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")

publicPUsergetUser(){}

//controller和上面的代码在同一controller中

@Controller

@SeesionAttributes(value="user",types={

User.class

})

publicclassUserController{}

SpringBoot注解

@EnableAutoConfiguration此注解通常被用在主应用class上,告诉Spring

Boot自动基于当前包添加Bean、对bean的属性进行设置等。

@SpringBootApplication此注解用在SpringBoot项目的应用主类上(此类需

要在basepackage中)。使用了此注解的类首先会让SpringBoot启动对base

package以及其sub-pacakage下的类进行componentscan。这篇整理的也非常

全:SpringBoot最核心的25个注解,建议大家看下。此注解同时添加了以下

几个注解:

@Configuration@EnableAutoConfiguration@ComponentSc

an

Stereotype注解

@Component此注解使用在class上来声明一个Spring组件(Bean),将其加入到

应用上下文中。@Controller前文已经提到过@Service此注解使用在class上,

声明此类是一个服务类,执行业务逻辑、计算、调用内部api等。是@Component

注解的一种具体形式。@Repository此类使用在class上声明此类用于访问数据

库,一般作为DAO的角色。此注解有自动翻译的特性,例如:当此种component

抛出了一个异常,那么会有一个handler来处理此异常,无需使用try-catch

块。

数据访问注解

@Transactional此注解使用在接口定义、接口中的方法、类定义或者类中的

public方法上。需要注意的是此注解并不激活事务行为,它仅仅是一个元数据,

会被一些运行时基础设施来消费。

任务执行、调度注解

@Scheduled此注解使用在方法上,声明此方法被定时调度。使用了此注解的方

法返回类型需要是Void,并且不能接受任何参数。

@Scheduled(fixedDelay=1000)

publicvoidschedule(){

}

@Scheduled(fixedRate=1000)

publicvoidschedulg(){

}

第二个与第一个不同之处在于其不会等待上一次的任务执行结束。@Async此注

解使用在方法上,声明此方法会在一个单独的线程中执行。不同于Scheduled

注解,此注解可以接受参数。使用此注解的方法的返回类型可以是Void也可是

返回值。但是返回值的类型必须是一个Future。

测试注解

@ContextConfiguration此注解使用在Class上,声明测试使用的配置文件,此

外,也可以指定加载上下文的类。此注解一般需要搭配

SpringJUnit4ClassRunner使用。

@RunWith(SpringJUnit4ClassRunner.class)

@ContextConfiguration(classes=SpringCoreConfig.class)

publicclassUserServiceTest{

}

免费分享Java技术资料,需要的朋友可以在文章评论中加群

相关文章

网友评论

      本文标题:Spring最常用的7大类注解,史上最强整理!

      本文链接:https://www.haomeiwen.com/subject/ruloictx.html