基于 EntityFramework 生成 Repository 模式代码

借助 WeihanLi.EntityFramework 实现简单的 Repository

Intro

很多时候一些简单的业务都是简单的增删改查，动态生成一些代码完成基本的增删改查，而这些增删改查代码大多类似，只有一些有复杂业务逻辑的可能需要手动去写。于是实现了一个基于 EF Core 的 Repository。

GetStarted

0. 添加包引用

在项目里增加对 WeihanLi.EntityFramework 的引用

dotnet add package WeihanLi.EntityFramework

来看个使用例子：

使用方式：

1. 不需要定义自己的Repository，默认使用泛型的Repository

1. // 注册 EFREpository

2. services.AddEFRepostory();

3. 
   

4. // 在需要的地方使用，直接获取一个 `IEFRepository<TestDbContext, TestEntity>` 服务

5. DependencyResolver.Current.TryInvokeService<IEFRepository<TestDbContext, TestEntity>>(repo =>

6. {

7. repo.Update(new TestEntity

8. {

9. CreatedAt = DateTime.UtcNow,

10. Extra = new { Name = "Abcde", Count = 4 }.ToJson(),

11. Id = 3

12. }, t => t.CreatedAt, t => t.Extra);

13. repo.Insert(new[]

14. {

15. new TestEntity

16. {

17. Extra = new { Name = "Abcdes"}.ToJson(),

18. CreatedAt = DateTime.Now

19. },

20. new TestEntity

21. {

22. Extra = new { Name = "Abcdes"}.ToJson(),

23. CreatedAt = DateTime.Now

24. }

25. });

26. var list = repo.GetAll().Select(_ => _.Id).ToArray();

27. Console.WriteLine($"Ids: {list.StringJoin(",")}");

28. 
    

29. repo.Get(_ => _.Id, queryBuilder => queryBuilder

30. .WithOrderBy(q => q.OrderByDescending(_ => _.Id)));

31. 
    

32. var lastItem = repo.FirstOrDefault(queryBuilder => queryBuilder

33. .WithOrderBy(q => q.OrderByDescending(_ => _.Id)));

34. 
    

35. var list1 = repo.Get(x => x.Id, queryBuilder => queryBuilder

36. .WithOrderBy(query => query.OrderByDescending(q => q.Id))

37. );

38. 
    

39. repo.Delete(t => DbFunctions.JsonValue(t.Extra, "$.Name") == "Abcdes");

40. Console.WriteLine($"Count: {repo.Count()}");

41. });

2. 生成自己的 Repository 代码

你可以生成自己的 基于 默认的 Repository 的代码，默认的 Repository 的所有方法都是虚方法，可以重写也可以，默认会生成接口和类，如果不要生成接口可以配置 EFRepositoryGeneratorOptions

1. // 配置不生成接口

2. services.Configure<EFRepositoryGeneratorOptions>(options=>options.GenerateInterface=false);

3. 
   

4. // 配置生成的 Repository 类型名称， 默认是 EntityName+"Repository"，可以通过 RepositoryNameResolver 自定义

5. services.Configure<EFRepositoryGeneratorOptions>(options=>options.RepositoryNameResolver = entityName=> $"{entityName}Service");

默认生成的代码类似于这样子：

1. using WeihanLi.EntityFramework;

2. using WeihanLi.EntityFramework.Samples;

3. 
   

4. namespace WeihanLi.EntityFramework.Samples.Business

5. {

6. 
   

7. public partial interface ITestEntityRepository : IEFRepository<TestDbContext, TestEntity> { }

8. public partial class TestEntityRepository : EFRepository<TestDbContext, TestEntity>, ITestEntityRepository

9. {

10. public TestEntityRepository(TestDbContext dbContext) : base(dbContext) { }

11. }

12. }

如果对生成的代码内容部分要修改，可以自定义自己的 IEFRepositoryGenerator，然后 services.AddSingleton<IEFRepositoryGenerator,CustomEFRepositoryGenerator>() 覆盖掉默认的就可以了，或者可以 Replace 直接替换也是可以的~

调用下面的代码去生成代码：

1. DependencyResolver.Current.ResolveService<IEFRepositoryGenerator>()

2. .GenerateRepositoryCodeFor<TestDbContext>("WeihanLi.EntityFramework.Samples.Business");

QueryBuilder 使用

为 EF 添加了 FluentAPI 的 QueryBuilder 支持，使得可以更方便的进行数据查询。

默认的 QueryBuilder 会 AsNoTracking()，如果不要 AsNoTracking可以使用 WithNoTracking(false) 来设置，EFCore 新增了一个 QueryFilter 可以全局过滤，默认查询也是启动全局过滤的，如果要在查询中禁用这个全局过滤可以通过 IgnoreQueryFilters() 来设置。

基本方法：

1. EFRepositoryQueryBuilder<TEntity> WithPredict(Expression<Func<TEntity, bool>> predict);// 设置查询条件

2. EFRepositoryQueryBuilder<TEntity> WithOrderBy(Func<IQueryable<TEntity>, IOrderedQueryable<TEntity>> orderByExpression); // 设置排序

3. EFRepositoryQueryBuilder<TEntity> WithNoTracking(bool noTracking = true); // 设置是否 Tracking

4. EFRepositoryQueryBuilder<TEntity> IgnoreQueryFilters(bool ignoreQueryFilters = true);// 是否忽略查询

5. EFRepositoryQueryBuilder<TEntity> WithInclude(Func<IQueryable<TEntity>, IIncludableQueryable<TEntity, object>> include); // 设置 include

6. EFRepositoryQueryBuilder<TEntity> WithCount(int count);// 如果要查 Top N 的时候可以设置

使用示例如下：

1. var repository = serviceProvider.GetService<IEFRepository<TestDbContext, TestEntity>>();

2. 
   

3. // query lastItem

4. var lastItem = repo.FirstOrDefault(queryBuilder => queryBuilder

5. .WithOrderBy(q => q.OrderByDescending(_ => _.Id)));

6. 
   

7. // query id list orderBy id desending

8. var idList = repo.Get(x => x.Id, queryBuilder => queryBuilder

9. .WithOrderBy(query => query.OrderByDescending(q => q.Id))

10. );

11. 
    

12. var blockList = serviceProvider.GetService<IEFRepository<TestDbContext, BlockEntity>>().GetPagedList(queryBuilder => queryBuilder

13. .WithPredict(whereLambda)

14. .WithInclude(q => q.Include(b => b.BlockType))

15. .WithOrderBy(q => q.OrderByDescending(b => b.BlockTime)), search.PageIndex, search.PageSize);

16. 
    

17. //load data

18. var list = _reservationBLL.GetPagedList(queryBuilder => queryBuilder

19. .WithPredict(whereLambda)

20. .WithOrderBy(query => query.OrderByDescending(r => r.ReservationForDate).ThenByDescending(r => r.ReservationTime))

21. .WithInclude(query => query.Include(r => r.Place))

22. , search.PageIndex, search.PageSize);

Reference

• https://github.com/WeihanLi/ActivityReservation/blob/dev/ActivityReservation/Controllers/HomeController.cs#L43

• https://github.com/WeihanLi/ActivityReservation/blob/dev/ActivityReservation.AdminLogic/Controllers/BlockEntityController.cs#L39

• https://github.com/WeihanLi/WeihanLi.EntityFramework/blob/dev/samples/WeihanLi.EntityFramework.Samples/Program.cs

---

.NET社区新闻，深度好文，欢迎访问公众号文章汇总 http://www.csharpkit.com