使用 HttpClient 進行表單提交時，遇到的問題

問題

在開發微信支付的小微商戶進件接口時，須要經過表單來上傳身份證圖片等數據。在微信支付接口文檔也說明了，須要使用 multipart/form-data 的方式發送請求。.NET 提供了 MultipartFormDataContent 類型，幫助咱們構建表單請求，故有如下代碼：

var form = new MultipartFormDataContent()
{
    {new StringContent("Value"),"Name},
    {new ByteArrayContent(new byte[]{}/*模擬文件數據*/),"File,"FileName}
}

按照微信支付官方文檔提交以後，一直提示參數錯誤，百思不得其解。

緣由

經過 Postman 模擬表單提交，捕獲數據包，將其與 C# 的提交代碼進行對比，發現了兩處問題。

Postman 的原始提交：

POST http://api.mch.weixin.qq.com/secapi/mch/uploadmedia HTTP/1.1
User-Agent: PostmanRuntime/7.21.0
Accept: */*
Cache-Control: no-cache
Postman-Token: b6800c0f-3f16-4981-b661-e6d16fc1bb1e
Host: api.mch.weixin.qq.com
Content-Type: multipart/form-data; boundary=--------------------------639275760242036520206377
Accept-Encoding: gzip, deflate
Content-Length: 566
Connection: keep-alive

----------------------------639275760242036520206377
Content-Disposition: form-data; name="mch_id"

1565111111
----------------------------639275760242036520206377
Content-Disposition: form-data; name="media_hash"

7215E92A8F3F3D0256484EFFF53A25F6
----------------------------639275760242036520206377
Content-Disposition: form-data; name="sign_type"

HMAC-SHA256
----------------------------639275760242036520206377
Content-Disposition: form-data; name="sign"

A1D8B094FA24BE5531D1AC198DE25550
----------------------------639275760242036520206377--

C# 代碼的提交：

POST http://api.mch.weixin.qq.com/secapi/mch/uploadmedia HTTP/1.1
Host: api.mch.weixin.qq.com
Content-Type: multipart/form-data; boundary="e9d5712f-7923-4ec5-8bf3-c8d5d3cd3217"
Content-Length: 502

--e9d5712f-7923-4ec5-8bf3-c8d5d3cd3217
Content-Type: text/plain; charset=utf-8
Content-Disposition: form-data; name=mch_id


--e9d5712f-7923-4ec5-8bf3-c8d5d3cd3217
Content-Type: text/plain; charset=utf-8
Content-Disposition: form-data; name=media_hash

33F15BC2D17D6FFBC18FA566EF65722E
--e9d5712f-7923-4ec5-8bf3-c8d5d3cd3217
Content-Type: text/plain; charset=utf-8
Content-Disposition: form-data; name=sign

1E377684F9BD583D2ED26FB367916C0C
--e9d5712f-7923-4ec5-8bf3-c8d5d3cd3217--

1. Boundary 的雙引號

使用 MultipartFormDataContent 提交的表單請求，外部 Content-Type 的 boundary 值帶有 " 號。而 Postman 提交的表單請求，它的 boudary 值是沒有雙引號的。

那爲何會形成這樣的差別呢？參考 這篇 博客的講解，是因爲各個系統/語言針對 RFC 2046 的實現不一致致使的。針對於 MultipartFormDataContent 的行爲，若是 Boundary 後面的值帶有雙引號是符合標準的。

RFC 2612 原文：

2) Although RFC 2046 [40] permits the boundary string to be
quoted, some existing implementations handle a quoted boundary
string incorrectly.

Boundary 的做用，是一個隨機生成的字符串，在 HTTP 協議當中用於分割內部多個 Content。爲何是隨機生成的呢？就是防止這個分割符跟你內部的 Content 產生重複形成意外。(C# 默認使用的是 Guid 做爲隨機串，你也能夠在構造 MultipartFormDataContent 的時候，經過其構造函數手動指定)

2. 表單內鍵值對，值的雙引號

第二個問題則是表單內的內容，他們的 name 鍵值對，其值又沒有雙引號，因此你得在添加 Content 的時候，得手動指定雙引號。

解決

兩個問題都是因爲雙引號致使的，因此只須要在真正發起調用以前將內部的雙引號替換爲空，或者將缺失的雙引號添加上便可。

針對問題一，其內部的 ContentType.Parameters ，經過 LINQ 找到 boundary 的鍵值對，替換內部的雙引號便可。

var boundaryValue = form.Headers.ContentType.Parameters.Single(p => p.Name == "boundary");
boundaryValue.Value = boundaryValue.Value.Replace("\"", String.Empty);

針對問題二，在構造內部 Content 的時候，其 Name 手動賦予雙引號。

var form = new MultipartFormDataContent
{
    {new StringContent(mchId), "\"mch_id\""},
    {new ByteArrayContent(bytes), "media", $"\"{HttpUtility.UrlEncode(Path.GetFileName(imagePath))}\""},
    {new StringContent(mediaHash), "\"media_hash\""},
    {new StringContent(sign), "sign"}
};