[開源]OSharpNS 步步為營系列 - 2. 添加業務數據層

来源:https://www.cnblogs.com/guomingfeng/archive/2019/05/09/osharpns-steps-entity.html
-Advertisement-
Play Games

CodeFirst的開發模式，資料庫的設計細節完全靠代碼來完成，數據實體映射配置正是負責這項工作的，針對一個實體，可以在這裡配置其在資料庫中的數據表關係、數據約束及各個數據欄位的每一個細節配置 ...


什麼是OSharp

OSharpNS全稱OSharp Framework with .NetStandard2.0，是一個基於.NetStandard2.0開發的一個.NetCore快速開發框架。這個框架使用最新穩定版的.NetCore SDK（當前是.NET Core 2.2），對 AspNetCore 的配置、依賴註入、日誌、緩存、實體框架、Mvc(WebApi)、身份認證、許可權授權等模塊進行更高一級的自動化封裝，並規範了一套業務實現的代碼結構與操作流程，使 .Net Core 框架更易於應用到實際項目開發中。

概述

一個模塊的數據層，主要包括如下幾個方面：

  • 數據實體：數據實體是服務層向資料庫進行數據持久化的數據載體，也是數據層進行業務處理的數據載體，數據層與數據層的數據交換都應通過實體類來完成。
  • 輸入DTO：InputDto用於前端向API層輸入數據，API層向服務層輸入數據

  • 輸出DTO：OutputDto主要用於數據查詢服務，是API層向前端輸出數據的載體

  • 數據實體映射配置：CodeFirst的開發模式，資料庫的設計細節完全靠代碼來完成，數據實體映射配置正是負責這項工作的，針對一個實體，可以在這裡配置其在資料庫中的數據表關係、數據約束及各個數據欄位的每一個細節配置。

  • 對象Mapper映射：數據傳輸對象DTO 與 實體類Entity 之間的轉換與更新，如果都要通過手寫代碼來進行屬性的一一對應賦值，是件很累人的事，通過 對象Mapper映射（例如AutoMapper）功能，只需進行一次配置，即可很方便的實現不同類型對象的數據轉換與更新。

數據層文件夾佈局

src                                     # 源代碼文件夾
├─Liuliu.Blogs.Core                     # 項目核心工程
│  └─Blogs                              # 博客模塊文件夾
│      ├─Dtos                           # 博客模塊DTO文件夾
│      │    ├─BlogInputDto.cs           # 博客輸入DTO
│      │    ├─BlogOutputDto.cs          # 博客輸出DTO
│      │    ├─PostInputDto.cs           # 文章輸入DTO
│      │    └─PostOutputDto.cs          # 文章輸出DTO
│      └─Entities                       # 博客模塊實體類文件夾
│           ├─Blog.cs                   # 博客實體類
│           └─Post.cs                   # 文章實體類
└─Liuliu.Blogs.EntityConfiguration      # 實體映射配置工程
   └─Blogs                              # 博客模塊文件夾
       ├─BlogConfiguration.cs           # 博客實體映射配置類
       └─PostConfiguration.cs           # 文章實體映射配置類

實體類

必選介面

IEntity

數據實體介面：所有的實體類都必須實現 IEntity 介面，此介面給實體類添加一個 名為 Id 的實體唯一編號屬性，這個屬性是實體類的 主鍵 屬性

/// <summary>
/// 數據模型介面
/// </summary>
/// <typeparam name="TKey">實體主鍵類型</typeparam>
public interface IEntity<out TKey>
{
    /// <summary>
    /// 獲取 實體唯一標識，主鍵
    /// </summary>
    TKey Id { get; }
}

EntityBase

實體類基類：為了方便實體類快速實現 IEntity 介面，定義了一個通用基類 EntityBase，所有實體都可以通過繼承此基類方便實現 IEntity 介面

/// <summary>
/// 實體類基類
/// </summary>
public abstract class EntityBase<TKey> : IEntity<TKey> where TKey : IEquatable<TKey>
{
    /// <summary>
    /// 初始化一個<see cref="EntityBase{TKey}"/>類型的新實例
    /// </summary>
    protected EntityBase()
    {
        if (typeof(TKey) == typeof(Guid))
        {
            Id = CombGuid.NewGuid().CastTo<TKey>();
        }
    }

