在spring 3.2中，新增了@ControllerAdvice 注解，可以用于定义@ExceptionHandler、@InitBinder、@ModelAttribute，并应用到所有@RequestMapping中。

一、介绍

创建 MyControllerAdvice，并添加 @ControllerAdvice注解。

package com.sam.demo.controller;

import org.springframework.ui.Model;

import org.springframework.web.bind.WebDataBinder;

import org.springframework.web.bind.annotation.*;

import java.util.HashMap;

import java.util.Map;

/**

 * controller 增强器

 * @author sam

 * @since 2017/7/17

 */

@ControllerAdvice

public class MyControllerAdvice {

    /**

     * 应用到所有@RequestMapping注解方法，在其执行之前初始化数据绑定器

     * @param binder

     */

    @InitBinder

    public void initBinder(WebDataBinder binder) {}

    /**

     * 把值绑定到Model中，使全局@RequestMapping可以获取到该值

     * @param model

     */

    @ModelAttribute

    public void addAttributes(Model model) {

        model.addAttribute("author", "Magical Sam");

    }

    /**

     * 全局异常捕捉处理

     * @param ex

     * @return

     */

    @ResponseBody

    @ExceptionHandler(value = Exception.class)

    public Map errorHandler(Exception ex) {

        Map map = new HashMap();

        map.put("code", 100);

        map.put("msg", ex.getMessage());

        return map;

    }

}

启动应用后，被 @ExceptionHandler、@InitBinder、@ModelAttribute 注解的方法，都会作用在 被 @RequestMapping 注解的方法上。

@ModelAttribute：在Model上设置的值，对于所有被 @RequestMapping 注解的方法中，都可以通过 ModelMap 获取，如下：

@RequestMapping("/home")

public String home(ModelMap modelMap) {

    System.out.println(modelMap.get("author"));

}

//或者 通过@ModelAttribute获取

@RequestMapping("/home")

public String home(@ModelAttribute("author") String author) {

    System.out.println(author);

}

@ExceptionHandler 拦截了异常，我们可以通过该注解实现自定义异常处理。其中，@ExceptionHandler 配置的 value 指定需要拦截的异常类型，上面拦截了 Exception.class 这种异常。

二、自定义异常处理（全局异常处理）

spring boot 默认情况下会映射到 /error 进行异常处理，但是提示并不十分友好，下面自定义异常处理，提供友好展示。

1、编写自定义异常类：

package com.sam.demo.custom;

/**

 * @author sam

 * @since 2017/7/17

 */

public class MyException extends RuntimeException {

    public MyException(String code, String msg) {

        this.code = code;

        this.msg = msg;

    }

    private String code;

    private String msg;

    // getter & setter

}

注：spring 对于 RuntimeException 异常才会进行事务回滚。

2、编写全局异常处理类

创建 MyControllerAdvice.java，如下：

package com.sam.demo.controller;

import org.springframework.ui.Model;

import org.springframework.web.bind.WebDataBinder;

import org.springframework.web.bind.annotation.*;

import java.util.HashMap;

import java.util.Map;

/**

 * controller 增强器

 *

 * @author sam

 * @since 2017/7/17

 */

@ControllerAdvice

public class MyControllerAdvice {

    /**

     * 全局异常捕捉处理

     * @param ex

     * @return

     */

    @ResponseBody

    @ExceptionHandler(value = Exception.class)

    public Map errorHandler(Exception ex) {

        Map map = new HashMap();

        map.put("code", 100);

        map.put("msg", ex.getMessage());

        return map;

    }

    /**

     * 拦截捕捉自定义异常 MyException.class

     * @param ex

     * @return

     */

    @ResponseBody

    @ExceptionHandler(value = MyException.class)

    public Map myErrorHandler(MyException ex) {

        Map map = new HashMap();

        map.put("code", ex.getCode());

        map.put("msg", ex.getMsg());

        return map;

    }

}

3、controller中抛出异常进行测试。

@RequestMapping("/home")

public String home() throws Exception {

//        throw new Exception("Sam 错误");

    throw new MyException("101", "Sam 错误");

}

启动应用，访问：http://localhost:8080/home ，正常显示以下json内容，证明自定义异常已经成功被拦截。

{"msg":"Sam 错误","code":"101"}

如果不需要返回json数据，而要渲染某个页面模板返回给浏览器，那么MyControllerAdvice中可以这么实现：

@ExceptionHandler(value = MyException.class)

public ModelAndView myErrorHandler(MyException ex) {

    ModelAndView modelAndView = new ModelAndView();

    modelAndView.setViewName("error");

    modelAndView.addObject("code", ex.getCode());

    modelAndView.addObject("msg", ex.getMsg());

    return modelAndView;

}

在 templates 目录下，添加 error.ftl（这里使用freemarker） 进行渲染：

<!DOCTYPE html>

<html lang="en">

<head>

    <meta charset="UTF-8">

    <title>错误页面</title>

</head>

<body>

    <h1>${code}</h1>

    <h1>${msg}</h1>

</body>

</html>

重启应用，http://localhost:8080/home 显示自定的错误页面内容。

补充：如果全部异常处理返回json，那么可以使用 @RestControllerAdvice 代替 @ControllerAdvice ，这样在方法上就可以不需要添加 @ResponseBody。

转载自：

