在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。

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

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

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

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

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

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

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

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

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

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

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

  6. SpringBoot起飞系列-拦截器和统一错误处理（七）

    一.前言 在前边部分我们已经学会了基本的web开发流程,在web开发中,我们通常会对请求做统一处理,比如未登录的用户要拦截掉相关请求,报错页面统一显示等等,这些都需要配置,可以大大简化我们的代码,实现 ...

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

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

  8. @ControllerAdvice全局异常拦截

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

  9. SpringBoot - @ControllerAdvice 处理异常

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

随机推荐

  1. 初学 Python 需要安装哪些软件？

    自动配置.有效求助.协作编程.版本控制.一站式解决 Python 新手练习中的痛点. 痛点 这个学期,我在北得克萨斯大学(University of North Texas)教 INFO 5731: ...

  2. CSS选择器的关系

    .selector > box 的使用 该方式,只会选择其第一级子盒子 .selector + box 的使用 除了其本身,选择其兄弟盒子,但会受到其他元素的影响,如在兄弟间添加其他元素,则无法 ...

  3. 李志杰的C语言程序设计第一次作业

    这个作业属于C语言程序设计课程 : https://edu.cnblogs.com/campus/zswxy/CST2020-2 这个作业要求在哪里: https://edu.cnblogs.com/ ...

  4. 实战一：建立springcloud基础项目结构

    一,,创建父工程,用于管理项目依赖版本 1,new -> project -> maven 2,修改pom.xml,这里管理了springboot,springcloud,springcl ...

  5. linux中nginx中配置端口转发

    域名指向主机IP地址,通过域名:8080才能访问网站,去掉后面的8080:或者其他的端口号,直接使用域名访问网站 版权声明:本文为博主原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处 ...

  6. NB-IOT的应用场景有哪些

    虽然抄表.停车.井盖监测等应用是最为常见的示范,但若低功耗广域网络仅限于这几个领域,则整个产业的规模就显得太小了.实际上,经过近两年的探索,目前示范应用的数量已有数十个,分布在各行各业,带来了大量的机 ...

  7. pause容器作用

    1.概念 Pause容器 全称infrastucture container(又叫infra)基础容器. 作为init pod存在,其他pod都会从pause 容器中fork出来. 每个Pod里运行着 ...

  8. Linux 系统编程 学习：07-基于socket的网络编程2：基于 UDP 的通信

    Linux 系统编程 学习:07-基于socket的网络编程2:基于 UDP 的通信 背景 上一讲我们介绍了网络编程的一些概念.socket的网络编程的有关概念 这一讲我们来看UDP 通信. 知识 U ...

  9. 微信小程序新闻网站列表页

    在app.json中可以设置所有文件的头部导航颜色 (是window属性的子属性) 在具体页面可以单独设置该页面的导航颜色 (直接写该属性,不需要写window属性) 查看官方文档,可以看到好多全局属 ...

  10. 转：Microsoft Dynamics AX内部版本号概述

    Overview of Microsoft Dynamics AX build numbers 转自:https://community.dynamics.com/ax/b/axsupport/arc ...