ASP.NET Core 2 使用 HttpClientFactory 讀取中央氣象局 OpenData 的XML 下載

-
這是使用 ASP.NET Core 2 來讀取 CWB 的開放資料的 XML 檔，並讓 Client 端下載方式

註冊CWB會員

  1. CWB OpenData 平台(以下稱CWBODP)取用資料必須先註冊會員→ 這裡註冊
  2. 然後，登入OpenData平台→這裡登入
  3. 選擇『資料選擇說明』頁面，在下方可以找到『取得授權碼』，這個頁面下有使用教學
  4. 要取得資料代碼可以從『資料清單』頁面取得需要的代碼

有了上述資訊後，就可以著手開始做 .NET Core 2 的取用程式了。

CWODP取用 XML 檔案的 URI：
http://opendata.cwb.gov.tw/opendataapi?dataid={資料代碼}&authorizationkey={授權碼}

.NET Core 2 使用 HttpClient 有以下幾種：

  1. 一般 HttpClient 方式
  2. 直接使用 HttpClientFactory
  3. 具名式 Client
  4. 型別式 Client
  5. 產生式 Client

一般 HttpClient 方式

FileController.cs
using System;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using System.Net.Http;

namespace CWBReader.Controllers
{
    [Route("[controller]")]
    public class FileController : Controller
    {
        [Route("")]
        public async Task<string> DownloadFile()
        {
            using (var client = new HttpClient())
            {
                string url = "http://opendata.cwb.gov.tw/opendataapi?dataid=F-C0032-001&authorizationkey=CWB-1234ABCD-78EF-GH90-12XY-IJKL12345678";
                using (var result = await client.GetAsync(url))
                {
                    if (result.IsSuccessStatusCode)
                    {
                        //直接將XML內容顯示出來
                        return await result.Content.ReadAsStringAsync();
                    }
                }
            }
            throw new Exception("File/can not show XML data!");
        }
    }
}

上面這段是展示如何使用標準 HttpClient 向 CWBODP 取得XML檔案，並顯示在畫面上。

但是如果要變成可以讓使用者端下載，就必須取得原本的檔案名稱資訊，並將返回資訊改成 FileResult 型別返回。如下：

FileController.cs
namespace CWBReader.Controllers
{
         [Route("download")]
        public async Task<FileResult> DownFile()
        {
            using (var client = new HttpClient())
            {
                string url = "http://opendata.cwb.gov.tw/opendataapi?dataid=F-C0032-001&authorizationkey=CWB-1234ABCD-78EF-GH90-12XY-IJKL12345678";
                using (var result = await client.GetAsync(url))
                {
                    if (result.IsSuccessStatusCode)
                    {
                        //以檔案下載方式輸出，取得原檔案名，並改以FileResult輸出
                        string filename = result.Content.Headers.ContentDisposition.FileName;
                        byte[] xml = await result.Content.ReadAsByteArrayAsync();
                        return File(xml, "application/xml", filename);
                    }
                }
            }
            throw new Exception("File/download can not download file!");
        }
    }
}

上面標準方式使用起來沒有問題，使用人數少的情況下也都還好，但是在很多人使用情況下下 HttpClient 就會被反覆的建立/銷毀，這個過程不但浪費時間也消耗資源，而且最嚴重的問題是使用 using 套接 HttpClient 實作時，離開 using 區段後 HttpClient 也沒有被及時銷毀，多人重複使用會導致通訊端口被占用到資源耗盡為止。

第二個問題是 HttpClient 不會理會 DNS 的有效時間 (TTL)，可能發生了 DNS 變更了 IP 內容，卻還是繼續使用舊的IP對應。

可參考下面文章：



HttpClientFactory
於是乎，ASP.NET Core 2.1 以後推出了 HttpClientFactory ，它用來集中管理使用的 HttpClient ，這樣可以有效減少重構 HttpClient ，也可以減少資源浪費，重點也解決 DNS 本來就有 TTL 的問題。

直接使用 HttpClientFactory

要使用 HttpClientFactory 方法首先作成 DI 服務

startup.cs
        public void ConfigureServices(IServiceCollection services)
        {
            // 使用HttpClientFactory
            services.AddHttpClient();
            services.AddMvc();
         
        }

