C# 数据操作系列 - 14 深入探索SqlSugar

2024-02-15 14:36:46

0.前言

在上一篇中，我们知道了如何使用SqlSugar，但是也只是简单的了解了如何使用，仿佛是套着镣铐行走，这明显不符合一个合格的程序员应有的素养。所以，这一篇我们将对其进行深挖，探究其背后的秘密。

1. 花式映射

在实际开发中，程序中的实体类和数据库的表名并不能完全一致，造成的原因有很多，例如说团队对数据库的命名和对程序的命名有着不同的要求，数据库是先建立的而程序是后开发的，又或者是程序只使用了数据库中一部分表等等。

这时候就会与C#约定优于配置相违背，但是这也符合C#的设计哲学，因为配置也是C#的一部分。我们该如何从实际角度来完成表与实体类之间的关系建立呢？

那就让我来带着大家一起看看SqlSugar是否能优雅的完成这一部分：

1.1 Attribute设置

SqlSugar预制了一些Attribute，允许我们通过Attribute来为实体表与数据库表之间建立关系：

SugarTable：用来定义实体类映射的数据表

public SugarTable(string tableName);
public SugarTable(string tableName, string tableDescription);

这是SugarTable的两个构造函数，允许设置表名和数据表描述

SugarColumn：用来定义属性与数据表中的列的关系

public string ColumnDataType { get; set; }// 列的数据类型，填SQL 的数据类型
public string OldColumnName { get; set; }// 当做了表更新之后，用来生成数据库用，此处填写原列名
public bool IsNullable { get; set; }// 设置列是否允许为NULL
public int Length { get; set; } // 设置列的数据长度
public string ColumnDescription { get; set; }// 设置列的描述名称
public bool IsIdentity { get; set; }         // 设置该列是否是自增列
public bool IsPrimaryKey { get; set; }        //设置该列是主键
public bool IsIgnore { get; set; }            // 不作数据库操作，true将不会进行查询、添加等操作
public string ColumnName { get; set; }        // 设置对应的列名
public string DefaultValue { get; set; }    // 设置该列的默认值

SqlSugar的Attribute配置非常的简单，只需要针对类与表的映射和属性对列的映射做出配置即可。

1.2 动态配置

与EF等一样，SqlSugar也支持动态配置，那么就跟着我一起去看看，如何实现动态配置吧：

SqlSugar支持的动态配置功能较少，最好是预先设计好了数据库，然后使用动态配置做好关联。

通过SugarClient设置数据表的动态配置：

Client.MappingTables.Add

方法有：

public void Add(string entityName, string dbTableName);
public void Add(string entityName, string dbTableName, string dbTableShortName);
public void Add(MappingTable table);

然后通过SugarClient设置列的动态配置：

Client.MmappingColumn.Add

方法有：

public void Add(string propertyName, string dbColumnName, string entityName);
public void Add(MappingColumn col);

显然，动态配置并不支持设置列的其他内容。当然，SugarClient还可以配置忽略字段：

Client.IgnoreColumns.Add

具体实现方法如下：

public void Add(string propertyName, string EntityName);
publiv void Add(IgnoreColumn col);

1.3 As 别名模式

SqlSugar在增删改查的时候，为数据实体添加了别名处理，使用方法As(string newName)即可。

Queryable<T>().As("newName")   //select * from newName
Insertable
Updateable
Deleteable

类似与SQL的别名查询

2. 外键关联

SqlSugar中并没有设置导航属性的正式加载，而是添加了一个Mapper方法：在查询的时候，调用Mapper映射外键关系，以达到导航属性一起加载的功能。

首先需要注意的是，在SqlSugar中导航属性需要配置为忽略，避免被直接解析为SQL，否则会提示Sequence contains no elements。

添加几个示例类：

[SugarTable("P_Person")]
public class Person
{
    [SugarColumn(IsPrimaryKey = true, IsIdentity = true)]
    public int Id { get; set; }
    public string Name { get; set; }
    public int Age { get; set; }
    /// <summary>
    /// 忽略
    /// </summary>
    [SugarColumn(IsIgnore = true)]
    public Employee Employee { get; set; }
}

public class Employee
{
    [SugarColumn(IsPrimaryKey = true, IsIdentity = true)]
    public int Id { get; set; }
    public string Name { get; set; }
    public int PersonId { get; set; }
    [SugarColumn(IsIgnore = true)]
    public Person Person { get; set; }
    public int DeptId{get;set;}
    [SugarColumn(IsIgnore = true)]
    public Dept Dept{get;set;}
}

public class Dept
{
    [SugarColumn(IsPrimaryKey = true, IsIdentity = true)]
    public int Id { get; set; }
    public string Name { get; set; }
    [SugarColumn(IsIgnore = true)]
    public List<Employee> Employees{get;set;}
}

使用上一篇的Context类：

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<Person, Employee, Dept>();
        Client.Aop.OnLogExecuting = (sql, paramters) =>
        {
            Console.WriteLine(sql);
        };
    }
}

简单介绍一下，

InitTables这个方法，SqlSugar提供了很多重载版本，但推荐使用以下三个：

void InitTables(string entitiesNamespace);
void InitTables(string[] entitiesNamespaces);
void InitTables(params Type[] entityTypes);

前两个，可以约定实体类的命名空间，然后一次性初始化所有实体类。第三个初始化传入的实体类类型实例，也可以根据一定规则反射遍历出需要的类。

OnLogExecuting是SqlSugar 的一个监听事件（虽然它不是事件，但我个人觉得写成事件模式比较好），作用是监控框架执行的SQL语句，可以用来调试或者做日志监控等。

使用Mapper查询一对一映射类型：

var results = context.Client.Queryable<Employee>().Mapper(t=>t.Person, p=>p.PersonId).ToList();

使用Mapper查询一对多映射类型：

var results = context.Client.Queryable<Dept>().Mapper(p => p.Employees, p => p.Employees.First().DeptId).ToList();

需要注意的是，这两个是固定写法。

其中，一对一要求必须从主对象开始查询。所谓主对象就是必须持有一个外键指向另一个表。

一对多要求从拥有集合属性的那段（也就是其中的“一”）开始，关联指示为集合.First().外键。

还有一点就是SqlSugar的导航属性必须手动加载，不会自动加载进来，所以完全不会出现深度递归的问题。

3. 总结

这一篇我们一起探索了如何自定义表和实体类之间的映射关系，下一篇将为大家写一个实用的模板类，包括数据库基本查询功能。以上是本篇内容，期待后续哦～

码农公寓