    /// <summary>
    /// 獲取或設置 編號
    /// </summary>
    [DisplayName("編號")]
    public TKey Id { get; set; }

    // ...
}

可選的裝配功能介面與特性

OSharp框架給實體類設計了一些可裝配的功能，通過特定的介面來提供，實體類實現了特定的介面，則實體類在系統中將自動擁有一些額外的功能。

ICreatedTime

定義創建時間：ICreatedTime 介面給實體類添加一個 創建時間CreatedTime 的屬性，該屬性將在數據層執行 創建Insert 操作時，自動賦予系統當前時間。

/// <summary>
/// 定義創建時間
/// </summary>
public interface ICreatedTime
{
    /// <summary>
    /// 獲取或設置 創建時間
    /// </summary>
    DateTime CreatedTime { get; set; }
}

ILockable

定義可鎖定功能：ILockable 介面給實體類添加一個 是否鎖定IsLocked 的屬性

/// <summary>
/// 定義可鎖定功能
/// </summary>
public interface ILockable
{
    /// <summary>
    /// 獲取或設置 是否鎖定當前信息
    /// </summary>
    bool IsLocked { get; set; }
}

IEntityHash

定義實體Hash功能：給實體添加 GetHash 擴展方法，用於對實體的屬性值進行Hash，確定實體是否存在變化，這些變化可用於系統初始化時確定是否需要進行數據同步。
當前系統中 實體信息EntityInfo, 功能點Function, API模塊Module 在系統啟動時與資料庫中的相應數據進行對比同步時，使用的就是這個介面的特性

/// <summary>
/// 定義實體Hash功能，對實體的屬性值進行Hash，確定實體是否存在變化，
/// 這些變化可用於系統初始化時確定是否需要進行數據同步
/// </summary>
public interface IEntityHash
{ }

IExpirable

定義可過期性，包含生效時間和過期時間：給實體添加 生效時間BeginTime，過期時間EndTime 的屬性

/// <summary>
/// 定義可過期性，包含生效時間和過期時間
/// </summary>
public interface IExpirable
{
    /// <summary>
    /// 獲取或設置 生效時間
    /// </summary>
    DateTime? BeginTime { get; set; }

    /// <summary>
    /// 獲取或設置 過期時間
    /// </summary>
    DateTime? EndTime { get; set; }
}

ICreationAudited

定義創建審計信息：給實體添加創建時的 創建人CreatorId，創建時間CreatedTime 的審計信息，這些值將在數據層執行 創建Insert 時自動賦值。

/// <summary>
/// 定義創建審計信息
/// </summary>
public interface ICreationAudited<TUserKey> : ICreatedTime
    where TUserKey : struct
{
    /// <summary>
    /// 獲取或設置 創建者編號
    /// </summary>
    TUserKey? CreatorId { get; set; }
}

ICreationAudited 已繼承了 ICreatedTime 介面，不會重覆添加 CreatedTime 屬性

IUpdateAudited

定義更新審計的信息：給實體添加更新時的 最後更新人LastUpdaterId，最後更新時間LastUpdatedTime 的審計信息，這些值將在數據層執行 更新Update 操作時自動賦值。

/// <summary>
/// 定義更新審計的信息
/// </summary>
public interface IUpdateAudited<TUserKey> where TUserKey : struct
{
    /// <summary>
    /// 獲取或設置 更新者編號
    /// </summary>
    TUserKey? LastUpdaterId { get; set; }

    /// <summary>
    /// 獲取或設置 最後更新時間
    /// </summary>
    DateTime? LastUpdatedTime { get; set; }
}

ISoftDeletable

定義邏輯刪除功能：給實體添加一個用於邏輯刪除的 刪除時間DeletedTime 屬性，當實體實現了 ISoftDeletable 介面之後，數據層執行 刪除 Delete 操作時，將 DeletedTime 賦予當前時間，即表示數據已被刪除。數據查詢的時候通過全局過濾器自動過濾掉 DeletedTime 不為 null 的數據，從而查詢出正常數據。