然後，在使用時取用該服務

CWBController .cs
namespace CWBReader.Controllers
{
    [Route("[controller]")]
    public class CWBController : Controller
    {
        private readonly IHttpClientFactory _httpClientFactory;

        public CWBController(IHttpClientFactory httpClientFactory)
        {
            // 取用HttpClientFactory 的服務
            _httpClientFactory = httpClientFactory;
        }

        [Route("t1")]
        public async Task<FileResult> GetByFctory1()
        {
            HttpClient client = _httpClientFactory.CreateClient();
            string uri = "http://opendata.cwb.gov.tw/opendataapi?dataid=F-C0032-001&authorizationkey=CWB-1234ABCD-78EF-GH90-12XY-IJKL12345678";
            using (var result = await client.GetAsync(uri))
            {
                if (result.IsSuccessStatusCode)
                {
                    // 取得XML內容
                    byte[] content = await result.Content.ReadAsByteArrayAsync();
                    // 取得下載檔案名稱
                    string filename = result.Content.Headers.ContentDisposition.FileName;
                    FileContentResult response = File(content, "application/xml", filename);
                    return response;
                }
            }
            throw new Exception("CWB/t1 can not download file!");
        }
    }
}

具名式 Client

在建立 DI 時就賦予特定名稱，然後取用時，只要指定名稱就可以取用套好的內容，通常是經常性且固定的取用會很方便。

startup.cs
        public void ConfigureServices(IServiceCollection services)
        {
           // 使用固定內容，並賦予指定名稱 CWB
            services.AddHttpClient("CWB", c =>
            {
                c.BaseAddress = new Uri("http://opendata.cwb.gov.tw/opendataapi?dataid=F-C0032-001&authorizationkey=CWB-1234ABCD-78EF-GH90-12XY-IJKL12345678");
                c.DefaultRequestHeaders.Add("Accept", "*/*");
                c.DefaultRequestHeaders.Add("User-Agent" , "Mozilla/5.0 (Windows NT 5.1; rv:7.0.1) Gecko/20100101 Firefox/7.0.1");
            });
            services.AddMvc();
         
        }

然後取用具名服務

CWBController .cs
namespace CWBReader.Controllers
{
    [Route("[controller]")]
    public class CWBController : Controller
    {
        private readonly IHttpClientFactory _httpClientFactory;

        public CWBController(IHttpClientFactory httpClientFactory)
        {
            _httpClientFactory = httpClientFactory;
        }

        [Route("t2")]
        public async Task<FileResult> GetByFctory2()
        {
            // 在這裡取用具名 CWB
            HttpClient client = _httpClientFactory.CreateClient("CWB");
         
            using (var result = await client.GetAsync(""))
            {
                if (result.IsSuccessStatusCode)
                {
                    byte[] content = await result.Content.ReadAsByteArrayAsync();
                    string filename = result.Content.Headers.ContentDisposition.FileName;
                    FileContentResult response = File(content, "application/xml", filename);
                    return response;
                }
            }
            throw new Exception("CWB/t2 下載不到檔案");
        }
    }
}

型別式 Client

這種方式好處是可以先定義好很多不同需求的 Client 類別，灌入 DI 後，以Client形式來取用

CWBClient.cs
using System;
using System.Net.Http;

namespace CWBReader.Clients
{
    public class CWBClient
    {
        public HttpClient Client { get; private set; }

        public CWBClient(HttpClient client)
        {
            client.BaseAddress = new Uri("http://opendata.cwb.gov.tw/opendataapi?dataid=F-C0032-001&authorizationkey=CWB-1234ABCD-78EF-GH90-12XY-IJKL12345678");
            client.DefaultRequestHeaders.Add("Accept", "*/*");
            client.DefaultRequestHeaders.Add("User-Agent", "Mozilla/5.0 (Windows NT 5.1; rv:7.0.1) Gecko/20100101 Firefox/7.0.1");
            this.Client = client;
        }
    }
}

在 startup.cs 注入 DI 服務
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddHttpClient<CWBClient>();
            services.AddMvc();
         
        }

然後取用

CWB2Controller.cs
namespace CWBReader.Controllers
{
    [Route("[controller]")]
    public class CWB2Controller : Controller
    {
        private readonly CWBClient _cwbClient;

