Entity Framework 中 IMigrationMetadata 接口的用途和语义

Posted 2023-03-14

【中文标题】Entity Framework 中 IMigrationMetadata 接口的用途和语义

【英文标题】：Purpose and semantic of IMigrationMetadata interface in Entity Framework

【发布时间】：2012-11-23 09:20:23

【问题描述】：

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

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

【参考方案1】：

据我所知，IMigrationMetadata Interface 有以下职责。

通过 ID 属性识别迁移，以便可以被 Update-Database 等命令识别和包含。 在通过 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=

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

【讨论】：

@Scott Munro：感谢您的回答 - 对我的“手动迁移”帮助很大：github.com/loki2302/ef-codefirst-migrations-experiment

【参考方案2】：

我只是在研究这个，因为我想使用 Source 属性来强制执行严格的迁移顺序。

问题1的答案隐藏在DbMigrator.Scaffold中

var scaffoldedMigration
    = _configuration.CodeGenerator.Generate(
        migrationId,
        migrationOperations,
        (sourceModel == _emptyModel.Value)
        || (sourceModel == _currentModel)
        || !sourceMigrationId.IsAutomaticMigration()
            ? null
            : Convert.ToBase64String(modelCompressor.Compress(sourceModel)),
        Convert.ToBase64String(modelCompressor.Compress(_currentModel)),
        @namespace,
        migrationName);

换句话说，只有在之前的迁移是“自动迁移”时才会填充 Source 属性。刚刚测试了一下，自动迁移后的后续迁移会产生这样的结果：

[GeneratedCode("EntityFramework.Migrations", "6.2.0-61023")]
public sealed partial class Fourth : IMigrationMetadata

    private readonly ResourceManager Resources = new ResourceManager(typeof(Fourth));

    string IMigrationMetadata.Id
    
        get  return "201905250916038_Fourth"; 
    

    string IMigrationMetadata.Source
    
        get  return Resources.GetString("Source"); 
    

    string IMigrationMetadata.Target
    
        get  return Resources.GetString("Target"); 
    

【参考方案3】：

你去：EF6 repository on codeplex 你会看到：

public interface IMigrationMetadata

    /// <summary>
    ///     Gets the unique identifier for the migration.
    /// </summary>
    string Id  get; 

    /// <summary>
    ///     Gets the state of the model before this migration is run.
    /// </summary>
    string Source  get; 

    /// <summary>
    ///     Gets the state of the model after this migration is run.
    /// </summary>
    string Target  get; 

您可以获取项目并检查参考资料以了解此接口的使用情况。 base64 的东西是你的模型。再次使用代码，您应该能够跟踪它是如何完成的。

【讨论】：

感谢您的回答，但这真的不是我上面具体问题的答案。

没问题。很高兴它有帮助。