/// <summary>
/// 定義邏輯刪除功能
/// </summary>
public interface ISoftDeletable
{
    /// <summary>
    /// 獲取或設置 數據邏輯刪除時間，為null表示正常數據，有值表示已邏輯刪除，同時刪除時間每次不同也能保證索引唯一性
    /// </summary>
    DateTime? DeletedTime { get; set; }
}

UserFlagAttribute

用戶標記特性：此特性與數據許可權有關，用於實體類的 用戶編號UserId 屬性，用於標記實體類中與用戶私有數據相關聯的用戶編號，以在數據許可權判斷時，將實體的用戶編號與當前線上用戶的用戶編號進行對比，找出用戶的私有數據。

    /// <summary>
    /// 用戶標記，用於標示用戶屬性/欄位
    /// </summary>
    [AttributeUsage(AttributeTargets.Property)]
    public class UserFlagAttribute : Attribute
    { }

博客模塊的實體類定義

回到我們的 Liuliu.Blogs 項目，根據 業務模塊設計#模塊文件夾結構佈局給出的結構，在 Liuliu.Blogs.Core 項目中創建 Blogs/Entities 的文件夾存放實體類，添加如下實體類文件。

博客實體 - Blog

namespace Liuliu.Blogs.Blogs.Entities
{
    /// <summary>
    /// 實體類：博客信息
    /// </summary>
    public class Blog : EntityBase<int>, ICreatedTime, ISoftDeletable
    {
        /// <summary>
        /// 獲取或設置 博客地址
        /// </summary>
        [Required]
        public string Url { get; set; }

        /// <summary>
        /// 獲取或設置 顯示名稱
        /// </summary>
        [Required]
        public string Display { get; set; }

        /// <summary>
        /// 獲取或設置 已開通
        /// </summary>
        public bool IsEnabled { get; set; }

        /// <summary>
        /// 獲取或設置 創建時間
        /// </summary>
        public DateTime CreatedTime { get; set; }

        /// <summary>
        /// 獲取或設置 數據邏輯刪除時間，為null表示正常數據，有值表示已邏輯刪除
        /// </summary>
        public DateTime? DeletedTime { get; set; }

        /// <summary>
        /// 獲取或設置 作者編號
        /// </summary>
        [UserFlag]
        public int UserId { get; set; }

        /// <summary>
        /// 獲取或設置 作者
        /// </summary>
        public virtual User User { get; set; }
    }
}

文章實體 - Post

namespace Liuliu.Blogs.Blogs.Entities
{
    /// <summary>
    /// 實體類：文章信息
    /// </summary>
    public class Post:EntityBase<int>,ICreatedTime,ISoftDeletable
    {
        /// <summary>
        /// 獲取或設置 文章標題
        /// </summary>
        [Required]
        public string Title { get; set; }

        /// <summary>
        /// 獲取或設置 文章內容
        /// </summary>
        [Required]
        public string Content { get; set; }

        /// <summary>
        /// 獲取或設置 創建時間
        /// </summary>
        public DateTime CreatedTime { get; set; }

        /// <summary>
        /// 獲取或設置 數據邏輯刪除時間，為null表示正常數據，有值表示已邏輯刪除
        /// </summary>
        public DateTime? DeletedTime { get; set; }

        /// <summary>
        /// 獲取或設置 所屬博客編號
        /// </summary>
        public int BlogId { get; set; }

        /// <summary>
        /// 獲取或設置 所屬博客
        /// </summary>
        public virtual Blog Blog { get; set; }

        /// <summary>
        /// 獲取或設置 作者編號
        /// </summary>
        [UserFlag]
        public int UserId { get; set; }

        /// <summary>
        /// 獲取或設置 作者
        /// </summary>
        public virtual User User { get; set; }
    }
}

輸入輸出DTO

輸入輸出DTO：輸入輸出DTO主要負責各層次之間的數據傳輸工作，避免在外層暴露實體類。

輸入輸出DTO相關介面

InputDto

定義輸入DTO：輸入DTO 需實現此介面，作為 業務層參數類型、DTO屬性合法性驗證數據類型 的約束。

/// <summary>
/// 定義輸入DTO
/// </summary>
/// <typeparam name="TKey"></typeparam>
public interface IInputDto<TKey>
{
    /// <summary>
    /// 獲取或設置 主鍵，唯一標識
    /// </summary>
    TKey Id { get; set; }
}

