一、Spring Web MVC 与 Spring Bean 注解
Spring Web MVC 注解
@RequestMapping
@RequestMapping注解的主要用途是将Web请求与请求处理类中的方法进行映射。Spring MVC和Spring WebFlux都通过RquestMappingHandlerMapping
和RequestMappingHndlerAdapter
两个类来提供对@RequestMapping注解的支持。
@RequestMapping
注解对请求处理类中的请求处理方法进行标注;@RequestMapping
注解拥有以下的六个配置属性:
value
:映射的请求URL或者其别名method
:兼容HTTP的方法名params
:根据HTTP参数的存在、缺省或值对请求进行过滤header
:根据HTTP Header的存在、缺省或值对请求进行过滤consume
:设定在HTTP请求正文中允许使用的媒体类型product
:在HTTP响应体中允许使用的媒体类型
提示:在使用@RequestMapping之前,请求处理类还需要使用@Controller或@RestController进行标记
下面是使用@RequestMapping的两个示例:
@RequestMapping还可以对类进行标记,这样类中的处理方法在映射请求路径时,会自动将类上@RequestMapping设置的value拼接到方法中映射路径之前,如下:
@RequestBody
@RequestBody在处理请求方法的参数列表中使用,它可以将请求主体中的参数绑定到一个对象中,请求主体参数是通过HttpMessageConverter
传递的,根据请求主体中的参数名与对象的属性名进行匹配并绑定值。此外,还可以通过@Valid注解对请求主体中的参数进行校验。
下面是一个使用@RequestBody
的示例:
@GetMapping
@GetMapping
注解用于处理HTTP GET请求,并将请求映射到具体的处理方法中。具体来说,@GetMapping是一个组合注解,它相当于是@RequestMapping(method=RequestMethod.GET)
的快捷方式。
下面是@GetMapping
的一个使用示例:
@PostMapping
@PostMapping
注解用于处理HTTP POST请求,并将请求映射到具体的处理方法中。@PostMapping与@GetMapping一样,也是一个组合注解,它相当于是@RequestMapping(method=HttpMethod.POST)
的快捷方式。
下面是使用@PostMapping
的一个示例:
@PutMapping
@PutMapping
注解用于处理HTTP PUT请求,并将请求映射到具体的处理方法中,@PutMapping是一个组合注解,相当于是@RequestMapping(method=HttpMethod.PUT)
的快捷方式。
下面是使用@PutMapping
的一个示例:
@DeleteMapping
@DeleteMapping
注解用于处理HTTP DELETE请求,并将请求映射到删除方法中。@DeleteMapping是一个组合注解,它相当于是@RequestMapping(method=HttpMethod.DELETE)
的快捷方式。
下面是使用@DeleteMapping
的一个示例:
@PatchMapping
@PatchMapping
注解用于处理HTTP PATCH请求,并将请求映射到对应的处理方法中。@PatchMapping相当于是@RequestMapping(method=HttpMethod.PATCH)
的快捷方式。
下面是一个简单的示例:
@ControllerAdvice
@ControllerAdvice
是@Component注解的一个延伸注解,Spring会自动扫描并检测被@ControllerAdvice所标注的类。@ControllerAdvice
需要和@ExceptionHandler
、@InitBinder
以及@ModelAttribute
注解搭配使用,主要是用来处理控制器所抛出的异常信息。
首先,我们需要定义一个被@ControllerAdvice
所标注的类,在该类中,定义一个用于处理具体异常的方法,并使用@ExceptionHandler注解进行标记。
此外,在有必要的时候,可以使用@InitBinder
在类中进行全局的配置,还可以使用@ModelAttribute配置与视图相关的参数。使用@ControllerAdvice
注解,就可以快速的创建统一的,自定义的异常处理类。
下面是一个使用@ControllerAdvice
的示例代码:
@ResponseBody
@ResponseBody
会自动将控制器中方法的返回值写入到HTTP响应中。特别的,@ResponseBody
注解只能用在被@Controller
注解标记的类中。如果在被@RestController
标记的类中,则方法不需要使用@ResponseBody
注解进行标注。@RestController
相当于是@Controller
和@ResponseBody
的组合注解。
下面是使用该注解的一个示例
@ExceptionHandler
@ExceptionHander
注解用于标注处理特定类型异常类所抛出异常的方法。当控制器中的方法抛出异常时,Spring会自动捕获异常,并将捕获的异常信息传递给被@ExceptionHandler
标注的方法。
下面是使用该注解的一个示例:
@ResponseStatus
@ResponseStatus
注解可以标注请求处理方法。使用此注解,可以指定响应所需要的HTTP STATUS。特别地,我们可以使用HttpStauts类对该注解的value属性进行赋值。
下面是使用@ResponseStatus
注解的一个示例:
@PathVariable
@PathVariable
注解是将方法中的参数绑定到请求URI中的模板变量上。可以通过@RequestMapping
注解来指定URI的模板变量,然后使用@PathVariable
注解将方法中的参数绑定到模板变量上。
特别地,@PathVariable
注解允许我们使用value或name属性来给参数取一个别名。下面是使用此注解的一个示例:
模板变量名需要使用{ }
进行包裹,如果方法的参数名与URI模板变量名一致,则在@PathVariable
中就可以省略别名的定义。
下面是一个简写的示例:
提示:如果参数是一个非必须的,可选的项,则可以在@PathVariable
中设置require = false
@RequestParam
@RequestParam
注解用于将方法的参数与Web请求的传递的参数进行绑定。使用@RequestParam
可以轻松的访问HTTP请求参数的值。
下面是使用该注解的代码示例:
该注解的其他属性配置与@PathVariable
的配置相同,特别的,如果传递的参数为空,还可以通过defaultValue设置一个默认值。示例代码如下:
@Controller
@Controller
是@Component
注解的一个延伸,Spring 会自动扫描并配置被该注解标注的类。此注解用于标注Spring MVC的控制器。下面是使用此注解的示例代码:
@RestController
@RestController
是在Spring 4.0开始引入的,这是一个特定的控制器注解。此注解相当于@Controller
和@ResponseBody
的快捷方式。当使用此注解时,不需要再在方法上使用@ResponseBody
注解。
下面是使用此注解的示例代码:
@ModelAttribute
通过此注解,可以通过模型索引名称来访问已经存在于控制器中的model。下面是使用此注解的一个简单示例:
与@PathVariable
和@RequestParam
注解一样,如果参数名与模型具有相同的名字,则不必指定索引名称,简写示例如下:
特别地,如果使用@ModelAttribute
对方法进行标注,Spring会将方法的返回值绑定到具体的Model上。示例如下:
在Spring调用具体的处理方法之前,被@ModelAttribute
注解标注的所有方法都将被执行。
@CrossOrigin
@CrossOrigin
注解将为请求处理类或请求处理方法提供跨域调用支持。如果我们将此注解标注类,那么类中的所有方法都将获得支持跨域的能力。使用此注解的好处是可以微调跨域行为。使用此注解的示例如下:
@InitBinder
@InitBinder
注解用于标注初始化WebDataBinider 的方法,该方法用于对Http请求传递的表单数据进行处理,如时间格式化、字符串处理等。下面是使用此注解的示例:
图片
推荐下自己做的 Spring Boot 的实战项目: