Azure Cosmos DB (三) EF Core 實現 CURD Demo

一，引言

　　接着上一篇使用 EF Core 操作 Azure CosmosDB 生成種子數據，今天我們完成通過 EF Core 實現CRUD一系列功能。EF Core 3.0 提供了CosmosDB 數據庫提供程序的第一個可用的版本，今天我們使用 EF Core 3.1在嘗試使用Cosmos DB 來存儲和構建 Asp.NET Core 應用程序時，可能還有一些差異。

1，CosmosDB 不會生成唯一的主鍵，Cosmos DB不會像SQL數據庫那樣創建主鍵。如果需要添加到 Cosmos DB中，則可能會使用類似GUID 字符串的名稱。

2，Cosmos DB 不支持EF Core 遷移

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

1，Azure Cosmos DB (一) 入門介紹

2，Azure Cosmos DB (二) SQL API 操作

3，Azure Cosmos DB (三) EF Core 操作CURD Demo

4，Azure Cosmos DB (四) 使用EF的SQL API 異地冗余

二，正文

1，Repository 基類倉儲實現類

將之前創建好的UserContext 注入基類倉儲中

    /// <summary>
    /// 基類倉儲
    /// </summary>
    public abstract class Repository<TEntity> : IRepository<TEntity> where TEntity : class,new()
    {
        protected DbContext Db;

        public async virtual Task<TEntity> GetById(string partitionKey)
        {
            return await Db.Set<TEntity>().FindAsync( partitionKey);
        }

        public async virtual Task<TEntity> Add(TEntity entity)
        {
            await Db.AddAsync<TEntity>(entity);
            return entity;
        }

        public virtual bool Update(TEntity entity)
        {
            Db.Add(entity);
            Db.Entry(entity).State = EntityState.Modified;
            return true;
        }

        public virtual bool Remove(TEntity entity)
        {
            Db.Set<TEntity>().Remove(entity);
            return true;
        }

        public virtual IEnumerable<TEntity> GetAll()
        {
            return Db.Set<TEntity>();
        }

        public virtual IEnumerable<TEntity> Find(Expression<Func<TEntity, bool>> conditions)
        {
            return Db.Set<TEntity>().Where(conditions);
        }

        public async Task<int> SaveChangesAsync()
        {
            return await Db.SaveChangesAsync();
        }

        public int SaveChanges()
        {
            return  Db.SaveChanges();
        }

        public void Dispose()
        {
            Db.Dispose();
            GC.SuppressFinalize(this);
        }
    }

public interface IRepository<TEntity> : IDisposable where TEntity : class
    {
        /// <summary>
        /// 根據Id獲取對象
        /// </summary>
        /// <param name="partitionKey"></param>
        /// <returns></returns>
        Task<TEntity> GetById(string partitionKey);

        /// <summary>
        /// 添加
        /// </summary>
        /// <param name="entity"></param>
        Task<TEntity> Add(TEntity entity);

        /// <summary>
        /// 更新
        /// </summary>
        /// <param name="entity"></param>
        bool Update(TEntity entity);

        /// <summary>
        /// 刪除
        /// </summary>
        /// <param name="entity"></param>
        bool Remove(TEntity entity);

        /// <summary>
        /// 查詢全部
        /// </summary>
        /// <returns></returns>
        IEnumerable<TEntity> GetAll();

        /// <summary>
        /// 查詢根據條件
        /// </summary>
        /// <param name="conditions"></param>
        /// <returns></returns>
        IEnumerable<TEntity> Find(Expression<Func<TEntity, bool>> conditions);


        /// <summary>
        /// 保存
        /// </summary>
        /// <returns></returns>
        Task<int> SaveChangesAsync();


        /// <summary>
        /// 保存
        /// </summary>
        /// <returns></returns>
        int SaveChanges();
    }

    /// <summary>
    /// IUserRepository接口
    /// </summary>
    public interface IUserRepository : IRepository<UserModel>
    {
        //一些UserModel獨有的接口
        Task<UserModel> GetByName(string name);
    }

public class UserRepository : Repository<UserModel>, IUserRepository
    {
        public UserRepository(UserContext context)
        {
            Db = context;
        }

        #region 01，獲取用戶根據姓名+async Task<UserModel> GetByName(string name)
        /// <summary>
        /// 獲取用戶根據姓名
        /// </summary>
        /// <param name="name">姓名</param>
        /// <returns></returns>
        public async Task<UserModel> GetByName(string name)
        {
            //返回一個新查詢，其中返回的實體將不會在 System.Data.Entity.DbContext 中進行緩存
            return await Db.Set<UserModel>().AsNoTracking().FirstOrDefaultAsync(c => c.Name == name);
        }
        #endregion
    }

注意，在更新操作中，有個小坑

每個項目都必須具有 id 給定分區鍵唯一的值。默認情況下，EF Core通過使用“ |”將區分符和主鍵值連接起來來生成該值。作為分隔符。僅當實體進入 Added 狀態時才生成鍵值。如果實體 id 在.NET類型上沒有屬性來存儲值，則在附加實體時可能會出現問題。

