百度360必应搜狗淘宝本站头条
python判断字典是否为空crontab每周一执行aes和des区别安装指定版本npmadb pull
当前位置：网站首页 > IT知识 > 正文

C# 数据操作系列 - 15 SqlSugar 增删改查详解(超长篇)

liuian 2025-04-05 20:08 16 浏览

0. 前言

继上一篇，以及上上篇，我们对SqlSugar有了一个大概的认识，但是这并不完美，因为那些都是理论知识，无法描述我们工程开发中实际情况。而这一篇，将带领小伙伴们一起试着写一个能在工程中使用的模板类。



1. 创建一个Client

SqlSugar在操作的时候需要一个Client，用来管理数据库连接，并操作数据库。所以我们写一个DbContext用来创建Client：

public class DefaultContext
{
    public SqlSugarClient Client { get; }

    public DefaultContext(string connectionString, DbType dbType)
    {
        Client = new SqlSugarClient(new ConnectionConfig
        {
            ConnectionString = connectionString,//"Data Source=./demo.db",
            DbType = dbType,
            IsAutoCloseConnection = true,
            InitKeyType = InitKeyType.Attribute
        });
        Client.CodeFirst.InitTables(typeof(Dept), typeof(Person), typeof(Employee));
        Client.Aop.OnLogExecuting = (sql, paramters) =>
        {
            Console.WriteLine(sql);
        };
    }

    public SimpleClient CreateClient() where T : class, new()
    {
        return Client.GetSimpleClient();
    }
}

SqlSugar 提供了一个SimpleClient，这里面有很多可以直接拿来用的方法，而且这个是一个泛型类。也就是说我们可以使用它对单个实体类进行操作，这在开发中很重要。



2. 插入数据

对于一个程序而言，数据就像是血液一样重要。对于ORM框架，插入是一切来源的基础。所以我们先来看看SqlSugar的插入是怎样的吧：

2.1 简单的插入模式

public bool Insert(T insertObj);
public bool InsertRange(T[] insertObjs);
public bool InsertRange(List insertObjs);

这是SqlSugar在SimpleClient里提供的两个默认插入方法，一个是插入单个实体对象，一个是插入一组对象。

默认情况下，SqlSugar插入并不会将主键返回给数据。如果后续操作需要当前数据的主键，则可以调用另外一个方法：

public int InsertReturnIdentity(T insertObj);

通过这个方法可以获取一个默认的int类型主键值。

2.2 高级玩法

SqlSugar还有一种插入模式，通过AsInsertable返回一个 IInsertable泛型接口：

public IInsertable AsInsertable(T insertObj);
public IInsertable AsInsertable(T[] insertObjs);
public IInsertable AsInsertable(List insertObjs);

这种模式与SimpleClient的普通插入模式不同，它并不会直接执行插入动作，需要手动调用并执行插入动作：

int ExecuteCommand();

执行动作，然后返回受影响的行数。

bool ExecuteCommandIdentityIntoEntity();

执行动作，然后将主键插入实体对象，返回插入结果。执行完成后，主键数据保存到实体示例中。

long ExecuteReturnBigIdentity();
int ExecuteReturnIdentity();

执行动作，然后返回主键值，不会更新实体。

有一点值得特别注意：

所有会返回主键的插入都只针对单个数据，如果一次插入多个数据，并不会返回主键信息也无法将主键信息更新入实体中。

以上都是全列插入，SqlSugar还提供了只插入部分列和忽略某些列两种模式：

IInsertable InsertColumns(Expression<Func> columns);// 满足条件的插入，其他列则不插入
IInsertable InsertColumns(params string[] columns);//插入指定列名
IInsertable IgnoreColumns(Expression<Func> columns);// 忽略满足条件的列，插入其他列
IInsertable IgnoreColumns(params string[] columns);// 忽略这几个列
IInsertable IgnoreColumns(bool ignoreNullColumn, bool isOffIdentity = false);//指定是否忽略Null列，并是否强制插入主键


3. 更新或插入

