Azure Storage 系列（四）在.Net 上使用Table Storage

一，引言

　　今天我們就不多說廢話了，直接進入正題，Azure Table Storage。開始內容之前，我們先介紹一下Azure Table Storage.

　　1，什麼是Azure Table Storage

　　答：Azure Table Storage 是儲存結構化的 NoSql 資料的服務，通過無架構設計提供鍵/屬性儲存。 因為表儲存無架構，因此可以很容易地隨著應用程式需求的發展使資料適應儲存。 對於許多型別的應用程式來說，訪問表儲存資料速度快且經濟高效，在資料量相似的情況下，其成本通常比傳統 SQL 要低（官方解釋）。簡單來說，Azure  Table Srorage 可以直接將實體，實體物件存入表結構中，和一般的關係型資料庫的 Table 很像，包含了列名和行資料，但是它不能提供像SQL中 inner join 方法，也是不能管理 Foreign Key。

--------------------我是分割線--------------------

Azure Storage 儲存系列：

1，Azure Storage 系列（一）入門簡介

2，Azure Storage 系列（二） .NET Core Web 專案中操作 Blob 儲存

3，Azure Storage 系列（三）Blob 引數設定說明

4，Azure Storage 系列（四）在.Net 上使用Table Storage 

二，正文

1，新增對 Table Storage 的 “增，刪，改，查” 方法

1.1，安裝 Azure.TableStorage 相關的 Nuget 包，

NuGet：WindowsAzure.Storage（此包已被棄用，推薦使用 “Microsoft.Azure.Cosmos.Table”，今天作為演示，就暫時使用當前已經遺棄的包）

Install-Package WindowsAzure.Storage -Version 9.3.3

從9.4.0版本開始，此庫已分為多個部分並被替換。大家可以通過當前連結進行檢視當前庫的狀態：https://www.nuget.org/packages/WindowsAzure.Storage

1.2，建立 ITableService 介面，和 TableService 實現類，以及新增相應的對 Table 操作的方法

 新增Table資料操作

public async Task AddEntity(UserInfo user)
{
    var cloudTableClient = _cloudStorageClient.CreateCloudTableClient();
    var cloudTable = cloudTableClient.GetTableReference("USERINFO");
    await cloudTable.CreateIfNotExistsAsync();

    var tableOperation = TableOperation.Insert(user);
    await cloudTable.ExecuteAsync(tableOperation);
}

批量新增 Table 表資料

public async Task BatchAddEntities(List<UserInfo> users)
{
    var cloudTableClient = _cloudStorageClient.CreateCloudTableClient();
    var cloudTable = cloudTableClient.GetTableReference("USERINFO");
    await cloudTable.CreateIfNotExistsAsync();

    var tableBatchOperation = new TableBatchOperation();
    foreach (UserInfo item in users)
    {
         tableBatchOperation.Insert(item);
    }

    await cloudTable.ExecuteBatchAsync(tableBatchOperation);
 }

修改 Table 表資料

public async Task UpdateEntity(UserInfo user)
{
   var cloudTableClient = _cloudStorageClient.CreateCloudTableClient();
   var cloudTable = cloudTableClient.GetTableReference("USERINFO");

   var queryOperation = TableOperation.Retrieve<UserInfo>(user.PartitionKey, user.RowKey);

   var tableResult = await cloudTable.ExecuteAsync(queryOperation);
   if (tableResult.Result is UserInfo userInfo)
   {
        user.ETag = userInfo.ETag;
        var deleteOperation = TableOperation.Replace(user);
        await cloudTable.ExecuteAsync(deleteOperation);
   }
}

查詢Table 表資料

public async IAsyncEnumerable<UserInfo> QueryUsers(string filter)
{
    var cloudTableClient = _cloudStorageClient.CreateCloudTableClient();
    var cloudTable = cloudTableClient.GetTableReference("USERINFO");

    TableQuery<UserInfo> query = new TableQuery<UserInfo>().Where(filter);

    var users = await cloudTable.ExecuteQuerySegmentedAsync<UserInfo>(query, null);
    foreach (var item in users)
    {
        yield return item;
    }
}

刪除 Table 表資料

public async Task DeleteEntity(UserInfo user)
{
    var cloudTableClient = _cloudStorageClient.CreateCloudTableClient();
    var cloudTable = cloudTableClient.GetTableReference("USERINFO");

    var queryOperation = TableOperation.Retrieve<UserInfo>(user.PartitionKey, user.RowKey);

    var tableResult = await cloudTable.ExecuteAsync(queryOperation);
    if (tableResult.Result is UserInfo userInfo)
    {
        var deleteOperation = TableOperation.Delete(userInfo);
        await cloudTable.ExecuteAsync(deleteOperation);
     }
 }

