ネットワーク

[C#] HTTPリクエストでJSONを扱う方法

C#でHTTPリクエストを使用してJSONを扱うには、HttpClientクラスを利用します。

まず、HttpClientをインスタンス化し、GetAsyncメソッドでGETリクエストを送信します。

レスポンスはHttpResponseMessageとして受け取り、ReadAsStringAsyncメソッドでJSON文字列を取得します。

取得したJSONをオブジェクトに変換するには、JsonConvert.DeserializeObject<T>メソッドを使用します。

POSTリクエストの場合は、StringContentを作成し、PostAsyncメソッドで送信します。

これにより、C#でJSONデータを簡単に送受信できます。

目次から探す

C#でのHTTPクライアントの使用

HttpClientクラスの概要

HttpClientクラスは、C#でHTTPリクエストを送信し、HTTPレスポンスを受信するための基本的なクラスです。

このクラスは、HTTPプロトコルを使用してWebサービスと通信するための機能を提供します。

以下に、HttpClientクラスの主な特徴を示します。

非同期操作のサポート: HttpClientは非同期操作をサポートしており、ネットワーク通信中にアプリケーションの他の部分がブロックされるのを防ぎます。
リソースの効率的な管理: HttpClientは接続を再利用するため、リソースの効率的な管理が可能です。
簡単なリクエストの作成: GET、POST、PUT、DELETEなどのHTTPメソッドを簡単に使用できます。

HttpClientのインスタンス化

HttpClientのインスタンス化は非常に簡単です。

以下のコードは、HttpClientの基本的なインスタンス化の例です。

using System.Net.Http; // HttpClientクラスを使用するための名前空間
class Program
{
    static void Main()
    {
        HttpClient client = new HttpClient(); // HttpClientのインスタンスを作成
        // ここでHttpClientを使用してリクエストを送信できます
    }
}

このコードでは、HttpClientのインスタンスを作成し、clientという変数に格納しています。

このインスタンスを使用して、HTTPリクエストを送信することができます。

非同期処理の重要性

非同期処理は、特にネットワーク通信を行う際に重要です。

HTTPリクエストは、ネットワークの状態やサーバーの応答時間に依存するため、同期的に処理するとアプリケーションがブロックされ、ユーザーエクスペリエンスが低下する可能性があります。

非同期処理を使用することで、以下の利点があります。

ユーザーインターフェースの応答性の向上: 非同期処理を使用することで、UIスレッドがブロックされず、ユーザーインターフェースがスムーズに動作します。
スケーラビリティの向上: 非同期処理により、アプリケーションは同時に複数のリクエストを処理できるため、スケーラビリティが向上します。
リソースの効率的な使用: 非同期処理は、リソースを効率的に使用し、システム全体のパフォーマンスを向上させます。

以下は、非同期メソッドを使用してHTTPリクエストを送信する例です。

using System;
using System.Net.Http;
using System.Threading.Tasks; // 非同期処理を行うための名前空間
class Program
{
    static async Task Main()
    {
        HttpClient client = new HttpClient(); // HttpClientのインスタンスを作成
        HttpResponseMessage response = await client.GetAsync("https://example.com"); // 非同期でGETリクエストを送信
        string responseBody = await response.Content.ReadAsStringAsync(); // レスポンスの内容を非同期で取得
        Console.WriteLine(responseBody); // レスポンスの内容を表示
    }
}

このコードでは、GetAsyncメソッドを使用して非同期でGETリクエストを送信し、ReadAsStringAsyncメソッドでレスポンスの内容を非同期で取得しています。

これにより、アプリケーションの他の部分がブロックされることなく、HTTPリクエストを処理できます。

JSONデータの取得

GETリクエストの送信

C#でJSONデータを取得するためには、まずHTTP GETリクエストを送信する必要があります。

HttpClientクラスを使用して、指定したURLに対してGETリクエストを送信します。

以下は、GETリクエストを送信する基本的な例です。

using System;
using System.Net.Http;
using System.Threading.Tasks;
class Program
{
    static async Task Main()
    {
        HttpClient client = new HttpClient(); // HttpClientのインスタンスを作成
        HttpResponseMessage response = await client.GetAsync("https://api.example.com/data"); // GETリクエストを非同期で送信
        // ここでレスポンスを処理します
    }
}

このコードでは、GetAsyncメソッドを使用して、指定したURLに対して非同期でGETリクエストを送信しています。

HttpResponseMessageの処理

GETリクエストを送信した後、HttpResponseMessageオブジェクトを受け取ります。

このオブジェクトには、HTTPレスポンスのステータスコードやヘッダー、コンテンツが含まれています。

レスポンスのステータスコードを確認し、リクエストが成功したかどうかを判断します。

HttpResponseMessage response = await client.GetAsync("https://api.example.com/data"); // GETリクエストを非同期で送信
if (response.IsSuccessStatusCode) // ステータスコードが成功を示しているか確認
{
    // レスポンスが成功した場合の処理
}
else
{
    Console.WriteLine($"エラー: {response.StatusCode}"); // エラーメッセージを表示
}

このコードでは、IsSuccessStatusCodeプロパティを使用して、レスポンスが成功したかどうかを確認しています。

成功した場合は、次のステップでJSONデータを取得します。

JSON文字列の取得

レスポンスが成功した場合、HttpResponseMessageオブジェクトからJSONデータを文字列として取得します。

ReadAsStringAsyncメソッドを使用して、レスポンスのコンテンツを非同期で文字列として読み取ります。

if (response.IsSuccessStatusCode) // ステータスコードが成功を示しているか確認
{
    string jsonString = await response.Content.ReadAsStringAsync(); // レスポンスの内容を非同期で文字列として取得
    Console.WriteLine(jsonString); // JSON文字列を表示
}

このコードでは、ReadAsStringAsyncメソッドを使用して、レスポンスのコンテンツを文字列として取得し、コンソールに表示しています。

これで、JSONデータを文字列として取得することができました。

以上の手順で、C#を使用してHTTP GETリクエストを送信し、JSONデータを取得することができます。

取得したJSONデータは、次のステップで解析して使用することができます。

JSONデータの解析

JSON文字列からオブジェクトへの変換

JSONデータを取得した後、そのデータをC#のオブジェクトに変換する必要があります。

これにより、プログラム内でデータを簡単に操作できるようになります。

C#では、Newtonsoft.Jsonライブラリを使用して、JSON文字列をオブジェクトに変換することが一般的です。

このライブラリは、JsonConvertクラスを提供しており、JSONデータのシリアライズとデシリアライズを簡単に行うことができます。

JsonConvert.DeserializeObject<T>の使用方法

JsonConvert.DeserializeObject<T>メソッドは、JSON文字列を指定した型のオブジェクトに変換するために使用されます。

以下は、JSON文字列をオブジェクトに変換する基本的な例です。

using System;
using Newtonsoft.Json; // JsonConvertクラスを使用するための名前空間
class Program
{
    static void Main()
    {
        string jsonString = "{\"Name\":\"太郎\",\"Age\":30}"; // JSON文字列
        Person person = JsonConvert.DeserializeObject<Person>(jsonString); // JSON文字列をPersonオブジェクトに変換
        Console.WriteLine($"名前: {person.Name}, 年齢: {person.Age}"); // オブジェクトのプロパティを表示
    }
}
class Person
{
    public string Name { get; set; } // 名前プロパティ
    public int Age { get; set; } // 年齢プロパティ
}

このコードでは、JsonConvert.DeserializeObject<T>メソッドを使用して、JSON文字列をPersonクラスのオブジェクトに変換しています。

変換されたオブジェクトのプロパティを使用して、データを簡単に操作できます。

カスタムクラスの作成

JSONデータをオブジェクトに変換するためには、JSONの構造に対応するカスタムクラスを作成する必要があります。

カスタムクラスは、JSONデータの各フィールドに対応するプロパティを持つ必要があります。

以下は、カスタムクラスを作成する際のポイントです。

プロパティ名はJSONのキーと一致させる: JSONのキーとクラスのプロパティ名を一致させることで、正しくデシリアライズされます。
データ型を適切に設定する: JSONの値に対応する適切なデータ型をプロパティに設定します。

以下は、JSONデータに対応するカスタムクラスの例です。

class Person
{
    public string Name { get; set; } // 名前プロパティ
    public int Age { get; set; } // 年齢プロパティ
}

このPersonクラスは、NameとAgeというプロパティを持ち、JSONデータの"Name"キーと"Age"キーに対応しています。

これにより、JsonConvert.DeserializeObject<T>メソッドを使用して、JSONデータをPersonオブジェクトに変換することができます。

以上の手順で、JSONデータをC#のオブジェクトに変換し、プログラム内でデータを操作することができます。

これにより、JSONデータを効率的に利用することが可能になります。

JSONデータの送信

POSTリクエストの送信

C#でJSONデータを送信するには、HTTP POSTリクエストを使用します。

HttpClientクラスを利用して、サーバーにデータを送信することができます。

POSTリクエストは、データをサーバーに送信してリソースを作成または更新する際に使用されます。

以下は、POSTリクエストを送信する基本的な例です。

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
class Program
{
    static async Task Main()
    {
        HttpClient client = new HttpClient(); // HttpClientのインスタンスを作成
        var content = new StringContent("{\"Name\":\"太郎\",\"Age\":30}", Encoding.UTF8, "application/json"); // JSONデータをStringContentとして作成
        HttpResponseMessage response = await client.PostAsync("https://api.example.com/data", content); // POSTリクエストを非同期で送信
        Console.WriteLine($"ステータスコード: {response.StatusCode}"); // レスポンスのステータスコードを表示
    }
}

このコードでは、PostAsyncメソッドを使用して、指定したURLに対してPOSTリクエストを送信しています。

StringContentの作成

POSTリクエストでJSONデータを送信するためには、StringContentクラスを使用して、送信するデータをHTTPコンテンツとしてラップする必要があります。

StringContentは、文字列データをHTTPコンテンツとして扱うためのクラスです。

以下は、StringContentを作成する方法です。

var content = new StringContent("{\"Name\":\"太郎\",\"Age\":30}", Encoding.UTF8, "application/json"); // JSONデータをStringContentとして作成

このコードでは、JSON文字列をUTF-8エンコーディングでStringContentとして作成し、Content-Typeをapplication/jsonに設定しています。

これにより、サーバーは受信したデータがJSON形式であることを認識します。

JSONデータのシリアライズ

C#オブジェクトをJSON形式に変換するには、JsonConvert.SerializeObjectメソッドを使用します。

このメソッドは、オブジェクトをJSON文字列にシリアライズするために使用されます。

以下は、オブジェクトをJSON文字列にシリアライズする例です。

using Newtonsoft.Json; // JsonConvertクラスを使用するための名前空間
class Program
{
    static async Task Main()
    {
        Person person = new Person { Name = "太郎", Age = 30 }; // Personオブジェクトを作成
        string jsonString = JsonConvert.SerializeObject(person); // オブジェクトをJSON文字列にシリアライズ
        var content = new StringContent(jsonString, Encoding.UTF8, "application/json"); // JSON文字列をStringContentとして作成
        HttpClient client = new HttpClient(); // HttpClientのインスタンスを作成
        HttpResponseMessage response = await client.PostAsync("https://api.example.com/data", content); // POSTリクエストを非同期で送信
        Console.WriteLine($"ステータスコード: {response.StatusCode}"); // レスポンスのステータスコードを表示
    }
}
class Person
{
    public string Name { get; set; } // 名前プロパティ
    public int Age { get; set; } // 年齢プロパティ
}

このコードでは、PersonオブジェクトをJSON文字列にシリアライズし、その文字列をStringContentとしてPOSTリクエストで送信しています。

これにより、C#オブジェクトをJSON形式でサーバーに送信することができます。

エラーハンドリング

HTTPステータスコードの確認

HTTPリクエストを送信した際、サーバーからのレスポンスにはステータスコードが含まれています。

これにより、リクエストが成功したかどうか、またはエラーが発生したかを判断できます。

ステータスコードは、レスポンスのHttpResponseMessageオブジェクトのStatusCodeプロパティで確認できます。

以下は、ステータスコードを確認する例です。

HttpResponseMessage response = await client.GetAsync("https://api.example.com/data"); // GETリクエストを非同期で送信
if (response.IsSuccessStatusCode) // ステータスコードが成功を示しているか確認
{
    Console.WriteLine("リクエストが成功しました。"); // 成功メッセージを表示
}
else
{
    Console.WriteLine($"エラー: {response.StatusCode}"); // エラーメッセージを表示
}

このコードでは、IsSuccessStatusCodeプロパティを使用して、レスポンスが成功したかどうかを確認しています。

成功した場合は、成功メッセージを表示し、失敗した場合はステータスコードを表示します。

例外処理の実装

HTTPリクエストを送信する際には、ネットワークの問題やサーバーのエラーなど、さまざまな理由で例外が発生する可能性があります。

これらの例外を適切に処理するために、try-catchブロックを使用します。

以下は、例外処理を実装する例です。

try
{
    HttpResponseMessage response = await client.GetAsync("https://api.example.com/data"); // GETリクエストを非同期で送信
    response.EnsureSuccessStatusCode(); // ステータスコードが成功を示しているか確認
    string responseBody = await response.Content.ReadAsStringAsync(); // レスポンスの内容を非同期で取得
    Console.WriteLine(responseBody); // レスポンスの内容を表示
}
catch (HttpRequestException e)
{
    Console.WriteLine($"リクエストエラー: {e.Message}"); // リクエストエラーメッセージを表示
}
catch (Exception e)
{
    Console.WriteLine($"一般的なエラー: {e.Message}"); // 一般的なエラーメッセージを表示
}

このコードでは、HttpRequestExceptionをキャッチして、リクエストに関連するエラーを処理しています。

また、一般的な例外もキャッチして、他のエラーを処理しています。

ログの活用

エラーハンドリングの一環として、ログを活用することは非常に重要です。

ログを使用することで、エラーの発生状況を記録し、後で分析することができます。

C#では、NLogやlog4netなどのライブラリを使用して、ログを簡単に管理できます。

NLogやlog4netは標準ライブラリではないので、Nugetで検索してインストールしてください。

以下は、ログを活用する基本的な例です。

using NLog; // NLogライブラリを使用するための名前空間
class Program
{
    private static readonly Logger logger = LogManager.GetCurrentClassLogger(); // ロガーのインスタンスを作成
    static async Task Main()
    {
        try
        {
            HttpResponseMessage response = await client.GetAsync("https://api.example.com/data"); // GETリクエストを非同期で送信
            response.EnsureSuccessStatusCode(); // ステータスコードが成功を示しているか確認
            string responseBody = await response.Content.ReadAsStringAsync(); // レスポンスの内容を非同期で取得
            Console.WriteLine(responseBody); // レスポンスの内容を表示
        }
        catch (HttpRequestException e)
        {
            logger.Error(e, "リクエストエラーが発生しました。"); // リクエストエラーをログに記録
        }
        catch (Exception e)
        {
            logger.Error(e, "一般的なエラーが発生しました。"); // 一般的なエラーをログに記録
        }
    }
}

このコードでは、NLogを使用して、エラーが発生した際にログを記録しています。

これにより、エラーの詳細を後で確認することができ、問題のトラブルシューティングに役立ちます。

応用例

APIからのデータ取得と表示

C#を使用してAPIからデータを取得し、ユーザーに表示することは、さまざまなアプリケーションで一般的なタスクです。

以下は、APIからデータを取得し、コンソールに表示する例です。

using System;
using System.Net.Http;
using System.Threading.Tasks;
using Newtonsoft.Json;
class Program
{
    static async Task Main()
    {
        HttpClient client = new HttpClient(); // HttpClientのインスタンスを作成
        HttpResponseMessage response = await client.GetAsync("https://api.example.com/users"); // APIからデータを取得
        response.EnsureSuccessStatusCode(); // ステータスコードが成功を示しているか確認
        string responseBody = await response.Content.ReadAsStringAsync(); // レスポンスの内容を非同期で取得
        var users = JsonConvert.DeserializeObject<User[]>(responseBody); // JSONデータをUserオブジェクトの配列に変換
        foreach (var user in users)
        {
            Console.WriteLine($"名前: {user.Name}, 年齢: {user.Age}"); // ユーザー情報を表示
        }
    }
}
class User
{
    public string Name { get; set; } // 名前プロパティ
    public int Age { get; set; } // 年齢プロパティ
}

このコードでは、APIからユーザー情報を取得し、各ユーザーの名前と年齢をコンソールに表示しています。

JSONデータのフィルタリングと加工

取得したJSONデータをフィルタリングしたり、加工したりすることで、必要な情報だけを抽出することができます。

以下は、特定の条件に基づいてデータをフィルタリングする例です。

using System;
using System.Linq;
using System.Net.Http;
using System.Threading.Tasks;
using Newtonsoft.Json;
class Program
{
    static async Task Main()
    {
        HttpClient client = new HttpClient(); // HttpClientのインスタンスを作成
        HttpResponseMessage response = await client.GetAsync("https://api.example.com/users"); // APIからデータを取得
        response.EnsureSuccessStatusCode(); // ステータスコードが成功を示しているか確認
        string responseBody = await response.Content.ReadAsStringAsync(); // レスポンスの内容を非同期で取得
        var users = JsonConvert.DeserializeObject<User[]>(responseBody); // JSONデータをUserオブジェクトの配列に変換
        var adults = users.Where(user => user.Age >= 18); // 18歳以上のユーザーをフィルタリング
        foreach (var user in adults)
        {
            Console.WriteLine($"名前: {user.Name}, 年齢: {user.Age}"); // フィルタリングされたユーザー情報を表示
        }
    }
}
class User
{
    public string Name { get; set; } // 名前プロパティ
    public int Age { get; set; } // 年齢プロパティ
}

このコードでは、18歳以上のユーザーのみをフィルタリングして表示しています。

Webサービスとの連携

C#を使用してWebサービスと連携することで、さまざまな機能を実現できます。

例えば、ユーザーの登録情報をWebサービスに送信して保存することができます。

以下は、ユーザー情報をWebサービスに送信する例です。

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
class Program
{
    static async Task Main()
    {
        HttpClient client = new HttpClient(); // HttpClientのインスタンスを作成
        User newUser = new User { Name = "花子", Age = 25 }; // 新しいユーザー情報を作成
        string jsonString = JsonConvert.SerializeObject(newUser); // ユーザー情報をJSON文字列にシリアライズ
        var content = new StringContent(jsonString, Encoding.UTF8, "application/json"); // JSON文字列をStringContentとして作成
        HttpResponseMessage response = await client.PostAsync("https://api.example.com/users", content); // ユーザー情報をWebサービスに送信
        Console.WriteLine($"ステータスコード: {response.StatusCode}"); // レスポンスのステータスコードを表示
    }
}
class User
{
    public string Name { get; set; } // 名前プロパティ
    public int Age { get; set; } // 年齢プロパティ
}

このコードでは、新しいユーザー情報をWebサービスにPOSTリクエストとして送信し、サーバーに保存しています。

これにより、C#アプリケーションとWebサービスが連携してデータを管理することができます。