使用 WebClient 來存取 GET,POST,PUT,DELETE,PATCH 網路資源

WebClient 基本資訊

提供通用方法使用 WebRequest 類別傳送及接收 URI (支援 http:, https:, ftp:,和 file: ) 的資源

• Namespace：System.Net
• Assembly：System (System.dll)
• 基本要求：.NET Framework 1.1 以上
• WebClient 預設僅會傳送必要的 http header
• 缺點：無法指定 Timeout ,另外保哥文章 利用 WebClient 類別模擬 HTTP POST 表單送出的注意事項有提到 不適合用來下載大量的檔案，高負載的網站也不適合這樣用，即便你用非同步的方式撰寫，也會讓 WebClient 因為佔據過多 Threads 而導致效能降低這我不知道怎麼模擬，請大家參考保哥文章

1. GET

1. 寫法 1

   using (WebClient webClient = new WebClient())
   // 從 url 讀取資訊至 stream
   using(Stream stream = webClient.OpenRead("http://jsonplaceholder.typicode.com/posts"))
   // 使用 StreamReader 讀取 stream 內的字元
   using(StreamReader reader= new StreamReader(stream))
   {
    // 將 StreamReader 所讀到的字元轉為 string
    string request = reader.ReadToEnd();
    request.Dump();
   }

2. 寫法 2

   // 建立 webclient
   using(WebClient webClient = new WebClient())
   {
    // 指定 WebClient 的編碼
    webClient.Encoding = Encoding.UTF8;
    // 指定 WebClient 的 Content-Type header
    webClient.Headers.Add(HttpRequestHeader.ContentType, "application/json");
    // 從網路 url 上取得資料
    var body = webClient.DownloadString("http://jsonplaceholder.typicode.com/posts");
    body.Dump();
   }

2. POST

WebClient 共有四種 POST 相關的方法

1. UploadString(string)

   將 String 傳送至資源。

   • 以下 demo 會搭配 application/json

     // 建立 WebClient
     using (WebClient webClient = new WebClient())
     {
      // 指定 WebClient 編碼
      webClient.Encoding = Encoding.UTF8;
      // 指定 WebClient 的 Content-Type header
      webClient.Headers.Add(HttpRequestHeader.ContentType, "application/json");
      // 指定 WebClient 的 authorization header
      webClient.Headers.Add("authorization", "token {apitoken}");
      // 準備寫入的 data
      PostData postData = new PostData() { userId = 1123456, title = "yowko", body = "yowko test body 中文" };
      // 將 data 轉為 json
      string json = JsonConvert.SerializeObject(postData);
      // 執行 post 動作
      var result = webClient.UploadString("https://jsonbin.org/yowko/test", json);
      // linqpad 將 post 結果輸出
      result.Dump();
     }
     

     　　

2. UploadData(byte[])
   

   將位元組陣列傳送至資源，並傳回含有任何回應的 Byte 陣列。

   • 以下 demo 會搭配 application/x-www-form-urlencoded

     // 建立 WebClient
     using (WebClient webClient = new WebClient())
     {
      // 指定 WebClient 編碼
      webClient.Encoding = Encoding.UTF8;
      // 指定 WebClient 的 Content-Type header
      webClient.Headers.Add(HttpRequestHeader.ContentType, "application/x-www-form-urlencoded");
      // 指定 WebClient 的 authorization header
      webClient.Headers.Add("authorization", "token {apitoken}");
      //要傳送的資料內容(依字串表示)
      string postData = "id=12354&name=yowko&body=yowko test body 中文";
      //將傳送的字串轉為 byte array
      byte[] byteArray = Encoding.UTF8.GetBytes(postData);
      // 執行 post 動作
      var result = webClient.UploadData("https://jsonbin.org/yowko/test", byteArray);
      // linqpad 將 post 結果輸出
      result.Dump();
     }

3. UploadValues (byte[])
   

   將 NameValueCollection 傳送至資源，並傳回含有任何回應的 Byte 陣列。

   • 不需指定 content type

     // 建立 WebClient
       using (WebClient webClient = new WebClient())
       {
        // 指定 WebClient 編碼
        webClient.Encoding = Encoding.UTF8;
        // 指定 WebClient 的 authorization header
        webClient.Headers.Add("authorization", "token {apitoken}");
        //要傳送的資料內容
        NameValueCollection nameValues = new NameValueCollection();
        nameValues["userId"] = "456";
        nameValues["title"] = "yowko";
        nameValues["body"]="yowko test body 中文";
     
        // 執行 post 動作
        var result = webClient.UploadValues("https://jsonbin.org/yowko/test", nameValues);
        //將 post 結果轉為 string
        string resultstr = Encoding.UTF8.GetString(result);
        // linqpad 將 post 結果輸出
        resultstr.Dump();
       }
     

