Java 学习 --SpringBoot 常用注解详解(一)
在日常 Java 开发或者说在日常 Java 学习中总会遇到各种各样的注解,有 Spring 官方的注解,有自定义的注解,总之你在开发中一定会遇到注解的使用,也是有了注解才使得开发效率更高,也使得开发人员不用去关注 SpringBoot 内部实现,而只需要关注自身业务,在需要的时候直接使用注解即可,而无需再次开发公共功能,从而提高开发效率,那么 SpringBoot 常用注解有哪些呢?我们来看 Spring Web MVC 注解
Spring Web MVC 注解
@RequestMapping
@RequestMapping 注解的主要用途是将 Web 请求与请求处理类中的方法进行映射。比如
@RequestMapping 注解对请求处理类中的请求处理方法进行标注;@RequestMapping 注解属性主要有一下配置属性:
name:为此映射指定一个名称
value:映射的请求 URL 或者其别名
path:映射路径 URI
method:要映射到的 HTTP 请求方法,缩小主映射范围
params:映射请求的参数,缩小主映射范围。
headers:映射请求的头,缩小主映射范围
consumes:通过可由映射处理程序使用的媒体类型缩小主映射范围
produces:通过可由映射处理程序生成的媒体类型缩小主映射
提示:在使用 @RequestMapping 之前,请求处理类还需要使用 @Controller 或 @RestController 进行标记。
@RequestMapping 可以对类和方法进行标记
这样类中的处理方法在映射请求路径时,会自动将类上 @RequestMapping 设置的 value 拼接到方法中映射路径之前。
@RequestBody
@RequestBody 在处理请求方法的参数列表中使用,它可以将请求主体中的参数绑定到一个对象中,请求主体参数是通过 HttpMessageConverter 传递的,根据请求主体中的参数名与对象的属性名进行匹配并绑定值。
此外,还可以通过 @Validated 注解对请求主体中的参数进行校验,比如
@GetMapping
@GetMapping 注解用于处理 HTTP GET 请求,并将请求映射到具体的处理方法中。具体来说,@GetMapping 是一个组合注解,它相当于是 @RequestMapping(method=RequestMethod.GET)的快捷方式,比如
@PostMapping
@PostMapping 注解用于处理 HTTP POST 请求,并将请求映射到具体的处理方法中。@PostMapping 与 @GetMapping 一样,也是一个组合注解,它相当于 @RequestMapping(method=HttpMethod.POST)的快捷方式,比如
@DeleteMapping
@DeleteMapping 注解用于处理 HTTP DELETE 请求,并将请求映射到删除方法中。@DeleteMapping 是一个组合注解,它相当于是 @RequestMapping(method=HttpMethod.DELETE)的快捷方式,比如
@PatchMapping
@PatchMapping 注解用于处理 HTTP PATCH 请求,并将请求映射到对应的处理方法中。@PatchMapping 相当于是 @RequestMapping(method=HttpMethod.PATCH)的快捷方式。
@ControllerAdvice @RestControllerAdvice
@ControllerAdvice 是 @Component 注解的一个延伸注解,Spring 会自动扫描并检测 @ControllerAdvice 所标注的类。@ControllerAdvice 需要和 @ExceptionHandler、@InitBinder 以及 @ModelAttribute 注解搭配使用,主要是用来处理控制器所抛出的异常信息。
首先,我们需要定义一个被 @ControllerAdvice 所标注的类,在该类中,定义一个用于处理具体异常的方法,并使用 @ExceptionHandler 注解进行标记,比如
此外,在有必要的时候,可以使用 @InitBinder 在类中进行全局的配置,还可以使用 @ModelAttribute 配置与视图相关的参数。使用 @ControllerAdvice 注解,就可以快速的创建统一的,自定义的异常处理类。
@RestControllerAdvice 其实就是在 @ControllerAdvice 加了一个 @ResponseBody 注解,用来将返回值写入到响应体。
@ResponseBody
@ResponseBody 会自动将控制器中方法的返回值写入到 HTTP 响应中,比如
特别的,@ResponseBody 注解只能用在被 @Controller 注解标记的类中。如果在被 @RestController 标记的类中,则方法不需要使用 @ResponseBody 注解进行标注。@RestController 相当于是 @Controller 和 @ResponseBody 的组合注解。
@ExceptionHandler
@ExceptionHander 注解用于标注处理特定类型异常类所抛出异常的方法,当控制器中的方法抛出异常时,Spring 会自动捕获异常,并将捕获的异常信息传递给被 @ExceptionHandler 标注的方法,比如
@ResponseStatus
@ResponseStatus 注解可以标注请求处理方法。使用此注解,可以指定响应所需要的 HTTP STATUS。特别地,我们可以使用 HttpStauts 类对该注解的 value 属性进行赋值。
@PathVariable
@PathVariable 注解是将方法中的参数绑定到请求 URI 中的模板变量上。可以通过 @RequestMapping 注解来指定 URI 的模板变量,然后使用 @PathVariable 注解将方法中的参数绑定到模板变量上,比如
特别地,@PathVariable 注解允许我们使用 value 或 name 属性来给参数取一个别名。模板变量名需要使用{ }进行包裹,如果方法的参数名与 URI 模板变量名一致,则在 @PathVariable 中就可以省略别名的定义。
@RequestParam
@RequestParam 注解用于将方法的参数与 Web 请求的传递的参数进行绑定。使用 @RequestParam 可以轻松的访问 HTTP 请求参数的值。该注解的其他属性配置与 @PathVariable 的配置相同,
特别的,如果传递的参数为空,还可以通过 defaultValue 设置一个默认值。
@Controller @RestController
@Controller 是 @Component 注解的一个延伸,比如
@RestController 是在 Spring 4.0 开始引入的,这是一个特定的控制器注解。此注解相当于 @Controller 和 @ResponseBody 的快捷方式。当使用此注解时,不需要再在方法上使用 @ResponseBody 注解。
@ModelAttribute
通过此注解,可以通过模型索引名称来访问已经存在于控制器中的 model。与 @PathVariable 和 @RequestParam 注解一样,如果参数名与模型具有相同的名字,则不必指定索引名称。
特别地,如果使用 @ModelAttribute 对方法进行标注,Spring 会将方法的返回值绑定到具体的 Model 上。
在 Spring 调用具体的处理方法之前,被 @ModelAttribute 注解标注的所有方法都将被执行。
@CrossOrigin
@CrossOrigin 注解将为请求处理类或请求处理方法提供跨域调用支持。如果我们将此注解标注类,那么类中的所有方法都将获得支持跨域的能力。使用此注解的好处是可以微调跨域行为。
@InitBinder
@InitBinder 注解用于标注初始化 WebDataBinider 的方法,该方法用于对 Http 请求传递的表单数据进行处理,如时间格式化、字符串处理等,比如
总结
以上就是日常开发中经常会用到的 Spring Web MVC 的注解,注解的讲解如有不明白欢迎指导。
版权声明: 本文为 InfoQ 作者【六月的雨在InfoQ】的原创文章。
原文链接:【http://xie.infoq.cn/article/1fca8725d79d9ed46c4b421fe】。
本文遵守【CC-BY 4.0】协议,转载请保留原文出处及本版权声明。
评论