C# 数据操做系列 - 15 SqlSugar 增删改查详解

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<T> CreateClient<T>() where T : class, new()
    {
        return Client.GetSimpleClient<T>();
    }
}

SqlSugar 提供了一个SimpleClient，这里面有不少能够直接拿来用的方法，并且这个是一个泛型类。也就是说咱们可使用它对单个实体类进行操做，这在开发中很重要。

2. 插入数据

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

2.1 简单的插入模式

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

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

默认状况下，SqlSugar插入并不会将主键返回给数据。若是后续操做须要当前数据的主键，则能够调用另一个方法：

public int InsertReturnIdentity(T insertObj);

经过这个方法能够获取一个默认的int类型主键值。

2.2 高级玩法

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

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

这种模式与SimpleClient的普通插入模式不一样，它并不会直接执行插入动做，须要手动调用并执行插入动做：

int ExecuteCommand();

执行动做，而后返回受影响的行数。

bool ExecuteCommandIdentityIntoEntity();

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

long ExecuteReturnBigIdentity();
int ExecuteReturnIdentity();

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

有一点值得特别注意：

全部会返回主键的插入都只针对单个数据，若是一次插入多个数据，并不会返回主键信息也没法将主键信息更新入实体中。

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

IInsertable<T> InsertColumns(Expression<Func<T, object>> columns);// 知足条件的插入，其余列则不插入
IInsertable<T> InsertColumns(params string[] columns);//插入指定列名

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

3. 更新或插入

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

3.1 简单模式

先来两个最简单的：

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

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

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

这是另外一种条件更新，会更新知足whereExpression的全部元素，更新示例：

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

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

3.2 高级模式

一样，经过AsUpdateable开启高级模式：

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

而后能够针对这些今天更多的操做：

int ExecuteCommand();

返回命令执行影响的行数

bool ExecuteCommandHasChange();

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

• 只更新某些列：

IUpdateable<T> SetColumns(Expression<Func<T, bool>> columns);

更新示例：

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

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

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

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

• 不更新某些列

IUpdateable<T> IgnoreColumns(params string[] columns);// 忽略传入的列名
IUpdateable<T> IgnoreColumns(Expression<Func<T, object>> columns);// 用匿名对象表示要忽略的列名
IUpdateable<T> IgnoreColumns(bool ignoreAllNullColumns, bool isOffIdentity = false, bool ignoreAllDefaultValue = false);// 设置是否忽略Null列，是否强制更新主键，是否忽略全部默认值列

• 条件更新

IUpdateable<T> Where(Expression<Func<T, bool>> expression);
IUpdateable<T> Where(string fieldName, string conditionalType, object fieldValue);
IUpdateable<T> Where(string whereSql, object parameters = null);
IUpdateable<T> WhereColumns(Expression<Func<T, object>> columns);
IUpdateable<T> WhereColumns(string columnName);
IUpdateable<T> WhereColumns(string[] columnNames);

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

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

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

3.3 更新或插入

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

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

不过这个方法是在SugarClient里，咱们能够经过：

public ISqlSugarClient AsSugarClient();

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

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

4. 删除

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

public bool Delete(Expression<Func<T, bool>> 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<T, bool>> whereExpression);// 查询是否存在符合条件的数据
public int Count(Expression<Func<T, bool>> whereExpression);// 获取知足条件的数量

public T GetById([Dynamic] dynamic id);//根据主键获取一个实例
public bool IsAny(Expression<Func<T, bool>> whereExpression);//返回知足条件的一个对象

public List<T> GetList();// 以List的形式返回全部数据
public List<T> GetList(Expression<Func<T, bool>> whereExpression);//返回符合条件的全部数据

分页获取数据：

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

public List<T> GetPageList(List<IConditionalModel> conditionalList, PageModel page);
public List<T> GetPageList(List<IConditionalModel> conditionalList, PageModel page, Expression<Func<T, object>> 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<string,object> 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<IConditionalModel>
{
    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的知识点和设置。

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