SpringMVC--控制器增强(十四)

一、@ControllerAdvice

@ControllerAdvice，是Spring3.2提供的新注解，从名字上可以看出大体意思是控制器增强。
通过@ControllerAdvice，我们可以对于控制器的全局配置放在同一个位置，注解了@Controller的类的方法可使用@ExceptionHandler、@ModelAttribute、@InitBinder注解到方法上，这对所有注解了@RequestMapping的控制器内的方法有效。
@ExceptionHandler：用于全局处理控制器里的异常。
@ModelAttribute：@ModelAttribute本来的作用是绑定健值对到Model里，此处是让全局的@RequestMapping都能获得此处设置的健值对。
@InitBinder：用来设置WebDataBinder，WebDataBinder用来自动绑定前台请求参数到Model中。

二、定义异常处理控制器

/**
 * 声明了一个控制器，@ControllerAdvice 组合了@Component注解，所以自动注册到Spring的Bean。
 */
@ControllerAdvice
public class ExceptionHandlerAdvice {
    // 在此处定义全局处理，通过value属性可过滤拦截条件，在此处我们可以看出拦截了所有的Exception。
    @ExceptionHandler(value = Exception.class)
    public ModelAndView exception(Exception exception, WebRequest request) {
        // errorJSP页面
        ModelAndView modelAndView = new ModelAndView("error");
        modelAndView.addObject("errorMessage", exception.getMessage());
        return modelAndView;
    }

    /**
     *  将键值对添加到全局，所有注解了@RequestMapping的方法可获得此健值对。
     * @param model
     */
    @ModelAttribute
    public void addAttributes(Model model) {
        model.addAttribute("msg", "全局错误信息");
    }
    @InitBinder //定制WebDataBinder
    public void initBinder(WebDataBinder webDataBinder) {
        webDataBinder.setDisallowedFields("id"); // 忽略request参数的id
    }
}

异常方法:

@ExceptionHandler(value = Exception.class)
    public ModelAndView exception(Exception exception, HttpServletRequest request, HttpServletResponse response){
}

三、定义错误页面

<%@ page contentType="text/html;charset=UTF-8" language="java" %>


    


${errorMessage}

四、异常测试

@RestController
@RequestMapping("/user")
@Slf4j
public class UserController {
    @Autowired
    private UserService userService;
    @RequestMapping("/advice")
    public String getSomething(@ModelAttribute("msg") String msg){
        throw new IllegalArgumentException("非常抱歉，参数有误/"+"来自@ModelAttribute:"+ msg);
    }
}

测试结果

五、@InitBinder

  从字面意思可以看出这个的作用是给Binder做初始化的，被此注解的方法可以对WebDataBinder初始化。webDataBinder是用于表单到方法的数据绑定的！
  @InitBinder用于在@Controller中标注于方法上，表示为当前控制器注册一个属性编辑器，只对当前的Controller有效。@InitBinder标注的方法必须有一个参数WebDataBinder。所谓的属性编辑器可以理解就是帮助我们完成参数绑定。

1. 对数据绑定进行设置
   WebDataBinder中有很多方法可以对数据绑定进行具体的设置：比如我们设置name属性为非绑定属性（也可以设置绑定值setAllowedFields）：
   在Controller中添加一个方法：

    /**
     * 禁止绑定
     * @param binder
     */
    @InitBinder
    public void initBinder(WebDataBinder binder) {
        // 禁止绑定
//        binder.setDisallowedFields("name");
        // 允许绑定
        binder.setAllowedFields("name");
    }
    @RequestMapping(value = "/getName",method = RequestMethod.POST)
    public String getName(Role role){
        log.info(role.getName());
        return "user/user";
    }

说明：
绑定与禁止绑定只能作用在实体类上参数方式与JSON格式都可以使用，简单类型无效果。

2. 数据格式处理
   @InitBinder方法会帮助我们把String类型的参数先trim再绑定，而对于Date类型的参数会先格式化在绑定。

@ControllerAdvice
public class GlobalControllerAdvice {
    @InitBinder
    public void initBinder(WebDataBinder binder) {
        binder.registerCustomEditor(String.class,
                new StringTrimmerEditor(true));
        binder.registerCustomEditor(Date.class,
                new CustomDateEditor(new SimpleDateFormat("yyyy-MM-dd"), false));
    }
}

除了使用@ControllerAdvice来配置全局的WebDataBinder，还可以使用RequestMappingHandlerAdapter：

    @Configuration
public class ConfigTest {
    @Bean
    public RequestMappingHandlerAdapter webBindingInitializer() {
        RequestMappingHandlerAdapter adapter = new RequestMappingHandlerAdapter();
        adapter.setWebBindingInitializer(new WebBindingInitializer() {
            @Override
            public void initBinder(WebDataBinder binder) {
                binder.registerCustomEditor(Date.class, new CustomDateEditor(new SimpleDateFormat("yyyy-MM-dd"), false));
            }
        });
        return adapter;
    }
}

在applicationContext.xml中添加包扫描：