IOutputDto

定義輸出DTO：輸出DTO 需實現此介面，此介面將作為 分頁查詢 返回類型的約束。

    /// <summary>
    /// 定義輸出DTO
    /// </summary>
    public interface IOutputDto
    { }

數據實體映射

定義數據許可權的更新，刪除狀態：用於 輸入DTOIOutputDto，此介面為輸出DTO提供 是否允許更新Updatable、是否允許刪除Deletable 兩個數據許可權屬性，輸出DTO實現了此介面，在進行數據分頁查詢時，將使用 全實體 查詢模式併進行 數據許可權校驗，在輸出DTO中自動附加數據許可權（是否可更新、是否可刪除）信息。

    /// <summary>
    /// 定義數據許可權的更新，刪除狀態
    /// </summary>
    public interface IDataAuthEnabled
    {
        /// <summary>
        /// 獲取或設置 是否可更新的數據許可權狀態
        /// </summary>
        bool Updatable { get; set; }

        /// <summary>
        /// 獲取或設置 是否可刪除的數據許可權狀態
        /// </summary>
        bool Deletable { get; set; }
    }

博客模塊的輸入輸出DTO類定義

回到我們的 Liuliu.Blogs 項目，根據 業務模塊設計#模塊文件夾結構佈局給出的結構，在 Liuliu.Blogs.Core 項目中創建 Blogs/Dtos 的文件夾存放實體類，添加如下輸入輸出DTO類文件。

博客 - Blog

博客 InputDto

namespace Liuliu.Blogs.Blogs.Dtos
{
    /// <summary>
    /// 輸入DTO：博客信息
    /// </summary>
    public class BlogInputDto : IInputDto<int>
    {
        /// <summary>
        /// 獲取或設置 博客編號
        /// </summary>
        public int Id { get; set; }

        /// <summary>
        /// 獲取或設置 博客地址
        /// </summary>
        [Required]
        public string Url { get; set; }

        /// <summary>
        /// 獲取或設置 顯示名稱
        /// </summary>
        [Required]
        public string Display { get; set; }
    }
}

博客 OutputDto

namespace Liuliu.Blogs.Blogs.Dtos
{
    /// <summary>
    /// 輸出DTO：博客信息
    /// </summary>
    public class BlogOutputDto : IOutputDto, IDataAuthEnabled
    {
        /// <summary>
        /// 獲取或設置 博客編號
        /// </summary>
        public int Id { get; set; }

        /// <summary>
        /// 獲取或設置 博客地址
        /// </summary>
        public string Url { get; set; }

        /// <summary>
        /// 獲取或設置 顯示名稱
        /// </summary>
        public string Display { get; set; }

        /// <summary>
        /// 獲取或設置 已開通
        /// </summary>
        public bool IsEnabled { get; set; }

        /// <summary>
        /// 獲取或設置 創建時間
        /// </summary>
        public DateTime CreatedTime { get; set; }

        /// <summary>
        /// 獲取或設置 作者編號
        /// </summary>
        public int UserId { get; set; }

        /// <summary>
        /// 獲取或設置 是否可更新的數據許可權狀態
        /// </summary>
        public bool Updatable { get; set; }

        /// <summary>
        /// 獲取或設置 是否可刪除的數據許可權狀態
        /// </summary>
        public bool Deletable { get; set; }
    }
}

文章 - Post

文章 InputDto

namespace Liuliu.Blogs.Blogs.Dtos
{
    /// <summary>
    /// 輸入DTO：文章信息
    /// </summary>
    public class PostInputDto : IInputDto<int>
    {
        /// <summary>
        /// 獲取或設置 文章編號
        /// </summary>
        public int Id { get; set; }

        /// <summary>
        /// 獲取或設置 文章標題
        /// </summary>
        [Required]
        public string Title { get; set; }

        /// <summary>
        /// 獲取或設置 文章內容
        /// </summary>
        [Required]
        public string Content { get; set; }
    }
}

文章 OutputDto

namespace Liuliu.Blogs.Blogs.Dtos
{
    /// <summary>
    /// 輸出DTO：文章信息
    /// </summary>
    public class PostOutputDto : IOutputDto, IDataAuthEnabled
    {
        /// <summary>
        /// 獲取或設置 文章編號
        /// </summary>
        public int Id { get; set; }

