ASP.NET Core模組化前後端分離快速開發框架介紹之3、資料訪問模組介紹

oldli發表於2019-05-23

ASP.NET後端框架

原始碼

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

演示地址

地址：http://129.211.40.240:6220
賬戶：admin
密碼：admin

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

地址：http://progqx5cu.bkt.clouddn.com/skins/index.html#/
賬戶：admin
密碼：admin

簡介

NetModular 的資料訪問模組是基於 Dapper 擴充套件的輕量級的ORM，它本身是完全獨立的，可以在任何專案中直接使用。在NetModular中也提供了擴充套件，能夠完美的與模組化整合在一起。

支援的功能

[x] 支援SqlServer、MySql、SQLite資料庫
[x] 基礎的CRUD方法
[x] 批量新增、刪除、修改
[x] 修改指定列
[x] Lamdba表示式支援
[x] 多表連線查詢
[x] 分頁查詢
[x] 分組查詢
[x] 倉儲模式
[x] 工作單元
[x] 自定義表名、列名
[x] 支援同步/非同步方法

使用方法

NetModular 本身已經做好了整合，所以業務模組中，可以直接寫程式碼，不用考慮注入的問題，如果想要了解它的整合邏輯的，可以檢視Data.AspNetCore庫

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();
    }
}

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

ASP.NET Core模組化前後端分離快速開發框架介紹之1、開篇
2019-05-20
ASP.NET後端框架
ASP.NET Core模組化前後端分離快速開發框架介紹之4、模組化實現思路
2019-05-29
ASP.NET後端框架
ASP.NET Core模組化前後端分離快速開發框架介紹之2、快速建立一個業務模組
2019-05-22
ASP.NET後端框架
Android模組化框架介紹
2018-09-03
Android框架
ModStartCMS模組開發介紹
2021-12-17
Python模組介紹
2017-03-31
Python
TSM功能模組介紹
2009-08-03
HanLP分類模組的分詞器介紹
2019-06-14
HanLP分詞
Django重要元件之Auth模組介紹
2021-09-11
Django元件
【StoneDB 模組介紹】伺服器模組
2022-10-17
伺服器
日常工作中關於前後端分離的簡單介紹
2017-12-14
後端
3.03 模組外掛介紹
2018-12-11
nodejs主要模組介紹
2017-04-14
NodeJS
Tengine 常用模組使用介紹
2016-05-20
python之pymsql模組相關介紹
2021-09-11
PythonSQL
Laravel Vue 前後端分類模組化外掛化開發疑惑
2019-05-24
LaravelVue後端
開源公開課丨 ChunJun 資料傳輸模組介紹
2022-08-15
GoldenGate 12.3 MA架構介紹系列(3) - 各功能模組介紹
2017-12-23
Go架構
uni-app跨端開發框架介紹
2019-04-18
APP跨端框架
Python3 日曆（Calendar）模組介紹
2020-01-16
Python
螞蟻金服 SOFAArk 0.6.0 新特性介紹 | 模組化開發容器
2019-03-21
力軟快速開發框架建設與介紹
2018-08-30
框架
JavaScript 模組化程式設計簡單介紹
2017-07-13
JavaScript程式設計
ngx_pagespeed-nginx前端優化模組介紹
2017-02-21
Nginx前端優化
Python標準庫系列之模組介紹
2017-02-03
Python
nodejs常用核心模組介紹
2017-04-07
NodeJS
percona之資料庫開發工具介紹
2015-03-30
資料庫
C/S框架網介紹|.NET快速開發平臺|Winform開發框架
2019-01-05
框架ORM
手把手教你使用 Spring Boot 3 開發上線一個前後端分離的生產級系統（一） - 介紹
2022-05-28
Spring Boot後端
python基礎之-sys模組、os模組基本介紹（未完成）
2024-04-19
Python
Nginx 架構——【核心流程+模組介紹】
2019-03-25
Nginx架構
簡單介紹python process模組
2021-05-28
Python
mysql SQL Layer各個模組介紹
2018-03-31
MySql
python shutil模組簡單介紹
2017-08-24
Python
前後端分離——資料mock
2018-08-10
後端Mock
ASP.NET Core 實戰：使用 ASP.NET Core Web API 和 Vue.js，搭建前後端分離框架
2018-12-20
ASP.NETWebAPIVue.js後端框架
基於 ThinkPHP6 開發的模組化前後臺分離管理系統
2020-07-03
PHP
Python的常見模組：OS和 time模組介紹
2021-06-08
Python