JSONを送受信するRESTサービスを作成する方法のバックアップ(No.5)

出力したいJSON	定義するクラス・プロパティ
{ "key1" : "value1", "key2" : "value2" }	public class Sample { string key1 { get; set; } string key2 { get; set; } }
[ "1", "2", "3" ]	List<string> listData { get; set; }
{ "key1" : [ "1", "2", "3" ] }	public class Sample { List<string> key1 { get; set; } }
{ "key" : { "key1" : "value1", "key2" : "value2" } }	public class Sample { string key1 { get; set; } string key2 { get; set; } } public class Sample2 { Sample key { get; set; } }
[ { "key1" : "value1", "key2" : "value2" }, { "key1" : "value3", "key2" : "value4" } ]	public class Sample { string key1 { get; set; } string key2 { get; set; } } List<Sample> listData { get; set; }

↑

応用 †

キー名が不定の場合
- キー名が不定 (実行時に決まる) の場合、事前にクラス／プロパティを定義しておくことができません。
- このようなときは、Dictionary<TKey, TValue>を、Dictionary<string, object> として定義します。

↑

JSONを返すサービスを作成する †

↑

WCFの場合 †

WCFでJSONを返す場合、既定ではDataContractJsonSerializer?が使用されます。

↑

既定のDataContractJsonSerializer?を使用してJSONを返す方法 †

WCFサービスを作成し、コントラクト部分にWebGet?属性を追加します。ポイントは以下の2点です。
- ResponseFormat?に、WebMessageFormat?.Jsonを指定し、JSONを返すサービスであることを宣言する
- サービスメソッドの戻り値の型に、先ほど定義したクラス／プロパティの型を指定する

サービスを実装します。

[ServiceContract]
public interface IJSONService
{
    [OperationContract]
    [WebGet(ResponseFormat = WebMessageFormat.Json, UriTemplate = "GetJson")]
    Sample GetJson();
}

public class JSONService : IJSONService
{
    public Sample GetJson()
    {
        // JSON にシリアライズする元となるオブジェクトを作成する
        Sample sample = new Sample()
        {
            StringKey = "StringValue",
            IntKey = 123,
            ListKey = new List<string>() { "List1", "List2", "List3" }
        };

        // クライアントにデータを返す
        return sample;
    }
}

public class Sample
{
    public string StringKey { get; set; }
    public int IntKey { get; set; }
    public List<string> ListKey { get; set; }
}

作成したWCFサービスを、RESTサービスとして公開するための設定をweb.configに行います

<system.serviceModel>
    <services>
        <service name="WebApplication1.JSONService">
            <endpoint address="" binding="webHttpBinding" behaviorConfiguration="MyBehavior"
                      contract="WebApplication1.IJSONService" />
        </service>
    </services>
    <behaviors>
        <serviceBehaviors>
            <behavior name="">
                <serviceMetadata httpGetEnabled="true" httpsGetEnabled="true" />
                <serviceDebug includeExceptionDetailInFaults="false" />
            </behavior>
        </serviceBehaviors>
        <endpointBehaviors>
            <behavior name="MyBehavior">
                <webHttp/>
            </behavior>
        </endpointBehaviors>
    </behaviors>
    <serviceHostingEnvironment aspNetCompatibilityEnabled="true"
        multipleSiteBindingsEnabled="true" />
</system.serviceModel>

"http://～/JSONService.svc/GetJson?" にリクエストを送ったときの実行結果
```
{"IntKey":123,"ListKey":["List1","List2","List3"],"StringKey":"StringValue"}
```

既定のDataContractJsonSerializer?の注意点
既定のDataContractJsonSerializer?では、Dictionary型のオブジェクトを正しく扱えません。
Dictionary型のオブジェクトを扱う場合は、JSON.NETやJavaScriptSerializer?など、その他のシリアライザーを使用する必要があります。その方法は、次に紹介します。

↑

DataContractJsonSerializer?以外のシリアライザーを使用してJSONを返す方法 †

WCFサービスを作成し、コントラクト部分にWebGet?属性を追加します。ポイントは以下の2点です。
- ResponseFormat?には何も指定しない
- サービスメソッドの戻り値の型は、System.ServiceModel?.Channels.Messageを指定する
  (SOAPのMessage BodyにJSONを直接書き込む)

