.NET Core 中的 XML 序列化生成器深度解析

岑风霖

于 2025-06-10 09:01:53 发布

阅读量375

点赞数 5

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00853/article/details/148548974

.NET Core 中的 XML 序列化生成器深度解析

docs This repository contains .NET Documentation. 项目地址: https://gitcode.com/gh_mirrors/docs2/docs

前言

在 .NET 开发中，XML 序列化是一个常见需求。本文将深入探讨 .NET Core 中的 Microsoft XML Serializer Generator（XML 序列化生成器），帮助开发者理解其工作原理并掌握实际应用技巧。

什么是 XML 序列化生成器？

XML 序列化生成器是一个工具，它能够预先为程序集中的类型生成序列化代码，从而显著提升 XML 序列化的启动性能。在 .NET Framework 时代，我们使用 sgen.exe 工具实现这一功能，而在 .NET Core/.NET 5+ 和 .NET Standard 项目中，这一功能由 Microsoft.XmlSerializer.Generator NuGet 包提供。

为什么需要 XML 序列化生成器？

当使用 XmlSerializer 序列化或反序列化对象时，运行时需要动态生成序列化代码。这个过程会导致：

首次序列化时出现延迟
增加应用程序启动时间
产生运行时编译开销

XML 序列化生成器通过预先生成这些代码，解决了上述问题，特别适合需要频繁进行 XML 序列化的应用场景。

实战：创建使用 XML 序列化生成器的应用

环境准备

确保已安装：

.NET Core 2.1 SDK 或更高版本
任意代码编辑器（如 Visual Studio、VS Code 等）

步骤详解

1. 创建控制台应用

打开命令行工具，执行以下命令：

dotnet new console -n XmlSerializerDemo
cd XmlSerializerDemo

2. 添加 NuGet 包引用

添加 XML 序列化生成器包：

dotnet add package Microsoft.XmlSerializer.Generator

3. 配置项目文件

编辑项目文件（.csproj），添加工具引用：

<ItemGroup>
    <DotNetCliToolReference Include="Microsoft.XmlSerializer.Generator" Version="8.0.0" />
</ItemGroup>

4. 创建可序列化类

在 Program.cs 中添加示例类：

public class Product
{
    public int Id { get; set; }
    public string Name { get; set; }
    public decimal Price { get; set; }
    public DateTime ManufactureDate { get; set; }
}

5. 使用 XmlSerializer

修改 Main 方法：

static void Main(string[] args)
{
    var product = new Product
    {
        Id = 1,
        Name = "Laptop",
        Price = 999.99m,
        ManufactureDate = DateTime.Now
    };

    var serializer = new XmlSerializer(typeof(Product));
    
    using (var writer = new StreamWriter("product.xml"))
    {
        serializer.Serialize(writer, product);
    }
    
    Console.WriteLine("Serialization completed!");
}

6. 构建并运行

执行以下命令：

dotnet build
dotnet run

构建过程会自动生成序列化程序集 XmlSerializerDemo.XmlSerializers.dll。

高级配置选项

XML 序列化生成器提供了多种配置选项，可通过项目文件进行定制：

<PropertyGroup>
    <!-- 指定需要引用的程序集 -->
    <SGenReferences>path\to\assembly1.dll;path\to\assembly2.dll</SGenReferences>
    
    <!-- 明确指定需要生成序列化的类型 -->
    <SGenTypes>XmlSerializerDemo.Product;XmlSerializerDemo.Order</SGenTypes>
    
    <!-- 是否生成代理类型 -->
    <SGenProxyTypes>false</SGenProxyTypes>
    
    <!-- 启用详细输出 -->
    <SGenVerbose>true</SGenVerbose>
    
    <!-- 使用强名称密钥文件 -->
    <SGenKeyFile>mykey.snk</SGenKeyFile>
    
    <!-- 延迟签名 -->
    <SGenDelaySign>true</SGenDelaySign>
</PropertyGroup>