        public CWB2Controller(CWBClient cwbClient)
        {
            // 取用定義好的 Client
            _cwbClient = cwbClient;
        }
     
        [Route("t1")]
        public async Task<FileResult> GetByClient1()
        {
            using (var result = await _cwbClient.Client.GetAsync(""))
            {
                if (result.IsSuccessStatusCode)
                {
                    byte[] content = await result.Content.ReadAsByteArrayAsync();
                    string filename = result.Content.Headers.ContentDisposition.FileName;
                    FileContentResult response = File(content, "application/xml", filename);
                    return response;
                }
            }
            throw new Exception("CWB2/t1 can not download file");
        }
    }
}

產生式 Client

這種方式可以封裝整個 HttpClient ，也可以由第三方套件來提供，只要有套件方的介面即可實現。因為此處我沒有第三方套件，所以先由自己做。

首先產生一個介面

ICWBClient.cs
using Microsoft.AspNetCore.Mvc;
using System.Threading.Tasks;

namespace CWBReader.Clients
{
    public interface ICWBClient
    {
        Task<FileResult> GetFile();
    }
}

然後建立一個具有介面特徵的類別(被封裝者)

CWBHubClient.cs
using System;
using System.Net.Http;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;

namespace CWBReader.Clients
{
    public class CWBHubClient :ICWBClient
    {
        private readonly HttpClient _client;

        public CWBHubClient(HttpClient client)
        {
            client.BaseAddress = new Uri("http://opendata.cwb.gov.tw/opendataapi?dataid=F-C0032-001&authorizationkey=CWB-1234ABCD-78EF-GH90-12XY-IJKL12345678");
            client.DefaultRequestHeaders.Add("Accept", "*/*");
            client.DefaultRequestHeaders.Add("User-Agent", "Mozilla/5.0 (Windows NT 5.1; rv:7.0.1) Gecko/20100101 Firefox/7.0.1");
            _client = client;
        }

        public async Task<FileResult> GetFile()
        {
            using (var result = await _client.GetAsync(""))
            {
                if (result.IsSuccessStatusCode)
                {
                    byte[] content = await result.Content.ReadAsByteArrayAsync();
                    string filename = result.Content.Headers.ContentDisposition.FileName;
                    FileContentResult response = new FileContentResult(content, "application/xml") { FileDownloadName = filename };
                    return response;
                }
            }
            throw new Exception("CWB2/t2 下載不到檔案");
        }
    }
}

注入DI

startup.cs
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddHttpClient<ICWBClient, CWBHubClient>();
            services.AddMvc();
         
        }

呼叫引用

CWB3Controller.cs
namespace CWBReader.Controllers
{
    [Route("[controller]")]
    public class CWB3Controller : Controller
    {
        private readonly ICWBClient _cwbClient;

        public CWB3Controller(ICWBClient cwbClient)
        {
            _cwbClient = cwbClient;
        }

        [Route("t1")]
        public Task<FileResult> GetByClient1()
        {
            return _cwbClient.GetFile();
        }
    }
}

將 Http 服務封裝注入 DI 好處是除了這些控制器可以使用外，也可以用在 Razor 網頁上，提供不少便利。


參考相關：




留言

張貼留言

這個網誌中的熱門文章

【研究】列印的條碼為什麼很難刷(掃描)