刪除 Table 表

public async Task DeleteTable(string tableName)
{
    var cloudTableClient = _cloudStorageClient.CreateCloudTableClient();
    var cloudTable = cloudTableClient.GetTableReference(tableName);
    await cloudTable.DeleteIfExistsAsync();
 }

1.3，新增對 TableService ,CloudStorageAccount 的注入

services.AddSingleton(x => new CloudStorageAccount(new StorageCredentials("cnbateblogaccount", "FU01h022mn1JjONp+ta0DAXOO7ThK3diYhsdsdm0Hpg891n9nycsTLGZF83nJpGvTIZvsdsdVCVFhGOfV0wndOOQ=="), true));
services.AddSingleton<ITableService, TableService>();

完整程式碼

public class TableService : ITableService
    {
        private readonly CloudStorageAccount _cloudStorageClient;
        public TableService(CloudStorageAccount cloudStorageClient)
        {
            _cloudStorageClient = cloudStorageClient;
        }

        #region 01，新增表資料+async Task AddEntity(UserInfo user)
        /// <summary>
        /// 新增表資料
        /// </summary>
        /// <param name="user">使用者資料</param>
        /// <returns></returns>
        public async Task AddEntity(UserInfo user)
        {
            var cloudTableClient = _cloudStorageClient.CreateCloudTableClient();
            var cloudTable = cloudTableClient.GetTableReference("USERINFO");
            await cloudTable.CreateIfNotExistsAsync();

            var tableOperation = TableOperation.Insert(user);
            await cloudTable.ExecuteAsync(tableOperation);
        }
        #endregion

        #region 02，批量新增使用者表資料+async Task BatchAddEntities(List<UserInfo> users)
        /// <summary>
        /// 批量新增使用者表資料
        /// </summary>
        /// <param name="users">使用者資料</param>
        /// <returns></returns>
        public async Task BatchAddEntities(List<UserInfo> users)
        {
            var cloudTableClient = _cloudStorageClient.CreateCloudTableClient();
            var cloudTable = cloudTableClient.GetTableReference("USERINFO");
            await cloudTable.CreateIfNotExistsAsync();

            var tableBatchOperation = new TableBatchOperation();
            foreach (UserInfo item in users)
            {
                tableBatchOperation.Insert(item);
            }

            await cloudTable.ExecuteBatchAsync(tableBatchOperation);
        }
        #endregion

        #region 03，刪除表操作根據表名+async Task DeleteTable(string tableName)
        /// <summary>
        /// 刪除表操作根據表名
        /// </summary>
        /// <param name="tableName">表命</param>
        /// <returns></returns>
        public async Task DeleteTable(string tableName)
        {
            var cloudTableClient = _cloudStorageClient.CreateCloudTableClient();
            var cloudTable = cloudTableClient.GetTableReference(tableName);
            await cloudTable.DeleteIfExistsAsync();
        }
        #endregion

        #region 04，刪除使用者資料根據使用者條件+async Task DeleteEntity(UserInfo user)
        /// <summary>
        /// 刪除使用者資料根據使用者條件
        /// </summary>
        /// <param name="user">使用者條件</param>
        /// <returns></returns>
        public async Task DeleteEntity(UserInfo user)
        {
            var cloudTableClient = _cloudStorageClient.CreateCloudTableClient();
            var cloudTable = cloudTableClient.GetTableReference("USERINFO");

            var queryOperation = TableOperation.Retrieve<UserInfo>(user.PartitionKey, user.RowKey);

            var tableResult = await cloudTable.ExecuteAsync(queryOperation);
            if (tableResult.Result is UserInfo userInfo)
            {
                var deleteOperation = TableOperation.Delete(userInfo);
                await cloudTable.ExecuteAsync(deleteOperation);
            }
        }
        #endregion

        #region 05，查詢使用者根據條件+async IAsyncEnumerable<UserInfo> QueryUsers(string filter)
        /// <summary>
        /// 查詢使用者根據條件
        /// </summary>
        /// <param name="filter">條件</param>
        /// <returns></returns>
        public async IAsyncEnumerable<UserInfo> QueryUsers(string filter)
        {
            var cloudTableClient = _cloudStorageClient.CreateCloudTableClient();
            var cloudTable = cloudTableClient.GetTableReference("USERINFO");

            TableQuery<UserInfo> query = new TableQuery<UserInfo>().Where(filter);

            var users = await cloudTable.ExecuteQuerySegmentedAsync<UserInfo>(query, null);
            foreach (var item in users)
            {
                yield return item;
            }
        }
        #endregion

        #region 06，更新使用者表資料根據新的使用者資料+async Task UpdateEntity(UserInfo user)
        /// <summary>
        /// 更新使用者表資料根據新的使用者資料
        /// </summary>
        /// <param name="user">新使用者資料</param>
        /// <returns></returns>
        public async Task UpdateEntity(UserInfo user)
        {
            var cloudTableClient = _cloudStorageClient.CreateCloudTableClient();
            var cloudTable = cloudTableClient.GetTableReference("USERINFO");

            var queryOperation = TableOperation.Retrieve<UserInfo>(user.PartitionKey, user.RowKey);

            var tableResult = await cloudTable.ExecuteAsync(queryOperation);
            if (tableResult.Result is UserInfo userInfo)
            {
                user.ETag = userInfo.ETag;
                var deleteOperation = TableOperation.Replace(user);
                await cloudTable.ExecuteAsync(deleteOperation);
            }
        } 
        #endregion
    }