        /// <summary>
        /// 獲取或設置 文章標題
        /// </summary>
        public string Title { get; set; }

        /// <summary>
        /// 獲取或設置 文章內容
        /// </summary>
        public string Content { get; set; }

        /// <summary>
        /// 獲取或設置 創建時間
        /// </summary>
        public DateTime CreatedTime { get; set; }

        /// <summary>
        /// 獲取或設置 所屬博客編號
        /// </summary>
        public int BlogId { get; set; }

        /// <summary>
        /// 獲取或設置 作者編號
        /// </summary>
        [UserFlag]
        public int UserId { get; set; }

        /// <summary>
        /// 獲取或設置 是否可更新的數據許可權狀態
        /// </summary>
        public bool Updatable { get; set; }

        /// <summary>
        /// 獲取或設置 是否可刪除的數據許可權狀態
        /// </summary>
        public bool Deletable { get; set; }
    }
}

數據實體映射配置

OSharp框架中，實體映射配置類主要有兩個作用：

  1. 在系統初始化時將實體類載入到上下文中
  2. 實現實體類到資料庫的映射細節配置

相關介面與基類

IEntityRegister

將實體配置類註冊到上下文中：IEntityRegister 介面定義了一個DbContextType屬性，可將一個實體類註冊到指定的上下文中，這在自定義多個數據上下文的時候會用到。
在實體映射類中實現此介面，數據上下文初始化的時候，在OnModelCreating方法中通過調用RegisterTo(ModelBuilder modelBuilder)方法，將實體映射類的實例註冊到ModelBuilder中。

/// <summary>
/// 定義將實體配置類註冊到上下文中
/// </summary>
public interface IEntityRegister
{
    /// <summary>
    /// 獲取所屬的上下文類型，如為null，將使用預設上下文，否則使用指定類型的上下文類型
    /// </summary>
    Type DbContextType { get; }

    /// <summary>
    /// 獲取 相應的實體類型
    /// </summary>
    Type EntityType { get; }

    /// <summary>
    /// 將當前實體類映射對象註冊到數據上下文模型構建器中
    /// </summary>
    /// <param name="modelBuilder">上下文模型構建器</param>
    void RegisterTo(ModelBuilder modelBuilder);
}

EntityTypeConfigurationBase

數據實體映射配置基類：為方便實現實體映射配置類，OSharp定義了此基類，實現了 IEntityTypeConfiguration<TEntity>，IEntityRegister 兩個介面，在實現實體映射配置類時，只需繼承此類，實現Configure(EntityTypeBuilder<TEntity> builder)抽象方法即可。

/// <summary>
/// 數據實體映射配置基類
/// </summary>
/// <typeparam name="TEntity">實體類型</typeparam>
/// <typeparam name="TKey">主鍵類型</typeparam>
public abstract class EntityTypeConfigurationBase<TEntity, TKey> : IEntityTypeConfiguration<TEntity>, IEntityRegister
    where TEntity : class, IEntity<TKey>
    where TKey : IEquatable<TKey>
{
    /// <summary>
    /// 獲取 所屬的上下文類型，如為null，將使用預設上下文， 否則使用指定類型的上下文類型
    /// </summary>
    public virtual Type DbContextType => null;

    /// <summary>
    /// 獲取 相應的實體類型
    /// </summary>
    public Type EntityType => typeof(TEntity);

    /// <summary>
    /// 將當前實體類映射對象註冊到數據上下文模型構建器中
    /// </summary>
    /// <param name="modelBuilder">上下文模型構建器</param>
    public void RegisterTo(ModelBuilder modelBuilder)
    {
        modelBuilder.ApplyConfiguration(this);
        // 給軟刪除的實體添加全局過濾器
        if (typeof(ISoftDeletable).IsAssignableFrom(typeof(TEntity)))
        {
            modelBuilder.Entity<TEntity>().HasQueryFilter(m => ((ISoftDeletable)m).DeletedTime == null);
        }
    }

    /// <summary>
    /// 重寫以實現實體類型各個屬性的資料庫配置
    /// </summary>
    /// <param name="builder">實體類型創建器</param>
    public abstract void Configure(EntityTypeBuilder<TEntity> builder);
}

