spring boot 最佳实践（四）--Spring MVC

Spring MVC注解分类

为简化RestFul api的开发，Spring MVC 4.X提供了Rest相关的组合注解。例如@Restcontroller是@Controller和@ResponseBody的组合，@GetMapping是@RequestMapping(method = RequestMethod.GET)的组合，@RestControllerAdvice是@ControllerAdvice和@ResponseBody的组合。

@ResponseBody 将内容或对象作为 HTTP 响应正文返回，并调用适合HttpMessageConverter的Adapter转换对象，写入输出流。RestFul api默认使用json数据传输（contentType : ‘application/json’ ），Spring MVC 将@ResponseBody注解的方法返回值自动转换为json字符串。所有与@ResponseBody相关的组合注解都默认由此功能。

Spring MVC 4.4提供的主要注解如下图。

RestFul api注解的使用案例

@Restcontroller
public class Login{

@CrossOrigin(origins = {"*.crfchina.com", "*.crfxjd.com"},
maxAge = 4800, allowCredentials = "false")
@PutMapping(value = "/login")
public String login(@RequestHeader(value="User-Agent") String userAgent,
@RequestBody LoginParam param){

}

@GetMapping(value = "/authenticationCode/{phone}",headers="app-type=ios")
public String getCodeForIos(@PathVariable(value = "phone") String phone) {
return "";
}

@GetMapping(value = "/authenticationCode/{phone}",headers="app-type=android")
public String getCodeForAndroid(@PathVariable(value = "phone") String phone) {
return "";
}

@PostMapping(value = "/checkMessage")
public String checkMessage(
@CookieValue(value = "authenticationCode", required = false) String authenticationCode,
String code) {
return "";
}
}

@ControllerAdvice 通过AOP对全局controller增强功能，支持@ExceptionHandler和@Initbinder两种注解。

异常拦截器

@RestControllerAdvice可以对RestFul api做一些统一处理，比如异常拦截和日志打印。

@RestControllerAdvice
public class ExceptionHandlerAdvice {

@ExceptionHandler(value = { Exception.class })
@ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR)
public Object handleOtherExceptions(final Exception ex, final ServletWebRequest req) {
Log.error("系统内部异常:" + req, ex);
Map<String, Object> view = new HashMap<>();
view.put("code", 2);
view.put("message", "系统繁忙,请稍后再试");
return view;
}
}

自定义请求参数转换

如果请求端的数据不符合标准的数据转换格式，controller无法直接接收的话，可以使用SpringMVC的注解@Initbinder和Spring自带的WebDateBinder类来自定义请求参数转换。@InitBinder对当前controller有效果，如果要全局生效则需要在@ControllerAdvice控制下。

WebDataBinder是用来绑定请求参数到指定的属性编辑器。由于前台传到controller里的值是String类型的，当往Model里Set这个值的时候，如果set的这个属性是个对象，Spring就会去找到对应的editor进行转换，然后再SET进去。

@RestControllerAdvice
public class BinderAdvice {
@InitBinder
public void initBinder(WebDataBinder binder) {
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
dateFormat.setLenient(false);
binder.registerCustomEditor(Date.class, new CustomDateEditor(dateFormat, true));
}
}