SqlSugar基础用法

项肜

SQLSugar是什么

**1. 轻量级ORM框架，专为.NET CORE开发人员设计，它提供了简单、高效的方式来处理数据库操作，使开发人员能够更轻松地与数据库进行交互
2. 简化数据库操作和数据访问，允许开发人员在C#代码中直接操作数据库，而不需要编写复杂的SQL语句
3. 支持多种数据库，包括但不限于MYSQL、SQLSERVER、SQLITE、ORACLE等**
使用SQLSugar的优点与缺点

优点：

1. 高性能：相比EF等ORM框架，SQLSUGAR在性能上表现出色。在大数据的写入、更新和查询统计方面，SQLSUGAR的性能是EF的数倍。此外，它在批量操作和一对多查询上也进行了不错的SQL优化。
2. 高扩展性：SQLSUGAR支持自定义拉姆达函数解析、扩展数据类型、自定义实体特性，以及外部缓存等功能，这些都使得其具有较高的可扩展性。
3. 稳定性：虽然不是官方的ORM框架，但SQLSUGAR在稳定性上也有着数年用户积累。如果遇到问题，可以在GITHUB上提出，开发者会根据紧急度定期解决。
4. 功能全面：虽然SQLSUGAR体积小巧，但其功能并不逊色于其他大型ORM框架，如EF。
5. 生态丰富与多库兼容：SQLSUGAR支持多种数据库，为开发者提供了灵活的选择。同时，它还提供了详细的文档、教程以及专业技术支持，为开发者提供了全方位的服务。
6. 易用性：SQLSUGAR的使用非常简单，它提供了各种默认值作为最佳配置，开发者只需关注自己的业务逻辑即可。这种易用性大大降低了学习成本，提高了开发效率。
缺点

没啥大缺点
SQLSugar基础使用

安装SQLSugarCore包

创建上下文类

配置链接字符串--这块有点坑、以下这种格式可能会爆错、SLL证书错误

以下是我的链接字符串

Data Source=.;Initial Catalog=SQLSugarDemo;Integrated Security=True;Trust Server Certificate=True

注册SQLSugar--我封装了Ioc

在控制器定义方法进行迁移数据库

当然你也可以用命令进行迁移

Sugar迁移命令：
dotnet ef migrations add 生成文件夹名称 --project SqlSugarTests.WebAPI.csproj
dotnet ef database update
迁移命令有点麻烦还不一定能迁移成功，可以用ef或者方法进行迁移
以下是基础用法(增删改查)

我大概是给整复杂了，我封装了一下、我再研究研究给整简单点
定义泛型接口

接口与实现

``
点击查看代码

1. public interface IRepository<T> where T : class,new()
2. {
3.      // 插入（增）  
4.      Task<int> Insert(T entity);
5.      // 根据ID查询（查）  
6.      Task<T> GetById(int id);
7.      //删除
8.      Task<int> DeleteById(int id);
10.      // 更新（改）  
11.      Task<bool> Update(T entity, Expression<Func<T, bool>> whereCondition);
13.      // 删除（删）  
14.      Task<bool> Delete(Expression<Func<T, bool>> whereCondition);
16.      // 查询（查）  
17.      Task<T> Get(Expression<Func<T, bool>> whereCondition);
19.      // 查询列表  
20.      Task<List<T>> GetAll(Expression<Func<T, bool>> whereCondition = null);
21.      
22. }

复制代码

``
点击查看代码

