f 数据仓库与分析-深入剖析 SqlSugar 与泛型封装：实现通用数据访问层 - Powered by qidao123.com技术社区

深入剖析 SqlSugar 与泛型封装：实现通用数据访问层

乌市泽哥  论坛元老 | 2025-5-4 18:58:16 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 2021|帖子 2021|积分 6063

马上注册，结交更多好友，享用更多功能，让你轻松玩转社区。

您需要 登录 才可以下载或查看，没有账号？立即注册

x
在现代软件开发中，ORM（对象关系映射）框架的使用已经成为不可或缺的部分，SqlSugar 是一款非常盛行且强大的 ORM框架。它不但提供了简单易用的数据库操纵，还具备了高效的性能和灵活的设置方式。为了进一步提升数据库操纵的灵活性和复用性，结合 泛型 进行封装是一种非常有效的方式。在本文中，我们将结合 SqlSugar 和泛型，深入探讨如何通过封装来简化数据库操纵，并实现一个通用的数据访问层。
1. 安装与设置 SqlSugar

首先，我们需要安装 SqlSugar 库并进行基本设置。SqlSugar 支持多种数据库类型，包罗 SQL Server、MySQL、SQLite 等。我们可以通过 NuGet 来安装 SqlSugar。
安装 SqlSugar

在 Visual Studio 中使用 NuGet 包管理器控制台执行以下命令：
  1. Install-Package SqlSugar
复制代码
或者通过 .NET CLI 安装：
  1. dotnet add package SqlSugar
复制代码
安装完成后，我们需要设置数据库连接和创建 SqlSugarClient 实例：
  1. using SqlSugar;
  3. public class SqlSugarHelper
  4. {
  5.     private static SqlSugarClient db;
  7.     static SqlSugarHelper()
  8.     {
  9.         db = new SqlSugarClient(new ConnectionConfig()
  10.         {
  11.             // 数据库连接字符串
  12.             ConnectionString = "Server=localhost;Database=TestDB;User Id=sa;Password=12345;",
  13.             DbType = DbType.SqlServer, // 选择数据库类型
  14.             IsAutoCloseConnection = true, // 自动关闭连接
  15.             InitKeyType = InitKeyType.Attribute // 使用属性标记主键
  16.         });
  17.     }
  19.     public static SqlSugarClient GetInstance()
  20.     {
  21.         return db;
  22.     }
  23. }
复制代码
此时，我们已完成基础设置，可以开始进行数据库操纵。
2. 泛型封装的基本头脑

在实际开发中，常常需要对多个数据表进行类似的增、删、改、查操纵。为了避免重复代码并进步代码的复用性，我们可以通过 泛型 将这些操纵封装成一个通用的类，从而支持对差异实体类的操纵。
通过创建一个 Repository（仓储）类来封装所有基本的数据库操纵，我们可以在需要时，快速实例化一个泛型仓储类，进行统一的数据操纵。
3. 封装数据库操纵

3.1 泛型仓储类的实现

我们首先实现一个通用的 Repository 类，利用泛型来处置惩罚所有基本的数据库操纵，包罗查询、插入、更新和删除。这样，无论操纵哪个实体类，我们只需要实例化一次仓储类即可。
  1. using SqlSugar;
  2. using System;
  3. using System.Collections.Generic;
  4. using System.Linq;
  6. public class Repository<T> where T : class, new()
  7. {
  8.     private readonly SqlSugarClient db;
  10.     public Repository(SqlSugarClient db)
  11.     {
  12.         this.db = db;
  13.     }
  15.     #region 查询操作
  17.     // 根据ID查询单个数据
  18.     public T GetById(int id)
  19.     {
  20.         return db.Queryable<T>().InSingle(id);
  21.     }
  23.     // 根据条件查询数据列表
  24.     public List<T> GetList(Func<T, bool> whereExpression)
  25.     {
  26.         return db.Queryable<T>().Where(whereExpression).ToList();
  27.     }
  29.     // 查询所有数据
  30.     public List<T> GetAll()
  31.     {
  32.         return db.Queryable<T>().ToList();
  33.     }
  35.     #endregion
  37.     #region 插入操作
  39.     // 插入一条数据
  40.     public int Insert(T entity)
  41.     {
  42.         return db.Insertable(entity).ExecuteCommand();
  43.     }
  45.     // 批量插入数据
  46.     public int InsertRange(List<T> entities)
  47.     {
  48.         return db.Insertable(entities).ExecuteCommand();
  49.     }
  51.     #endregion
  53.     #region 更新操作
  55.     // 更新一条数据
  56.     public int Update(T entity)
  57.     {
  58.         return db.Updateable(entity).ExecuteCommand();
  59.     }
  61.     // 根据条件更新数据
  62.     public int Update(Func<T, bool> whereExpression, object updateColumns)
  63.     {
  64.         return db.Updateable<T>().SetColumns(updateColumns).Where(whereExpression).ExecuteCommand();
  65.     }
  67.     #endregion
  69.     #region 删除操作
  71.     // 删除一条数据
  72.     public int Delete(int id)
  73.     {
  74.         return db.Deleteable<T>().In(id).ExecuteCommand();
  75.     }
  77.     // 根据条件删除数据
  78.     public int Delete(Func<T, bool> whereExpression)
  79.     {
  80.         return db.Deleteable<T>().Where(whereExpression).ExecuteCommand();
  81.     }
  83.     // 批量删除数据
  84.     public int DeleteRange(List<int> ids)
  85.     {
  86.         return db.Deleteable<T>().In(ids).ExecuteCommand();
  87.     }
  89.     #endregion
  90. }
