返回

基于SqlSugar的开发框架循序渐进介绍（4）-- 在数据访问基类中对GUID主键进行自动赋值处理

后端

前言

在数据库设计中，主键的选取往往影响着数据库的性能和易用性。字符串类型或GUID类型的主键，由于其长度固定且无序性，在实际应用中会带来一些不便。为了解决这一问题，本文将介绍如何基于SqlSugar开发框架，在数据访问基类中对GUID主键进行自动赋值处理，从而简化数据插入操作，并保证主键的唯一性和有序性。

背景知识

GUID（全局唯一标识符）是一种128位的十六进制数字，用于生成唯一标识符。它具有无序性和长度固定的特点，常被用作主键。SqlSugar是一个轻量级、高性能的.NET ORM框架，它提供了丰富的API，简化了数据库操作。

实现思路

在基于SqlSugar的开发框架中，可以在数据访问基类中定义一个自动赋值GUID主键的方法。这个方法通过拦截数据插入操作，在插入前自动生成一个新的GUID并赋值给主键字段。

代码实现

下面是一个基于SqlSugar框架实现自动赋值GUID主键的代码示例：

using SqlSugar;
using System;

public class AutoGuidDataFilter : ISqlFilter
{
    public bool Filter(SqlSugarProvider sqlSugar, EntityInfo entityInfo)
    {
        if (entityInfo.Columns.Any(it => it.PropertyInfo.PropertyType == typeof(Guid) && it.IsPrimarykey))
        {
            var primaryKey = entityInfo.Columns.First(it => it.IsPrimarykey);
            if (primaryKey.PropertyInfo.GetValue(entityInfo.EntityValue) == null)
            {
                primaryKey.PropertyInfo.SetValue(entityInfo.EntityValue, Guid.NewGuid());
            }
        }
        return true;
    }
}

使用方法

在使用SqlSugar框架进行数据插入时，可以通过调用SetFilter方法，将AutoGuidDataFilter过滤器添加到插入操作中。

using SqlSugar;

SqlSugarClient db = new SqlSugarClient();
db.SetFilter(new AutoGuidDataFilter());
db.Insertable(entity).ExecuteCommand();

优点

  • 简化数据插入操作： 自动赋值GUID主键，省去了手动生成和赋值主键的步骤，简化了数据插入操作。
  • 保证主键唯一性： GUID主键具有唯一性，可以确保数据库中记录的唯一性。
  • 有序性： 虽然GUID本身是无序的，但是通过使用有序GUID，可以保证主键的插入顺序，便于数据查询和管理。

局限性

  • 对于某些场景，可能需要手动控制主键的生成，此时需要移除自动赋值过滤器。
  • GUID主键的长度较长，可能影响数据库性能。

结语

通过在SqlSugar数据访问基类中实现自动赋值GUID主键，可以简化数据插入操作，保证主键唯一性和有序性。该方法适用于大多数使用GUID主键的场景，大大提高了开发效率和数据管理的便捷性。