springboot【6】web开发之异常处理

最新推荐文章于 2021-02-21 11:54:14 发布

JeeLearner

最新推荐文章于 2021-02-21 11:54:14 发布

阅读量670

点赞数

分类专栏： ⊹●springboot Spring Boot基础篇文章标签： springboot教程 springboot spring springboot入门异常处理Exception

本文链接：https://blog.csdn.net/IT_lyd/article/details/76538547

版权

Spring Boot基础篇同时被 2 个专栏收录

36 篇文章 4 订阅

订阅专栏

⊹●springboot

34 篇文章 1 订阅

订阅专栏

在开发Web应用的时候，请求处理过程中发生错误是非常常见的情况。Spring Boot提供了一个默认的映射：/error，当处理中抛出异常之后，会转到该请求中处理，并且该请求有一个全局的错误页面用来展示异常内容。

以example04为基础，启动该应用，访问一个不存在的URL，或是修改处理内容，直接抛出异常，如：

package com.lyd.web;

import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import com.lyd.exception.MyException;

@Controller
public class HelloController {

	@RequestMapping(value="/hello")
	@ResponseBody
	public String hello() throws Exception{
		throw new Exception("发生错误");
	}
}

此时，可以看到类似下面的报错页面，该页面就是Spring Boot提供的默认error映射页面。(下图是默认的错误页面)

统一异常处理

虽然Spring Boot中实现了默认的error映射，但是在实际应用中，上面默认的错误页面对用户来说并不够友好，我们通常需要去实现我们自己的异常提示。

下面我们进行统一异常处理的改造。

创建全局异常处理类：通过使用@ControllerAdvice定义统一的异常处理类，而不是在每个Controller中逐个定义。@ExceptionHandler用来定义函数针对的异常类型，最后将Exception对象和请求URL映射到error.html中

package com.lyd.exception;

import javax.servlet.http.HttpServletRequest;

import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.servlet.ModelAndView;

/**
 * 
 * <p>Title: GlobalExceptionHandler.java</p>
 * <p>Description: 全局异常</p>
 * @author lyd
 * @date 2017年8月1日
 * @version 1.0
 * @blog springboot学习http://blog.csdn.net/IT_lyd/article/category/6692929
 */
@ControllerAdvice
public class GlobalExceptionHandler {

	@ExceptionHandler(value = Exception.class)
	public ModelAndView defaultErrorHandler(HttpServletRequest request, Exception e){
		ModelAndView mav = new ModelAndView();
		mav.addObject("exception", e);
		mav.addObject("url", request.getRequestURL());
		mav.setViewName("error");
		return mav;
	}
}

实现error.html页面展示：在templates目录下创建error.html，将请求的URL和Exception对象的message输出。

<!DOCTYPE html>
<html>
<head lang="en">
    <meta charset="UTF-8" />
    <title>统一异常处理</title>
</head>
<body>
<h1>Error Handler</h1>
<div th:text="${url}"></div>
<div th:text="${exception.message}"></div>
</body>
</html>

启动该应用，访问：http://localhost:8080/hello，可以看到如下错误提示页面。

通过实现上述内容之后，我们只需要在Controller中抛出Exception，当然我们可能会有多种不同的Exception。然后在@ControllerAdvice类中，根据抛出的具体Exception类型匹配@ExceptionHandler中配置的异常类型来匹配错误映射和处理。

返回JSON格式

在上述例子中，通过@ControllerAdvice统一定义不同Exception映射到不同错误处理页面。而当我们要实现RESTful API时，返回的错误是JSON格式的数据，而不是HTML页面，这时候我们也能轻松支持。

本质上，只需在@ExceptionHandler之后加入@ResponseBody，就能让处理函数return的内容转换为JSON格式。

下面以一个具体示例来实现返回JSON格式的异常处理。

创建统一的JSON返回对象，code：消息类型，message：消息内容，url：请求的url，data：请求返回的数据

package com.lyd.dto;

/**
 * 
 * <p>Title: ErrorInfo.java</p>
 * <p>Description: 自定义异常实体类</p>
 * @author lyd
 * @date 2017年8月1日
 * @version 1.0
 * @blog springboot学习http://blog.csdn.net/IT_lyd/article/category/6692929
 */