博客模塊的實體映射配置類實現

回到我們的 Liuliu.Blogs 項目，根據 業務模塊設計#模塊文件夾結構佈局給出的結構，在 Liuliu.Blogs.EntityConfiguration 項目中創建 Blogs 的文件夾存放實體類，添加如下實體映射配置類文件。

博客 - Blog

根據 業務模塊設計#數據層的定義，博客實體的設計要求Url屬性 唯一索引，並且 博客與博主 之間的關係是 一對一，因此做如下約束：

  1. 創建Url屬性的唯一索引，形式本應是builder.HasIndex(m => m.Url)，但博客實體引入了邏輯刪除，因此唯一索引應加入邏輯刪除屬性DeletedTime
  2. 博客實體與用戶實體之間以UserId為外鍵，建立一對一關係，並且對於一個博客來說，其擁有者是必須的，因此需要加上IsRequired約束，並禁止級聯刪除。
/// <summary>
/// 實體映射配置類：博客信息
/// </summary>
public class BlogConfiguration : EntityTypeConfigurationBase<Blog, int>
{
    /// <summary>
    /// 重寫以實現實體類型各個屬性的資料庫配置
    /// </summary>
    /// <param name="builder">實體類型創建器</param>
    public override void Configure(EntityTypeBuilder<Blog> builder)
    {
        builder.HasIndex(m => new {m.Url, m.DeletedTime}).HasName("BlogUrlIndex").IsUnique();
        builder.HasOne(m => m.User).WithOne().HasForeignKey<Blog>(m => m.UserId).OnDelete(DeleteBehavior.Restrict).IsRequired();
    }
}

文章 - Post

根據 業務模塊設計#數據層的定義，文章實體的設計要求 文章與博客 之間的關係是 多對一，文章與作者 之間的關係是 多對一，因此做如下約束：

  1. 文章實體與博客實體之間以BlogId為外鍵，建立多對一關係，並且對於一篇文章來說，其所在博客是必須的，因此需要加上IsRequired約束，並禁止級聯刪除。
  2. 文章實體與用戶實體之間以UserId為外鍵，建立多對一關係，並且對於一篇文章來說，其作者是必須的，因此需要加上IsRequired約束，並禁止級聯刪除。
    /// <summary>
    /// 實體映射配置類：文章信息
    /// </summary>
    public class PostConfiguration : EntityTypeConfigurationBase<Post, int>
    {
        /// <summary>
        /// 重寫以實現實體類型各個屬性的資料庫配置
        /// </summary>
        /// <param name="builder">實體類型創建器</param>
        public override void Configure(EntityTypeBuilder<Post> builder)
        {
            builder.HasOne(m => m.Blog).WithMany().HasForeignKey(m => m.BlogId).OnDelete(DeleteBehavior.Restrict).IsRequired();
            builder.HasOne(m => m.User).WithMany().HasForeignKey(m => m.UserId).OnDelete(DeleteBehavior.Restrict).IsRequired();
        }
    }

對象Mapper映射

對象Mapper映射，指的是同一實體數據的不同類型的相同屬性（亦可是不同屬性之間，需要單獨配置）之間的數據賦值與更新操作。例如：

  • 新增業務中使用 InputDto 創建 新的實體類
  • 更新業務中通過 InputDto 更新 已存在的實體類
  • 數據查詢中將 實體類 轉換為指定的 OutputDto
  • 其他不同類型的數據之間的數據賦值與更新

對象Mapper映射相關基礎建設

OSharp框架中定義了一些基礎建設代碼，用於定義對象映射功能。

IMapper

IMapper 介面用於定義對象映射功能，業務代碼中依賴此介面實現對象映射工作，系統初始化時，將使用具體的對象映射框架（如 AutoMapper，``）

/// <summary>
/// 定義對象映射功能
/// </summary>
public interface IMapper
{
    /// <summary>
    /// 將對象映射為指定類型
    /// </summary>
    /// <typeparam name="TTarget">要映射的目標類型</typeparam>
    /// <param name="source">源對象</param>
    /// <returns>目標類型的對象</returns>
    TTarget MapTo<TTarget>(object source);

