ASP.NET MVC 使用政府公開資料 Part.1

現在越來越多政府單位有提供公開資料，我們可以拿這些公開資料來做一些工具或是服務，大部分的政府公開資料都會提供 JSON 或是 XML 格式的資料，也有一些是直接提供檔案讓我們下載使用，所以這一次就來練習怎麼在 ASP.NET MVC 網站裡使用政府公開資料，這裡將會使用「新北市政府資料開放平台」的「新北市 WIFI 熱點」來作為這次練習的資料來源。

 

---

開發環境：Visual Studio 2013, ASP.NET MVC 5

資料來源：新北市政府資料公開平台 – 新北市WIFI熱點

這裡有提供以 URL 取得 JSON, XML, CSV，還有下載 Excel 檔案的方式，在範例裡將會使用以 URL 取得 JSON 資料的方式。

 

首先在建立好的空白 ASP.NET MVC 專案裡加入一個 HotSpotController，

接著我們要使用 HttpClient 類別來傳送 HTTP 要求以及接收 HTTP 回應，HttpClient 類別是 .NET Framework 4.5 才有提供的，與以往 WebClient 類別最大的不同在於「非同步」，HttpClient 類別的方法大部分都是非同步作業方式，這邊將會使用 GetStringAsync(String) 來取得 JSON 資料。

MSDN - HttpClient 類別 (System.Net.Http)

MSDN - HttpClient.GetStringAsync 方法 (String) (System.Net.Http)

要特別注意的是，因為使用了 HttpClient.GetStringAsync() 取得指定 URI 所回傳的資料，使用了非同步作業的方式，所以原本的 Action 方法也需要修改為非同步。

檢視頁面就很簡單，把取回的 JSON 字串顯示出來，

執行結果

 

但是這樣的 JSON 字串並不能直接拿來使用，所以要反序列化還原為物件，這邊我們不必自己用手動的方式去建立類別，可以使用「編輯 > 選擇性貼上 > 貼上 JSON 做為類別」的方式來建立，

先複製 JSON 字串裡的一個物件的資料「{"id":"ZZZITWF100261","spot_name":"中和錦和運動公園-司令台 -3","type":"NewTaipei","company":"全球一動","district":"中和區","address":"235新北市中和區錦和路350號","apparatus_name":"新北市中和區公所","latitude":"24.99249","longitude":"121.49033"}」，然後在 Models 目錄裡建立一個 HotSpot 類別的檔案，再來就是使用「編輯 > 選擇性貼上 > 貼上 JSON 做為類別」建立類別，如下：

依據「新北市WIFI熱點」頁面上的欄位定義，稍做修改，

public class HotSpot

{

    [Display(Name = "熱點代碼")]

    public string ID { get; set; }

    [Display(Name = "熱點名稱")]

    public string Spot_Name { get; set; }

    [Display(Name = "熱點分類")]

    public string Type { get; set; }

    [Display(Name = "業者")]

    public string Company { get; set; }

    [Display(Name = "鄉鎮市區")]

    public string District { get; set; }

    [Display(Name = "地址")]

    public string Address { get; set; }

    [Display(Name = "機關名稱")]

    public string Apparatus_Name { get; set; }

    [Display(Name = "緯度")]

    public string Latitude { get; set; }

    [Display(Name = "經度")]

    public string Longitude { get; set; }

}

 

原本 HotSpotController Index Action 方法就可以使用 JSON.NET 的 JsonConvert.DeserializeObject<T>() 來反序列化 JSON 字串，以取得 HotSpot Collection，

檢視頁面也做了修改，改以 Table 來顯示資料，

@model IEnumerable<BlogSample.Models.HotSpot>

@{

    ViewBag.Title = "Index";

}

<h2>新北市 WIFI 熱點</h2>