-
圖片
條碼在我們的世界無處不在，小至發票，大至大型裝置設備都會有它的身影。 每一家有制度化的公司，多少都會需要用到條碼來進行管理，身為開發人員，就很難不會碰到它。 但是我們常常因為不熟悉條碼的規則，而導致作出來的條碼沒辦法被讀取(掃描)，也常遇到A設備可以讀取，B設備就無法讀取的奇怪現象，當然讀取設備本身的讀取元件也是有功力上的差別，有些廠商有能力可以調教讀寫元件的設定。 接下來，我就做點實驗給大家知道這個條碼的問題出在哪裡，以便在往後使用條碼時可以更注意到發生的原因。 在這裡我不再重述條碼的來由，這次的比較是使用大家常用的Code39(又稱39碼)來比較。 使用39碼得主要是因為他有字型檔可以使用，可以拿來做比較。 條碼的列印方式分類與優缺： 一、由條碼機(又稱標籤機)內建指令列印 優點：線條清晰，掃描讀取容易、速度快。             列印特殊紙張(背膠式、連續型.....) 缺點：特殊的指令語言(每一個廠牌都不太一樣)，等於換機器就要改寫程式碼。             有一些貼心的廠商(精聯)會提供比較簡單的統一語言列印工具，減少開發者困擾。             版面變化較少，沒有視覺化編輯。 二、由Windows Driver列印，或稱普通列印 優點：只要有驅動程式就可以列印，不需要改寫程式(或改寫幅度小)。            版面彈性比較自由。由於只要有驅動就可以列印，            所以比較不限定紙張種類，或印表機種類。 缺點：列印線條有很多模糊地帶，沒控制好就會導致無法讀取。            受到列印裝置解析度限制，匹配沒做好就會失敗。 底下先做出三種情境比較： 雷射印表機：600DPI 條碼印表機(標籤機)：203DPI 這裡，我們先 比較印表機解析度的列印差異 ，請忽略機器種類。
裡面更多內容 》》》

統一發票列印小程式

-
圖片
1、請注意本版留言過多， 您的留言可能不在這一頁，請到以下留言樓層看看再回應喔～  2、如果您有填寫表單，卻沒有收到我的郵件，有可能您填寫的電子郵件有錯誤，麻煩您查看一下留言是否有我給您的信息喔。因為我沒辦法直接連繫到您。 1 ~200 則，請按這裡   200+ 以上請按這裡 因為公司會在一堆系統上都有可能要印發票(真不懂要怎麼搞?) 希望可以有個小工具可以列印電子發票， 原本發票列印程式要使用條碼機專用語言(ZPL、EPL)，但容易被某種機型綁定。 當然可以考慮使用ESC/POS指令的方式，但也是要印表機支援這種指令列印模式(當然多數表機都有支援)，不過要列印QR碼，就有點不是那麼容易了，除了要自己編碼外還要注意中文問題。 後來我想改用Windows Printer Driver來列印，雖然不如指令式快速，但可以方便各類型程式應用，因此考慮了以下的條件： 使用C#開發、.Net 2.0平台、Console呼叫 本來想用RDLC來做，但是很不幸的，失敗了，原因就在於條碼， 國稅局訂定的Code39條碼內要放入21個字元(19+2)長度， 如果使用RDLC的話，解析度只有100DPI，密度不夠，條碼線條沾黏嚴重。 一般的條碼機至少都有200DPI得等級，這RDLC也太彆腳了吧， 網路上找盡RDLC條整解析度的方式都沒有比較好的效果。 因此，改用直接C#繪製的方式來做， 當然中間為了條碼圖像清晰度的問題花了不少心力解決。 下載點： PrintInvoice
裡面更多內容 》》》

C# 使用 Process.Start 執行外部程式

-
圖片
C# 執行外部程式的方式並不難，也很簡單，首先引入 using System.Diagnostics; 然後使用 Process.Start( "OtherProgram.exe" ) 方式就可以呼叫並執行。 但是，某些情況下會導致程式無法被執行(或是無法正常執行)， 很多原因在於『執行程式的起始位置』，由於被呼叫的程式執行時， 它所啟動的路徑其實是在呼叫程式的路徑下， 如果被呼叫程式需要讀取與程式相同路徑下的文件檔案(或是INI)，可能會導致找不到的問題。 為了測試這樣的現象，我準備了2支程式， 一支是被呼叫端的程式 HelloConsole.exe 另外一支就是呼叫端程式 CallOtherProgram.exe HelloConsole.exe 這支程式 在啟動時會讀取相同路徑下的 Doc.txt 並將內容顯示出來，如果有參數也會把參數列出來。而這支程式我固定放在 D:\TEST\ 下，以方便測試，如果不是在這路徑下，那呼叫端的程式碼裡面的路徑也要變更。 HelloConsole.exe using System; using System.IO; namespace HelloConsole {     class Program     {         static void Main(string[] args)         {             Console.WriteLine("This is HelloConsole.exe");             Console.WriteLine(" ");             Console.WriteLine("Environment.CurrentDirectory is ");             Console.WriteLine(Env...
裡面更多內容 》》》