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

轉載于：https://github.com/Meowv/Blog

本篇說一下自定義倉儲的實現方式，其實在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>接口定義看一下

圖片

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

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

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

你可以擴展這些接口（并可選擇性地從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
{
///
/// IPostRepository
///
public interface IPostRepository : IRepository<Post, int>
{
}
}
//ICategoryRepository.cs
using Volo.Abp.Domain.Repositories;

namespace Meowv.Blog.Domain.Blog.Repositories
{
///
/// ICategoryRepository
///
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
{
///
/// ITagRepository
///
public interface ITagRepository : IRepository<Tag, int>
{
///
/// 批量插入
///
///
///
Task BulkInsertAsync(IEnumerable tags);
}
}
//IPostTagRepository.cs
using System.Collections.Generic;
using System.Threading.Tasks;
using Volo.Abp.Domain.Repositories;

namespace Meowv.Blog.Domain.Blog.Repositories
{
///
/// IPostTagRepository
///
public interface IPostTagRepository : IRepository<PostTag, int>
{
///
/// 批量插入
///
///
///
Task BulkInsertAsync(IEnumerable postTags);
}
}
//IFriendLinkRepository.cs
using Volo.Abp.Domain.Repositories;

namespace Meowv.Blog.Domain.Blog.Repositories
{
///
/// IFriendLinkRepository
///
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。

圖片

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
{
///
/// PostRepository
///
public class PostRepository : EfCoreRepository<MeowvBlogDbContext, Post, int>, IPostRepository
{
public PostRepository(IDbContextProvider 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
{
///
/// CategoryRepository
///
public class CategoryRepository : EfCoreRepository<MeowvBlogDbContext, Category, int>, ICategoryRepository
{
public CategoryRepository(IDbContextProvider 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
{
///
/// TagRepository
///
public class TagRepository : EfCoreRepository<MeowvBlogDbContext, Tag, int>, ITagRepository
{
public TagRepository(IDbContextProvider 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
{
///
/// PostTagRepository
///
public class PostTagRepository : EfCoreRepository<MeowvBlogDbContext, PostTag, int>, IPostTagRepository
{
public PostTagRepository(IDbContextProvider 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
{
///
/// PostTagRepository
///
public class FriendLinkRepository : EfCoreRepository<MeowvBlogDbContext, FriendLink, int>, IFriendLinkRepository
{
public FriendLinkRepository(IDbContextProvider dbContextProvider) : base(dbContextProvider)
{
}
}
}

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

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

圖片

增刪改查

接下來在就可以在.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 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 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 ，已經出現我們的接口了。

圖片

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

圖片

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

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

…
public async Task 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中調用，代碼如下：

…
///
/// 刪除博客
///
///
///
[HttpDelete]
public async Task 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文檔看看效果，并試試我們的接口是否好使吧，反正我試了是沒有問題的。

圖片

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

圖片

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

開源地址：https://github.com/Meowv/Blog/tree/blog_tutorial

總結

以上是生活随笔為你收集整理的基于 abp vNext 和 .NET Core 开发博客项目 - 自定义仓储之增删改查的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。