使用EFCore封装Service层CRUD代码

2024-06-21 18:04

本文主要是介绍使用EFCore封装Service层CRUD代码,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

在使用asp.net core写后端接口的时候,经常会有很多相似的crud操作,甚至有的接口只需要一行代码就能实现,还要在service层里面定义方法,再来调用,显得很繁琐,因此可以利用c#里面的泛型对service层代码进行封装,写一些通用的crud操作,方便将来进行调用。

1、定义实体类的基类

public class BaseModel<Key>
{[Key]public Key Id { get; set; }}

这个类里面就包含一个主键属性,并且带了一个泛型Key,用来代表主键的类型,因为很多crud操作需要用到主键,因此需要这样定义,其他的实体类需要继承这个基类,比如User类

[Table("sys_user")]
[Comment("用户表")]
public class User:BaseModel<long>
{[Comment("用户名")]public string UserName { get; set; }[Comment("密码")]public string Password { get; set; }[Comment("邮箱")][EmailAddress]public string? Email { get; set; }public List<Role>? Roles { get; set; }internal void Deconstruct(out string userName, out string password){(userName, password) = (UserName, Password);}
}

2、定义service层通用接口

public interface IBaseService<T,Key,Context> where T:BaseModel<Key> where Context:DbContext
{Context GetContext();DbSet<T> GetDbSet();/// <summary>/// 查询表中所有数据,并返回一个数组/// </summary>/// <returns></returns>Task<T[]> GetAllToArrayAsync();/// <summary>/// 保存一条记录/// </summary>/// <param name="entity">需要保存的对象</param>/// <returns></returns>Task<int> SaveAsync(T entity);/// <summary>/// 通过主键更新数据/// </summary>/// <param name="entity">需要更新的对象数据</param>/// <returns></returns>Task<int> UpdateByIdAsync(T entity);/// <summary>/// 先检查数据是否存在,再通过主键更新数据/// </summary>/// <param name="entity">需要更新的对象数据</param>/// <param name="notFoundMessage">数据不存在的提示信息</param>/// <returns></returns>Task<int> UpdateByIdAsync(T entity, string notFoundMessage);/// <summary>/// 根据主键删除数据/// </summary>/// <param name="id">主键</param>/// <returns></returns>Task<int> DeleteByIdAsync(Key id);/// <summary>/// 先检查数据是否存在,再根据主键删除数据/// </summary>/// <param name="id">主键</param>/// <param name="notFoundMessage">数据不存在的提示信息</param>/// <returns></returns>Task<int> DeleteByIdAsync(Key id, string notFoundMessage);/// <summary>/// 根据主键批量删除数据/// </summary>/// <param name="ids">主键的数组或集合</param>/// <returns></returns>Task<int> DeleteByIdsAsync(IEnumerable<Key> ids);/// <summary>/// 先检查数据是否存在,再根据主键批量删除数据/// </summary>/// <param name="ids">主键的数组或集合</param>/// <param name="notFoundMessage">数据都不存在的提示信息</param>/// <returns></returns>Task<int> DeleteByIdsAsync(IEnumerable<Key> ids,string notFoundMessage);/// <summary>/// 执行事务操作/// </summary>/// <param name="execute">在事务中执行的代码</param>/// <returns></returns>Task ExecuteTransactionAsync(Func<Task> execute);
}

这个接口用到了三个泛型,T表示实体类的类型,必须是BaseModel的子类,Key表示主键类型,Context表示数据库上下文类型,并且定义了很多抽象方法,其中GetContext方法可以返回数据库上下文类型,这意味着可以在controller层通过调用这个方法获取数据库上下文对象,简单的查询只要一行代码就能实现,GetDbSet方法可以返回DbSet对象,其他方法可以根据自己的需要来定义。

3、定义service层通用实现类

public class BaseService<T,Key,Context> : IBaseService<T,Key,Context> where T :BaseModel<Key> where Context:DbContext
{protected readonly Context context;protected readonly DbSet<T> dbSet;public BaseService(Context context, DbSet<T> dbSet){this.context = context;this.dbSet = dbSet;}public Context GetContext(){return context;}public DbSet<T> GetDbSet(){return dbSet;}public Task<int> DeleteByIdAsync(Key id){return dbSet.Where(data => data.Id.Equals(id)).ExecuteDeleteAsync();}public async Task<int> DeleteByIdAsync(Key id, string notFoundMessage){var exist = await dbSet.AnyAsync(data => data.Equals(id));if (!exist){throw new AdminException(notFoundMessage);}return await dbSet.Where(data => data.Id.Equals(id)).ExecuteDeleteAsync();}public Task<int> DeleteByIdsAsync(IEnumerable<Key> ids){return dbSet.Where(data => ids.Contains(data.Id)).ExecuteDeleteAsync();}public async Task<int> DeleteByIdsAsync(IEnumerable<Key> ids, string notFoundMessage){var exist=await dbSet.AnyAsync(data => ids.Contains(data.Id));if (!exist){throw new AdminException(notFoundMessage);}return await dbSet.Where(data => ids.Contains(data.Id)).ExecuteDeleteAsync();}public Task<T[]> GetAllToArrayAsync(){return dbSet.ToArrayAsync();}public Task<int> SaveAsync(T entity){dbSet.Add(entity);return context.SaveChangesAsync();}public async Task<int> UpdateByIdAsync(T entity, string notFoundMessage){var exist = await dbSet.AnyAsync(data => data.Id.Equals(entity.Id));if (!exist){throw new AdminException(notFoundMessage);}dbSet.Update(entity);return await context.SaveChangesAsync();}public Task<int> UpdateByIdAsync(T entity){dbSet.Update(entity);return context.SaveChangesAsync();}public async Task ExecuteTransactionAsync(Func<Task> execute){using var transaction=context.Database.BeginTransaction();try{await execute();await transaction.CommitAsync();}catch (Exception ex){throw ex;transaction.RollbackAsync();}}
}

