在 Azure 行動應用後端專案,新增差旅費用頁面需要用的資料表
為了要進行這個部分練習,需要建立一個新的SQL Database資料表,因此,我們需要啟用 Code First Migration 功能,來幫助我們依據專案內的資料模型,進行自動調整遠端資料庫內的綱要 (Schema) 內容。
- 開啟您從 Azure Moible App 項目中下載的
XamarinAzureService
內的XamarinAzureDay.sln
Visual Studio 專案下圍呈現了這個 Visual Studio 方案/專案的結構 - 按下 F5 ,在本地端執行這個專案您可以使用 PostMan 來檢查本地端執行與運作結果是否正常
- 中斷除錯執行
- 點選功能表
工具
>NuGet封裝管理員
>套件管理員主控台
- 在
套件管理員主控台
中輸入底下指令
Enable-Migrations
完成後,會出現底下訊息
Checking if the context targets an existing database...
Detected database created with a database initializer. Scaffolded migration '201702111723152_InitialCreate' corresponding to existing database. To use an automatic migration instead, delete the Migrations folder and re-run Enable-Migrations specifying the -EnableAutomaticMigrations parameter.
Code First Migrations enabled for project XamarinAzureDayService.
- 接著,執行底下指令
Add-Migration Initial
完成後,會出現底下訊息
Scaffolding migration 'Initial'.
The Designer Code for this migration file includes a snapshot of your current Code First model. This snapshot is used to calculate the changes to your model when you scaffold the next migration. If you make additional changes to your model that you want to include in this migration, then you can re-scaffold it by running 'Add-Migration Initial' again.
- 打開資料夾
App_Start
底下的Startup.MobileApp.cs
檔案 - 在這個檔案最上方加入底下 using
using System.Data.Entity.Migrations;
using XamarinAzureDayService.Migrations;
- 將這行程式碼註解起來
Database.SetInitializer(new XamarinAzureDayInitializer());
- 在剛剛註解的程式碼後,加入底下程式碼
var migrator = new DbMigrator(new Migrations.Configuration());
migrator.Update();
- 按下 F5 ,在本地端執行這個專案您可以使用 PostMan 來檢查本地端執行與運作結果是否正常
- 中斷除錯執行
建立資料傳輸物件 (DTO) 類別
接下來,我們需要修改這個後端 API 專案,讓這個專案可以提供更多的功能。
- 為了要開始產生一個我們自訂的資料表,我們需要定義資料表控制器, 設定資料表控制器需要三個步驟︰
這裡,我們需要定義一個差旅費用的申請紀錄表單,用來定義 SQL Database 內的資料表。
- 請滑鼠右擊
DataObjects
資料夾,選擇加入
>類別
- 在對話窗下方的
名稱
輸入BusinessTripExpense
- 點選
新增
按鈕 - 請將剛剛產生的類別
BusinessTripExpense
,修改成為如下程式碼:
public class BusinessTripExpense : EntityData
{
public DateTime 出差日期 { get; set; }
public string 類型 { get; set; }
public string 項目名稱 { get; set; }
public string 地點 { get; set; }
public double 費用 { get; set; }
public string 備註 { get; set; }
public bool 國內外 { get; set; }
public bool 是否有單據 { get; set; }
}
若有找不到的類別或者命名空間,請點選燈泡來修正
EntityData 類別
每個要新增的資料表類別,需要繼承
EntityData
這個類別,這個類別的定義如下。 public bool Deleted { get; set; }
您可以看到我們並不需要額外定義 Id 作為每筆紀錄的唯一紀錄欄位,因為在
EntityData
內已經幫我們加入進來了 (要實作出 ITableData
這個介面);而其他的欄位 CreatedAt
/ Deleted
/ UpdatedAt
/ Version
將會用於方便 Azure Mobile 服務進行使用 Entity Framework 工作處理之用。 //
// 摘要:
// An abstract implementation of the Microsoft.Azure.Mobile.Server.Tables.ITableData
// interface indicating how the system properties for a given table data model are
// to be serialized when communicating with clients when using Entity Framework
// for accessing the backend store. The uniform serialization of system properties
// ensures that the clients can process the system properties uniformly across platforms.
// Concrete entity framework models can derive from this base class in order to
// support the system properties.
public abstract class EntityData : ITableData
{
protected EntityData();
[System.ComponentModel.DataAnnotations.Schema.DatabaseGeneratedAttribute]
[Index(IsClustered = true)]
[TableColumn(TableColumnType.CreatedAt)]
public DateTimeOffset? CreatedAt { get; set; }
[TableColumn(TableColumnType.Deleted)]
public bool Deleted { get; set; }
[System.ComponentModel.DataAnnotations.KeyAttribute]
[TableColumn(TableColumnType.Id)]
public string Id { get; set; }
[System.ComponentModel.DataAnnotations.Schema.DatabaseGeneratedAttribute]
[TableColumn(TableColumnType.UpdatedAt)]
public DateTimeOffset? UpdatedAt { get; set; }
[TableColumn(TableColumnType.Version)]
[System.ComponentModel.DataAnnotations.TimestampAttribute]
public byte[] Version { get; set; }
}
建立資料表控制器。
如果已安裝 Azure SDK,您現在可以建立範本資料表控制器,請進行底下操作
使用 Azure 行動應用程式資料表控制器
- 滑鼠右擊
Controller
資料夾,選擇加入
>控制器
- 在對話窗中,選擇
Azure 行動應用程式資料表控制器
- 點選新增按鈕
- 在出現
新增控制器
對話窗,請輸入或者選擇如下圖結果模型類別:您剛剛定義的 SQL 資料表型別,可用下拉選單來選擇資料內容類別:,也就是這個專案內繼承 DbContext 的類別,可用下拉選單來選擇控制器名稱:可以使用自動產生的名稱,注意,最後面一定要有Controller
- 點選
新增
按鈕,完成這個資料表控制器產生動作。 - 底下為產生後的
BusinessTripExpenseController
資料控制器程式碼您可以看到,對於差旅費用資料表的基本 CRUD API 程式碼,都已經幫您自動產生好了這裡請特別注意,在使用 Azure Mobile App 的資料表控制項類別中,必須要繼承TableController
這個類別,而不是要使用ApiController
類別
public class BusinessTripExpenseController : TableController<BusinessTripExpense>
{
protected override void Initialize(HttpControllerContext controllerContext)
{
base.Initialize(controllerContext);
XamarinAzureDayContext context = new XamarinAzureDayContext();
DomainManager = new EntityDomainManager<BusinessTripExpense>(context, Request);
}
// GET tables/BusinessTripExpense
public IQueryable<BusinessTripExpense> GetAllBusinessTripExpense()
{
return Query();
}
// GET tables/BusinessTripExpense/48D68C86-6EA6-4C25-AA33-223FC9A27959
public SingleResult<BusinessTripExpense> GetBusinessTripExpense(string id)
{
return Lookup(id);
}
// PATCH tables/BusinessTripExpense/48D68C86-6EA6-4C25-AA33-223FC9A27959
public Task<BusinessTripExpense> PatchBusinessTripExpense(string id, Delta<BusinessTripExpense> patch)
{
return UpdateAsync(id, patch);
}
// POST tables/BusinessTripExpense
public async Task<IHttpActionResult> PostBusinessTripExpense(BusinessTripExpense item)
{
BusinessTripExpense current = await InsertAsync(item);
return CreatedAtRoute("Tables", new { id = current.Id }, current);
}
// DELETE tables/BusinessTripExpense/48D68C86-6EA6-4C25-AA33-223FC9A27959
public Task DeleteBusinessTripExpense(string id)
{
return DeleteAsync(id);
}
}
加入 Migration
- 點選功能表
工具
>NuGet封裝管理員
>套件管理員主控台
- 在
套件管理員主控台
中輸入底下指令
Add-Migration BusinessTripExpense
- 按下 F5 ,在本地端執行這個專案您可以使用 PostMan 來檢查本地端執行與運作結果是否正常
- 中斷除錯執行
發佈到 Azure 雲端上
- 滑鼠右擊
XamarinAzureDayService
,選擇發行
- 在對話窗中,點選
發行
按鈕 - 您可以使用 PostMan 來檢查本地端執行與運作結果是否正常
PostMan 測試資料
本地端
Azure
Header 資訊
Key : ZUMO-API-VERSION
Value : 2.0.0
這個練習範例專案,請參考
XamarinAzureService_Custom