介绍完插入，那么来介绍一下更新。正所谓，没有更新数据就是一滩死水，有了更新数据才有了变化。所以，就让我们来看看如何优雅的更新数据吧：

3.1 简单模式

先来两个最简单的：

public bool Update(T updateObj);
public bool UpdateRange(T[] updateObjs);
public bool UpdateRange(List updateObjs);

传入实体，直接更新到数据库中，需要注意的是这种更新模式只需要保证主键有值，且与之对应即可。

public bool Update(Expression<Func> columns, Expression<Func> whereExpression);

这是另一种条件更新，会更新满足whereExpression的所有元素，更新示例：

personClient.Update(p=>new Person
{
    Age = 1
}, p=>p.Id == 1);

columns需要返回一个要更新的对象的属性列，也就是在columns中设置需要更新的内容。

3.2 高级模式

同样，通过AsUpdateable开启高级模式：

public IUpdateable AsUpdateable(T[] updateObjs);
public IUpdateable AsUpdateable(T updateObj);
public IUpdateable AsUpdateable(List updateObjs);

然后可以针对这些今天更多的操作：

int ExecuteCommand();

返回命令执行影响的行数

bool ExecuteCommandHasChange();

返回是否有变化，也就是影响行数是否大于0。

  • 只更新某些列：
IUpdateable SetColumns(Expression<Func> columns);

更新示例：

personClient.AsUpdateable(d).SetColumns(t=>t.Age ==2).ExecuteCommand();

传入一个lambda表达式，使数据满足lambda表达式。要求lambda表达式只能用 == 来判断列是否等于某个值。

IUpdateable SetColumns(Expression<Func> columns);
IUpdateable UpdateColumns(params string[] columns);
IUpdateable UpdateColumns(Expression<Func> columns);

传入要更新的实际列名。其中 object 用来接一个匿名对象，其中属性名字就是要更新的值。

  • 不更新某些列
IUpdateable IgnoreColumns(params string[] columns);// 忽略传入的列名
IUpdateable IgnoreColumns(Expression<Func> columns);// 用匿名对象表示要忽略的列名
IUpdateable IgnoreColumns(bool ignoreAllNullColumns, bool isOffIdentity = false, bool ignoreAllDefaultValue = false);// 设置是否忽略Null列，是否强制更新主键，是否忽略所有默认值列
  • 条件更新
IUpdateable Where(Expression<Func> expression);
IUpdateable Where(string fieldName, string conditionalType, object fieldValue);
IUpdateable Where(string whereSql, object parameters = null);
IUpdateable WhereColumns(Expression<Func> columns);
IUpdateable WhereColumns(string columnName);
IUpdateable WhereColumns(string[] columnNames);

来，简单猜一猜这几个是什么意思呢？

可以说很简单明了的几种条件设置模式，lambda表示筛选更新数据，字段值判断条件更新。

其中 conditionType的值，推荐使用 ConditionalType枚举的值。

3.3 更新或插入

在实际开发中可能会遇到插入或更新是走的一个方法，所以我们就要寻找一个可以直接更新或插入的方法。SqlSugar为此提供了解决方案：

ISaveable Saveable(T saveObject) where T : class, new();
ISaveable Saveable(List saveObjects) where T : class, new();

不过这个方法是在SugarClient里，我们可以通过：

public ISqlSugarClient AsSugarClient();

在SimpleClient中获得 与之关联的SugarClient对象。

关于更新或插入判断标准是，主键是否有值。如果主键有值且在数据库中存在该条记录，则执行更新，否则执行插入。


4. 删除

删除在实际开发过程中是一个非常重要的功能点，所以如何快速有效的删除数据也是一件很重要的事。那么，就来看看如何执行删除吧：

public bool Delete(Expression<Func> whereExpression);
public bool Delete(T deleteObj);
public bool DeleteById([Dynamic] dynamic id);
public bool DeleteByIds([Dynamic(new[] { false, true })] dynamic[] ids);

删除没有其他需要注意的地方，第一个是条件删除，所有满足条件的都要删除。第二个删除单个对象，后面两个根据主键删除对象。

