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

出力したい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; }

↑

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? など、その他のSerializerを使用する必要があります。その方法は、次に紹介します。

↑

DataContractJsonSerializer? 以外の Serializer を使用して JSON を返す方法 †

WCF サービスを作成し、コントラクト部分に WebGet? 属性を追加します。ポイントは以下の 2 点です。
- ResponseFormat? には何も指定しない
- サービスメソッドの戻り値の型は、System.ServiceModel.Channels.Message を指定する
  (WCF の 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 によって Serialize されます。
このため、Dictionary 型も問題なく Serialize できます。

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を必ずつけるようにしてください。

↑

Java など、他プラットフォームとの相互運用 †

Java などの他プラットフォームとの相互運用を考えた場合も、まずは出力したい JSON フォーマットを確認することが基本です。

つまり、以下のような流れとなります。

出力したい JSON フォーマットを決める
(これがデータコントラクトとなる)
そのフォーマットにあわせて、Java であれば POJO、.NET であれば POCO クラスを作成する。

↑

POJO または POCO をデータコントラクトとすべきでない理由 †

.NET と Java では、JSON シリアライザの挙動が違います。
そのため、同じ形式の POJO または POCO であっても、シリアライズ後の JSON フォーマットが異なります。
(例えば、以下のように Java と .NET では、ジェネリック型を含むオブジェクトの JSON シリアライズ結果が異なる)

このため、実際に送受信される JSON フォーマットを、コントラクトとするのが良いと思います。

言語	POJO / POCO サンプル	シリアライズされた JSON
Java	public class Sample { public String _key1; public String _key2; public void setKey1(String key1) { this._key1 = key1; } public String getKey1() { return this._key1; } public void setKey2(String key2) { this._key2 = key2; } public String getKey2() { return this._key2; } }	{ "key1" : "value1", "key2" : "value2" }
Java	public class Sample { public HashMap?<String, String> _key; public void setKey(HashMap?<String, String> key) { this._key = key; } }
.NET	public class Sample { public string key1 { get; set; } public string key2 { get; set; } }
.NET	public class Sample { public Dictionary<string, string> key { get; set; } }	[ { "Key": "Prop1", "Value": "Value1" }, { "Key": "Prop2", "Value": "Value2" } ] 同じ形式のジェネリック型であっても、 Java と .NET ではシリアライズ結果が異なる

↑

参考 (Microsoft Azure が公開している REST API サンプル) †

数個、Microsoft Azure が公開している REST API をピックアップしてみました。

List all virtual machines in a resource group
https://msdn.microsoft.com/en-us/library/azure/mt163572.aspx
resourceGroup の name が REST の Uri に含まれていて、Responce が JSON 形式で返されます

Start a virtual machine
https://msdn.microsoft.com/en-us/library/azure/mt163628.aspx
Responce が HTTP 200 だけのもあります

Create or update a virtual machine
https://msdn.microsoft.com/en-us/library/azure/mt163591.aspx
呼び出すパラメタが大きく、変更を加える操作は、PUT で行われ、Request Body にパラメタが JSON 形式で渡されます。

これらの REST API でも、JSON のフォーマットが明記されています。
このことからも、JSON フォーマットレベルでデータコントラクトを結ぶ必要があると思います。

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

目次 †

概要 †

はじめに †

出力したい JSON フォーマットを確認する †

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

基本 †

ルール †