实体框架中IMigrationMetadata接口的用途和语义

Question

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

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

Answer 1

该IMigrationMetadata接口有下列责任,我知道的.

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 element is missing.".

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

我开始逐渐建立模型并没有走得太远,<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=

如果需要回滚到早期版本,请小心确保在源代码管理中保留每个迁移的实际目标值.您可以尝试将迁移应用于数据库,然后使用Visual Studio生成EDMX文件.另一种方法是回滚形成模型的类然后执行Add-Migration.从新创建的迁移中获取Target值.