public class ErrorInfo<T> {

	public static final Integer OK = 0;
	public static final Integer ERROR = 100;
	
	private Integer code;
	private String message;
	private String url;
	private T data;
	
	// get/set方法.....
	
}

创建一个自定义异常，用来实验捕获该异常，并返回json

package com.lyd.exception;

/**
 * 
 * <p>Title: MyException.java</p>
 * <p>Description: 自定义异常</p>
 * @author lyd
 * @date 2017年8月1日
 * @version 1.0
 * @blog springboot学习http://blog.csdn.net/IT_lyd/article/category/6692929
 */
public class MyException extends Exception{

	public MyException(String message){
		super(message);
	}
}

Controller中增加json映射，抛出MyException异常

package com.lyd.web;

import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import com.lyd.exception.MyException;

@Controller
public class HelloController {

	@RequestMapping("/json")
	public String json() throws MyException{
		throw new MyException("发生错误MyException");
	}
}

为MyException异常创建对应的处理

package com.lyd.exception;

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;
import org.springframework.web.servlet.ModelAndView;

import com.lyd.dto.ErrorInfo;

/**
 * 
 * <p>Title: GlobalExceptionHandler.java</p>
 * <p>Description: 全局异常</p>
 * @author lyd
 * @date 2017年8月1日
 * @version 1.0
 * @blog springboot学习http://blog.csdn.net/IT_lyd/article/category/6692929
 */
@ControllerAdvice
public class GlobalExceptionHandler {

	/*
        @ExceptionHandler(value = Exception.class)
	public ModelAndView defaultErrorHandler(HttpServletRequest request, Exception e){
		ModelAndView mav = new ModelAndView();
		mav.addObject("exception", e);
		mav.addObject("url", request.getRequestURI());
		mav.setViewName("error");
		return mav;
	}
       */
       @ExceptionHandler(value = MyException.class)
	@ResponseBody
	public ErrorInfo<String> jsonErrorHandler(HttpServletRequest request, MyException me){
		ErrorInfo<String> ei = new ErrorInfo<String>();
		ei.setMessage(me.getMessage());
		ei.setCode(ErrorInfo.ERROR);
		ei.setData("Some Data");
		ei.setUrl(request.getRequestURI().toString());
		return ei;
	}
}

启动应用，访问：http://localhost:8080/json，可以得到如下返回内容：

至此，已完成在Spring Boot中创建统一的异常处理，实际实现还是依靠Spring MVC的注解，更多更深入的使用可参考Spring MVC的文档。

补充：

/**
 * 3.6.4 自定义异常
 * 针对网页请求返回500页面
 * 针对http请求返回异常json信息
 * @author qilongfei
 *
 */
public class UserNotExistException extends RuntimeException{
	private static final long serialVersionUID = 1L;
	private String id;
	
	public UserNotExistException(String id) {
		super("user not exist");
		this.id = id;
	}
	public String getId() {
		return id;
	}
	public void setId(String id) {
		this.id = id;
	}
}

@ControllerAdvice
public class ControllerExceptionHandler {

    @ExceptionHandler(UserNotExistException.class)
    @ResponseBody
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) //服务器内部错误500
    public Map<String, Object> handleUserNotExistException(UserNotExistException ex){
        Map<String, Object> result = new HashMap<String,Object>();
        result.put("id", ex.getId());
        result.put("message", ex.getMessage());
        return result;
    }
}

@GetMapping("/hello")
public String hello(){
    throw new UserNotExistException("1");
}

下面是完整项目结构：

JeeLearner

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
springboot【6】web开发之异常处理

在开发Web应用的时候，请求处理过程中发生错误是非常常见的情况。Spring Boot提供了一个默认的映射：/error，当处理中抛出异常之后，会转到该请求中处理，并且该请求有一个全局的错误页面用来展示异常内容。以example04为基础，启动该应用，访问一个不存在的URL，或是修改处理内容，直接抛出异常，如：package com.lyd.web;import org.springf
复制链接

扫一扫