最近遇到的問題記錄：UrlEncode、UrlDecode

本文閱讀前瞭解知識：何時須要使用UrlEncode和UrlDecode函數

做者使用谷歌瀏覽器，經過按下F12對第三方網站http協議的接口抓包進行分析操做。

場景

運維小哥哥偶爾使用某某外包公司的網站系統，作設備錄入工做，流程簡單：

1. 錄入設備基本信息，有七、8個字段須要輸入，而後點擊保存按鈕；
2. 基本信息保存成功，進入設備類型選擇操做，而後點擊生成設備標識按鈕；
3. 設備標識生成成功，錄入設備關聯的模塊信息，簡單設備只須要錄入2條模塊，複雜的設備有6條模塊，每一個模塊有三、4個字段須要輸入，最後點擊保存。

一條設備錄入成功，單身多年的手速可能也花不了幾分鐘，其實這也沒啥。

忽然領導說有1000個設備須要搞？運維小哥哥哭了😂，這時就該開發人員上場了：

1. 運維準備一個Excel模板，輸入須要錄入的1000個設備基本信息、設備類型信息，這個工做量不大，就半天吧，最多一天工做量；
2. 開發作個C/S客戶端小工具，程序中按業務要求配置模塊錄入規則；
3. 程序執行過程當中錄入一個設備就把生成的設備標識與設備關聯；
4. 所有錄入完成，提供一個Excel導出，可將設備基本信息、生成的設備標識所有關聯導出，工做完成。

通過幾天的開發工做，開發哥哥將精心打磨的小工具交給運維小哥，運維小哥哥使用後投來了讚許的目光...

問題

前面鋪墊的話有點囉嗦了，開發這個小工具時，開發小哥遇到一個問題：

這是某個接口的信息，Content-Type 是 application/x-www-form-urlencoded,下面參數使用的Form Data，即參數使用了UrlEncode，好比未編碼前的一個參數：

"Content":"{"AP_Name":"HK_7889","IP":"192.168.0.1"}"

編碼後(可使用這個在線URL編碼解碼工具驗證)：

"Content":"%7B%22AP_Name%22%3A%22HK_7889%22%2C%22IP%22%3A%2292.168.0.1%22%7D"

使用Postman測試時，未對參數使用UrlEncode，接口測試成功,開發這個小工具時，有3個接口都是相似的，未進行UrlEncode操做：

