EF7数据库提供者的自定义值生成器

退思养草

本文将讲解提供者使用值生成器的原理。因代码太多，本文只摘要重要代码，并且删除了代码中的注释。
SqlServer提供者：

Microsoft.EntityFrameworkCore.SqlServer
如下代码：我们可以看到提供者已经帮我们实现好了顺序Guid自定义值生成器。

1. public class SequentialGuidValueGenerator : ValueGenerator<Guid>
2. {
3.     private long _counter = DateTime.UtcNow.Ticks;
5.     public override Guid Next(EntityEntry entry)
6.     {
7.         var guidBytes = Guid.NewGuid().ToByteArray();
8.         var counterBytes = BitConverter.GetBytes(Interlocked.Increment(ref _counter));
10.         if (!BitConverter.IsLittleEndian)
11.         {
12.             Array.Reverse(counterBytes);
13.         }
15.         guidBytes[08] = counterBytes[1];
16.         guidBytes[09] = counterBytes[0];
17.         guidBytes[10] = counterBytes[7];
18.         guidBytes[11] = counterBytes[6];
19.         guidBytes[12] = counterBytes[5];
20.         guidBytes[13] = counterBytes[4];
21.         guidBytes[14] = counterBytes[3];
22.         guidBytes[15] = counterBytes[2];
24.         return new Guid(guidBytes);
25.     }
27.     public override bool GeneratesTemporaryValues => false;
28. }

复制代码

有了值生成器，我们来看看数据库提供者是如何使用的？首先它帮我们写了生成值选择器，看代码我们会发现。
只有属性为Guid类型，并且是需要生成值的状态下自动使用 SequentialGuidValueGenerator 值生成器。
如下代码所示：

1. public class SqlServerValueGeneratorSelector : RelationalValueGeneratorSelector
2. {
3.     protected override ValueGenerator? FindForType(IProperty property, IEntityType entityType, Type clrType)
4.         => property.ClrType.UnwrapNullableType() == typeof(Guid)
5.             ? property.ValueGenerated == ValueGenerated.Never || property.GetDefaultValueSql() != null
6.                 ? new TemporaryGuidValueGenerator()
7.                 : new SequentialGuidValueGenerator()
8.             : base.FindForType(property, entityType, clrType);
9. }

复制代码

SqlServerValueGeneratorSelector 将附加到 AddEntityFrameworkSqlServer 中第109行。
AddEntityFrameworkSqlServer 将被附加到 ApplyServices 中第66行。
最终 ApplyServices 将为EF 核心内部API 解释服务与功能。
MySql提供者：

Pomelo.EntityFrameworkCore.MySql
首先，MySql提供者与SqlServer提供者的原理是一样的机制。不过为了适配Mysql的uuid（RFC 4122）规范，提供者写了属于Mysql的顺序Guid自定义值生成器。

1. public class MySqlSequentialGuidValueGenerator  : ValueGenerator<Guid>
2. {
4.     private readonly IMySqlOptions _options;
6.     public MySqlSequentialGuidValueGenerator(IMySqlOptions options)
7.     {
8.         _options = options;
9.     }
11.     private static readonly RandomNumberGenerator _rng = RandomNumberGenerator.Create();
13.     public override Guid Next(EntityEntry entry)
14.     {
15.         return Next();
16.     }
18.     public Guid Next()
19.     {
20.         return Next(DateTimeOffset.UtcNow);
21.     }
23.     public Guid Next(DateTimeOffset timeNow)
24.     {
25.         var randomBytes = new byte[7];
26.         _rng.GetBytes(randomBytes);
27.         var ticks = (ulong) timeNow.Ticks;
29.         var uuidVersion = (ushort) 4;
30.         var uuidVariant = (ushort) 0b1000;
32.         var ticksAndVersion = (ushort)((ticks << 48 >> 52) | (ushort)(uuidVersion << 12));
33.         var ticksAndVariant = (byte)  ((ticks << 60 >> 60) | (byte)  (uuidVariant << 4));
35.         if (_options.ConnectionSettings.GuidFormat == MySqlGuidFormat.LittleEndianBinary16)
36.         {
37.             var guidBytes = new byte[16];
38.             var tickBytes = BitConverter.GetBytes(ticks);
39.             if (BitConverter.IsLittleEndian)
40.             {
41.                 Array.Reverse(tickBytes);
42.             }
44.             Buffer.BlockCopy(tickBytes, 0, guidBytes, 0, 6);
45.             guidBytes[6] = (byte)(ticksAndVersion << 8 >> 8);
46.             guidBytes[7] = (byte)(ticksAndVersion >> 8);
47.             guidBytes[8] = ticksAndVariant;
48.             Buffer.BlockCopy(randomBytes, 0, guidBytes, 9, 7);
50.             return new Guid(guidBytes);
51.         }
53.         var guid = new Guid((uint) (ticks >> 32), (ushort) (ticks << 32 >> 48), ticksAndVersion,
54.             ticksAndVariant,
55.             randomBytes[0],
56.             randomBytes[1],
57.             randomBytes[2],
58.             randomBytes[3],
59.             randomBytes[4],
60.             randomBytes[5],
61.             randomBytes[6]);
63.         return guid;
64.     }
66.     public override bool GeneratesTemporaryValues => false;
67. }

复制代码

与SqlServer提供者同理，值生成器附加到MysqlValueGeneratorSelector，MysqlValueGeneratorSelector又附加到 AddEntityFramwrokMySql中，AddEntityFramwrokMySql又被附加到AppServices中。
使用方式

只有在属性为Guid类型，并且是需要生成值的状态下自动使用 SequentialGuidValueGenerator 值生成器。

1. builder.Property(p => p.Id).ValueGeneratedOnAdd();

复制代码

总结

我们了解到了EF的数据库提供者使用值生成器的原理，知道了每个数据库的Guid算法不一样。还了解到我们使用EF时，不用过多的关心数据库数据类型值的生成方式，这些提供者都帮我们做到了。

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