Spring Boot 异常处理 Exception

处理 API 中的异常和错误并向客户端发送正确的响应对于企业应用程序是有益的。 在本章中，我们将学习如何在 Spring Boot 中处理异常(Exception)。

在进行异常处理之前，让我们了解以下注解。

Controller Advice

@ControllerAdvice 是一个注解，用于全局处理异常。

Exception Handler

@ExceptionHandler 是一个注解，用于处理特定异常并将自定义响应发送给客户端。

我们可以使用以下代码创建 @ControllerAdvice 类来全局处理异常

package com.study.exception;

import org.springframework.web.bind.annotation.ControllerAdvice;

@ControllerAdvice
public class ProductExceptionController {
}

定义一个继承 RuntimeException 类的类。

package com.study.exception;

public class ProductNotFoundException extends RuntimeException {

    private static final long serialVersionUID = 1L;
}

我们可以定义@ExceptionHandler 方法来处理异常，如图所示。 此方法应用于编写 Controller Advice 类文件。

@ExceptionHandler(value = ProductNotfoundException.class)

public ResponseEntity<Object> exception(ProductNotfoundException exception) {
}

现在，使用下面给出的代码从 API 抛出异常

@RequestMapping(value = "/products/{id}", method = RequestMethod.PUT)
public ResponseEntity<Object> updateProduct() { 
   throw new ProductNotfoundException();
}

下面给出了处理异常的完整代码。 在此示例中，我们使用 PUT API 来更新商品。 这里，在更新商品时，如果没有找到该商品，则返回响应错误消息为“未找到商品”。 请注意，ProductNotFoundException 异常类应该继承 RuntimeException。

package com.study.exception;

/**
 * @author jiyik.com
 */
public class ProductNotFoundException extends RuntimeException {

    private static final long serialVersionUID = 1L;
}

下面给出了全局处理异常的 Controller Advice 类。 我们可以在这个类文件中定义任何异常处理方法。

package com.study.exception;

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

/**
 * @author jiyik.com
 */
@ControllerAdvice
public class ProductExceptionController {

    @ExceptionHandler(value = ProductNotFoundException.class)
    public ResponseEntity<Object> exception(ProductNotFoundException exception) {
        return new ResponseEntity<>("未找到商品", HttpStatus.NOT_FOUND);
    }
}

下面给出了 Product Service API 控制器文件来更新商品。 如果未找到商品，则抛出 ProductNotFoundException 异常。

package com.study.controller;

import java.util.HashMap;
import java.util.Map;

import com.study.exception.ProductNotFoundException;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import com.study.model.Product;

@RestController
public class ProductServiceController {
    private static Map<String, Product> productRepo = new HashMap<>();
    static {
        Product honey = new Product();
        honey.setId("1");
        honey.setName("Honey");
        productRepo.put(honey.getId(), honey);

        Product almond = new Product();
        almond.setId("2");
        almond.setName("Almond");
        productRepo.put(almond.getId(), almond);
    }

    @RequestMapping(value = "/products/{id}", method = RequestMethod.PUT)
    public ResponseEntity<Object> updateProduct(@PathVariable("id") String id, @RequestBody Product product) {
        if(!productRepo.containsKey(id)) {
            throw new ProductNotFoundException();
        }
        productRepo.remove(id);
        product.setId(id);
        productRepo.put(id, product);
        return new ResponseEntity<>("商品更新成功", HttpStatus.OK);
    }
}

主 Spring Boot 应用程序类文件的代码如下

package com.study;

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

/**
 * @author jiyik.com
 */
@SpringBootApplication
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

Product 的 POJO 类的代码如下

package com.study.model;

/**
 * @author jiyik.com
 */
public class Product {
    private String id;
    private String name;

    public String getId() {
        return id;
    }
    public void setId(String id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}

Maven build – pom.xml 的代码如下所示

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.spring</groupId>
    <artifactId>springBootProject</artifactId>
    <version>1.0-SNAPSHOT</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.6</version>
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

Gradle Build - build.gradle 的代码如下

buildscript {
   ext {
      springBootVersion = '1.5.8.RELEASE'
   }
   repositories {
      mavenCentral()
   }
   dependencies {
      classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
   }
}
apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'org.springframework.boot'

group = 'com.study'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8

repositories {
   mavenCentral()
}
dependencies {
   compile('org.springframework.boot:spring-boot-starter-web')
   testCompile('org.springframework.boot:spring-boot-starter-test')
}

这里我们使用 IDEA 来启动服务（读者也可以使用 mvn clean install 或者 gradle clean build 生成可执行jar包）

接下来在 apifox 应用程序中访问以下 URL，我们可以看到如下所示的输出 -

UPDATE URL ：http://localhost:8080/products/3