1. public class Repository<T> : IRepository<T> where T : class, new()
2. {
3.     private readonly ISqlSugarClient _db;
5.     public Repository(ISqlSugarClient db)
6.     {
7.         _db = db;
8.     }
9.     // 插入（增）  
10.     public async Task<int> Insert(T entity)
11.     {
12.         try
13.         {
14.             return await _db.Insertable(entity).ExecuteCommandAsync();
15.         }
16.         catch (Exception ex)
17.         {
18.             // 处理异常或记录日志  
19.             throw;
20.         }
21.     }
22.     // 更新（改）  
23.     public async Task<bool> Update(T entity, Expression<Func<T, bool>> whereCondition)
24.     {
25.         try
26.         {
27.             var updateable = _db.Updateable(entity).Where(whereCondition);
28.             return await updateable.ExecuteCommandAsync() > 0;
29.         }
30.         catch (Exception ex)
31.         {
32.             // 处理异常或记录日志  
33.             throw;
34.         }
35.     }
36.     // 删除（删）  
37.     public async Task<bool> Delete(Expression<Func<T, bool>> whereCondition)
38.     {
39.         try
40.         {
41.             return await _db.Deleteable<T>().Where(whereCondition).ExecuteCommandAsync() > 0;
42.         }
43.         catch (Exception ex)
44.         {
45.             // 处理异常或记录日志  
46.             throw;
47.         }
48.     }
49.     // 查询（查）  
50.     public async Task<T> Get(Expression<Func<T, bool>> whereCondition)
51.     {
52.         try
53.         {
54.             return await _db.Queryable<T>().Where(whereCondition).SingleAsync();
55.         }
56.         catch (Exception ex)
57.         {
58.             // 处理异常或记录日志  
59.             return null;
60.         }
61.     }
63.     // 查询列表  
64.     public async Task<List<T>> GetAll(Expression<Func<T, bool>> whereCondition = null)
65.     {
66.         try
67.         {
68.             var query = _db.Queryable<T>();
69.             if (whereCondition != null)
70.             {
71.                 query = query.Where(whereCondition);
72.             }
73.             return await query.ToListAsync();
74.         }
75.         catch (Exception ex)
76.         {
77.             // 处理异常或记录日志  
78.             return null;
79.         }
80.     }
81.     //查询单个
82.     public async Task<T> GetById(int id)
83.     {
84.         // 使用SQLSugar的Queryable API来获取单个实体  
85.         var result = _db.Queryable<T>().InSingle(id);
86.         // 注意：这里result已经是DepartmentModel的实例或null（如果没有找到）  
87.         // 因为InSingle是同步的，所以不需要await  
88.         return result;
89.     }
90.     /// <summary>
91.     /// 删除
92.     /// </summary>
93.     /// <param name="id"></param>
94.     /// <returns></returns>
95.     public async Task<int> DeleteById(int id)
96.     {
97.         var result =_db.Deleteable<T>().In(id).ExecuteCommand();
98.         return result;
99.     }
101.     #region 其他扩展
102.     public async Task<bool> Delete<T1>(int id)
103.     {
104.         throw new NotImplementedException();
105.     }
106.     public async Task<List<T1>> GetAll<T1>()
107.     {
108.         throw new NotImplementedException();
109.     }
110.     public T1 GetById<T1>(int id)
111.     {
112.         throw new NotImplementedException();
113.     }
114.     public int Insert<T1>(T1 entity)
115.     {
116.         throw new NotImplementedException();
117.     }
118.     public bool Update<T1>(T1 entity, int? id = null)
119.     {
120.         throw new NotImplementedException();
121.     }
122.     #endregion
124. }

复制代码

然后我封装了IocServer

这段代码主要做了两件事：
将ISqlSugarClient注册为Scoped服务到依赖注入容器中，并配置了数据库连接和AOP日志记录。

将SqlSugarContext（可能是一个封装了ISqlSugarClient的上下文类）也注册为Scoped服务，并确保它能够从DI容器中获取到ISqlSugarClient的实例。

``
点击查看代码