4. UploadFile(byte[]) 今天不會介紹
   

   將本機檔案傳送至資源，並傳回含有任何回應的 Byte 陣列。

3. PUT

方法與 POST 相同，只需在 url 與 data 間多傳一個 method 的參數，範例中 PUT 是將 jsonbin 的網址改為 public

// 建立 WebClient
using (WebClient webClient = new WebClient())
{
 // 指定 WebClient 編碼
 webClient.Encoding = Encoding.UTF8;
 // 指定 WebClient 的 Content-Type header
 webClient.Headers.Add(HttpRequestHeader.ContentType, "application/json");
 // 指定 WebClient 的 authorization header
 webClient.Headers.Add("authorization", "token {apitoken}");
 // 執行 PUT 動作
 var result = webClient.UploadString("https://jsonbin.org/yowko/test/_perms","PUT", "");
 // linqpad 將 post 結果輸出
 result.Dump();
}

5. DELETE

方法與 POST 相同，只需在 url 與 data 間多傳一個 method 的參數，範例中 DELETE 是將 jsonbin 的網址改為 private

// 建立 WebClient
using (WebClient webClient = new WebClient())
{
 // 指定 WebClient 編碼
 webClient.Encoding = Encoding.UTF8;
 // 指定 WebClient 的 Content-Type header
 webClient.Headers.Add(HttpRequestHeader.ContentType, "application/json");
 // 指定 WebClient 的 authorization header
 webClient.Headers.Add("authorization", "token {apitoken}");
 // 執行 DELETE 動作
 var result = webClient.UploadString("https://jsonbin.org/yowko/test/_perms","DELETE", "");
 // linqpad 將 post 結果輸出
 result.Dump();
}

6. PATCH

方法與 POST 相同，只需在 url 與 data 間多傳一個 method 的參數

// 建立 WebClient
using (WebClient webClient = new WebClient())
{
 // 指定 WebClient 編碼
 webClient.Encoding = Encoding.UTF8;
 // 指定 WebClient 的 Content-Type header
 webClient.Headers.Add(HttpRequestHeader.ContentType, "application/json");
 // 指定 WebClient 的 authorization header
 webClient.Headers.Add("authorization", "token {api token}");
 // 準備寫入的 data
 PostData postData = new PostData() { title = "yowko 中文", body = "yowko body 中文" };
 // 將 data 轉為 json
 string json = JsonConvert.SerializeObject(postData);
 // 執行 PATCH 動作
 var result = webClient.UploadString("https://jsonbin.org/yowko/test","PATCH", json);
 // linqpad 將 post 結果輸出
 result.Dump();
}

7. 使用 proxy

有時候程式的 host 環境無法直接上網或是我們想要確認傳出去的相關資訊，就需要設定 proxy

// 建立 WebClient
using (WebClient webClient = new WebClient())
{
 // 指定 WebClient 編碼
 webClient.Encoding = Encoding.UTF8;
 // 指定 WebClient 的 Content-Type header
 webClient.Headers.Add(HttpRequestHeader.ContentType, "application/json");
 // 指定 WebClient 的 authorization header
 webClient.Headers.Add("authorization", "token {api token}");
 //指令 proxy address
 string proxyAddress = "http://127.0.0.1:8888";
 //建立 proxy
 WebProxy myProxy = new WebProxy(new Uri(proxyAddress));
 //建立 proxy 的認證資訊
 myProxy.Credentials = new NetworkCredential("{username}", "{password}");
 //將 proxy 指定給 request 使用
 webClient.Proxy = myProxy;
 // 準備寫入的 data
 PostData postData = new PostData() { userId=1, title = "yowko1", body = "yowko test body 中文" };
 // 將 data 轉為 json
 string json = JsonConvert.SerializeObject(postData);
 // 執行 post 動作
 var result = webClient.UploadString("https://jsonbin.org/yowko/test", json);
 // linqpad 將 post 結果輸出
 result.Dump();
}

• 以 fiddler 為例
  • fiddler 的相關設定請參考 使用 fiddler 內建 proxy 來截錄手機或是程式封包
  • 截錄到的內容
    

    

參考資料

1. WebClient 類別
2. 利用 WebClient 類別模擬 HTTP POST 表單送出的注意事項
3. 如何使用 WebRequest,HttpWebRequest 來存取 (GET,POST,PUT,DELETE,PATCH) 網路資源
4. 使用 fiddler 內建 proxy 來截錄手機或是程式封包