ASP.NET Core模塊化前后端分離快速開發框架介紹之3、數據訪問模塊介紹

源碼

GitHub：https://github.com/iamoldli/NetModular

演示地址

地址：https://nm.iamoldli.com
賬戶：admin
密碼：admin

前端框架演示地址(臨時)

地址：http://nm.demo.iamoldli.com/index.html
賬戶：admin
密碼：admin

目錄

1、開篇
2、快速創建一個業務模塊
3、數據訪問模塊介紹
4、模塊化實現思路

簡介

NetModular 的數據訪問模塊是基於 Dapper 擴展的輕量級的ORM，它本身是完全獨立的，可以在任何項目中直接使用。在NetModular中也提供了擴展，能夠完美的與模塊化集成在一起。

支持的功能

• [x] 支持SqlServer、MySql、SQLite數據庫
• [x] 基礎的CRUD方法
• [x] 批量添加、刪除、修改
• [x] 修改指定列
• [x] Lamdba表達式支持
• [x] 多表連接查詢
• [x] 分頁查詢
• [x] 分組查詢
• [x] 倉儲模式
• [x] 工作單元
• [x] 自定義表名、列名
• [x] 支持同步/異步方法

使用方法

NetModular 本身已經做好了集成，所以業務模塊中，可以直接寫代碼，不用考慮注入的問題，如果想要了解它的集成邏輯的，可以查看Data.AspNetCore庫

Node： 數據庫上下文、倉儲和工作單元的注入方式采用的是Scoped

1、添加數據庫上下文

數據庫上下文需要繼承DbContext

    public class MallDbContext : DbContext
    {
        public MallDbContext(IDbContextOptions options) : base(options)
        {
        }
    }

2、創建實體

實體需要繼承IEntity接口，在NetModular中，已經提供了幾個通用的實體基類，並且內部已經實現了對應的功能，比如EntityBase：

    public class EntityBase<TKey> : Entity<TKey>
    {
        /// <summary>
        /// 創建時間
        /// </summary>
        public DateTime CreatedTime { get; set; } = DateTime.Now;

        /// <summary>
        /// 創建人
        /// </summary>
        public Guid CreatedBy { get; set; }

        /// <summary>
        /// 修改時間
        /// </summary>
        public DateTime ModifiedTime { get; set; } = DateTime.Now;

        /// <summary>
        /// 修改人
        /// </summary>
        public Guid ModifiedBy { get; set; }

        /// <summary>
        /// 創建人名稱
        /// </summary>
        [Ignore]
        public string Creator { get; set; }

        /// <summary>
        /// 修改人
        /// </summary>
        [Ignore]
        public string Modifier { get; set; }
    }

可以看到 EntityBase 已經包含了CreatedTime,CreatedBy,ModifiedTime,ModifiedBy這四個實體屬性，通過實體繼承了EntityBase，那么該實體也包含了這個屬性，同時NetModular內部已經實現了在添加，修改時，自動設置對應的創建人和修改人編號，所以你不需要你去考慮這些事情了。

另外還有包含軟刪除功能的EntityWithSoftDelete以及包含上面兩個實體功能的EntityBaseWithSoftDelete兩個實體，這些都已經封裝好了，可以直接用。

Node: 上面的三個實體基類都會繼承自Entity，該實體包含了一個主鍵Id，主鍵類型支持Guid(默認)、Int、Long三種類型。

可以通過Table特性，設置實體對應的表名稱

以下是一個產品的實體示例：

[Table("Product")]
public partial class ProductEntity : EntityBase
{
    /// <summary>
    /// 標題
    /// </summary>
    public string Title { get; set; }

    /// <summary>
    /// 價格
    /// </summary>
    public decimal Price { get; set; }

    /// <summary>
    /// 庫存
    /// </summary>
    public int Store { get; set; }

    /// <summary>
    /// 狀態
    /// </summary>
    public ProductStatus Status { get; set; }
}

實體擴展類：

Node： 實體擴展類中的屬性，必須添加Ignore特性，否則屬性會被當成表的列處理。

public partial class ProductEntity
{
    /// <summary>
    /// sku列表
    /// </summary>
    [Ignore]
    public List<Guid> Skus { get; set; }
}

3、添加倉儲接口

倉儲接口必須繼承IRepository<>接口