复制代码
3.2 封装分页查询功能

为了进一步提升通用性，我们可以在仓储类中增长 分页查询 功能。SqlSugar 提供了一个方便的分页方法 ToPageList，结合泛型，我们可以封装一个通用的分页查询方法。
  1. #region 分页查询
  3. // 分页查询
  4. public List<T> GetPageList(int pageIndex, int pageSize, Func<T, bool> whereExpression, out int totalCount)
  5. {
  6.     return db.Queryable<T>()
  7.              .Where(whereExpression)
  8.              .ToPageList(pageIndex, pageSize, out totalCount);
  9. }
  11. #endregion
复制代码
4. 使用泛型仓储类

接下来，我们通过实例化 Repository<T> 来对具体的实体类进行操纵。例如，我们有一个 User 实体类：
  1. public class User
  2. {
  3.     public int Id { get; set; }
  4.     public string Name { get; set; }
  5.     public int Age { get; set; }
  6. }
复制代码
4.1 在 Service 层使用泛型仓储类

我们可以在业务层 (Service) 中使用 Repository<User> 来封装对 User 表的操纵。
  1. public class UserService
  2. {
  3.     private readonly Repository<User> userRepository;
  5.     public UserService(SqlSugarClient db)
  6.     {
  7.         // 初始化泛型仓储类
  8.         userRepository = new Repository<User>(db);
  9.     }
  11.     // 获取所有用户
  12.     public List<User> GetAllUsers()
  13.     {
  14.         return userRepository.GetAll();
  15.     }
  17.     // 根据ID获取用户
  18.     public User GetUserById(int id)
  19.     {
  20.         return userRepository.GetById(id);
  21.     }
  23.     // 根据名称查询用户
  24.     public List<User> GetUsersByName(string name)
  25.     {
  26.         return userRepository.GetList(u => u.Name == name);
  27.     }
  29.     // 插入用户
  30.     public int AddUser(User user)
  31.     {
  32.         return userRepository.Insert(user);
  33.     }
  35.     // 更新用户
  36.     public int UpdateUser(User user)
  37.     {
  38.         return userRepository.Update(user);
  39.     }
  41.     // 删除用户
  42.     public int DeleteUser(int id)
  43.     {
  44.         return userRepository.Delete(id);
  45.     }
  47.     // 批量删除用户
  48.     public int DeleteUsers(List<int> ids)
  49.     {
  50.         return userRepository.DeleteRange(ids);
  51.     }
  52. }
复制代码
4.2 在 Main 方法中调用

  1. class Program
  2. {
  3.     static void Main(string[] args)
  4.     {
  5.         // 配置数据库连接
  6.         var db = new SqlSugarClient(new ConnectionConfig()
  7.         {
  8.             ConnectionString = "Server=localhost;Database=TestDB;User Id=sa;Password=12345;",
  9.             DbType = DbType.SqlServer,
  10.             IsAutoCloseConnection = true
  11.         });
  13.         // 使用 UserService 操作 User 表
  14.         var userService = new UserService(db);
  16.         // 添加新用户
  17.         var newUser = new User { Name = "John", Age = 25 };
  18.         userService.AddUser(newUser);
  20.         // 查询所有用户
  21.         var users = userService.GetAllUsers();
  22.         Console.WriteLine($"共查询到 {users.Count} 个用户");
  24.         // 根据 ID 查询用户
  25.         var user = userService.GetUserById(1);
  26.         Console.WriteLine($"用户 {user.Name} 的年龄是 {user.Age}");
  28.         // 删除用户
  29.         userService.DeleteUser(2);
  30.     }
  31. }
复制代码
5. 总结

通过结合 SqlSugar 和 泛型，我们可以或许实现一个简洁、通用且高效的数据库操纵层。在这篇文章中，我们通过封装一个 Repository 类，将常见的数据库操纵（增、删、改、查）以及分页查询功能都进行了通用化封装。这样，我们可以轻松地处置惩罚差异实体类的数据操纵，减少了重复代码，进步了代码的可复用性和可维护性。
泛型的使用不但让我们可以或许在差异实体类之间共享同一套操纵方法，还使得我们的代码更加简洁、易于扩展。在实际项目中，结合 SqlSugar 和泛型封装，是一种非常有效的办理方案，特殊是对于需要操纵大量数据表的项目，可以或许大幅提升开发效率。
希望本文的示例和思路可以或许资助你在项目中高效地实现数据库操纵和封装。如果你有任何问题或想进一步探讨的内容，欢迎随时提问！

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。
继续阅读请点击广告
回复

使用道具 举报

0 个回复

倒序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

乌市泽哥

论坛元老
这个人很懒什么都没写!

楼主热帖

标签云

渠道 国产数据库 集成商 AI 运维 CIO 存储 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表