質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

新規登録して質問してみよう
ただいま回答率
85.48%
JSON

JSON(JavaScript Object Notation)は軽量なデータ記述言語の1つである。構文はJavaScriptをベースとしていますが、JavaScriptに限定されたものではなく、様々なソフトウェアやプログラミング言語間におけるデータの受け渡しが行えるように設計されています。

Java

Javaは、1995年にサン・マイクロシステムズが開発したプログラミング言語です。表記法はC言語に似ていますが、既存のプログラミング言語の短所を踏まえていちから設計されており、最初からオブジェクト指向性を備えてデザインされています。セキュリティ面が強力であることや、ネットワーク環境での利用に向いていることが特徴です。Javaで作られたソフトウェアは基本的にいかなるプラットフォームでも作動します。

REST

REST(Representational State Transfer)はwebアプリケーションの構築スタイルの一種です。HTTP GET/POSTによってリクエストを送信し、レスポンスはXMLで返されます。SOAPのようなRPCの構築と比べるとサーバからクライアントを分離することが出来る為、人気です。

Spring Boot

Spring Bootは、Javaのフレームワークの一つ。Springプロジェクトが提供する様々なフレームワークを統合した、アプリケーションを高速で開発するために設計されたフレームワークです。

Q&A

解決済

1回答

5208閲覧

正常/異常でAPIレスポンス形式が異なる場合のオブジェクトへのマッピングについて

Matsukubo

総合スコア10

JSON

JSON(JavaScript Object Notation)は軽量なデータ記述言語の1つである。構文はJavaScriptをベースとしていますが、JavaScriptに限定されたものではなく、様々なソフトウェアやプログラミング言語間におけるデータの受け渡しが行えるように設計されています。

Java

Javaは、1995年にサン・マイクロシステムズが開発したプログラミング言語です。表記法はC言語に似ていますが、既存のプログラミング言語の短所を踏まえていちから設計されており、最初からオブジェクト指向性を備えてデザインされています。セキュリティ面が強力であることや、ネットワーク環境での利用に向いていることが特徴です。Javaで作られたソフトウェアは基本的にいかなるプラットフォームでも作動します。

REST

REST(Representational State Transfer)はwebアプリケーションの構築スタイルの一種です。HTTP GET/POSTによってリクエストを送信し、レスポンスはXMLで返されます。SOAPのようなRPCの構築と比べるとサーバからクライアントを分離することが出来る為、人気です。

Spring Boot

Spring Bootは、Javaのフレームワークの一つ。Springプロジェクトが提供する様々なフレームワークを統合した、アプリケーションを高速で開発するために設計されたフレームワークです。

0グッド

0クリップ

投稿2020/11/04 06:58

編集2020/11/05 03:17

前提・実現したいこと

webシステムで以下のような機能の実装をしております。
①APIのレスポンスに応じて処理をハンドリングさせる。
※APIのレスポンスは正常系と異常系で形式が異なる。
▼正常系
{"User_ID":"Test-202010260001","Amount":"1000"}
▼異常系
[{"ErrCode":"xxx","ErrType":"xxxxxxxxx"}]
②正常系のときは画面にUser_IDとAmountを表示、異常系のときはErrCodeの内容に応じてメッセージを切替えて画面に表示する。

私は以下のように実装しております。
①エラーレスポンスクラス

Java

1@Getter 2@Setter 3public class ErrorBean { 4 private String ErrCode; 5 private String ErrType; 6}

②エラーレスポンスのリストを持つレスポンス基底クラス

java

1@Getter 2@Setter 3public abstract class AbstractBaseRes { 4 private List<ErrorInfoBean> errorInfoBeans; 5 public boolean hasErrors() { 6 return errorInfoBeans != null; 7 } 8}

③実際のレスポンスクラス(②を継承しています)

java

