SpringBoot学习——全局异常处理设置（返回JSON）

桃扇骨 2022-06-12 06:44 400阅读 0赞

# SpringBoot学习——全局异常处理设置（返回JSON） #

## 需求 ##

1.  现在习惯使用ajax的方式发起请求，所以经常需要服务端返回一个json或者字符串。
2.  控制全局的异常处理。
3.  如果在单个方法中使用try，catch把方法包裹起来，工作量大，而且会异常的抛出而导致@Transactional注解的方法事务不会回滚。

## 说明 ##

1.  使用@ControllerAdvice注解
2.  使用@ExceptionHandler注解

### @ControllerAdvice ###

该注解是spring2.3以后新增的一个注解，主要是用来Controller的一些公共的需求的低侵入性增强提供辅助，作用于@RequestMapping标注的方法上。

### @ExceptionHandler ###

该注解是配合@ExceptionHandler一起使用的注解，自定义错误处理器，可自己组装json字符串，并返回到页面。

## 代码 ##

创建一个全局异常处理类，如下：  
如果向实现，不同的异常有不同的操作的话，只需要将 @ExceptionHandler的value的值不一样就可以了，可以同时实现多个不同的异常处理，但不能出现包含状态。

import javax.servlet.http.HttpServletRequest;
    
    import org.springframework.web.bind.annotation.ControllerAdvice;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    @ControllerAdvice
    @ResponseBody
    public class GlobalExceptionHandler { 
    
        /** * 所有异常报错 * @param request * @param exception * @return * @throws Exception */
        @ExceptionHandler(value=Exception.class)  
        public String allExceptionHandler(HttpServletRequest request,  
                Exception exception) throws Exception  
        {  
            exception.printStackTrace();
            System.out.println("我报错了："+exception.getLocalizedMessage());
            System.out.println("我报错了："+exception.getCause());
            System.out.println("我报错了："+exception.getSuppressed());
            System.out.println("我报错了："+exception.getMessage());
            System.out.println("我报错了："+exception.getStackTrace());
            return "服务器异常，请联系管理员！";  
        }  
    
    }

模拟一个抛出异常类,下例是抛出一个空指针异常和分母不为异常

import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    @Controller
    @RequestMapping("/exceptionTest")
    @ResponseBody
    public class ExceptionTest { 
        @RequestMapping("/test")
        public String test(){
            Message msg = null;
            msg.toString();
            createException();
            return "我是正常的";
        }
    
        private void createException(){
            int i = 5/0;
        }
    }

## 启动Springboot，执行结果 ##

因为返回的是字符串，也可以使用json工具类来封装，返回一个json字符串  
![wnJIhW3.png][]  
![JegjDFp.png][]

## 参考 ##

[http://www.cnblogs.com/yangzhilong/p/6148309.html][http_www.cnblogs.com_yangzhilong_p_6148309.html]

[wnJIhW3.png]: http://i.imgur.com/wnJIhW3.png
[JegjDFp.png]: http://i.imgur.com/JegjDFp.png
[http_www.cnblogs.com_yangzhilong_p_6148309.html]: http://www.cnblogs.com/yangzhilong/p/6148309.html