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


什么是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

MapFromMapTo兩個特性用於類型的 同類型同名屬性 的簡單映射,不能支持復雜屬性間的映射關系。

  • [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.Blogdbo.Post已經成功創建:


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM