ASP.NET Web API POSTされた文字エンコードShift_JISのXMLデータをモデルバインドできない

Question

先日、POSTされたXMLデータをXML形式で取得する方法を質問させていただきました。
https://teratail.com/questions/282343

実現したいこと

POSTされたXMLデータが文字エンコード UTF-8 だとモデルバインドできるのですが、文字エンコード Shift_JIS だと引数に入る値がNULLになってしまいモデルバインドできません。

Shift_JIS でモデルバインドする方法をご存知の方いらっしゃいませんでしょうか？
どうぞよろしくお願い致します。

試したこと

Web.config と WebApiConfig.csに下記のコードを追加しました。

Web.config
<system.web>
    <globalization requestEncoding="Shift-JIS" responseEncoding="Shift-JIS" fileEncoding="Shift-JIS"/>
</system.web>

WebApiConfig.cs
config.Formatters.XmlFormatter.SupportedEncodings.Clear();
config.Formatters.XmlFormatter.SupportedEncodings.Add(System.Text.Encoding.GetEncoding("Shift_JIS"));

取得したいXMLデータ

POST http://localhost:9000/Default
Content-Type: text/xml; charset=Shift_JIS
Accept: text/html

<?xml version="1.0" encoding="Shift_JIS"?>
<sample code="1.0">
  <data>
    <id>100</id>
  </data>
  <value>
    <name>aaaa</name>
    <version>1.0.0</version>
  </value>
</sample>

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

Windows 10
Visual Studio Community 2019
C#
ASP.NET
Web API
Postman

Answer 1

Shift_JIS でモデルバインドする方法をご存知の方いらっしゃいませんでしょうか？

普通に（先のスレッドのようなやり方で）やってもうまくいかないようです。少なくとも自分はやり方を知りませんし、ググって調べても（Shift_JIS では記事がないので UTF-16 の例）できなかったという記事しか見つかりません。

Web API not able to bind model for POST with utf-16 encoded XML
https://stackoverflow.com/questions/39919822/web-api-not-able-to-bind-model-for-post-with-utf-16-encoded-xml

そこを何とかするには、先のスレッドで紹介した以下の記事の最初の方に書いてあるように、HttpRequestMessage を引数に持つメソッドで取得する他手がなさそうな感じです。

How WebAPI does Parameter Binding
https://docs.microsoft.com/ja-jp/archive/blogs/jmstall/how-webapi-does-parameter-binding

HttpRequestMessage.Content プロパティで HttpContent オブジェクトを取得し、HttpContent.ReadAsStringAsync メソッドで POST されてきた xml 文字列を取得し、XDocument.Load メソッドで XDocument オブジェクトを作ってそれを操作するようにしてはいかがですか？

HttpContent.ReadAsStringAsync メソッドを使っての文字列の取得の具体例は以下の記事のサンプルコードを見てください。

ASP.NET Web API のバインディング (2)
http://surferonwww.info/BlogEngine/post/2019/03/06/aspnet-web-api-parameter-binding-2nd.aspx

【2020/8/7 11:05 追記】

上のように回答しておいてできなかったら何なので検証してみました。

Fiddler から以下のように送信して、

HttpRequestMessage を引数に持つアクションメソッドで HttpRequestMessage オブジェクトを取得し、それから送信されてきた XML 文字列を取得できます。

XML 文字列は質問にあるものと同じですが、ASCII 文字しか使ってないので文字コードは UTF-8 でも Shift_JIS でも同じです。実際に Shift_JIS の 2 バイト文字を使ったらどうなるかまでは検証してません。質問者さんの方で確認してください。

【追記】

下の 2020/08/07 10:51 の私のコメントで「あとで、回答欄に画像を貼っておきます」と書きましたが、それを以下に追加します。

自分は送信には Fiddler の Composer を使っています。それで以下のように試すと文字化けはしません。質問者さんは Postman？　その違いがあるのでは？

(1) XML 文字列の <name>aaaa</name> を <name>日本語</name> に変更。画像は Fiddler の Composer

(2) 要求ヘッダとボディの HexView。「日本語」のコードは Shift_JIS

(3) デバッグ中のアクションメソッドの Local 変数。文字化けはしていない

Comments

[yuniben00]

SurferOnWww様
検証までしていただきありがとうございます。
私の方でも試してクラスに格納することが出来ました。
ただ、Shift_JIS の 2 バイト文字を取得すると文字化けが発生してしまいました。

以下を変更して実行すると回避？できました。
//string str = await content.ReadAsStringAsync();
//TextReader tr = new StringReader(str);
↓
var stream = await content.ReadAsStreamAsync();
TextReader tr = new StreamReader(stream, Encoding.GetEncoding("UTF-8"), true);

なぜ、UTF-8なのかは、Shift_JISだと文字化けのままでだったのでUTF-8にしたらたまたま取得できました。
原因はよくわかりませんが、Shift_JIS の 2 バイト文字は、送信されません。
今回も丁寧に解説していただきありがとうございました。
また、質問させていただきます。

[退会済みユーザー]

> Shift_JIS の 2 バイト文字を取得すると文字化けが発生してしまいました。

どうやって試したのですか？　ホントに Shift_JIS だったのですか？　Encoding を UTF-8 にしたら文字化けは解決したということは、実は UTF-8 だったということだと思うのですが。

上の回答の例のまま、XML 文字列の <name>aaaa</name> を <name>日本語</name> に変更して試してみましたが、文字化けなどはなく期待通り取得できましたけど？

自分は送信には Fiddler の Composer を使っています。その違いがあるのでは？

あとで、回答欄に画像を貼っておきます。

[yuniben00]

SurferOnWww様
再度、試していただきありがとうございます。
>どうやって試したのですか？　ホントに Shift_JIS だったのですか？　Encoding を UTF-8 にしたら文字化けは解決したということは、実は UTF-8 だったということだと思うのですが。

PostmanでContent-Typeを text/xml; charset=Shift_JIS と設定して送信しました。
文字コードをShift_JISとしたのでてっきりそうだと思ってしまいました。失礼しました。

私もFiddlerから送信してみました。
文字化けすることなくShift_JIS の 2 バイト文字を取得できました。
Postman と Fiddler で何か違いがあるのかもしれません。
便利なだけに一回はまると抜け出すのに時間がかかりそうです。
勉強になりました。また、質問させていただきます。