【ASP.NET Core】從向 Web API 提交純文本內容談起

前些時日，老周在升級「華南閒腎回收登記平臺」時，爲了擴展業務，尤爲是容許其餘開發人員在其餘平臺向本系統提交有關腎的介紹資料，因而就爲該系統增長了幾個 Web API。

其中，有關腎的介紹採用純文本方式提交，大概的代碼是這樣的。

    [Route("api/[controller]/[action]")]
    public class PigController : Controller
    {
        [HttpPost]
        public string KidneyRemarks([FromBody]string remarks)
        {
            return $"根據你的描述，貴腎的當前狀態爲：{remarks}";
        }
    }

這個 Action 很簡單（主要爲了方便別人看懂），參數接受一個字符串實例，返回的也是字符串。哦，重點要記住，對參數要加上 FromBody 特性。嗯，爲啥呢。由於咱們要獲得的數據是從客戶端發來的 HTTP 正文提取的，應用這個特性就是說參數的值來自於提交的正文，而不是 Header，也不是 url 參數。

隨後老周興高采烈地用 Postman 進行測試。

幻想老是很美麗的，現實老是很骨感的。結果……

 

沒成功，這時候，按照常規思路，會產生各類懷疑。懷疑地址錯了嗎？哪一個配置沒寫上？是否是路由不正確？……

別急，看看服務器返回的狀態碼：415 Unsupported Media Type。啥意思呢，其實，這就是問題所在了。咱們提交純文本類型的數據，用的 Content-Type 是 text/plain，但是，不受支持！

不信？如今把提交的內容改成 JSON 看看。

看看，我沒說錯吧。

這就很明瞭啦，JSON 默認是被支持的，可是純文本不行。有辦法讓它支持 text / plain 類型的數據嗎？答案是：能的。

在 Startup 中使用 ConfigureServices 方法配置服務時，咱們通常就是簡單地寫上。

   services.AddMvc();

而後，各個 MVC 選項保持默認。

在 MVC 選項中，能夠控制輸入和輸出的格式，分別由兩個屬性來管理：

InputFormatters 屬性：是一個集合，裏面的每一個對象都要實現 IInputFormatter 接口，默認提供對 JSON 和 XML 的支持。

OutputFormatters 屬性：也是一個集合，裏面的元素都要實現 IOutputFormatter 接口，默認支持 JSON 和 XML，也支持文本類型。

也就是說，輸出是支持純文本的，因此 Action 能夠返回 string 類型的值，但輸入是不支持文本格式的，因此，用 text / plain 格式提交，就會獲得 415 代碼了。

 

明白了這個原理，解決起問題來就好辦了，我們本身實現一個支持純文本格式的 InputFormatter 就好了。不過呢，咱們也沒必要直接實現 IInputFormatter 接口，由於，有個抽象類挺好使的—— TextInputFormatter，處理文本直接實現它就行了。

因而乎，老周就寫了這個類。

    public sealed class PlainTextInputFormatter : TextInputFormatter
    {
        public override async Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context, Encoding encoding)
        {
            string content;
            using(var reader = context.ReaderFactory(context.HttpContext.Request.Body, encoding))
            {
                content = await reader.ReadToEndAsync();
            }
            // 最後一步別忘了
            return await InputFormatterResult.SuccessAsync(content);
        }
    }

TextInputFormatter 類只有 ReadRequestBodyAsync 方法是抽象的，因此，若是沒其餘活要乾的話，只實現這個方法就夠了。這個方法的功能就是讀取 HTTP 請求的正文，而後把你讀取到的內容填充給 InputFormatterResult 對象。

InputFormatterResult 類頗有意思的，沒有公共構造函數，你沒法 new 對象，只能靠媒人介紹對象，經過 Failure、Success 這些方法直接返回對象實例。這些方法你看名字就知道什麼用途了，不用多解釋。

在上面代碼中，ReaderFactory 屬性實際上是個委託，經過構造函數建立的，不過，這個委託實例在傳進 ReadRequestBodyAsync 方法時已經建立，你只須要像調用方法同樣調用它就好了，第一個參數是一個流，哪裏的流？固然是 HTTP 請求的正文了，這裏能夠透過 HttpContext 的 Request 的 Body 來得到；第二個參數嘛，呵呵，是文本編碼，這個好辦，直接把傳進 ReadRequestBodyAsync 方法的 encoding 傳過去就好了。