    /// <summary>
    /// 使用源類型的對象更新目標類型的對象
    /// </summary>
    /// <typeparam name="TSource">源類型</typeparam>
    /// <typeparam name="TTarget">目標類型</typeparam>
    /// <param name="source">源對象</param>
    /// <param name="target">待更新的目標對象</param>
    /// <returns>更新後的目標類型對象</returns>
    TTarget MapTo<TSource, TTarget>(TSource source, TTarget target);

    /// <summary>
    /// 將數據源映射為指定輸出DTO的集合
    /// </summary>
    /// <typeparam name="TOutputDto">輸出DTO類型</typeparam>
    /// <param name="source">數據源</param>
    /// <param name="membersToExpand">成員展開</param>
    /// <returns>輸出DTO的結果集</returns>
    IQueryable<TOutputDto> ToOutput<TOutputDto>(IQueryable source, params Expression<Func<TOutputDto, object>>[] membersToExpand);
}

MapFromAttribute，MapToAttribute

MapFrom和MapTo兩個特性用於類型的 同類型同名屬性 的簡單映射，不能支持複雜屬性間的映射關係。

  • [MapFrom]：標註從源類型到當前類型的Mapping映射關係，例如在 OutputDto 上標註[MapFrom(typeof(Entity))]，即表示OutputDto是從Entity映射而來的
/// <summary>
/// 標註當前類型從源類型的Mapping映射關係
/// </summary>
public class MapFromAttribute : Attribute
{
    /// <summary>
    /// 初始化一個<see cref="MapFromAttribute"/>類型的新實例
    /// </summary>
    public MapFromAttribute(params Type[] sourceTypes)
    {
        Check.NotNull(sourceTypes, nameof(sourceTypes));
        SourceTypes = sourceTypes;
    }

    /// <summary>
    /// 源類型
    /// </summary>
    public Type[] SourceTypes { get; }
}
  • [MapTo]：標註從當前類型到目標類型的Mapping映射關係，例如在 Input 上標註[MapTo(typeof(Entity))]，即表示可從InputDto通過映射創建或更新Entity
/// <summary>
/// 標註當前類型映射到目標類型的Mapping映射關係
/// </summary>
public class MapToAttribute : Attribute
{
    /// <summary>
    /// 初始化一個<see cref="MapToAttribute"/>類型的新實例
    /// </summary>
    public MapToAttribute(params Type[] targetTypes)
    {
        Check.NotNull(targetTypes, nameof(targetTypes));
        TargetTypes = targetTypes;
    }

    /// <summary>
    /// 目標類型
    /// </summary>
    public Type[] TargetTypes { get; }
}

IAutoMapperConfiguration

在使用AutoMapper的場景下，要實現複雜屬性的映射配置，需要實現此介面並通過MapperConfigurationExpression配置複雜類型間的屬性映射關係

/// <summary>
/// 定義通過<see cref="MapperConfigurationExpression"/>配置對象映射的功能
/// </summary>
[MultipleDependency]
public interface IAutoMapperConfiguration
{
    /// <summary>
    /// 創建對象映射
    /// </summary>
    /// <param name="mapper">映射配置表達</param>
    void CreateMaps(MapperConfigurationExpression mapper);
}

博客模塊的映射關係配置

回到我們的 Liuliu.Blogs 項目，博客實體和文章實體與他們的DTO之間的映射關係，均可以通過[MapFrom]，[MapTo]特性來進行配置，用法很簡單，只需在前面定義的DTO類型上加上相應的特性即可：

博客 - Blog

博客 InputDto

/// <summary>
/// 輸入DTO：博客信息
/// </summary>
[MapTo(typeof(Blog))]
public class BlogInputDto : IInputDto<int>
{
    //...
}

博客 OutputDto

/// <summary>
/// 輸出DTO：博客信息
/// </summary>
[MapFrom(typeof(Blog))]
public class BlogOutputDto : IOutputDto, IDataAuthEnabled
{
    //...
}

文章 - Post

文章 InputDto

/// <summary>
/// 輸入DTO：文章信息
/// </summary>
[MapTo(typeof(Post))]
public class PostInputDto : IInputDto<int>
{
    //...
}