サービスを実装します。

[ServiceContract]
public interface IJSONService2
{
    [OperationContract]
    [WebGet(UriTemplate = "GetJson")]
    Message GetJson();
}

public class JSONService2 : IJSONService2
{
    public Message GetJson()
    {
        // JSON にシリアライズする元となるオブジェクトを作成する
        Sample2 sample = new Sample2()
        {
            key = new Dictionary<string, string>()
            {
                {"key1", "value1"}, 
                {"key2", "value2"}, 
                {"key3", "value3"}
            }
        };

        // JSON.NET を使用して JSON 形式にシリアライズ
        string jsonStr = JsonConvert.SerializeObject(sample);

        // 'X-Content-Type-Options: nosniff' ヘッダーを追加する
        WebOperationContext.Current.OutgoingResponse.Headers.Add("X-Content-Type-Options", "nosniff");

        // JSON を返す
        return WebOperationContext.Current.CreateTextResponse(jsonStr,
            "application/json; charset=utf-8",
            Encoding.UTF8);
    }
}

public class Sample2
{
    public Dictionary<string, string> key { get; set; }
}

作成したWCFサービスを、RESTサービスとして公開するための設定をweb.configに行います

<system.serviceModel>
    <services>
        <service name="WebApplication1.JSONService2">
            <endpoint address="" binding="webHttpBinding" behaviorConfiguration="MyBehavior"
                      contract="WebApplication1.IJSONService2" />
        </service>
    </services>
    <behaviors>
        <serviceBehaviors>
            <behavior name="">
                <serviceMetadata httpGetEnabled="true" httpsGetEnabled="true" />
                <serviceDebug includeExceptionDetailInFaults="false" />
            </behavior>
        </serviceBehaviors>
        <endpointBehaviors>
            <behavior name="MyBehavior">
                <webHttp/>
            </behavior>
        </endpointBehaviors>
    </behaviors>
    <serviceHostingEnvironment aspNetCompatibilityEnabled="true"
        multipleSiteBindingsEnabled="true" />
</system.serviceModel>

"http://～/JSONService2.svc/GetJson?" にリクエストを送ったときの実行結果
```
{"key":{"key1":"value1","key2":"value2","key3":"value3"}}
```

↑

ASP.NET Web APIの場合 †

ASP.NET Web APIでは、既定でJSON.NETによってシリアライズされます。
このため、Dictionary型も問題なくシリアライズできます。

Webアプリケーションに、Web APIを作成します。

public class ValuesController : ApiController
{
    // GET api/values
    public Sample Get()
    {
        // JSON にシリアライズする元となるオブジェクトを作成する
        Sample sample = new Sample()
        {
            key = new Dictionary<string, string>()
            {
                {"key1", "value1"}, 
                {"key2", "value2"}, 
                {"key3", "value3"}
            }
        };
        
        // JSON を返す
        return sample;
    }
}

public class Sample
{
    public Dictionary<string, string> key { get; set; }
}

"http://～/api/Values" にリクエストを送ったときの実行結果
```
{"key":{"key1":"value1","key2":"value2","key3":"value3"}}
```

ASP.NET Web APIの注意点
既定では、ASP.NET Web APIは、HTTPリクエストに含まれるAcceptヘッダーの内容により、クライアントに返すデータの形式が決められます。
- Acceptにapplication/xmlが含まれていた場合は、XMLとして返されます。(レスポンスのContent-Typeヘッダーがapplication/xmlとなる)
- Acceptにapplication/jsonが含まれていた場合は、JSONとして返されます。(レスポンスのContent-Typeヘッダーがapplication/jsonとなる)
  このため、常にJSONとしてデータを受け取りたい場合は、リクエストヘッダーにAccept: application/jsonを必ずつけるようにしてください。

JSONを送受信するRESTサービスを作成する方法 のバックアップ(No.5)

目次 †

概要 †

はじめに †

出力したいJSONを確認する †

出力したいJSONに合わせて、クラスやプロパティを定義する †