public interface ITableService
    {
        Task AddEntity(UserInfo user);

        Task BatchAddEntities(List<UserInfo> users);

        IAsyncEnumerable<UserInfo> QueryUsers(string filter);

        Task UpdateEntity(UserInfo user);

        Task DeleteEntity(UserInfo user);

        Task DeleteTable(string tableName);

    }

[Route("Table")]
    public class TableExplorerController : Controller
    {
        private readonly ITableService _tableService;

        public TableExplorerController(ITableService tableService)
        {
            this._tableService = tableService;
        }

        [HttpPost("AddUser")]
        public async Task<ActionResult> AddEntity([FromBody]UserInfo user)
        {
            await _tableService.AddEntity(new UserInfo("zhangsan", "610124199012223650") { Email = "135012689@qq.com", TelNum = "13000000000" });
            return Ok();
        }

        [HttpPost("AddBatchUser")]
        public async Task<ActionResult> AddEntities([FromBody]List<UserInfo> users)
        {
            List<UserInfo> userList = new List<UserInfo>();
            userList.Add(new UserInfo("lisi", "610124199012223651") { Email = "1350126740@qq.com", TelNum = "13000000001" });
            userList.Add(new UserInfo("lisi", "610124199012223652") { Email = "1350126741@qq.com", TelNum = "13000000002" });
            userList.Add(new UserInfo("lisi", "610124199012223653") { Email = "1350126742@qq.com", TelNum = "13000000003" });
            await _tableService.BatchAddEntities(userList);
            return Ok();
        }

        [HttpGet("Users")]
        public ActionResult QueryUsers()
        {
            var filter = TableQuery.CombineFilters(TableQuery.GenerateFilterCondition("PartitionKey", QueryComparisons.Equal, "zhangsan"), TableOperators.And, TableQuery.GenerateFilterCondition("RowKey", QueryComparisons.Equal, "610124199012223650"));

            return Ok(_tableService.QueryUsers(filter));
        }

        [HttpPut("UpdateUser")]
        public async Task<ActionResult> UpdateUser([FromBody]UserInfo user)
        {
            await _tableService.UpdateEntity(new UserInfo("zhangsan", "610124199012223650") { Email = "135012689@qq.com", TelNum = "15000000000" });
            return Ok();
        }

        [HttpDelete("DeleteEntity")]
        public async Task<ActionResult> DeleteEntity([FromBody]UserInfo user)
        {
            await _tableService.DeleteEntity(new UserInfo("lisi", "610124199012223651"));
            return Ok();
        }

        [HttpDelete("{tableName}")]
        public async Task<ActionResult> DeleteTable(string tableName)
        {
            await _tableService.DeleteTable(tableName);
            return Ok();
        }
    }

public class UserInfo:TableEntity
    {
        public UserInfo()
        {

        }

        public UserInfo(string userName, string IdCardNum)
        {
            this.PartitionKey = userName;
            this.RowKey = IdCardNum;

        }

        public string Email { get; set; }

        public string TelNum { get; set; }
    }

2，執行專案，通過介面方式呼叫是否可以對 Table 表資料進行操作

2.1 新增使用者資料