ReaderFactory 委託調用後返回一個 TextReader，是了，咱們就是用它來讀取請求正文的。最後把讀出來的字符串填充給 InputFormatterResult 就好了。

不過呢，這個類如今還不能用，由於默認狀況下，SupportedMediaTypes 集合是空的，你得添加一下，它支持哪些 Content-Type，咱們這裏只要 text / plain 就好了。

        public PlainTextInputFormatter()
        {
            SupportedMediaTypes.Add("text/plain");
            SupportedEncodings.Add(System.Text.Encoding.UTF8);
        }

這些寫在構造函數裏就 OK 了。注意 SupportedEncodings 集合，是配置字符編碼，通常嘛，UTF-8 最合適了。你也能夠從 TextInputFormatter 類的兩個只讀的靜態字段中獲取。

protected static readonly Encoding UTF8EncodingWithoutBOM;
protected static readonly Encoding UTF16EncodingLittleEndian;

如今基本能夠用了。由於咱們上面寫的那個 Action 是帶字符串類型參數的，若是你以爲不放心，能夠覆寫一下 CanReadType 方法，這個方法有個 type 參數，指的是 Model Type，說白了就是 Action 要接收的參數的類型，我們這裏是 string，因此，實現這個方法很簡單，若是是字符串類型就返回 true，表示能讀取，不然返回 false，表示不能讀。

 

回到 Startup 類，找到 ConfigureServices 方法，咱們在 AddMvc 的時候要對 Options 配置一下，把我們剛剛寫好的 InputFormatter 加進去。

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc(opt =>
            {
                opt.InputFormatters.Add(new PlainTextInputFormatter());             });
        }

好了，如今再請 Postman 大叔，從新測試一下。

 

嗯，皆大歡喜，又解決一個問題了。

 

咱們不妨繼續擴展一下，若是提交的是 text / plain 數據內容，而 Action 想讓其賦值給 DateTime 或者 int 類型的參數呢。其實也同樣，就是本身實現一下輸入格式。這一次咱們不繼承 TextInputFormatter 類了，而是繼承抽象程度更高的 InputFormatter 類。

    public sealed class CustInputFormatter : InputFormatter
    {
        public CustInputFormatter()
        {
            SupportedMediaTypes.Add("text/plain");
        }

        protected override bool CanReadType(Type type)
        {
            return (type == typeof(DateTime)) || (type == typeof(int));
        }

        public override async Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)
        {
            string val;
            using (var reader = context.ReaderFactory(context.HttpContext.Request.Body, Encoding.UTF8))
            {
                val = await reader.ReadToEndAsync();
            }
            InputFormatterResult result = null;
            if(context.ModelType == typeof(DateTime))
            {
                result = InputFormatterResult.Success(DateTime.Parse(val));
            }
            else
            {
                result = InputFormatterResult.Success(int.Parse(val));
            }
            return result;
        }
    }

這一次應該不用我解釋，你都能看懂了。不過注意一點，由於要應用的目標參數多是 int 和 DateTime 類型，因此，在填充 InputFormatterResult 對象時，你要先檢查一下 ModelType 屬性。

            if(context.ModelType == typeof(DateTime))
            {
                result = InputFormatterResult.Success(DateTime.Parse(val));
            }
            else
            {
                result = InputFormatterResult.Success(int.Parse(val));
            }

如今應用一下這個輸入格式類。

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc(o =>
            {
                o.InputFormatters.Add(new CustInputFormatter());
            });
        }

 

下面來試試吧，建一個 Controller，而後定義兩個 Action，一個接收 int 類型的參數，一個接收 DateTime 類型的參數。

    [Route("[controller]/[action]")]
    public class TestController : Controller
    {
        [HttpPost]
        public string Upload([FromBody]DateTime dt)
        {
            return $"你提交的時間是：{dt}";
        }

        [HttpPost]
        public string UploadInt([FromBody]int val)
        {
            return $"你提交的整數值是：{val}";
        }
    }

FromBody 特性千萬要記得用上，否則待會讀不了你又要處處 Debug 了。

 

好，測試開始了，首先試一下 DateTime 類型的。

 

再試一下 int 類型的。

 

感受如何，好刺激吧。好啦，今天的高大上技巧就分享到這兒了。

示例源代碼下載：請用洪荒之力猛點這裏