將實體標記為首先添加，然后將其更改為所需狀態，我這里將狀態改為 “Modified”

public virtual bool Update(TEntity entity)
{
     Db.Add(entity);
     Db.Entry(entity).State = EntityState.Modified;
     return true;
}

以下是整個倉儲層的結構

2，實現業務層 Service 方法

2.1，這里我們的業務層的模型視圖為 “UserViewModel”，但是我們的倉儲使用的是實體數據模型 "UserModel"，這里我引用 Automapper，進行對象轉化 。

使用程序包管理控制台進行安裝

Install-Package AutoMapper -Version 10.0.0

Install-Package AutoMapper.Extensions.Microsoft.DependencyInjection -Version 8.0.1

2.2，配置構建函數，用來創建關系映射

public DomainToViewModelMappingProfile()
{
     CreateMap<UserModel, UserViewModel>();
}

public ViewModelToDomainMappingProfile()
{
            //手動進行配置
            CreateMap<UserViewModel, UserModel>();
}

全局 AutoMapper 配置文件

/// <summary>
/// 靜態全局 AutoMapper 配置文件
/// </summary>
public class AutoMapperConfig
{
    public static MapperConfiguration RegisterMappings()
    {
        //創建AutoMapperConfiguration, 提供靜態方法Configure，一次加載所有層中Profile定義 
        //MapperConfiguration實例可以靜態存儲在一個靜態字段中，也可以存儲在一個依賴注入容器中。 一旦創建，不能更改/修改。
        return new MapperConfiguration(cfg =>
        {
            //這個是領域模型 -> 視圖模型的映射，是 讀命令
            cfg.AddProfile(new DomainToViewModelMappingProfile());
            //這里是視圖模型 -> 領域模式的映射，是 寫 命令
            cfg.AddProfile(new ViewModelToDomainMappingProfile());
        });
    }
}

2.3，創建UserService 實現類，IApplicationService、IUserService 接口

/// <summary>
    /// UserService 服務接口實現類,繼承 服務接口
    /// </summary>
    public class UserService : IUserService
    {
        private readonly IUserRepository _UserRepository;
        // 用來進行DTO
        private readonly IMapper _mapper;

        public void Dispose()
        {
            GC.SuppressFinalize(this);
        }

        public UserService(
            IUserRepository userRepository,
            IMapper mapper)
        {
            _UserRepository = userRepository;
            _mapper = mapper;
        }

        public IEnumerable<UserViewModel> GetAll()
        {
            //第一種寫法 Map
            return _mapper.Map<IEnumerable<UserViewModel>>(_UserRepository.GetAll());
        }

        public UserViewModel GetById(string partitionKey)
        {
            return _mapper.Map<UserViewModel>(_UserRepository.GetById(partitionKey).Result);
        }

        public async Task<int> Register(UserViewModel userViewModel)
        {
            var partitionKey = _UserRepository.GetAll().Max(x => int.Parse(x.PartitionKey));
            userViewModel.PartitionKey = (++partitionKey).ToString();
            await _UserRepository.Add(_mapper.Map<UserModel>(userViewModel));
            return await _UserRepository.SaveChangesAsync();
        }

        public void Remove(string partitionKey)
        {

            _UserRepository.Remove(_mapper.Map<UserModel>(_UserRepository.GetById(partitionKey).Result));
            _UserRepository.SaveChangesAsync();
        }

        public int Update(UserViewModel userViewModel)
        {
            _UserRepository.Update(_mapper.Map<UserModel>(userViewModel));
            return _UserRepository.SaveChanges();
        }
    }

public interface IApplicationService<T> where T : class, new()
    {
        /// <summary>
        /// 獲取全部數據
        /// </summary>
        /// <returns></returns>
        IEnumerable<T> GetAll();

        /// <summary>
        /// 獲取單個數據
        /// </summary>
        /// <param name="partitionKey"></param>
        /// <returns></returns>
        T GetById(string partitionKey);

        /// <summary>
        /// 更新數據
        /// </summary>
        /// <param name="viewmodel"></param>
        int Update(T viewmodel);

        /// <summary>
        /// 刪除數據
        /// </summary>
        /// <param name="partitionKey"></param>
        void Remove(string partitionKey);
    }

public interface IUserService:IApplicationService<UserViewModel>
    {
        /// <summary>
        /// 注冊
        /// </summary>
        /// <param name="userViewModel"></param>
        Task<int> Register(UserViewModel userViewModel);
    }

3，創建 UserController 的CRUD 方法及頁面

3.1，用戶列表，用戶詳情控制器方法

// GET: User
public ActionResult Index()
{
    return View(_userService.GetAll());
}

// GET: User/Details/5
public ActionResult Details(string partitionKey)
{
   try
    {
        // TODO: Add insert logic here

        // 執行查詢方法
        var userViewModel= _userService.GetById(partitionKey);


        return View(userViewModel);
    }
    catch
    {
        return View();
    }
}