<table class="table">

    <tr>

        <th>

            @Html.DisplayNameFor(model => model.Spot_Name)

        </th>

        <th>

            @Html.DisplayNameFor(model => model.Type)

        </th>

        <th>

            @Html.DisplayNameFor(model => model.Company)

        </th>

        <th>

            @Html.DisplayNameFor(model => model.District)

        </th>

        <th>

            @Html.DisplayNameFor(model => model.Address)

        </th>

        <th>

            @Html.DisplayNameFor(model => model.Apparatus_Name)

        </th>

        <th>

            @Html.DisplayNameFor(model => model.Latitude)

        </th>

        <th>

            @Html.DisplayNameFor(model => model.Longitude)

        </th>

    </tr>

    @foreach (var item in Model)

    {

        <tr>

            <td>

                @Html.DisplayFor(modelItem => item.Spot_Name)

            </td>

            <td>

                @Html.DisplayFor(modelItem => item.Type)

            </td>

            <td>

                @Html.DisplayFor(modelItem => item.Company)

            </td>

            <td>

                @Html.DisplayFor(modelItem => item.District)

            </td>

            <td>

                @Html.DisplayFor(modelItem => item.Address)

            </td>

            <td>

                @Html.DisplayFor(modelItem => item.Apparatus_Name)

            </td>

            <td>

                @Html.DisplayFor(modelItem => item.Latitude)

            </td>

            <td>

                @Html.DisplayFor(modelItem => item.Longitude)

            </td>

        </tr>

    }

</table>

執行結果

 

但每次要執行時就必須要到遠端取得資料，所以我們可以在第一次取得資料後放到快取裡，之後讀取資料就從快取裡取得，當快取資料的期限過了或是快取資料不見就再到遠端資料來源去拿。

這邊的快取並不是使用 System.Web.Caching 而是使用 System.Runtime.Caching，

MSDN - System.Runtime.Caching 命名空間

要使用 System.Runtime.Caching 要另外加入組件參考，

 

到指定 URI 位置取得資料並且將資料置入 Cache 裡，快取是放在記憶體中，然後設定快取的期限為 30 分鐘，

MSDN - CacheItemPolicy 類別 (System.Runtime.Caching)

修改後的 Index Action 方法

using System;

using System.Collections.Generic;

using System.Linq;

using System.Net.Http;

using System.Runtime.Caching;

using System.Threading.Tasks;

using System.Web;

using System.Web.Mvc;

using BlogSample.Models;

using Newtonsoft.Json;

namespace BlogSample.Controllers

{

    public class HotSpotController : Controller

    {

        public async Task<ActionResult> Index()

        {

            var hotSpotSource = await this.GetHotSpotData();

            ViewData.Model = hotSpotSource;

            return View();

        }

        private async Task<IEnumerable<HotSpot>> GetHotSpotData()

        {

            string cacheName = "WIFI_HOTSPOT";

            ObjectCache cache = MemoryCache.Default;

            CacheItem cacheContents = cache.GetCacheItem(cacheName);

            if (cacheContents == null)

            {

                return await RetriveHotSpotData(cacheName);

            }

            else

            {

                return cacheContents.Value as IEnumerable<HotSpot>;

            }

        }

        private async Task<IEnumerable<HotSpot>> RetriveHotSpotData(string cacheName)

        {

            string targetURI = "http://data.ntpc.gov.tw/NTPC/od/data/api/IMC123/?$format=json";

            HttpClient client = new HttpClient();

            client.MaxResponseContentBufferSize = Int32.MaxValue;

            var response = await client.GetStringAsync(targetURI);

            var collection = JsonConvert.DeserializeObject<IEnumerable<HotSpot>>(response);

            CacheItemPolicy policy = new CacheItemPolicy();

            policy.AbsoluteExpiration = DateTime.Now.AddMinutes(30);

            ObjectCache cacheItem = MemoryCache.Default;

            cacheItem.Add(cacheName, collection, policy);

            return collection;

        }

    }

}

 

---

這一篇就先講到這裡，除了政府公開資料的取得與使用之外，最主要的是這個練習中用了幾個操作方式：Async/Await, HttpClient, SystemRuntime.Caching，下一篇再完成這個練習的其他部份。

 

參考連結：

MSDN - HttpClient 類別 (System.Net.Http)

MSDN - HttpClient.GetStringAsync 方法 (String) (System.Net.Http)

MSDN - System.Runtime.Caching 命名空間

MSDN - CacheItemPolicy 類別 (System.Runtime.Caching)

 

以上