var client = new RestClient("http://admin.lqclass.com/api/device");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("Content", "{\"AP_Name\":\"HK_7889\",\"IP\":\"92.168.0.1\"}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

但遇到稍微複雜一點的接口，好比截圖中的參數爲：

"Content":"{"AP_Name":"HK_7889","IP":"192.168.0.1","Module":[{"M_Name":"cameri0","Desc":"cameri0","AP_PUID":"54632325461320320"},{"M_Name":"cameri1","Desc":"cameri1","AP_PUID":"54636325461320320"},{"M_Name":"cameri2","Desc":"cameri2","AP_PUID":"54632325421320320"}]}"

Content值格式化看得清楚一點，Module是設備關聯的模塊信息：

{
  "AP_Name": "HK_7889",
  "IP": "192.168.0.1",
  "Module": [
    {
      "M_Name": "cameri0",
      "Desc": "cameri0",
      "AP_PUID": "54632325461320320"
    },
    {
      "M_Name": "cameri1",
      "Desc": "cameri1",
      "AP_PUID": "54636325461320320"
    },
    {
      "M_Name": "cameri2",
      "Desc": "cameri2",
      "AP_PUID": "54632325421320320"
    }
  ]
}

實際UrlEncode後的參數爲：

"Content":"%7B%22AP_Name%22%3A%22HK_7889%22%2C%22IP%22%3A%22192.168.0.1%22%2C%22Module%22%3A%22%255B%257B%2522M_Name%2522%253A%2522cameri0%2522%252C%2522Desc%2522%253A%2522cameri0%2522%252C%2522AP_PUID%2522%253A%252254632325461320320%2522%257D%252C%257B%2522M_Name%2522%253A%2522cameri1%2522%252C%2522Desc%2522%253A%2522cameri1%2522%252C%2522AP_PUID%2522%253A%252254636325461320320%2522%257D%252C%257B%2522M_Name%2522%253A%2522cameri2%2522%252C%2522Desc%2522%253A%2522cameri2%2522%252C%2522AP_PUID%2522%253A%252254632325421320320%2522%257D%255D%22%7D"

原本通常接口，如上面成功執行的C#代碼那般直接未UrlEncode調用是沒問題的。

但這個接口調用，服務器返回錯誤信息：「xxx解析失敗」，調用代碼以下：

var client = new RestClient("http://admin.lqclass.com/api/device");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("Content", "{\"AP_Name\":\"HK_7889\",\"IP\":\"192.168.0.1\",\"Module\":[{\"M_Name\":\"cameri0\",\"Desc\":\"cameri0\",\"AP_PUID\":\"54632325461320320\"},{\"M_Name\":\"cameri1\",\"Desc\":\"cameri1\",\"AP_PUID\":\"54636325461320320\"},{\"M_Name\":\"cameri2\",\"Desc\":\"cameri2\",\"AP_PUID\":\"54632325421320320\"}]}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

兩處調用代碼哪裏不一樣？只是Content值不同，最後懷疑是否是須要手動進行UrlEncode？又不是url參數，爲啥須要編碼呢？無論啦，先編碼了再說。

問題解決

參數編碼後，調用：

var client = new RestClient("http://admin.lqclass.com/api/device");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("Content", "%7B%22AP_Name%22%3A%22HK_7889%22%2C%22IP%22%3A%22192.168.0.1%22%2C%22Module%22%3A%22%255B%257B%2522M_Name%2522%253A%2522cameri0%2522%252C%2522Desc%2522%253A%2522cameri0%2522%252C%2522AP_PUID%2522%253A%252254632325461320320%2522%257D%252C%257B%2522M_Name%2522%253A%2522cameri1%2522%252C%2522Desc%2522%253A%2522cameri1%2522%252C%2522AP_PUID%2522%253A%252254636325461320320%2522%257D%252C%257B%2522M_Name%2522%253A%2522cameri2%2522%252C%2522Desc%2522%253A%2522cameri2%2522%252C%2522AP_PUID%2522%253A%252254632325421320320%2522%257D%255D%22%7D");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

哈哈，成功了，這裏簡單猜想下：別人的服務對接收的參數可能作了UrlDecode操做。

其實中間還作了一個參數的UrlEncode操做，即下面的Module參數值：

"Content":{"AP_Name":"HK_7889","IP":"192.168.0.1","Module":[{"M_Name":"cameri0","Desc":"cameri0","AP_PUID":"54632325461320320"},{"M_Name":"cameri1","Desc":"cameri1","AP_PUID":"54636325461320320"},{"M_Name":"cameri2","Desc":"cameri2","AP_PUID":"54632325421320320"}]}

第一次UrlEncode，即先對Module的值進行UrlEncode：

"Content"：{"AP_Name":"HK_7889","IP":"192.168.0.1","Module":%5B%7B%22M_Name%22%3A%22cameri0%22%2C%22Desc%22%3A%22cameri0%22%2C%22AP_PUID%22%3A%2254632325461320320%22%7D%2C%7B%22M_Name%22%3A%22cameri1%22%2C%22Desc%22%3A%22cameri1%22%2C%22AP_PUID%22%3A%2254636325461320320%22%7D%2C%7B%22M_Name%22%3A%22cameri2%22%2C%22Desc%22%3A%22cameri2%22%2C%22AP_PUID%22%3A%2254632325421320320%22%7D%5D}

第二次UrlEncode便是上面成功的參數方式了，對整個Content的值進行UrlEncode，看上面成功的參數，不重複貼了。

最後總結

抓別人數據包時，不要憑印象、已有知識斷定該怎麼怎麼作，好比前面的參數，不使用UrlEncode時，調用成功了，其餘包我是否也沿用相同的方式使用就正確呢？搞不定時，多嘗試猜想的方法。

總結：「管他的，幹就是了」。

本文使用的UrlEncode C# 代碼：

public static string UrlEncode(string str)
{
    StringBuilder sb = new StringBuilder();
    byte[] byStr = System.Text.Encoding.UTF8.GetBytes(str); //默認是System.Text.Encoding.Default.GetBytes(str)
    for (int i = 0; i < byStr.Length; i++)
    {
        sb.Append(@"%" + Convert.ToString(byStr[i], 16));
    }

    return (sb.ToString());
}

---

文末分享

• 後臺回覆數字【00】：獲取DotNet、Java、C++、前端等技術資料
• 添加微信羣：添加號主微信號【dotnet9】，備註【入羣】
• 添加QQ羣：羣號【771992300】，備註【Dotnet9】

---

時間如流水，只能流去不流回。

• 公衆號：Dotnet9
• 號主微信號：dotnet9
• 做者及編輯：沙漠之盡頭的狼
• 原文連接：點擊閱讀
• 日期：2021-01-09