SpringBoot对异常的统一处理

Spring Boot默认提供了一种映射到错误页面/error的机制来处理所有的错误，可以映射到名为404或500等的错误页面，但此种机制存在局限性。为此，SpringBoot提供了注解的方式自定义统一处理服务器500错误机制。

@ControllerAdvice注解表示我们定义的是一个控制器增强类，当其他任何控制器发生异常且异常类型符合@ExceptionHandler注解中指定的异常类时，原请求将会被拦截到这个我们自定义的控制器方法中。 其annotations参数表示我们要拦截的带有指定注解的类或方法

在@ExceptionHandler所注解的方法中，只有一个value参数，为指定的异常类；常用的三个参数Exception、HttpServletRequset、HttpServletResponse便可解决大部分问题

在向浏览器做出响应时应注意：浏览器的请求方式是普通的请求方式？还是异步请求方式？
这里我们从请求头里获取请求方式：request.getHeader("x-requested-with");
如果是异步请求则返回json格式的字符串，如果是普通请求则重定向至html页面

具体代码实现如下：
（此代码实现拦截所有带有@Controller注解的Exception类型的错误，并记录日志、做出响应）

import com.nowcoder.community.community.util.CommunityUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;

// ()内容表示：扫描带有Controller注解的Bean
@ControllerAdvice(annotations = Controller.class)
public class ExceptionAdvice {

    private static final Logger logger = LoggerFactory.getLogger(ExceptionAdvice.class);

    @ExceptionHandler({Exception.class})
    public void handleException(Exception e, HttpServletRequest request, HttpServletResponse response) throws IOException {
        // 记录异常的概括
        logger.error("服务器发生异常：" + e.getMessage());
        // 记录详细的栈中异常
        for (StackTraceElement element : e.getStackTrace()){
            logger.error(element.toString());
        }

        // 给浏览器响应（响应前需要判断请求的方式）
        String xRequestedWith = request.getHeader("x-requested-with");
        if("XMLHttpRequest".equals(xRequestedWith)){
            // 异步请求，向浏览器响应字符串
            response.setContentType("application/plain;charset=utf-8");// "plain"表示普通字符串，也可"json"表示json字符串
            PrintWriter writer = response.getWriter();
            writer.write(CommunityUtil.getJSONString(1,"服务器异常！"));
            // CommunityUtil为自定义的工具类，getJSONString为此类中获取JSON字符串的方法
        } else {
            // 普通请求，向浏览器响应html页面
            response.sendRedirect(request.getContextPath() + "/error");
        }
    }

}

标签：浏览器,请求,org,注解,import,统一,异常,SpringBoot
来源： https://blog.csdn.net/weixin_52850476/article/details/122650715