c# - Entity Framework 中 IMigrationMetadata 接口(interface)的用途和语义

Question

我试图找出 EF 中 System.Data.Entity.Migrations.Infrastructure.IMigrationMetadata 接口(interface)的语义。我知道它用于管理和应用数据库迁移。但是我找不到关于它的详细信息。具体来说，我想知道:

1. Source 属性的用途是什么？为什么我使用工具生成迁移时它总是空的？
2. Target 属性的用途是什么？我看到工具正在生成类似 Base64 的东西并放入资源中。它是什么？为什么以这种不友好的格式生成？
3. 是否可以在不使用工具的情况下手动开发迁移？我想这并不容易，因为应该以某种方式生成类似 Base64 的 Target 属性值。我说得对吗？
4. 什么时候真正使用这个接口(interface)？目前我发现迁移器无法自动找到未实现此接口(interface)的迁移。我对吗？这是界面的唯一目的吗？

Answer 1

IMigrationMetadata Interface我知道有以下职责。

1. 通过 ID 属性识别迁移，以便它可以被 Update-Database 等命令识别和包含.
2. 提供通过 Target 属性应用迁移后模型的快照。这用于确定应包含在新迁移中的更改。

我猜测 Source 属性通常不会由工具实现，因为在 Add-Migration 的实现中不需要它。 .该代码可能只是将最近的现有迁移结束时的模型与从代码生成的模型进行比较，以确定需要包含在新迁移中的更改。

Target 属性返回一个 EDMX 格式的模型，该模型已使用 GZipStream 压缩并使用 Convert.ToBase64String 编码。我编写了以下代码来对这些值进行解码和编码。如果您要手动编写迁移代码，您可能会发现这很有用。

using System;
using System.IO;
using System.IO.Compression;
using System.Text;

namespace ConsoleApplication6
{
    class Program
    {
        static void Main()
        {
            var minimalModel = File.ReadAllText("Model1.edmx");

            var encodedMinimalModel = Encode(minimalModel);

            var decodedMinimalModel = Decode(encodedMinimalModel);
        }

        private static string Decode(string encodedText)
        {
            var compressedBytes = Convert.FromBase64String(encodedText);

            var decompressedBytes = Decompress(compressedBytes);

            return Encoding.UTF8.GetString(decompressedBytes);
        }

        private static string Encode(string plainText)
        {
            var bytes = Encoding.UTF8.GetBytes(plainText);

            var compressedBytes = Compress(bytes);

            return Convert.ToBase64String(compressedBytes);
        }

        public static byte[] Decompress(byte[] bytes)
        {
            using (var memorySteam = new MemoryStream(bytes))
            {
                using (var gzipStream = new GZipStream(memorySteam, CompressionMode.Decompress))
                {
                    return ToByteArray(gzipStream);
                }
            }
        }

        private static byte[] ToByteArray(Stream stream)
        {
            using (var resultMemoryStream = new MemoryStream())
            {
                stream.CopyTo(resultMemoryStream);

                return resultMemoryStream.ToArray();
            }
        }

        public static byte[] Compress(byte[] bytes)
        {
            using (var memoryStream = new MemoryStream())
            {
                using (var gzipStream = new GZipStream(memoryStream, CompressionMode.Compress))
                {
                    gzipStream.Write(bytes,0, bytes.Length);
                }

                return memoryStream.ToArray();
            }
        }
    }
}

压缩可能解释了您关于为什么选择非人类可读格式的问题。对于每次迁移，此内容至少重复一次(在 Target 属性中)，并且可能很大，具体取决于模型的大小。压缩节省了空间。

关于这一点，据我所知，实际上只有最后一次迁移才能在应用模型后返回模型的真实表示。 Add-Migration 仅使用该迁移计算新迁移所需的更改。如果您正在处理非常大的模型和/或非常大量的迁移，删除该内容可能是有利的。这篇文章的其余部分介绍了我对 Target 属性的最小值的推导，该属性可用于除最近迁移之外的所有迁移。

Target 属性必须返回一个字符串对象 - 如果 Target 返回 null，调用 update-database 时，调用 System.Data.Entity.Migrations.DbMigrator.ApplyMigration 中的 System.Convert.FromBase64String 时会抛出 ArgumentNullException。

此外，它必须是有效的 XML 文档。当我从 Target 返回一个空字符串时，我收到一个 XmlException 消息“根元素丢失。”。

从现在开始，我使用上面的代码对值进行编码。

我从 <root /> 开始逐步构建模型并没有走得太远。例如，所以我转而丢弃空 EDMX 文件中的元素，该文件是通过向我的项目添加新的“ADO.Net 实体数据模型”然后选择“空模型”选项生成的。这就是结果。

<?xml version="1.0" encoding="utf-8"?>
<edmx:Edmx Version="3.0" xmlns:edmx="http://schemas.microsoft.com/ado/2009/11/edmx">
  <edmx:Runtime>
    <edmx:StorageModels>
      <Schema xmlns="http://schemas.microsoft.com/ado/2009/11/edm/ssdl" Namespace="Model1.Store" Alias="Self" Provider="System.Data.SqlClient" ProviderManifestToken="2005">
      </Schema>
    </edmx:StorageModels>
  </edmx:Runtime>
</edmx:Edmx>

当我使用上面的代码对此进行编码时，这就是结果。

H4sIAAAAAAAEAJVQy07DMBC8I/EP1t6xExASRA1VVTgWIYK4W/amtfCjeN2q/D12HsqJAxdLOzOe2Z3V+uIsO2MkE3wLNa+AoVdBG79v4ZT6mwdYP11frVC7S/OSH/Y5i++KOH/31BS2hUNKx0YIUgd0krgzKgYKfeIqOCF1ELdV9SjqWhQ5ZFfGRt/3k0/G4YDMWJdClHvcBY2WJiZz3WA+xv4vURBpC+xVOqSjVNjC4F3zkoTANtbIbNmh7YG9xXA2GmOefyih488ySd5926016NMi2ElveqT0Eb4wd5Lz7mHZVozrzoeJPy6biKWGCSh95+kXfT3Qv6UBAAA=

请注意确保在源代码管理中为每个迁移保留真实的 Target 值，以防您需要回滚到早期版本。您可以尝试将迁移应用到数据库，然后使用 Visual Studio 生成 EDMX 文件。另一种选择是回滚构成模型的类，然后执行 Add-Migration .从新创建的迁移中获取目标值。