悄悄吐槽一下，主键的地方用object会比较好一点，因为动态对象会增加一次装箱拆箱的过程。

当然了，删除也有AsDeleteable方法。IDeleteable接口特别提供了根据sql语句删除的方法，除此之外没有别的需要注意的地方了。


5. 查询

一个好的ORM框架，至少五分功力在查询上，如何更快更准的查询成为了现在开发对ORM框架的要求。同时简单易用更是程序员对ORM的期望。

那么我们来看看SqlSugar在查询上的功力吧：

public bool IsAny(Expression<Func> whereExpression);// 查询是否存在符合条件的数据
public int Count(Expression<Func> whereExpression);// 获取满足条件的数量
public T GetById([Dynamic] dynamic id);//根据主键获取一个实例
public bool IsAny(Expression<Func> whereExpression);//返回满足条件的一个对象
public List GetList();// 以List的形式返回所有数据
public List GetList(Expression<Func> whereExpression);//返回符合条件的所有数据

分页获取数据：

public List GetPageList(Expression<Func> whereExpression, PageModel page);
public List GetPageList(Expression<Func> whereExpression, PageModel page, Expression<Func> orderByExpression = null, OrderByType orderByType = OrderByType.Asc);
public List GetPageList(List conditionalList, PageModel page);
public List GetPageList(List conditionalList, PageModel page, Expression<Func> orderByExpression = null, OrderByType orderByType = OrderByType.Asc);

其中IConditionModel是一个空的接口，用来定义规范查询规范，实际上使用的是类：

public class ConditionalModel: IConditionalModel
{
    public ConditionalModel()
    {
        this.ConditionalType = ConditionalType.Equal;
    }
    public string FieldName { get; set; }
    public string FieldValue { get; set; }
    public ConditionalType ConditionalType { get; set; }
    public Func FieldValueConvertFunc { get; set; }
}

那么，我们看一下 ConditionType，定义了各种判断依据：

public enum ConditionalType
{
    Equal=0,
    Like=1,
    GreaterThan =2,
    GreaterThanOrEqual = 3,
    LessThan=4,
    LessThanOrEqual = 5,
    In=6,
    NotIn=7,
    LikeLeft=8,
    LikeRight=9,
    NoEqual=10,
    IsNullOrEmpty=11,
    IsNot=12,
    NoLike = 13,
}

那么我们简单看一下 使用IConditionModel进行分页是怎样的效果：

var list = personClient.GetPageList(new List
{
    new ConditionalModel
    {
        FieldName = "Age",
        FieldValue = "3",
        ConditionalType = ConditionalType.LessThan
    }
}, pageModel);

生成如下SQL语句：

SELECT COUNT(1) FROM (SELECT `Id`,`Name`,`Age` FROM `Person`  WHERE   Age < @ConditionalAge0  ) CountTable 
SELECT `Id`,`Name`,`Age` FROM `Person`   WHERE   Age < @ConditionalAge0      LIMIT 0,2

可以看出两者并没有区别，只不过是不同的查询习惯。

6. 总结

按照之前的习惯，到目前应该可以结束了。但是SqlSugar还有一些很重要的地方没有介绍，所以就加个下期预告

下一篇将为大家分析SqlSugar的一些更高级的内容，查询的高级模式、事务以及批量操作

好，总结一下这一篇，我们在这一篇看到了SqlSugar在增删改查上的亮点，可以说更贴合实际业务需求开发。嗯，悄悄给个赞。

再有三篇的内容《C# 数据操作系列》就要完结了。从下一系列开始，就要步入工作中最重要的技术栈了：Asp.net Core。这是可以写入简历的。嗯，没错。下一系列计划以实战的形式介绍asp.net core的知识点和设置。

更多内容烦请关注我的博客《高先生小屋》

相关推荐

总结下SpringData JPA 的常用语法

SpringDataJPA常用有两种写法，一个是用Jpa自带方法进行CRUD，适合简单查询场景、例如查询全部数据、根据某个字段查询，根据某字段排序等等。另一种是使用注解方式，@Query、@Modi...

解决JPA在多线程中事务无法生效的问题