/// <summary>
/// 產品倉儲接口
/// </summary>
public interface IProductRepository : IRepository<ProductEntity>
{
    /// <summary>
    /// 查詢
    /// </summary>
    /// <param name="model"></param>
    /// <returns></returns>
    Task<IList<ProductEntity>> Query(ProductQueryModel model);
}

4、添加查詢模型

查詢模型包含查詢條件，需要繼承QueryModel類，該類包含了分頁相關的信息

public class ProductQueryModel : QueryModel
{
    public string Title { get; set; }
}

5、添加倉儲實現

倉儲實現需要繼承抽象倉儲RepositoryAbstract<>，不同數據庫的倉儲實現，需要放到不同的目錄中。因為不同的數據庫難免會有一些查詢，所以我們采用先實現一種數據庫的實現，然后其它數據實現直接繼承它，對於有查詢的方法，采用覆寫的方式實現。

public class ProductRepository : RepositoryAbstract<ProductEntity>, IProductRepository
{
    public ProductRepository(IDbContext context) : base(context)
    {
    }

    public async Task<IList<ProductEntity>> Query(ProductQueryModel model)
    {
        //分頁
        var paging = model.Paging();

        var query = Db.Find();
        query.WhereIf(model.Title.NotNull(), m => m.Title.Contains(model.Title));

        //設置默認排序
        if (!paging.OrderBy.Any())
        {
            query.OrderByDescending(m => m.Id);
        }

        var list = await query.PaginationAsync(paging);
        model.TotalCount = paging.TotalCount;
        return list;
    }
}

上面的例子是一個最簡單的分頁查詢，到此數據訪問的代碼就寫完了，剩下的就是在服務層調用就行了。

其它用法說明

1、CRUD

基礎的CRUD在RepositoryAbstract中已經實現了，所以可以直接在服務中調用

新增

_repository.AddAsync(entity);

批量新增

_repository.AddAsync(entities);

刪除

_repository.DeleteAsync(id);

軟刪除

_repository.SoftDeleteAsync(id);

修改

_repository.UpdateAsync(entity);

獲取

_repository.GetAsync(id);

獲取所有

_repository.GetAllAsync()

是否存在

_repository.ExistsAsync(m => m.Title.Contains("test"))

批量修改

/// <summary>
/// 批量修改狀態
/// </summary>
/// <param name="ids"></param>
/// <param name="status"></param>
/// <returns></returns>
public Task<bool> UpdateStatus(List<Guid> ids, ProductStatus status)
{
    return Db.Find(m => ids.Contains(m.Id)).UpdateAsync(m => new ProductEntity { Status = status });
}

批量刪除

/// <summary>
/// 批量刪除
/// </summary>
/// <param name="title"></param>
/// <returns></returns>
public Task<bool> Delete(string title)
{
    return Db.Find(m => m.Title.Contains(title)).DeleteAsync();
}

表連接查詢

public async Task<IList<ProductEntity>> Query(ProductQueryModel model)
{
    //分頁
    var paging = model.Paging();

    var query = Db.Find();
    query.WhereIf(model.Title.NotNull(), m => m.Title.Contains(model.Title));

    //設置默認排序
    if (!paging.OrderBy.Any())
    {
        query.OrderByDescending(m => m.Id);
    }

    var list = await query.LeftJoin<AccountEntity>((x, y) => x.CreatedBy == y.Id)
        .Select((x, y) => new { x, Creator = y.Name })
        .PaginationAsync(paging);

    model.TotalCount = paging.TotalCount;
    return list;
}

分組查詢

Db.Find().GroupBy(m => new { m.Status }).Select(m => new { m.Key.Status, Count = m.Count() });

工作單元

工作單元在服務中注入使用

private readonly IUnitOfWork _uow;
public ArticleService(IUnitOfWork<MalDbContext> uow)
{
    _uow = uow;
}

然后通過BeginTransaction方法開啟事務，Commit方法提交事務，Rollback方法回滾事務

_uow.BeginTransaction();
var result = await _accountRepository.AddAsync(account);
if (result)
{
    if (model.Roles != null && model.Roles.Any())
    {
        var accountRoleList = model.Roles.Select(m => new AccountRoleEntity { AccountId = account.Id, RoleId = m }).ToList();
        if (await _accountRoleRepository.AddAsync(accountRoleList))
        {
            _uow.Commit();
            return ResultModel.Success();
        }
    }
    else
    {
        _uow.Commit();
        return ResultModel.Success();
    }
}

好了，數據庫訪問的用法大致就是這樣~