基於 abp vNext 和 .NET Core 開發博客項目 - 自定義倉儲之增刪改查

来源:https://www.cnblogs.com/meowv/archive/2020/05/20/12916613.html
-Advertisement-
Play Games

上一篇文章(https://www.cnblogs.com/meowv/p/12913676.html)我們用Code First的方式創建了博客所需的實體類，生成了資料庫表，完成了對EF Core的封裝。 本篇說一下自定義倉儲的實現方式，其實在abp框架中已經預設給我們實現了預設的通用(泛型)倉儲 ...


上一篇文章(https://www.cnblogs.com/meowv/p/12913676.html)我們用Code-First的方式創建了博客所需的實體類，生成了資料庫表，完成了對EF Core的封裝。

本篇說一下自定義倉儲的實現方式，其實在abp框架中已經預設給我們實現了預設的通用(泛型)倉儲，IRepository<TEntity, TKey>，有著標準的CRUD操作，可以看：https://docs.abp.io/zh-Hans/abp/latest/Repositories 學習更多。

之所以實現自定義倉儲，是因為abp沒有給我們實現批量插入、更新的方法，這個是需要自己去擴展的。

既然是自定義倉儲，那麼就有了很高的自由度，我們可以任意發揮，可以接入第三方批量處理數據的庫，可以接入Dapper操作等等，在這裡貼一下微軟官方推薦的一些EF Core的工具和擴展：https://docs.microsoft.com/zh-cn/ef/core/extensions/ 。

自定義倉儲

在.Domain領域層中創建倉儲介面，IPostRepository、ICategoryRepository、ITagRepository、IPostTagRepository、IFriendLinkRepository，這裡直接全部繼承 IRepository<TEntity, TKey> 以使用已有的通用倉儲功能。

可以轉到IRepository<TEntity, TKey>介面定義看一下

1

看看abp對於倉儲的介紹，如下：

IRepository<TEntity, TKey> 介面擴展了標準 IQueryable<TEntity> 你可以使用標準LINQ方法自由查詢。但是，某些ORM提供程式或資料庫系統可能不支持IQueryable介面。

ABP提供了 IBasicRepository<TEntity, TPrimaryKey> 和 IBasicRepository<TEntity> 介面來支持這樣的場景。

你可以擴展這些介面（並可選擇性地從BasicRepositoryBase派生）為你的實體創建自定義存儲庫。

依賴於 IBasicRepository 而不是依賴 IRepository 有一個優點, 即使它們不支持 IQueryable 也可以使用所有的數據源, 但主要的供應商, 像 Entity Framework, NHibernate 或 MongoDb 已經支持了 IQueryable。

因此, 使用 IRepository 是典型應用程式的 建議方法。但是可重用的模塊開發人員可能會考慮使用 IBasicRepository 來支持廣泛的數據源。

對於想要使用只讀倉儲提供了IReadOnlyRepository<TEntity, TKey> 與 IReadOnlyBasicRepository<Tentity, TKey>介面。

倉儲介面類如下：

//IPostRepository.cs
using Volo.Abp.Domain.Repositories;

namespace Meowv.Blog.Domain.Blog.Repositories
{
    /// <summary>
    /// IPostRepository
    /// </summary>
    public interface IPostRepository : IRepository<Post, int>
    {
    }
}

//ICategoryRepository.cs
using Volo.Abp.Domain.Repositories;

namespace Meowv.Blog.Domain.Blog.Repositories
{
    /// <summary>
    /// ICategoryRepository
    /// </summary>
    public interface ICategoryRepository : IRepository<Category, int>
    {
    }
}

//ITagRepository.cs
using System.Collections.Generic;
using System.Threading.Tasks;
using Volo.Abp.Domain.Repositories;

namespace Meowv.Blog.Domain.Blog.Repositories
{
    /// <summary>
    /// ITagRepository
    /// </summary>
    public interface ITagRepository : IRepository<Tag, int>
    {
        /// <summary>
        /// 批量插入
        /// </summary>
        /// <param name="tags"></param>
        /// <returns></returns>
        Task BulkInsertAsync(IEnumerable<Tag> tags);
    }
}

//IPostTagRepository.cs
using System.Collections.Generic;
using System.Threading.Tasks;
using Volo.Abp.Domain.Repositories;

namespace Meowv.Blog.Domain.Blog.Repositories
{
    /// <summary>
    /// IPostTagRepository
    /// </summary>
    public interface IPostTagRepository : IRepository<PostTag, int>
    {
        /// <summary>
        /// 批量插入
        /// </summary>
        /// <param name="postTags"></param>
        /// <returns></returns>
        Task BulkInsertAsync(IEnumerable<PostTag> postTags);
    }
}

//IFriendLinkRepository.cs
using Volo.Abp.Domain.Repositories;

namespace Meowv.Blog.Domain.Blog.Repositories
{
    /// <summary>
    /// IFriendLinkRepository
    /// </summary>
    public interface IFriendLinkRepository : IRepository<FriendLink, int>
    {
    }
}

在ITagRepository和IPostTagRepository倉儲介面中，我們添加了批量插入的方法。相對於的在我們的.EntityFrameworkCore層實現這些介面。

創建Repositories/Blog 文件夾，添加實現類：PostRepository、CategoryRepository、TagRepository、PostTagRepository、FriendLinkRepository。

不知道大家發現沒有，我們的倉儲介面以及實現，都是以Repository結尾的，這和我們的.Application應用服務層都以Service結尾是一個道理。

在自定義倉儲的實現中，我們可以使用任意你想使用的數據訪問工具，我們這裡還是繼續用Entity Framework Core，需要繼承EfCoreRepository<TDbContext, TEntity, TKey>，和我們的倉儲介面IXxxRepository。

2

EfCoreRepository預設實現了許多預設的方法，然後就可以直接使用 DbContext 來執行操作了。

倉儲介面實現類如下：

//PostRepository.cs
using Meowv.Blog.Domain.Blog;
using Meowv.Blog.Domain.Blog.Repositories;
using Volo.Abp.Domain.Repositories.EntityFrameworkCore;
using Volo.Abp.EntityFrameworkCore;

namespace Meowv.Blog.EntityFrameworkCore.Repositories.Blog
{
    /// <summary>
    /// PostRepository
    /// </summary>
    public class PostRepository : EfCoreRepository<MeowvBlogDbContext, Post, int>, IPostRepository
    {
        public PostRepository(IDbContextProvider<MeowvBlogDbContext> dbContextProvider) : base(dbContextProvider)
        {
        }
    }
}

//CategoryRepository.cs
using Meowv.Blog.Domain.Blog;
using Meowv.Blog.Domain.Blog.Repositories;
using Volo.Abp.Domain.Repositories.EntityFrameworkCore;
using Volo.Abp.EntityFrameworkCore;
namespace Meowv.Blog.EntityFrameworkCore.Repositories.Blog
{
    /// <summary>
    /// CategoryRepository
    /// </summary>
    public class CategoryRepository : EfCoreRepository<MeowvBlogDbContext, Category, int>, ICategoryRepository
    {
        public CategoryRepository(IDbContextProvider<MeowvBlogDbContext> dbContextProvider) : base(dbContextProvider)
        {
        }
    }
}

//TagRepository.cs
using Meowv.Blog.Domain.Blog;
using Meowv.Blog.Domain.Blog.Repositories;
using System.Collections.Generic;
using System.Threading.Tasks;
using Volo.Abp.Domain.Repositories.EntityFrameworkCore;
using Volo.Abp.EntityFrameworkCore;

namespace Meowv.Blog.EntityFrameworkCore.Repositories.Blog
{
    /// <summary>
    /// TagRepository
    /// </summary>
    public class TagRepository : EfCoreRepository<MeowvBlogDbContext, Tag, int>, ITagRepository
    {
        public TagRepository(IDbContextProvider<MeowvBlogDbContext> dbContextProvider) : base(dbContextProvider)
        {
        }

        /// <summary>
        /// 批量插入
        /// </summary>
        /// <param name="tags"></param>
        /// <returns></returns>
        public async Task BulkInsertAsync(IEnumerable<Tag> tags)
        {
            await DbContext.Set<Tag>().AddRangeAsync(tags);
            await DbContext.SaveChangesAsync();
        }
    }
}

//PostTagRepository.cs
using Meowv.Blog.Domain.Blog;
using Meowv.Blog.Domain.Blog.Repositories;
using System.Collections.Generic;
using System.Threading.Tasks;
using Volo.Abp.Domain.Repositories.EntityFrameworkCore;
using Volo.Abp.EntityFrameworkCore;

namespace Meowv.Blog.EntityFrameworkCore.Repositories.Blog
{
    /// <summary>
    /// PostTagRepository
    /// </summary>
    public class PostTagRepository : EfCoreRepository<MeowvBlogDbContext, PostTag, int>, IPostTagRepository
    {
        public PostTagRepository(IDbContextProvider<MeowvBlogDbContext> dbContextProvider) : base(dbContextProvider)
        {
        }

        /// <summary>
        /// 批量插入
        /// </summary>
        /// <param name="postTags"></param>
        /// <returns></returns>
        public async Task BulkInsertAsync(IEnumerable<PostTag> postTags)
        {
            await DbContext.Set<PostTag>().AddRangeAsync(postTags);
            await DbContext.SaveChangesAsync();
        }
    }
}

//FriendLinkRepository.cs
using Meowv.Blog.Domain.Blog;
using Meowv.Blog.Domain.Blog.Repositories;
using Volo.Abp.Domain.Repositories.EntityFrameworkCore;
using Volo.Abp.EntityFrameworkCore;

namespace Meowv.Blog.EntityFrameworkCore.Repositories.Blog
{
    /// <summary>
    /// PostTagRepository
    /// </summary>
    public class FriendLinkRepository : EfCoreRepository<MeowvBlogDbContext, FriendLink, int>, IFriendLinkRepository
    {
        public FriendLinkRepository(IDbContextProvider<MeowvBlogDbContext> dbContextProvider) : base(dbContextProvider)
        {
        }
    }
}

在TagRepository和PostTagRepository倉儲介面的實現中，因為數據量不大，可以直接用了EF Core自帶的AddRangeAsync批量保存數據。

到這裡，關於博客的自定義倉儲便完成了，此時項目層級目錄圖，如下：

3

增刪改查

接下來在就可以在.Application服務層愉快的玩耍了，寫服務之前，我們要分析我們的項目，要有哪些功能業務。由於是博客項目，無非就是一些增刪改查。今天先不寫博客業務，先完成對資料庫文章表meowv_posts的一個簡單CRUD。

在.Application層新建Blog文件夾，添加一個IBlogService.cs博客介面服務類，分別添加增刪改查四個方法。

這時就要用到我們的數據傳輸對象(DTO)了，簡單理解，DTO就是從我們的領域模型中抽離出來的對象，它是很純粹的只包含我們拿到的數據，不參雜任何行為邏輯。

在.Application.Contracts層新建Blog文件夾，同時新建一個PostDto.cs類，與.Domain層中的Post.cs與之對應，他們很相似，但是不一樣。

於是IBlogService.cs介面服務類的CRUD為：

//IBlogService.cs
using Meowv.Blog.Application.Contracts.Blog;
using System.Threading.Tasks;

namespace Meowv.Blog.Application.Blog
{
    public interface IBlogService
    {
        Task<bool> InsertPostAsync(PostDto dto);

        Task<bool> DeletePostAsync(int id);

        Task<bool> UpdatePostAsync(int id, PostDto dto);

        Task<PostDto> GetPostAsync(int id);
    }
}

介面寫好了，少不了實現方式，直接在Blog文件夾新建Impl文件夾，用來存放我們的介面實現類BlogService.cs，註意：都是以Service結尾的噢~

實現服務介面除了要繼承我們的IBlogService外，不要忘了還需依賴我們的ServiceBase類。由於我們之前直接接入了Autofac，可以直接使用構造函數依賴註入的方式。

//BlogService.cs
using Meowv.Blog.Application.Contracts.Blog;
using Meowv.Blog.Domain.Blog.Repositories;
using System;
using System.Threading.Tasks;

namespace Meowv.Blog.Application.Blog.Impl
{
    public class BlogService : ServiceBase, IBlogService
    {
        private readonly IPostRepository _postRepository;

        public BlogService(IPostRepository postRepository)
        {
            _postRepository = postRepository;
        }
        ...
    }
}

現在就可以實現我們寫的IBlogService介面了。

先寫添加，這裡實現方式全採用非同步的方法，先構建一個Post實體對象，具體內容參數都從PostDto中獲取，由於主鍵之前設置了自增，這裡就不用管它了。然後調用 await _postRepository.InsertAsync(entity);，正好它返回了一個創建成功的Post對象，那麼我們就可以判斷對象是否為空，從而確定文章是否添加成功。

代碼如下：

...
        public async Task<bool> InsertPostAsync(PostDto dto)
        {
            var entity = new Post
            {
                Title = dto.Title,
                Author = dto.Author,
                Url = dto.Url,
                Html = dto.Html,
                Markdown = dto.Markdown,
                CategoryId = dto.CategoryId,
                CreationTime = dto.CreationTime
            };

            var post = await _postRepository.InsertAsync(entity);
            return post != null;
        }
...

然後在.HttpApi層和之前添加HelloWorldController一樣，添加BlogController。調用寫的InsertPostAsync方法，如下：

//BlogController.cs
using Meowv.Blog.Application.Blog;
using Meowv.Blog.Application.Contracts.Blog;
using Microsoft.AspNetCore.Mvc;
using System.Threading.Tasks;
using Volo.Abp.AspNetCore.Mvc;

namespace Meowv.Blog.HttpApi.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class BlogController : AbpController
    {
        private readonly IBlogService _blogService;

        public BlogController(IBlogService blogService)
        {
            _blogService = blogService;
        }

        /// <summary>
        /// 添加博客
        /// </summary>
        /// <param name="dto"></param>
        /// <returns></returns>
        [HttpPost]
        public async Task<bool> InsertPostAsync([FromBody] PostDto dto)
        {
            return await _blogService.InsertPostAsync(dto);
        }
    }
}

添加博客操作，我們將其設置為[HttpPost]方式來提交，因為現在開發介面api，都要遵循RESTful方式，所以就不用給他指定路由了，[FromBody]的意思是在請求正文中以JSON的方式來提交參數。

完成上述操作，打開我們的Swagger文檔看看， .../swagger/index.html ，已經出現我們的介面了。

4

隨手就試一下這個介面，能否成功創建文章。

5

可以看到資料庫已經躺著我們剛剛添加數據內容。

將剩下的三個介面一一實現，相信大家肯定都知道怎麼寫了。就不逐一嘮叨了，代碼如下：

...
        public async Task<bool> DeletePostAsync(int id)
        {
            await _postRepository.DeleteAsync(id);

            return true;
        }

        public async Task<bool> UpdatePostAsync(int id, PostDto dto)
        {
            var post = await _postRepository.GetAsync(id);

            post.Title = dto.Title;
            post.Author = dto.Author;
            post.Url = dto.Url;
            post.Html = dto.Html;
            post.Markdown = dto.Markdown;
            post.CategoryId = dto.CategoryId;
            post.CreationTime = dto.CreationTime;

            await _postRepository.UpdateAsync(post);

            return true;
        }

        public async Task<PostDto> GetPostAsync(int id)
        {
            var post = await _postRepository.GetAsync(id);

            return new PostDto
            {
                Title = post.Title,
                Author = post.Author,
                Url = post.Url,
                Html = post.Html,
                Markdown = post.Markdown,
                CategoryId = post.CategoryId,
                CreationTime = post.CreationTime
            };
        }
...

在這裡先暫時不做參數校驗，咱們預設都是正常操作，如果執行操作成功，直接返回true。大家會發現，當我們使用了DTO後，寫了大量對象的轉換，在這裡暫不做優化，將在後續業務開始後使用AutoMapper處理對象映射。如果大家感興趣可以自己先試一下。

在Controller中調用，代碼如下：

...
        /// <summary>
        /// 刪除博客
        /// </summary>
        /// <param name="id"></param>
        /// <returns></returns>
        [HttpDelete]
        public async Task<bool> DeletePostAsync([Required] int id)
        {
            return await _blogService.DeletePostAsync(id);
        }

        /// <summary>
        /// 更新博客
        /// </summary>
        /// <param name="id"></param>
        /// <param name="dto"></param>
        /// <returns></returns>
        [HttpPut]
        public async Task<bool> UpdatePostAsync([Required] int id, [FromBody] PostDto dto)
        {
            return await _blogService.UpdatePostAsync(id, dto);
        }

        /// <summary>
        /// 查詢博客
        /// </summary>
        /// <param name="id"></param>
        /// <returns></returns>
        [HttpGet]
        public async Task<PostDto> GetPostAsync([Required] int id)
        {
            return await _blogService.GetPostAsync(id);
        }
...

DeletePostAsync：指定了請求方式[HttpDelete]，參數id為必填項

UpdatePostAsync：指定了請求方式[HttpPut]，參數id為必填項並且為url的一部分，要更新的具體內容和添加博客的方法InsertPostAsync的一樣的

GetPostAsync：指定了請求方式[HttpGet]，參數id為必填項

ok，打開Swagger文檔看看效果，並試試我們的介面是否好使吧，反正我試了是沒有問題的。

6

做到這一步的項目層級目錄如下:

7

本篇使用自定義倉儲的方式完成了對博客(meowv_posts)的增刪改查，你學會了嗎？

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

-Advertisement-
Play Games
更多相關文章
  • C#作業調度FluentScheduler學習筆記
    一、簡介 FluentScheduler是一個簡單的任務調度框架，定時任務管理器。 GitHub地址：https://github.com/fluentscheduler/FluentScheduler 二、示常式序 2.1、界面 新建一個WinForm程式FluentSchedulerClient ...
  • C#作業調度Quartz.NET學習筆記
    一、簡單介紹 Quartz.NET是一個強大、開源、輕量的作業調度框架，是 OpenSymphony 的 Quartz API 的.NET移植，用C#改寫，可用於WinForm和ASP.NET應用中。它靈活而不複雜，可以為執行一個作業而創建簡單或複雜的作業調度。它有很多特征，如：資料庫支持、集群、插 ...
  • C# 數據操作系列 - 11 NHibernate 配置和結構介紹
    0. 前言 今天是NHibernate的第二篇內容，通過上一篇的內容，我們初步瞭解了NHibernate的創建和使用。這一篇，我繼續探索NHibernate背後的秘密。嗯，就是這樣。 1. NHibernate結構 先給小伙伴們放個圖： 這是NHibernate的整體結構圖。NHibernate通過 ...
  • 低代碼開發平臺選擇方案分析
    隨著信息技術對人們工作生活的影響越來越大，人們對於應用程式的依賴性也越來越大，越來越多的人使用應用程式來解決自己工作和生活中的問題，這也導致應用程式的開發需求越來越高，傳統的應用程式開發方法已經沒有辦法滿足市場的需求，低代碼開發平臺在這樣的背景下誕生了。 力軟低代碼開發平臺可以減少開發成本，代碼、功 ...
  • C#手動建立Table後，並設置列和賦值
    C#手動建立Table後，並設置列和賦值 public DataTable CreateTable() { //創建Table1 DataTable dt = new DataTable(); //對Table1添加列名，並設置列值類型 DataTable dt1 = new DataTable() ...
  • C#中的關於Table的Merge()
    C#中的關於Table的Merge() 簡介： Merge()方法可以實現對兩個table具有相同欄位的進行Morge,也可以實現對兩個table具有不同欄位的進行Merge。但是實現後的結果可能不太一樣。 一、對兩個table具有相同的欄位進行Merge的時候，所得到Merge後的table行數小 ...
  • 不幹膠、熱敏列印
    倉儲物流的過程中往往少不了一些使用熱敏印表機或者碳帶印表機列印一些條碼、信息貼在實物或者包裹上 最好的實現方式不過於直接使用熱敏代碼形成文本直接輸出到印表機做列印 但是熱敏代碼也是一門需要特殊的語言，需要學習 故為了更快更方便的實現，就用到了畫布繪製後形成image輸出到印表機 而image也是有要 ...
  • 關於讀取Excel模板對模板讀寫操作
    關於讀取Excel模板對模板讀寫操作 1.根據文件名稱(帶盤符的文件目錄)，建立SLDocument對象 SLDocument sldocument = new SLDocument(filename); sldocument.SelectWorksheet("Sheet1"); 2.讀取某一單元格 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類