这个类继承了IBaseService接口,并实现了接口中的方法,其中context和dbSet属性需要通过构造方法传入进来。
下一步就是要继承这些类和接口,进行调用,以用户的crud操作为例

4、定义用户的service层接口

public interface IUserService:IBaseService<User,long,SystemDbContext>
{}

这个接口继承了IBaseService接口,传入了实体类型、主键类型、数据库上下文类型,这三个泛型。前面定义的通用方法可以通过这个接口继承下来,一些复杂的crud操作方法,就需要自己再去定义。

5、定义用户的service层实现类

public class UserService : BaseService<User,long,SystemDbContext>,IUserService
{public UserService(SystemDbContext context):base(context,context.Users){}
}

这个类型继承了BaseService类和IUserService接口,并且通过构造方法注入了数据库上下对象,并调用父类的构造方法,将context对象和Dbset对象传给BaseService类
当然,要为这个类注册服务

services.AddScoped<IUserService, UserService>();

6、在controller层接口调用通用的crud方法

[HttpDelete]
public Task<Result<object>> Delete(long[] ids)
{return ExecuteCatchAsync(() => userService.DeleteByIdsAsync(ids, "用户不存在"));
}

其中,DeleteByIdsAsync方法就是前面定义的通用crud方法,将来再写其他业务的接口,就不需要再去定义这个方法了。

这篇关于使用EFCore封装Service层CRUD代码的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!


原文地址:
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.chinasem.cn/article/1081935

相关文章

Java Thread中join方法使用举例详解

《JavaThread中join方法使用举例详解》JavaThread中join()方法主要是让调用改方法的thread完成run方法里面的东西后,在执行join()方法后面的代码,这篇文章主要介绍... 目录前言1.join()方法的定义和作用2.join()方法的三个重载版本3.join()方法的工作原

Spring AI使用tool Calling和MCP的示例详解

《SpringAI使用toolCalling和MCP的示例详解》SpringAI1.0.0.M6引入ToolCalling与MCP协议,提升AI与工具交互的扩展性与标准化,支持信息检索、行动执行等... 目录深入探索 Spring AI聊天接口示例Function CallingMCPSTDIOSSE结束语

Linux系统之lvcreate命令使用解读

《Linux系统之lvcreate命令使用解读》lvcreate是LVM中创建逻辑卷的核心命令,支持线性、条带化、RAID、镜像、快照、瘦池和缓存池等多种类型,实现灵活存储资源管理,需注意空间分配、R... 目录lvcreate命令详解一、命令概述二、语法格式三、核心功能四、选项详解五、使用示例1. 创建逻

在Java中使用OpenCV实践

《在Java中使用OpenCV实践》用户分享了在Java项目中集成OpenCV4.10.0的实践经验,涵盖库简介、Windows安装、依赖配置及灰度图测试,强调其在图像处理领域的多功能性,并计划后续探... 目录前言一 、OpenCV1.简介2.下载与安装3.目录说明二、在Java项目中使用三 、测试1.测

C++中detach的作用、使用场景及注意事项

《C++中detach的作用、使用场景及注意事项》关于C++中的detach,它主要涉及多线程编程中的线程管理,理解detach的作用、使用场景以及注意事项,对于写出高效、安全的多线程程序至关重要,下... 目录一、什么是join()?它的作用是什么?类比一下:二、join()的作用总结三、join()怎么

mybatis中resultMap的association及collectio的使用详解

《mybatis中resultMap的association及collectio的使用详解》MyBatis的resultMap定义数据库结果到Java对象的映射规则,包含id、type等属性,子元素需... 目录1.reusltmap的说明2.association的使用3.collection的使用4.总

Spring Boot配置和使用两个数据源的实现步骤

《SpringBoot配置和使用两个数据源的实现步骤》本文详解SpringBoot配置双数据源方法,包含配置文件设置、Bean创建、事务管理器配置及@Qualifier注解使用,强调主数据源标记、代... 目录Spring Boot配置和使用两个数据源技术背景实现步骤1. 配置数据源信息2. 创建数据源Be

Java中使用 @Builder 注解的简单示例

《Java中使用@Builder注解的简单示例》@Builder简化构建但存在复杂性,需配合其他注解,导致可变性、抽象类型处理难题,链式编程非最佳实践,适合长期对象,避免与@Data混用,改用@G... 目录一、案例二、不足之处大多数同学使用 @Builder 无非就是为了链式编程,然而 @Builder

在MySQL中实现冷热数据分离的方法及使用场景底层原理解析

《在MySQL中实现冷热数据分离的方法及使用场景底层原理解析》MySQL冷热数据分离通过分表/分区策略、数据归档和索引优化,将频繁访问的热数据与冷数据分开存储,提升查询效率并降低存储成本,适用于高并发... 目录实现冷热数据分离1. 分表策略2. 使用分区表3. 数据归档与迁移在mysql中实现冷热数据分

mybatis-plus QueryWrapper中or,and的使用及说明

《mybatis-plusQueryWrapper中or,and的使用及说明》使用MyBatisPlusQueryWrapper时,因同时添加角色权限固定条件和多字段模糊查询导致数据异常展示,排查发... 目录QueryWrapper中or,and使用列表中还要同时模糊查询多个字段经过排查这就导致只要whe