019 例外と例外処理（カスタム例外処理戦略） 030 解答例

public class ApiRequestException extends Exception {
    private int statusCode;
    private String errorMessage;

    public ApiRequestException(int statusCode, String errorMessage) {
        super("API Request Failed with status code: " + statusCode + ", Error: " + errorMessage);
        this.statusCode = statusCode;
        this.errorMessage = errorMessage;
    }

    public int getStatusCode() {
        return statusCode;
    }

    public String getErrorMessage() {
        return errorMessage;
    }
}

public class ApiClient {
    // RESTful APIと通信するメソッド
    public void makeApiRequest() throws ApiRequestException {
        // APIリクエストを実行し、エラーレスポンスがあれば例外をスローする
        int statusCode = /* APIからのレスポンスのステータスコード */;
        
        if (statusCode >= 400) {
            String errorMessage = /* エラーレスポンスから取得したエラーメッセージ */;
            throw new ApiRequestException(statusCode, errorMessage);
        }

        // 正常な処理を続行
        System.out.println("API Request Successful");
    }
}

public class Main {
    public static void main(String[] args) {
        ApiClient apiClient = new ApiClient();

        try {
            apiClient.makeApiRequest();
        } catch (ApiRequestException e) {
            System.out.println("API Request Failed: " + e.getStatusCode() + ", " + e.getErrorMessage());
            // 他の例外処理やリトライロジックなどを追加することができます
        }
    }
}

ApiRequestException クラスの作成:
- ApiRequestException は、RESTful APIリクエスト中にエラーレスポンスが返された場合にスローされるカスタム例外クラスです。
- コンストラクタでステータスコードとエラーメッセージを受け取り、それらを含むエラーメッセージを生成します。
ApiClient クラス:
- makeApiRequest メソッドは、RESTful APIとの通信をシミュレートします。
- APIからのレスポンスのステータスコードを確認し、エラーレスポンスがあれば ApiRequestException をスローします。
Main クラス:
- Main クラスでは、ApiClient を使用して API リクエストを実行し、ApiRequestException をキャッチして適切な処理を行います。

このプログラムは、RESTful APIからのエラーレスポンスに対して ApiRequestException を使用して適切に例外処理を行うものです。

RESTful API

RESTful API（Representational State Transferful Application Programming Interface）は、Webサービスの設計原則に基づいたAPIの形式です。REST（Representational State Transfer）は、分散型ハイパーメディアシステムのための軽量で拡張可能なソフトウェアアーキテクチャスタイルです。

以下は、RESTful APIの主な特徴と原則です。

リソース指向:
- RESTful APIでは、リソース（データやサービスへのアクセスポイント）がURI（Uniform Resource Identifier）によって表現されます。例えば、/usersはユーザーリソースを表します。
HTTPメソッド:
- HTTPメソッド（GET、POST、PUT、DELETEなど）は、操作の種類を表現します。
- GETはリソースの取得、POSTは新しいリソースの作成、PUTは既存のリソースの更新、DELETEはリソースの削除を示します。
ステートレス:
- RESTfulサービスはステートレスであり、各リクエストは他のリクエストと独立しています。サーバはクライアントの状態を保持しないため、シンプルかつ拡張可能です。
表現:
- リソースの表現はクライアントとサーバ間でやり取りされるデータ形式を指します。通常はJSONやXMLが使用されます。
統一インターフェース:
- RESTful APIは統一されたインターフェースを持ちます。これには一貫したURI構造、統一されたHTTPメソッド、標準的なリクエスト/レスポンスフォーマットが含まれます。
リクエストとレスポンス:
- クライアントがサーバにリクエストを行い、サーバがそれに対するレスポンスを返します。レスポンスは成功または失敗を示すステータスコードと共にデータを含むことが一般的です。
HATEOAS（Hypermedia As The Engine Of Application State）:
- クライアントは動的にリンクされたハイパーメディアを介してアプリケーションの状態を理解し、操作することができます。

RESTful APIは、これらの原則に従ってシンプルで効果的なWebサービスを構築するための強力な手段となっています。

RESTful APIは、シンプルで効果的なWebサービスを構築するための原則として、リソース指向、HTTPメソッド、ステートレス性、表現、統一インターフェース、リクエストとレスポンス、HATEOASなどの特徴を持っています。これらの原則に基づいて構築されたAPIは、柔軟性と拡張性があり、クライアントとサーバーの間で一貫性のあるコミュニケーションを提供します。

RESTful APIの採用は、異なるプラットフォームやクライアントが互いに効率的かつシームレスに通信できるようになるなど、多くの利点をもたらしています。開発者は一度理解すれば、共通の原則に基づいて異なるサービスやアプリケーションを構築でき、保守性や拡張性の向上が期待できます。

これからも、RESTful APIの原則はWebサービスの設計や開発において重要な指針として位置づけられ、インターネット上の様々なサービスとアプリケーションの基盤としてさらに進化していくことでしょう。

外部API通信の例外処理

外部API通信の例外処理は、通信時に発生する様々な問題に対処し、システムの安定性を確保する重要な側面です。以下は、外部API通信時の例外処理に関する解説です。

ネットワークエラーの処理:
- 通信時にネットワークに関連するエラーが発生する可能性があります。これにはタイムアウト、接続の切断、DNSの解決エラーなどが含まれます。
- これらのエラーに対処するためには、java.net パッケージなどを使用してネットワークエラーをハンドリングし、適切なメッセージをユーザーに提供します。
HTTPステータスコードの処理:
- 外部APIがエラーを示すHTTPステータスコード（4xxや5xx）を返す場合、これをキャッチして適切な対応を行います。
- ステータスコードに基づいてリトライロジックを実装したり、ユーザーフレンドリーなエラーメッセージを表示したりします。
サービス利用制限の処理:
- 外部APIには利用制限がある場合があります。これに対処するためには、APIキーの有効性を確認し、制限に達した場合は適切なエラーメッセージを提示します。
データの整合性チェック:
- APIから受け取るデータが期待通りでない場合、例外をスローして異常を検知しやすくします。たとえば、JSONのパースエラー、必要なフィールドが存在しない場合などです。
ログの適切な利用:
- 例外が発生した場合、システムのログに詳細な情報を残し、デバッグやトラブルシューティングをサポートします。

外部API通信の例外処理は、システムのロバストさ（堅牢性）と信頼性を向上させるために不可欠です。利用者や開発者が発生したエラーに対処できるよう、適切かつ分かりやすいエラーメッセージを提供することが重要です。

外部API通信の例外処理は、システムの安定性と信頼性を確保するために不可欠です。異なるネットワーク環境やサービスの利用条件、データの変動に柔軟かつ堅牢に対応することが求められます。適切なエラーハンドリングとログの活用は、問題の早期発見と解決につながります。

エラーが発生した場合、ユーザーに対して分かりやすいエラーメッセージを提供するとともに、ログに詳細な情報を残すことで、デバッグやトラブルシューティングが円滑に行えるでしょう。冗長な通信やデータの不整合を未然に防ぎ、システム全体の品質を向上させるために、外部API通信の例外処理は慎重に検討されるべきです。

最良の実践では、外部APIのドキュメンテーションを適切に把握し、APIの仕様やエラーレスポンスに関する理解を深めることが重要です。これにより、予測可能なエラーや問題に対してより効果的かつ適切な対処が可能となります。

「019 例外と例外処理」問題集リスト