在使用SpringBoot2.x和JPA的过程中，如果在多线程环境下发现查询方法（如@Query或findAll）以及事务（如@Transactional）无法生效，通常是由于S...

PostgreSQL系列(一):数据类型和基本类型转换

自从厂子里出来后，数据库的主力就从Oracle变成MySQL了。有一说一哈，贵确实是有贵的道理，不是开源能比的。后面的工作里面基本上就是主MySQL，辅MongoDB、ES等NoSQL。最近想写一点跟...

基于MCP实现text2sql

目的：基于MCP实现text2sql能力参考：https://blog.csdn.net/hacker_Lees/article/details/146426392服务端#选用开源的MySQLMCP...

ORACLE 错误代码及解决办法

ORA-00001:违反唯一约束条件(.)错误说明：当在唯一索引所对应的列上键入重复值时，会触发此异常。ORA-00017:请求会话以设置跟踪事件ORA-00018:超出最大会话数ORA-00...

从 SQLite 到 DuckDB:查询快 5 倍，存储减少 80%

作者丨Trace译者丨明知山策划丨李冬梅Trace从一开始就使用SQLite将所有数据存储在用户设备上。这是一个非常不错的选择——SQLite高度可靠，并且多种编程语言都提供了广泛支持...

010:通过 MCP PostgreSQL 安全访问数据

项目简介提供对PostgreSQL数据库的只读访问功能。该服务器允许大型语言模型（LLMs）检查数据库的模式结构，并执行只读查询操作。核心功能提供对PostgreSQL数据库的只读访问允许L...

发现了一个好用且免费的SQL数据库工具(DBeaver)

缘起最近Ai不是大火么，想着自己也弄一些开源的框架来捣腾一下。手上用着Mac，但Mac都没有显卡的，对于学习Ai训练模型不方便，所以最近新购入了一台4090的拯救者，打算用来好好学习一下Ai（呸，以上...

微软发布.NET 10首个预览版:JIT编译器再进化、跨平台开发更流畅

IT之家2月26日消息，微软.NET团队昨日（2月25日）发布博文，宣布推出.NET10首个预览版更新，重点改进.NETRuntime、SDK、libraries、C#、AS...

数据库管理工具Navicat Premium最新版发布啦

管理多个数据库要么需要使用多个客户端应用程序，要么找到一个可以容纳你使用的所有数据库的应用程序。其中一个工具是NavicatPremium。它不仅支持大多数主要的数据库管理系统（DBMS），而且它...

50+AI新品齐发，微软Build放大招:拥抱Agent胜算几何?

北京时间5月20日凌晨，如果你打开微软Build2025开发者大会的直播，最先吸引你的可能不是一场原本属于AI和开发者的技术盛会，而是开场不久后的尴尬一幕：一边是几位微软员工在台下大...

揭秘:一条SQL语句的执行过程是怎么样的?

数据库系统能够接受SQL语句，并返回数据查询的结果，或者对数据库中的数据进行修改，可以说几乎每个程序员都使用过它。而MySQL又是目前使用最广泛的数据库。所以，解析一下MySQL编译并执行...

各家sql工具，都闹过哪些乐子?

相信这些sql工具，大家都不陌生吧，它们在业内绝对算得上第一梯队的产品了，但是你知道，他们都闹过什么乐子吗？首先登场的是Navicat，这款强大的数据库管理工具，曾经让一位程序员朋友“火”了一把。Na...

详解PG数据库管理工具--pgadmin工具、安装部署及相关功能

概述今天主要介绍一下PG数据库管理工具--pgadmin，一起来看看吧~一、介绍pgAdmin4是一款为PostgreSQL设计的可靠和全面的数据库设计和管理软件，它允许连接到特定的数据库，创建表和...

Enpass for Mac(跨平台密码管理软件)

还在寻找密码管理软件吗？密码管理软件有很多，但是综合素质相当优秀且完全免费的密码管理软件却并不常见，EnpassMac版是一款免费跨平台密码管理软件，可以通过这款软件高效安全的保护密码文件，而且可以...

一周热门
最近发表
标签列表