Spring Boot 系列（八）@ControllerAdvice 拦截异常并统一处理

@ControllerAdvice 拦截异常并统一处理（转载）的更多相关文章

  1. Spring Boot 系列（八）@ControllerAdvice 拦截异常并统一处理

    在spring 3.2中,新增了@ControllerAdvice 注解,可以用于定义@ExceptionHandler.@InitBinder.@ModelAttribute,并应用到所有@Requ ...

  2. @ControllerAdvice 拦截异常并统一处理

    在spring 3.2中,新增了@ControllerAdvice 注解,可以用于定义@ExceptionHandler.@InitBinder.@ModelAttribute,并应用到所有@Requ ...

  3. SpringBoot 之 @ControllerAdvice 拦截异常并统一处理

    在spring 3.2中,新增了@ControllerAdvice 注解,可以用于定义@ExceptionHandler.@InitBinder.@ModelAttribute,并应用到所有@Requ ...

  4. Spring Boot 系列 @ControllerAdvice 拦截异常并统一处理

    ControllerAdvice用法解析 简介 通过@ControllerAdvice注解可以将对于控制器的全局配置放在同一个位置. 注解了@Controller的类的方法可以使用@Exception ...

  5. SpringBoot-@ControllerAdvice 拦截异常并统一处理

    SpringBoot是为了简化Spring应用的创建.运行.调试.部署等一系列问题而诞生的产物, 自动装配的特性让我们可以更好的关注业务本身而不是外部的XML配置,我们只需遵循规范,引入相关的依赖就可 ...

  6. Spring-@ControllerAdvice 拦截异常并统一处理

    在spring 3.2中,新增了@ControllerAdvice 注解, 可以用于定义@ExceptionHandler.@InitBinder.@ModelAttribute,并应用到所有@Req ...

  7. @ControllerAdvice全局异常拦截

    @ControllerAdvice 拦截异常并统一处理 在spring 3.2中,新增了@ControllerAdvice 注解,可以用于定义@ExceptionHandler.@InitBinder ...

  8. 精通Spring Boot---使用@ControllerAdvice处理异常

    在Spring 3.2中,新增了@ControllerAdvice.@RestControllerAdvice 注解,可以用于定义@ExceptionHandler.@InitBinder.@Mode ...

  9. SpringBoot - @ControllerAdvice 处理异常

    在Spring 3.2中,新增了@ControllerAdvice.@RestControllerAdvice 注解,可以用于定义@ExceptionHandler.@InitBinder.@Mode ...

随机推荐

  1. Windows7光盘制作： 向脱机映像添加补丁

    所谓脱机(offline)映像就是WIM文件,install.wim就是脱机映像,有的install.wim里面有几个子映像,有的里面就只有一个.install.wim中有多个映像的光盘叫做多合一光盘 ...

  2. [转]ubuntu安装gcc

    Ubuntu缺省情况下,并没有提供C/C++的编译环境,因此还需要手动安装. 如果单独安装gcc以及g++比较麻烦,幸运的是,为了能够编译Ubuntu的内核,Ubuntu提供了一个build-esse ...

  3. struts解决form提交的中文参数乱码问题

    根据struts的工作原理,原文摘自<Java Web 开发实战经典> 在运行一个JSP页面前,会调用指定的ActionForm中的reset()方法,进行表单元素的初始化 因此,在相应的 ...

  4. plsql 查询到别的用户下面的表

    原因:勾选了"Allow multiple connections" 解决方法:打开"Tools"下面的"Perference",里面有个& ...

  5. 如何有效地提升JavaScript 水平？

    lyuehh 努力学习中.. 9 人赞同 简单的介绍一下, 不一定准确, 大家一起进步... (单词大小写什么的别计较....) 学习js主要是一下几个方面, js语言本身的知识, 和浏览器相关的知识 ...

  6. 1.3 Services - 服务

    服务是一种应用组件,它可以在后台执行耗时的操作,它是没有用户界面的.其它的应用组件都可以开启一个服务,服务开启后,即使用户离开了应用,服务仍然可以在后台运行.此外,绑定到服务的组件可以与服务进行交互, ...

  7. python 脚本撞库国内“某榴”账号

    其实日常生活中我们的用户名和密码就那么几个,所以这给撞库带来了可能,本文主要给出python脚本撞库的一点粗浅代码.这里只讨论技术本生,代码中某榴的地址也已经改掉,避免被管理员误解禁言等发生,谢谢大家 ...

  8. 设置Tomcat编码(UTF-8)

    Tomcat的默认编码是ISO-8859-1,如果有是get请求时,会出现乱码,这种情况可以修改Tomcat的编码解决. 在tomcat的conf目录下,编辑server.xml配置文件,在Conne ...

  9. Java Drp项目实战——Web应用server

    引言 Web应用server如今非常多人都在用,但是究竟什么是Web应用server呢,它与Webserver有什么关系,它与应用server又是什么关系,它是他们两种中的当中一种,还是简单的两种se ...

  10. 第二百一十九节，jQuery EasyUI，DateTimeBox(日期时间输入框)组件

    jQuery EasyUI,DateTimeBox(日期时间输入框)组件 学习要点: 1.加载方式 2.属性列表 3.方法列表 本节课重点了解 EasyUI 中 DateTimeBox(日期时间输入框 ...