3.2 用戶列表，用戶信息詳細頁面

Index.cshtml（用戶列表）

@model IEnumerable<Azure.CosmosDB.Models.UserViewModel>

@{
    ViewData["Title"] = "Index";
}

<h1>Index</h1>

<p>
    <a asp-action="Create">Create New</a>
</p>
<table class="table">
    <thead>
        <tr>
            <th>
                @Html.DisplayNameFor(model => model.Id)
            </th>
            <th>
                @Html.DisplayNameFor(model => model.Name)
            </th>
            <th>
                @Html.DisplayNameFor(model => model.Age)
            </th>
            <th>
                @Html.DisplayNameFor(model => model.Address)
            </th>
            <th></th>
        </tr>
    </thead>
    <tbody>
        @foreach (var item in Model)
        {
            <tr>
                <td>
                    @Html.DisplayFor(modelItem => item.Id)
                </td>
                <td>
                    @Html.DisplayFor(modelItem => item.Name)
                </td>
                <td>
                    @Html.DisplayFor(modelItem => item.Age)
                </td>
                <td>
                    @Html.DisplayFor(modelItem => item.Address)
                </td>
                <td>
                    @Html.ActionLink("Edit", "Edit", new { partitionKey = item.PartitionKey }) |
                    @Html.ActionLink("Details", "Details", new { partitionKey = item.PartitionKey }) |
                    @Html.ActionLink("Delete", "Delete", new { partitionKey = item.PartitionKey })
                </td>
            </tr>
        }
    </tbody>
</table>

Details.cshtml（用戶詳情）

@model Azure.CosmosDB.Models.UserViewModel

@{
    ViewData["Title"] = "Details";
    Layout = "~/Views/Shared/_Layout.cshtml";
}

<h1>Details</h1>

<div>
    <h4>UserViewModel</h4>
    <hr />
    <dl class="row">
        <dt class = "col-sm-2">
            @Html.DisplayNameFor(model => model.PartitionKey)
        </dt>
        <dd class = "col-sm-10">
            @Html.DisplayFor(model => model.PartitionKey)
        </dd>
        <dt class = "col-sm-2">
            @Html.DisplayNameFor(model => model.Id)
        </dt>
        <dd class = "col-sm-10">
            @Html.DisplayFor(model => model.Id)
        </dd>
        <dt class = "col-sm-2">
            @Html.DisplayNameFor(model => model.Name)
        </dt>
        <dd class = "col-sm-10">
            @Html.DisplayFor(model => model.Name)
        </dd>
        <dt class = "col-sm-2">
            @Html.DisplayNameFor(model => model.Age)
        </dt>
        <dd class = "col-sm-10">
            @Html.DisplayFor(model => model.Age)
        </dd>
        <dt class = "col-sm-2">
            @Html.DisplayNameFor(model => model.Address)
        </dt>
        <dd class = "col-sm-10">
            @Html.DisplayFor(model => model.Address)
        </dd>
    </dl>
</div>
<div>
    @Html.ActionLink("Edit", "Edit", new { partitionKey = Model.PartitionKey }) |
    <a asp-action="Index">Back to List</a>
</div>

4，依賴注入倉儲，服務模型以及AutoMap 配置等

// 注入 應用層Application
services.AddScoped<IUserService, UserService>();

// 注入 基礎設施層 - 數據層
services.AddScoped<IUserRepository, UserRepository>();

//添加服務
services.AddAutoMapper(typeof(AutoMapperConfig));
//啟動配置
AutoMapperConfig.RegisterMappings();

5，配置分區鍵(分區鍵屬性可以是任何類型，只要將其轉換為string)

默認情況下，EF Core將在創建分區時將分區鍵設置為的容器 "_partitionkey" 而不為其提供任何值。但是要充分利用 Azure Cosmos 的性能，應使用經過精心選擇的分區鍵。可以通過調用HasPartitionKey進行配置： 

//配置分區鍵 
modelBuilder.Entity<UserModel>()
.HasPartitionKey(o => o.PartitionKey);

運行項目，可以看到用戶列表信息，同時點擊數據的 “Details” 可以看到用戶數據詳情信息。 

ok，這里就不再演示運行后，測試各個增刪改查的方法，大家可以下載代碼，配置本地環境，運行代碼進行測試

撒花🎉🎉🎉🎉🎉，今天的分析到此結束。

三，結尾

　　寫這篇文章，花了我比預期更長的時間，主要耗時用在寫Demo 上，查文檔，寫測試等。希望對大家有用。當然也可以加深我們對Cosmos DB可以做什么以及EF Core 3.1 如何操作 Cosmos DB 數據庫所提供程序的有進一步的了解。

　　如果沒有大家沒有條件在Azure 上創建Cosmos DB 進行測試，學習，可以使用 “Azure Cosmos DB 仿真器”，仿真器在本地運行，並使用localdb存儲結果。它還帶有一個不錯的界面，用於查看/編輯數據。

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

作者：Allen 

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