文章 OutputDto

/// <summary>
/// 輸出DTO：文章信息
/// </summary>
[MapFrom(typeof(Post))]
public class PostOutputDto : IOutputDto, IDataAuthEnabled
{
    //...
}

至此，博客模塊的數據層代碼實現完畢。下麵可進行數據遷移將數據結構更新到現有資料庫中。

數據遷移

打開 VS2019 的 程式包管理器控制台，將預設項目設置為 src\Liuliu.Blogs.Web，執行如下命令添加名稱為AddBlogsEntities的新的遷移記錄：

add-migration AddBlogsEntities

再執行資料庫更新命令，執行遷移

update-database

數據遷移完畢，整個過程輸出如下：

PM> add-migration AddBlogsEntities
entryAssemblyName: Liuliu.Blogs.Web
To undo this action, use Remove-Migration.
PM> update-database
entryAssemblyName: Liuliu.Blogs.Web
Applying migration '20190504130412_AddBlogsEntities'.
Done.
PM>

打開資料庫，我們將看到新的數據表dbo.Blog和dbo.Post已經成功創建：


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Java_靜態變數
    本例中聲明瞭一個靜態變數num用於記錄程式中共產生了多少個對象。 因為對象創建時會自動調用構造方法，所以在構造方法中加入了“num++;”語句，這樣每創建一個對象就調用一次構造方法，從而每產生一個對象，num的值就會自動加1 。 此時，因為靜態變數是一個公共的存儲單元，所以類的任何一個對象去修改它時 ...
  • 今天2019年5月，21點58分
    今天早上到現在老師都沒有講新課，每天都寫博客，今天沒學到新的，也不知道學什麼，好煩啊，外邊還下雨，下一周了。 不知道什麼時候才能停，又想它停又想它繼續下，好糾結。 老師叫我們天天寫博客，叫我們要堅持，感覺班上好多人都沒寫了，感覺就我自己堅持寫，現在好了，今天老師 沒講新課 我只能寫日記了。 很快就要 ...
  • day19（random，json，pickle，hashlib，shutil，hmac，shelve 模塊）
    一，複習 二，random模塊： 三，json模塊： 四，pickle模塊： 五，shelve 模塊： 六，hashlib加密模塊： 七，hmac 加密模塊： 八，shutil 模塊： ...
  • Java_面向對象中的this和super用法
    this: 1、使用在類中，可以用來修飾屬性、方法、構造器 2、表示當前對象或者是當前正在創建的對象 3、當形參與成員變數重名時，如果在方法內部需要使用成員變數，必須添加 this 來表明該變數時類成員 4、在任意方法內，如果使用當前類的成員變數或者成員方法可以在其前面添加 this ，增強程式的閱 ...
  • 做一個有內涵的程式猿
    工作快一年了，一直沒有停下學習的腳步，但是發現自己學的東西太雜太亂也太容易忘記（從小學到大學一直沒有記筆記的習慣），總是反反覆復，所以在此進行總結，也記錄下自己的學習的歷程，從此做一個有內涵的程式猿。。。 ...
  • pip各種
    pip: 一個現代的，通用的 Python 包管理工具。提供了對Python 包的查找、下載、安裝、卸載的功能。 windows：自帶pip，直接使用。 Linux：執行下麵命令即可完成安裝。 Usage: pip <command> [options] 查看版本：pip show package_ ...
  • 10.JAVA-介面、工廠模式、代理模式、詳解
    1.介面定義 介面屬於一個特殊的類,這個類裡面只能有抽象方法和全局常量 (該概念在JDK1.8之後被打破,在1.8後介面中還可以定義普通方法和靜態方法,在後續章節會詳講) 1.1 介面具有以下幾個原則 介面通過interface關鍵字來實現定義 一個子類如果要繼承介面的話,則需要通過implemen ...
  • 企業微信-付款到員工零錢
    本次內容是基於獨立的“企業微信”而言的； 企業微信有獨立的管理後臺，和一般的服務號，訂閱號後臺不同； 企業微信涉及員工，所以這裡的支付是付款到員工零錢； 官方API文檔： https://work.weixin.qq.com/api/doc#90000/90135/90278 下麵具體步驟： 1：先 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類