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

一、介绍

创建 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。

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

  1. @ControllerAdvice 拦截异常并统一处理（转载）

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

  2. Spring Boot 系列（八）@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. spoj2142 Arranging Flowers

    传送门 题目大意 给你n和m,表示一个n*n的数独已经填完了m行,让你填出剩下几行,要求答案的字典序最小. 分析 看到这道题我首先想到的是记录每行每列使用了哪些数字,然后贪心的来填,但是发现用这种策略 ...

  2. Luogu 3457 [POI2007]POW-The Flood

    感觉自己什么题都写不动了. 又是一个神贪心:把所有城市中的点按照高度从小到大排序之后拿出来逐个计算,枚举其他高度小于它的点向四周扩展,如果这个点不能被之前放过的抽水机覆盖,那么把答案加一,并在这个点放 ...

  3. 巧用 git rebase 将某一部分 commit 复制到另一个分支

    一.为什么需要将一个 commit 复制到其他分支上去呢? 在我们的实际开发的过程中,我们的项目中会存在多个分支. 在某些情况下,可能需要将某一个分支上的 commit 复制到另一个分支上去.   二 ...

  4. Oracle数据库之多表查询一

    上一篇给大家介绍了数据的单表查询,相信大家对于单表的查询应该都有了一些了解.单表查询在数据库中的使用会有一些,但并不是很多,但是作为初学者,我们需要学习单表查询的思路.今天呢,我们为大家介绍一下数据库 ...

  5. java 字符流 字节流

    java对文本文档进行操作(拷贝.显示)出现乱码一般来说,可以从两个方面入手. 1.文本文件本身的编码格式. 2.java代码中处理文本文件的编码格式. 这里要注意的一点是,我们可以看出copyFil ...

  6. HTML5与CSS3设计模式 中文版 高清PDF扫描版

    HTML5与CSS3设计模式是一部全面讲述用HTML5和CSS3设计网页的教程.书中含350个即时可用的模式 (HTML5和CSS3代码片段),直接复制粘贴即可使用,更可以组合起来构建出无穷的解决方案 ...

  7. Zinterstore 命令

    先来看一下这个命令的定义: Redis Zinterstore 命令计算给定的一个或多个有序集的交集,其中给定 key 的数量必须以 numkeys 参数指定,并将该交集(结果集)储存到 destin ...

  8. KDevelop4调试pcl一直读取不到.pcd文件

    如题所示,KD下,能编译,运行时一直使用reader.read读取不到pcd,但是使用cmake能正常运行. 后来,使用terminator删掉工程的build文件夹,直接在工程文件下进行编译,报错提 ...

  9. POJ - 2528Mayor's posters （离散化+线段树区间覆盖）

    The citizens of Bytetown, AB, could not stand that the candidates in the mayoral election campaign h ...

  10. 设计一个MQ的考虑点

    转自: https://segmentfault.com/a/1190000004461970 序 这里总结下MQ的研究点,以及如果要自己设计一个MQ应该考虑的因素. 考虑点 1.远程通信功能 (1) ...