我們在 postman 中呼叫新增使用者表資料介面（控制器中預設構造了使用者資訊，所以我這邊沒有在Body中新增引數）

我們可以看到，在Azure Portal 上已經建立出一個叫 “USERINFO” 的表資訊（注意，大家不要疑惑，可以看看上面新增使用者的Service方法，我這裡有兩行程式碼）

var cloudTable = cloudTableClient.GetTableReference("USERINFO");
await cloudTable.CreateIfNotExistsAsync();

獲取 “USERINFO” 表的引用例項，如果當前例項不儲存就建立 “USERINFO” 表

接下來，我們看看 "USERINFO" 表中剛剛新增進去的資料，這時候我們就要藉助 VS 的 "Cloud Expoere“ 的工具了

VS 點選 ”檢視=》Cloud Expoere“

點選當前 ”賬號管理“ 找到與之對應的自己的Azure 訂閱相關聯的賬號

點選 ”cnbateblogaccount“ 的 Azure Storage 賬號，找到剛剛建立好的 ”USERINFO“ Azure Table，右鍵點選”開啟“

我們可以看到新增到 ”USERINFO“ 表中的資料 （注意，Timestamp欄位的時間問題，這裡是因為Azure Table Storage 採用的是標準時間，換算到中國時間 就得在原有時間基礎上+8）

 2.2 批量新增使用者資料

注意：批量新增 Table 資料的話，這些批量資料的 “PartitionKey” 必須是相同的

輸入批量新增使用者資料的連結，點選 “Send”

 

 我們繼續回到 VS 的Cloud Explorer 檢視 “USERINFO” Table 的表資訊

額外話題，剛才提到批量新增 Table 表資料，有提到這些資料的 “PartitionKey” 必須一致。Azure Table Storage 對批處理操作做了一些限制

　　1，單個批處理中的所有實體必須具有相同的分割槽鍵

　　2，單個批處理操作只能包含100個實體。

3，查詢使用者資料

注意，我這裡使用兩個查詢條件聯合進行查詢，分別是 “PartitionKey” 和 “RowKey” 作為查詢的 Key，通過 “Partition” 等於 “zhangsan” 和 “RowKey” 等於 “610124199012113650” 

輸入查詢使用者表資料介面，點選 “Send” 進行呼叫介面

同時，我們可以看到將查詢條件對應的資料查詢出來了

 4，更新表資料

注意，目前的更新操作時根據 “PartitionKey” 和 “RowKey” 進行檢索資料，將新的使用者資料進行替換操作，記得將舊的表資料中的 “ETag” 也要進行賦值到新的物件中，再執行替換操作

注意，我們此時更新操作主要更新的是 “TelNum” 欄位

 輸入更新使用者表資料介面，點選 “Send” 進行呼叫介面，返回狀態碼 200

同時我們再重新整理 Table 中的資料，成功的 PartitionKey 等於 “zhangsan”，RowKey 等於 “610124199012223650” 的資料的 TelNum 從 13000000000 改為 “15000000000”

5，刪除 Table 表資料

我們嘗試刪除 “PartitionKey” 等於 “lisi”，“RowKey” 等於 “610124199012223651”的資料

 也是根據條件先查詢到當前資料，再判斷是否儲存，如果存在 就執行刪除操作

在 postman 輸入刪除實體操作的介面連結，然後點選 “Sand”

 接下來，我們繼續檢視當前 Table 中的資料，以及沒有  “PartitionKey” 等於 “lisi”，“RowKey” 等於 “610124199012223651”的資料了。

6，刪除 Table 表

接下來，我們就要將整個 "SUERINFO" 表刪除的操作

 繼續在 postman 上呼叫刪除 Table 操作的介面地址

當前 Table Storage 已經找不到 “USERINFO” 的 Table 資訊了

 我們再上Azue Portal 上找一找，看看是否把 “USERINFO” 表刪除了

對應的 cnbatebogaccount 儲存賬戶下的 Tables 中已經沒有了任何表了

OK，今天的分享到此結束，撒花??????！

三，結尾

　　今天，我們通過程式碼（已遺棄的類庫）演示了一下如何操作 Tables 資料，已經建立/刪除 Table，下一篇繼續講解 Table 是如果進行操作的，但是會換一套微軟推薦的 “Microsoft.Azure.Cosmos.Table”，我們也要跟上微軟的腳步，與時俱進。

github：https://github.com/yunqian44/Azure.Storage.git

作者：Allen 

版權：轉載請在文章明顯位置註明作者及出處。如發現錯誤，歡迎批評指正。