SpringBoot 常用注解 – Spring Web MVC 注解
摘自:https://mp.weixin.qq.com/s/dWIO1bfmMhVWo1ZPVIS09Q
@RequestMapping
说明:
@RequestMapping注解的主要用途是将Web请求与请求处理类中的方法进行映射。Spring MVC和Spring WebFlux都通过RquestMappingHandlerMapping和RequestMappingHndlerAdapter两个类来提供对@RequestMapping注解的支持。
属性:
- value:映射的请求URL或者其别名
- method:兼容HTTP的方法名
- params:根据HTTP参数的存在、缺省或值对请求进行过滤
- header:根据HTTP Header的存在、缺省或值对请求进行过滤
- consume:设定在HTTP请求正文中允许使用的媒体类型
- product:在HTTP响应体中允许使用的媒体类型
注意:
在使用@RequestMapping之前,请求处理类还需要使用@Controller或@RestController进行标记
示例:
例1
@Controller
public class DemoController{
@RequestMapping(value="/demo/home",method=RequestMethod.GET)
public String home(){
return "/home";
}
}
例2
/**
* @RequestMapping还可以对类进行标记,这样类中的处理方法在映射请求路径时,
* 会自动将类上@RequestMapping设置的value拼接到方法中映射路径之前
*/
@Controller
@RequestMapping(value="/demo")
public class DemoController{
@RequestMapping(value="/home",method=RequestMethod.GET)
public String home(){
return "/home";
}
}
@RequestBody
说明:
@RequestBody在处理请求方法的参数列表中使用,它可以将请求主体中的参数绑定到一个对象中,请求主体参数是通过HttpMessageConverter传递的,根据请求主体中的参数名与对象的属性名进行匹配并绑定值。此外,还可以通过@Valid注解对请求主体中的参数进行校验。
示例:
@RequestController
@RequestMapping("/api/v1")
public class UserController{
@Autowired
private UserService userService;
@PostMapping("/users")
public User createUser(@Valid @RequestBody User user){
return userService.save(user);
}
}
@GetMapping
说明:
@GetMapping注解用于处理HTTP GET请求,并将请求映射到具体的处理方法中。具体来说,@GetMapping是一个组合注解,它相当于是@RequestMapping(method=RequestMethod.GET)的快捷方式。
示例:
@RequestController
@RequestMapping("/api/v1")
public class UserController{
@Autowired
private UserService userService;
@GetMapping("/users")
public List<User>findAllUser(){
List<User>users userService.findAll();
return users;
}
@GetMapping("/users/{id]")
public User findoneById(@PathVariable(name="id")long id)throws UserNotFoundException{
return userService.findOne(id);
}
}
@PostMapping
说明:
@PostMapping注解用于处理HTTP POST请求,并将请求映射到具体的处理方法中。@PostMapping与@GetMapping一样,也是一个组合注解,它相当于是@RequestMapping(method=HttpMethod.POST)的快捷方式。
示例:
@RequestController
@RequestMapping("/api/v1")
public class UserController{
@Autowired
private UserServiceuserService;
@PostMapping("/users")
public User createUser(@Valid @RequestBody User user){
return userService.save(user);
}
}
@PutMapping
说明:
@PutMapping注解用于处理HTTP PUT请求,并将请求映射到具体的处理方法中,@PutMapping是一个组合注解,相当于是@RequestMapping(method=HttpMethod.PUT)的快捷方式。
示例:
@RequestController
@RequestMapping("/api/v1")
public class UserController{
@Autowired
private UserRepository userRepository;
@PutMapping("/users/{id}")
public ResponseEntity<User>updateUser(@PathValriable(name="id")long id,avalue @ResponseBody User detail)throws UserNotFoundException{
User user userRepository.findById(id)
.orElseThrow(()->new UserNotFountException("User not found with this id:"+id));
user.setLastName(detail.getLastName());
user.setEmail(detail.getEmail());
user.setAddress(detail.getAddress());
final User origin = userRepository.save(user);
return ResponseEntity.ok(origin);
}
}
@DeleteMapping
说明:
@DeleteMapping注解用于处理HTTP DELETE请求,并将请求映射到删除方法中。@DeleteMapping是一个组合注解,它相当于是@RequestMapping(method=HttpMethod.DELETE)的快捷方式。
示例:
@RequestController
@RequestMapping("/api/v1")
public class UserController{
@Autowired
private UserRepository userRepository;
@DeleteMapping("/users/{id}")
public Map<String,Boolean>deleteById(@PathVariable(name="id")long id)throws UserNotFountException{
Useruser userRepository.findById(id)
.orElseThrow(()->new UserNotFoundException("User not found for this id "+id));
userRepository.delete(user);
Map<String,Boolean>response new HashMap();
response.put("deleted",Boolean.TRUE);
return response;
}
}
@PatchMapping
说明:
@PatchMapping注解用于处理HTTP PATCH请求,并将请求映射到对应的处理方法中。@PatchMapping相当于是@RequestMapping(method=HttpMethod.PATCH)的快捷方式。
示例:
@RequestController
@RequestMapping("/api/v1")
public class UserController{
@PatchMapping("/users/patch")
public ResponseEntity<Object>patch(){
return new ResposneEntity("Patch method response message",HttpStatus.OK);
}
}
@ControllerAdvice
说明:
@ControllerAdvice是@Component注解的一个延伸注解,Spring会自动扫描并检测被@ControllerAdvice所标注的类。@ControllerAdvice需要和@ExceptionHandler、@InitBinder以及@ModelAttribute注解搭配使用,主要是用来处理控制器所抛出的异常信息。
用法说明:
- 首先,我们需要定义一个被@ControllerAdvice所标注的类,在该类中,定义一个用于处理具体异常的方法,并使用@ExceptionHandler注解进行标记。
- 此外,在有必要的时候,可以使用@InitBinder在类中进行全局的配置,还可以使用@ModelAttribute配置与视图相关的参数。使用@ControllerAdvice注解,就可以快速的创建统一的,自定义的异常处理类。
示例:
@ControllerAdvice(basePackages={"com.ramostear.controller.user"})
public class UserControllerAdvice{
@InitBinder
public void binder(WebDataBinder binder){
SimpleDateFormat format new simpleDateFormat("yyyy-MM-dd");
format.setLenient(false);
binder.registerCustomEditor(Date.class,"user",new CustomDateFormat(format,true));
}
@ModelAttribute
public void modelAttribute(Modelmodel){
model.addAttribute("msg","User not found exception.");
}
@ExceptionHandler(UserNotFoundException.class)
public ModelAndView userNotFoundExceptionHandler(UserNotFoundException ex){
ModelAndViewmodelAndview new ModelAndView();
modelAndView.addobject("exception",ex);
modelAndView.setviewName("error");
return modelAndView;
}
}
@ResponseBody
说明:
@ResponseBody会自动将控制器中方法的返回值写入到HTTP响应中。特别的,@ResponseBody注解只能用在被@Controller注解标记的类中。如果在被@RestController标记的类中,则方法不需要使用@ResponseBody注解进行标注。@RestController相当于是@Controller和@ResponseBody的组合注解。
示例:
@ResponseBody
@GetMapping("/users/{id}"
public User findByUserId(@PathVariable long id)throws UserNotFoundException{
User user userService.findOne(id);
return user;
}
@ExceptionHandler
说明:
@ExceptionHander注解用于标注处理特定类型异常类所抛出异常的方法。当控制器中的方法抛出异常时,Spring会自动捕获异常,并将捕获的异常信息传递给被@ExceptionHandler标注的方法。
示例:
@ExceptionHandler(UserNotFoundException.class)
public ResponseEnitty<Object>userNotFoundExceptionHandler(UserNotFoundException ex,WebRequest request){
UserErrorDetail detail = new UserErrorDetail(new Date(),ex.getMessage(),request.getDescription(false));
return new ResponseEntity<>(detail,HttpStatus.NOT_FOUND);
}
@ResponseStatus
说明:
@ResponseStatus注解可以标注请求处理方法。使用此注解,可以指定响应所需要的HTTP STATUS。特别地,我们可以使用HttpStauts类对该注解的value属性进行赋值。
示例:
@ResponseStatus(Httpstatus.BAD_REQUEST)
@ExceptionHandler(UserNotFoundException.class)
public ResponseEnitty<Object>userNotFoundExceptionHandler(UserNotFoundException ex,WebRequest request){
UserErrorDetail detail = new UserErrorDetail(new Date(),ex.getMessage(),request.getDescription(false));
return new ResponseEntity<>(detail,HttpStatus.NOT_FOUND);
}
@PathVariable
说明:
@PathVariable注解是将方法中的参数绑定到请求URI中的模板变量上。可以通过@RequestMapping注解来指定URI的模板变量,然后使用@PathVariable注解将方法中的参数绑定到模板变量上。
属性:
value/name:给参数取一个别名。
注意:
- 模板变量名需要使用{ }进行包裹,如果方法的参数名与URI模板变量名一致,则在@PathVariable中就可以省略别名的定义。
- 如果参数是一个非必须的,可选的项,则可以在@PathVariable中设置require = false
示例:
例1
@GetMapping("/users/{id}/roles/{roleId}")
public Role getUserRole(@PathVariable(name="id")long id,@PathVariable(value="roleId")long roleId)throws ResourceNotFoundException{
return userRoleService.findByUserIdAndRoleId(id,roleId);
}
例2
@GetMapping("/users/{id}/roles/{roleId}")
public Role getUserRole(@PathVariable long id,@PathVariable long roleId)throws ResourceNotFoundException{
return userRoleService.findByUserIdAndRoleId(id,roleId);
}
@RequestParam
说明
@RequestParam注解用于将方法的参数与Web请求的传递的参数进行绑定。使用@RequestParam可以轻松的访问HTTP请求参数的值。
注意
该注解的其他属性配置与@PathVariable的配置相同,而且,如果传递的参数为空,还可以通过defaultValue设置一个默认值。
@GetMapping
public Role getUserRole(@RequestParam(name="id",defaultValue="0")long id,@RequestParam(name="roleId",defaultValue="0")long roleId)throws ResourceNotFoundException{
if(id=0 || roleId=0){
return new Role();
}
return userRoleService.findByUserIdAndRoleId(id,roleId);
}
@Controller
说明:
@Controller是@Component注解的一个延伸,Spring 会自动扫描并配置被该注解标注的类。此注解用于标注Spring MVC的控制器。
示例:
@Controller
@RequestMapping("/api/v1")
public class UserApiController{
@Autowired
private UserServiceuserService;
@GetMapping("/users/{id}")
@ResponseBody
public User getUserById(@PathVariable long id)throws UserNotFoundException{
return userService.findOne(id);
}
}
@RestController
说明:
@RestController是在Spring 4.0开始引入的,这是一个特定的控制器注解。此注解相当于@Controller和@ResponseBody的快捷方式。当使用此注解时,不需要再在方法上使用@ResponseBody注解。
示例:
@RestController
@RequestMapping("/api/v1")
public class UserApiController{
@Autowired
private UserService userService;
@GetMapping("/users/{id}")
public User getUserById(@PathVariable long id)throws UserNotFoundException{
return userService.findone(id);
}
}
@ModelAttribute
说明:
通过此注解,可以通过模型索引名称来访问已经存在于控制器中的model
例1
@PostMapping("/users")
public void createUser(@ModelAttribute("user")Useruser){
userService.save(user);
}
与@PathVariable和@RequestParam注解一样,如果参数名与模型具有相同的名字,则不必指定索引名称
例2
@PostMapping("/users")
public void createUser(@ModelAttribute User user){
userService.save(user);
}
如果使用@ModelAttribute对方法进行标注,Spring会将方法的返回值绑定到具体的Model上
例3
@ModelAttribute("ramostear")
User getuser(){
User user = new User();
user.setId(1);
user.setFirstName("ramostear");
user.setEmail("ramosteara163.com")
// ....
return user;
}
注意:
在Spring调用具体的处理方法之前,被@ModelAttribute注解标注的所有方法都将被执行。
@CrossOrigin
说明:
@CrossOrigin注解将为请求处理类或请求处理方法提供跨域调用支持。如果我们将此注解标注类,那么类中的所有方法都将获得支持跨域的能力。使用此注解的好处是可以微调跨域行为
示例:
@Crossorigin
@GetMapping("/users/home")
public String userDetails(@RequestParam(name="id",defaultvalue="0")long id)throws UserNotFoundException{
if(id == 0){
return new User();
}
return userservice.findone(id).tostring();
}
@InitBinder
说明:
@InitBinder注解用于标注初始化WebDataBinider 的方法,该方法用于对Http请求传递的表单数据进行处理,如时间格式化、字符串处理等。
示例:
@InitBinder
public void initBinder(WebDataBinder dataBinder){
StringTrimmerEditor editor = new StringTrimmerEditor(true);
dataBinder.registerCustomEditor(String.class,editor);
}