1. public static void AddRepositoryServer(this WebApplicationBuilder builder)
2. {
3.      // 直接注册 ISqlSugarClient 到 DI 容器  
4.      builder.Services.AddScoped<ISqlSugarClient>(sp => new SqlSugarClient(new ConnectionConfig()
5.      {
6.          ConnectionString = builder.Configuration.GetConnectionString("SQLSugar"), //数据库连接串
7.          DbType = DbType.SqlServer,      //数据库类型
8.          IsAutoCloseConnection = true, //自动释放
9.          MoreSettings = new ConnMoreSettings()
10.          {
11.              SqlServerCodeFirstNvarchar = true,//建表字符串默认Nvarchar
12.          }
13.      }, db =>
14.      {
15.          db.Aop.OnLogExecuting = (sql, pars) =>
16.          {
17.              Console.WriteLine(sql);//生成执行Sql语句
18.          };
19.      }
20.      ));
21.      builder.Services.AddScoped<SqlSugarContext>(sp => new SqlSugarContext(sp.GetRequiredService<ISqlSugarClient>()));
22. }

复制代码

在Program进行注册

控制器里使用

``
点击查看代码

1. public readonly SqlSugarContext db;
2. private readonly IRepository<DepartmentModel> _repository;
3. public SQLSugarController(SqlSugarContext context, IRepository<DepartmentModel> repository)
4. {
6.     this.db = context;
7.     this._repository = repository;
8. }
9. /// <summary>
10. /// 创建表
11. /// </summary>
12. /// <returns></returns>
13. [HttpGet("CreateTable")]
14. public IActionResult CreateTable()
15. {
16.     db.CreateTable();
17.     return Ok("执行成功！");
18. }
19. // 添加部门  
20. [HttpPost("AddDepartment")]
21. public async Task<IActionResult> AddDepartment([FromBody] DepartmentModel departmentModel)
22. {
23.     if (ModelState.IsValid)
24.     {
25.         int result = await _repository.Insert(departmentModel);
26.         if (result > 0)
27.         {
28.             return Ok(new { message = "部门添加成功", departmentId = departmentModel.DepartMentId });
29.         }
30.         else
31.         {
32.             return BadRequest(new { message = "部门添加失败" });
33.         }
34.     }
35.     else
36.     {
37.         return BadRequest(ModelState);
38.     }
39. }
41. // 更新部门  
42. [HttpPut("UpdateDepartment")]
43. public async Task<IActionResult> UpdateDepartment(int id, [FromBody] DepartmentModel departmentModel)
44. {
45.     if (ModelState.IsValid && departmentModel.DepartMentId == id)
46.     {
47.         bool result = await _repository.Update(departmentModel);
48.         if (result)
49.         {
50.             return Ok(new { message = "部门更新成功" });
51.         }
52.         else
53.         {
54.             return BadRequest(new { message = "部门更新失败" });
55.         }
56.     }
57.     else
58.     {
59.         return BadRequest(ModelState);
60.     }
61. }
63. // 删除部门  
64. [HttpDelete("DeleteDepartment")]
65. public async Task<IActionResult> DeleteDepartment(int id)
66. {
67.     int result = await _repository.DeleteById(id);
68.     if (result!=0)
69.     {
70.         return Ok(new { message = "部门删除成功" });
71.     }
72.     else
73.     {
74.         return NotFound(new { message = "未找到要删除的部门" });
75.     }
76. }
77. [HttpGet("GetDepartment")]
78. public async Task<IActionResult> GetDepartment(int id)
79. {
80.     DepartmentModel department = await _repository.GetById(id);
81.     if (department != null)
82.     {
83.         // 将DepartmentModel转换为DepartmentDto，这里只是一个简单的示例  
84.         //var departmentDto = new DepartmentDto { DepartMentId = department.DepartMentId };
85.         return Ok(department);
86.     }
87.     else
88.     {
89.         return NotFound(new { message = "未找到要获取的部门" });
90.     }
91. }
92. // 获取所有部门  
93. [HttpGet("GetAllDepartments")]
94. public async Task<IActionResult> GetAllDepartments()
95. {
96.     List<DepartmentModel> departments = await _repository.GetAll();
97.     return Ok(departments);
98. }

复制代码

官方网站：
果糖网： https://www.donet5.com/
这只是基础的使用，后续我也会发进阶用法，小伙伴们自己研究吧！加油、未来可期

来源:https://www.cnblogs.com/beiluoshimen/p/18243934
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！