Spring-boot-exception-handling

提供：Dev Guides
移動先:案内、検索

Spring Boot-例外処理

APIで例外とエラーを処理し、クライアントに適切な応答を送信することは、エンタープライズアプリケーションに適しています。 この章では、Spring Bootで例外を処理する方法を学びます。

例外処理に進む前に、次の注釈について理解しましょう。

コントローラーのアドバイス

@ControllerAdviceは、例外をグローバルに処理するための注釈です。

例外ハンドラー

@ExceptionHandlerは、特定の例外を処理し、カスタム応答をクライアントに送信するために使用される注釈です。

次のコードを使用して@ControllerAdviceクラスを作成し、例外をグローバルに処理できます- 

package com.finddevguides.demo.exception;

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

@ControllerAdvice
   public class ProductExceptionController {
}

RuntimeExceptionクラスを拡張するクラスを定義します。 

package com.finddevguides.demo.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.finddevguides.demo.exception;
public class ProductNotfoundException extends RuntimeException {
   private static final long serialVersionUID = 1L;
}

例外をグローバルに処理するController Adviceクラスを以下に示します。 このクラスファイルで例外ハンドラメソッドを定義できます。 

package com.finddevguides.demo.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;

@ControllerAdvice
public class ProductExceptionController {
   @ExceptionHandler(value = ProductNotfoundException.class)
   public ResponseEntity<Object> exception(ProductNotfoundException exception) {
      return new ResponseEntity<>("Product not found", HttpStatus.NOT_FOUND);
   }
}

製品を更新するためのProduct Service APIコントローラーファイルを以下に示します。 製品が見つからない場合、 ProductNotFoundException クラスがスローされます。 

package com.finddevguides.demo.controller;

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

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.finddevguides.demo.exception.ProductNotfoundException;
import com.finddevguides.demo.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<>("Product is updated successfully", HttpStatus.OK);
   }
}

メインのSpring Bootアプリケーションクラスファイルのコードは以下のとおりです- 

package com.finddevguides.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);
   }
}

製品の* POJOクラス*のコードは以下のとおりです- 

package com.finddevguides.demo.model;
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ビルドのコード– 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.finddevguides</groupId>
   <artifactId>demo</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <packaging>jar</packaging>
   <name>demo</name>
   <description>Demo project for Spring Boot</description>

   <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>1.5.8.RELEASE</version>
      <relativePath/>
   </parent>

   <properties>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
      <java.version>1.8</java.version>
   </properties>

   <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.finddevguides'
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')
}

あなたは、実行可能なJARファイルを作成し、MavenまたはGradleコマンドを使用してSpring Bootアプリケーションを実行することができます-

Mavenの場合、次のコマンドを使用できます- 

mvn clean install

「BUILD SUCCESS」の後、ターゲットディレクトリの下にJARファイルがあります。

Gradleの場合、次のコマンドを使用できます- 

gradle clean build

「BUILD SUCCESSFUL」の後、build/libsディレクトリの下にJARファイルがあります。

次のコマンドを使用してJARファイルを実行できます- 

java –jar <JARFILE>

これは、以下に示すようにTomcatポート8080でアプリケーションを開始します-

開始したTomcatアプリケーションの例外処理

今、POSTMANアプリケーションで以下のURLをヒットし、以下に示すように出力を見ることができます-

更新URL：http：//localhost：8080/products/3

Postmanアプリケーション更新URL

「https://www.finddevguides.com/index.php?title=Spring-boot-exception-handling&oldid=26366」から取得
Powered by MediaWiki