1@Getter 2@Setter 3public class TestRes extends AbstractBaseRes { 4 // ユーザー 5 private String User_ID; 6 // 金額 7 private String Amount; 8}

④RestTemplateを使って送信をするクラス
異常系=例外をキャッチして、例外オブジェクトからbodyを取得し、エラーリストをレスポンスクラスにつめる。

java

1@Component 2public class TestRestClient { 3 private final RestTemplate restTemplate; 4 private final HttpHeaders jsonHeaderTemplate; 5 /** 6 * 初期化 7 */ 8 public TestRestClient() { 9 jsonHeaderTemplate = new HttpHeaders(); 10 jsonHeaderTemplate.setContentType(MediaType.APPLICATION_JSON); 11 remitRestTemplate = new RestTemplateBuilder() 12 .requestFactory(() -> new BufferingClientHttpRequestFactory(new SimpleClientHttpRequestFactory())) 13 .build(); 14 } 15 16 public <T, T2 extends AbstractBaseRes> T2 sendJsonRequest(String url, T request, Class<T2> responseClass) { 17 HttpEntity<T> entity = new HttpEntity<>(request, jsonHeaderTemplate); 18 try { 19 return restTemplate.postForObject(url, entity, responseClass); 20 }catch (HttpStatusCodeException e) { 21 try { 22 List<ErrorBean> errorBeans = new ObjectMapper().readValue(e.getResponseBodyAsString(), new TypeReference<List<ErrorBean>>() { 23 }); 24 T2 response = responseClass.getDeclaredConstructor().newInstance(); 25 response.setErrorBeans(errorBeans); 26 return response; 27 }catch (Exception e2) { 28 throw new RuntimeException(e2); 29 } 30 } 31 } 32

発生している問題・エラーメッセージ

送信時、正常系は問題ないですが、異常系のときにpostForObjectで例外がスローされてはいますが、RestClientExceptionがスローされており、想定のcatchが出来ません。
また、RestClientExceptionの場合だとbodyを取得することができないです。

org.springframework.web.client.RestClientException: Error while extracting response for type [class jp.gmopg.remittance.mail.domain.bean.amzgift.DepositRegistrationAmazongiftRes] and content type [application/json;charset=Windows-31J]; nested exception is org.springframework.http.converter.HttpMessageNotReadableException: JSON parse error: Cannot deserialize instance of `{レスポンスクラス}` out of START_ARRAY token; nested exception is com.fasterxml.jackson.databind.exc.MismatchedInputException: Cannot deserialize instance of `{レスポンスクラス}` out of START_ARRAY token at [Source: (ByteArrayInputStream); line: 1, column: 1]

直接的なエラー起因は
Caused by: com.fasterxml.jackson.databind.exc.MismatchedInputException: Cannot deserialize instance of {レスポンスクラス} out of START_ARRAY token

試したこと

③のレスポンスクラスについて、②の継承をやめて、フィールドにErrCodeおよびErrTypeを持つようにする。
RestClientExceptionをキャッチするようにcatch句を追加し、そこで③レスポンスクラスの配列としてレスポンスを受け取るようにする。

この場合、エラーレスポンスを受け取ることはできますが、以下のように異常系の例外キャッチ時にわざわざエラーレスポンスをもらうためだけに再度JSON送信している動きとなってしまいます。
正常時 ⇒ JSON送信
異常時 ⇒ 例外キャッチ ⇒ レスポンスクラスの配列を受け取るように再度JSONを送信

どのように実装すれば解決できますでしょうか。
SpringやRestについて不勉強な部分も多く恐縮ですが、ご教示いただけると幸いです。

補足情報(FW/ツールのバージョンなど)

Spring bootのバージョンは2.2.1です。
Jackson 2.10.10

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答1

0

ベストアンサー

一般的に、正常系のクラスと異常系のクラスは継承関係も無い別々のクラスにします。
同じようにsendJsonRequestで正常系も異常系も処理しようとするはやめましょう。
(処理したいのであれば、戻り値をObjectまたはMap<String, Object>にする)

API(controller)クラスは正常系のみ処理する。
異常系は任意の例外を発生させて、
ハンドラー(ExceptionHandler)で異常系のクラスを返却する。

投稿2020/11/04 13:24

szk.

総合スコア1400

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

Matsukubo

2020/11/06 07:25

ありがとうございます。正常・異常でクラスを分けることで想定どおりに動作できました。
guest

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.48%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問