www.2527.com_澳门新葡8455手机版_新京葡娱乐场网址_
做最好的网站

Boot中Web应用的统一异常处理,Boot中Controller的统

2019-10-05 20:32 来源:未知

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

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

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

选择一个之前实现过的Web应用(chapter11-5-1 )为基础,启动该应用,访问一个不存在的URL,或是修改处理内容,直接抛出异常,如:

选择一个之前实现过的Web应用(Chapter3-1-2)为基础,启动该应用,访问一个不存在的URL,或是修改处理内容,直接抛出异常,如:

统一异常处理

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

下面我们以之前的Web应用例子为基础,进行统一异常处理的改造。

@RequestMapping@Throws(Exception::class)fun hello() { throw Exception}
@RequestMappingpublic String hello() throws Exception { throw new Exception;}

创建全局异常处理类

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

package com.pingkeke.rdf.exception;

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

import javax.servlet.http.HttpServletRequest;

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

    public static final String DEFAULT_ERROR_VIEW = "error";

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

注意版本实例修改默认端口,现在为8083,如果想修改为默认的,请修改application.yml文件

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

实现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/exception,可以看到如下错误提示页面。

Error Handler

http://localhost:8080/exception
发生错误

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

server: port: 8080

图片 1alt=默认的错误页面

返回JSON格式

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

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

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

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

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

创建统一的JSON返回对象

code:消息类型,message:消息内容,url:请求的url,data:请求返回的数据

package com.pingkeke.rdf.dto;

/**
 * 创建统一的JSON返回对象.
 *
 * code:消息类型;
 * message:消息内容;
 * url:请求的url;
 * data:请求返回的数据.
 */
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;

    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public static Integer getOK() {
        return OK;
    }

    public static Integer getERROR() {
        return ERROR;
    }

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }
}
Whitelabel Error PageThis application has no explicit mapping for /error, so you are seeing this as a fallback.Fri Jan 19 10:01:32 CST 2018There was an unexpected error (type=Internal Server Error, status=500).????

下面我们以之前的Web应用例子为基础(Chapter3-1-2),进行统一异常处理的改造。

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

package com.pingkeke.rdf.exception;

/**
 * 自定义异常.
 */
