【Spring实战】27 统一异常处理最佳实践

在 Spring 项目中，有效的异常处理是确保应用程序稳定性和用户体验的关键因素之一。通过实现统一异常处理，我们能够更好的管理和响应应用程序中的各种异常情况。本文将介绍在 Spring 项目中如何实现统一异常处理的最佳实践。

1. 自定义异常

首先，我们需要定义一些自定义异常类，以便能够区分和处理不同类型的异常。这样我们就可以在异常处理器中根据异常类型进行不同的处理。例如：此处我们定义了两种异常，找不到资源异常和校验失败异常。

ResourceNotFoundException.java

表示资源未找到的异常

package com.cheney.demo.exception;

public class ResourceNotFoundException extends RuntimeException {

    public ResourceNotFoundException() {
        super("Resource not found");
    }

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

    public ResourceNotFoundException(String message, Throwable cause) {
        super(message, cause);
    }
}

ValidationException.java

表示验证失败的异常

package com.cheney.demo.exception;

public class ValidationException extends RuntimeException {

   public ValidationException() {
       super("Validation failed");
   }

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

   public ValidationException(String message, Throwable cause) {
       super(message, cause);
   }
}

上述两个自定义异常类的代码中：

• 我们继承了 RuntimeException，这是一个运行时异常，它通常用于表示程序无法继续执行的情况。
• 我们提供了多个构造函数，以便在创建异常实例时能够传递不同的信息和异常原因。
• 构造函数中的 super 调用是为了将异常信息传递给父类，以便在异常发生时能够捕获和记录相关信息。

2. 统一异常处理

接下来，我们创建一个全局异常处理类，使用 @ControllerAdvice 注解标记，该类将捕获整个应用程序中抛出的异常，并通过 @ExceptionHandler 方法进行处理。

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;

@ControllerAdvice
public class GlobalExceptionHandler {

    // 处理找不到资源异常
    @ExceptionHandler(ResourceNotFoundException.class)
    @ResponseStatus(HttpStatus.NOT_FOUND)
    public ResponseEntity<String> handleNotFoundException(ResourceNotFoundException ex) {
        return new ResponseEntity<>("找不到资源！", HttpStatus.NOT_FOUND);
    }

    // 处理校验失败异常
    @ExceptionHandler(ValidationException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public ResponseEntity<String> handleValidationException(ValidationException ex) {
        return new ResponseEntity<>("校验失败！", HttpStatus.BAD_REQUEST);
    }

    // 处理其他异常
    @ExceptionHandler(Exception.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    public ResponseEntity<String> handleException(Exception ex) {
        return new ResponseEntity<>("服务器异常！", HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

在这个类中，我们通过 @ExceptionHandler 注解为不同类型的自定义异常定义了处理方法。每个方法都返回适当的HTTP响应码和消息。

3. 配置

确保在 Spring 配置文件中，server.error.include-stacktrace 配置项被设置为 never，以确保不将堆栈跟踪信息返回给客户端：

pom.xml

server.error.include-stacktrace=never

4. 应用

在你的控制器中，当出现需要处理的异常时，抛出相应的自定义异常：

package com.cheney.demo.controller;

import com.cheney.demo.exception.ResourceNotFoundException;
import com.cheney.demo.exception.ValidationException;
import org.springframework.core.io.Resource;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("demo")
public class DemoController {

    @GetMapping("resource")
    public ResponseEntity<Resource> checkResource() {
        // 业务逻辑，然后根据判断抛出异常
        throw new ResourceNotFoundException();
        // 正常返回
    }

    @GetMapping("validation")
    public ResponseEntity<Resource> checkValidation() {
        // 业务逻辑，然后根据判断抛出异常
        throw new ValidationException();
        // 正常返回
    }

    @GetMapping("other")
    public ResponseEntity<Resource> checkOther() throws Exception {
        // 业务逻辑，然后根据判断抛出异常
        throw new Exception();
        // 正常返回
    }
}

5. 启动类

DemoApplication.java

package com.cheney.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

6. 启动服务

7. 验证

1）访问下面 URL 验证 GlobalExceptionHandler 中的 handleNotFoundException 方法

http://localhost:8080/demo/resource

2）访问下面 URL 验证 GlobalExceptionHandler 中的 handleValidationException 方法

http://localhost:8080/demo/validation

3）访问下面 URL 验证 GlobalExceptionHandler 中的 handleException 方法

http://localhost:8080/demo/other

8. 优点

• 一致性

  统一异常处理确保应用程序在不同地方抛出的异常都能够得到一致的处理方式。无论是在控制器、服务层、还是其他组件中，都能够通过相同的规则进行异常处理，保持了一致性。

• 代码可读性

  通过将异常处理集中在一个地方，提高了代码的可读性。不同类型的异常有各自的处理逻辑，开发人员无需在每个地方都编写相同的异常处理代码，而是集中在全局异常处理器中进行维护。

• 减少重复代码

  统一异常处理减少了代码中的冗余和重复，使得开发者能够更专注于业务逻辑而不是异常处理。这有助于减少错误，并提高开发效率。

• 集中式问题追踪

  当应用程序遇到问题时，异常信息被集中记录，使得问题的诊断和修复更加方便。全局异常处理器允许你自定义日志输出、监控或通知等行为，方便问题的集中式追踪。

• 用户友好的错误响应

  通过全局异常处理，可以为不同类型的异常定义适当的用户友好的错误响应。这有助于提高用户体验，让用户更容易理解发生了什么问题。

• 安全性

  统一异常处理可以处理安全相关的异常，比如认证失败、权限不足等。通过在全局异常处理器中处理这些异常，可以更好地保护应用程序的安全性。

• 灵活性

  全局异常处理允许开发者灵活地定义处理不同类型异常的策略。你可以根据具体的业务需求，为每种异常类型定义特定的处理方式，而不是在每个地方都硬编码相同的异常处理逻辑。

总结

通过这种方式，当你的应用程序中的任何地方抛出自定义异常时，全局异常处理类将捕获它并相应地处理异常。这提供了一种一致的方式来处理异常，提高了代码的可读性和可维护性。通过实现这些步骤，你可以在 Spring 项目中轻松实现统一异常处理，确保应用程序在面对异常情况时表现出一致的行为，提高用户体验和开发效率。