public class MyException extends Exception {

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

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

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

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

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

下面我们以之前的Web应用例子为基础(chapter11-5-1 ),进行统一异常处理的改造。

为MyException异常创建对应的处理

@ExceptionHandler(value = MyException.class)
@ResponseBody
public ErrorInfo<String> jsonErrorHandler(HttpServletRequest req, MyException e) throws Exception {
    ErrorInfo<String> r = new ErrorInfo<>();
    r.setMessage(e.getMessage());
    r.setCode(ErrorInfo.ERROR);
    r.setData("Some Data");
    r.setUrl(req.getRequestURL().toString());
    return r;
}

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

@ControllerAdviceclass GlobalExceptionHandler { public static final String DEFAULT_ERROR_VIEW = "error"; @ExceptionHandler(value = Exception.class) public ModelAndView defaultErrorHandler(HttpServletRequest req, Exception e) throws Exception { ModelAndView mav = new ModelAndView(); mav.addObject("exception", e); mav.addObject("url", req.getRequestURL; mav.setViewName(DEFAULT_ERROR_VIEW); return mav; }}

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

{
    "code": 100, 
    "message": "发生错误2", 
    "url": "http://localhost:8080/json", 
    "data": "Some Data"
}

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

@ControllerAdvice 注解的类需要增加 @RestController //springboot1.5.7版本,如果不加 这个会报错 jsonErrorHandler

  • 实现error.html页面展示:在templates目录下创建error.html,将请求的URL和Exception对象的message输出。
import org.springframework.web.bind.annotation.ControllerAdviceimport org.springframework.web.bind.annotation.ExceptionHandlerimport org.springframework.web.bind.annotation.RestControllerimport org.springframework.web.servlet.ModelAndViewimport javax.servlet.http.HttpServletRequest/** * Created by http://quanke.name on 2018/1/10. */@ControllerAdvice@RestController //springboot1.5.7版本,如果不加 这个会报错 jsonErrorHandlerclass GlobalExceptionHandler { @ExceptionHandler(value = Exception::class) @Throws(Exception::class) fun defaultErrorHandler(req: HttpServletRequest, e: Exception): ModelAndView { val mav = ModelAndView() mav.addObject("exception", e) mav.addObject("url", req.requestURL) mav.viewName = "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>
<!DOCTYPE html><html xmlns:th="http://www.w3.org/1999/xhtml"><head lang="en"> <meta charset="UTF-8" /> <title>统一异常处理</title></head><body><h1>http://quanke.name Error Handler</h1><div th:text="${url}"></div><div th:text="${exception.message}"></div></body></html>

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

启动该应用,访问:

图片 2alt=自定义的错误页面

http://quanke.name Error Handlerhttp://127.0.0.1:8083/hello发生错误

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

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

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

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

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

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

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

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

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

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

data class ErrorInfo<T>(var code: Int? = null, var message: String? = "", var url: String? = "", var data: T? = null)
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; // 省略getter和setter}

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

  • 创建一个自定义异常,用来实验捕获该异常,并返回json
/** * Created by http://quanke.name on 2018/1/11. */class QkException(message: String) : Exception

Controller中增加json映射,抛出QkException异常

public class MyException extends Exception { public MyException(String message) { super; } }
import name.quanke.kotlin.chaper11_5_3.exception.QkExceptionimport org.springframework.stereotype.Controllerimport org.springframework.web.bind.annotation.RequestMapping/** * Created by http://quanke.name on 2018/1/10. */@Controllerclass UserController { @RequestMapping @Throws(QkException::class) fun json(): String { throw QkException("发生错误 json") }}
  • Controller中增加json映射,抛出MyException异常

为QkException异常创建对应的处理

import name.quanke.kotlin.chaper11_5_3.entity.ErrorInfoimport org.springframework.web.bind.annotation.ControllerAdviceimport org.springframework.web.bind.annotation.ExceptionHandlerimport org.springframework.web.bind.annotation.RestControllerimport javax.servlet.http.HttpServletRequest/** * Created by http://quanke.name on 2018/1/10. */@ControllerAdvice@RestController //springboot1.5.7版本,如果不加 这个会报错 jsonErrorHandlerclass GlobalExceptionHandler { @ExceptionHandler(value = QkException::class) @Throws(QkException::class) fun jsonErrorHandler(req: HttpServletRequest, e: QkException): ErrorInfo<String> { val r = ErrorInfo<String>() r.message = e.message r.code = 1 r.data = "Some Data" r.url = req.requestURL.toString() return r }
@Controllerpublic class HelloController { @RequestMapping public String json() throws MyException { throw new MyException; }}

启动应用,访问:

  • MyException异常创建对应的处理
{ "code": 1, "message": "发生错误 json", "url": "http://127.0.0.1:8083/json", "data": "Some Data"}

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

@ControllerAdvicepublic class GlobalExceptionHandler { @ExceptionHandler(value = MyException.class) @ResponseBody public ErrorInfo<String> jsonErrorHandler(HttpServletRequest req, MyException e) throws Exception { ErrorInfo<String> r = new ErrorInfo<>(); r.setMessage(e.getMessage; r.setCode(ErrorInfo.ERROR); r.setData("Some Data"); r.setUrl(req.getRequestURL().toString; return r; }}
  • 启动应用,访问:
{ code: 100, data: "Some Data", message: "发生错误2", url: "http://localhost:8080/json"}

《Spring Boot 与 kotlin 实战》 专题欢迎关注

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

图片 3全科龙婷

本文完整示例:chapter3-1-6

TAG标签:
版权声明:本文由澳门新葡8455手机版发布于www.2527.com,转载请注明出处:Boot中Web应用的统一异常处理,Boot中Controller的统