.NET Core で Microsoft XML シリアライザー ジェネレーターを使用する

このチュートリアルでは、C# アプリケーションで Microsoft XML シリアライザー ジェネレーターを使用する方法について説明します。 このチュートリアルでは、次の内容を学習します。

.NET Framework の Xml シリアライザー ジェネレーター (sgen.exe) と同様に、 Microsoft.XmlSerializer.Generator NuGet パッケージ は、.NET Core/.NET 5 以降および .NET Standard プロジェクトと同等です。 アセンブリに含まれる型の XML シリアル化アセンブリが作成され、 XmlSerializerを使用してそれらの型のオブジェクトをシリアル化または逆シリアル化するときの XML シリアル化のスタートアップ パフォーマンスが向上します。

[前提条件]

このチュートリアルを完了するには:

• .NET Core 2.1 SDK 以降。
• お気に入りのコード エディター。

次の手順では、.NET Core コンソール アプリケーションで XML シリアライザー ジェネレーターを使用する方法を示します。

アプリを作成する

1. コマンド プロンプトを開き、 MyApp という名前のフォルダーを作成します。 作成したフォルダーに移動し、次のコマンドを入力します。

   dotnet new console
   

2. Microsoft.XmlSerializer.Generator パッケージへの参照を追加します。

   dotnet add package Microsoft.XmlSerializer.Generator -v 8.0.0
   

   このコマンドを実行すると、 MyApp.csproj プロジェクト ファイルに次の行が追加されます。

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

3. 次の ItemGroup セクションをプロジェクト ファイルに追加して、ツール参照を追加します。

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

4. テキスト エディターで Program.cs を開きます。 Program.csに MyClass という名前のクラスを追加します。

   public class MyClass
   {
      public int Value;
   }
   

5. XmlSerializerをMyClassのために作成します。 Program.cs ファイルに次の行を追加します。

   var serializer = new System.Xml.Serialization.XmlSerializer(typeof(MyClass));
   

6. アプリケーションをビルドして実行します。 dotnet runを使用してアプリケーションを実行します。

   dotnet run
   

   アプリは、実行時に事前に生成されたシリアライザーを自動的に読み込んで使用します。

   ヒント

   dotnet run は dotnet build を呼び出してビルド ターゲットがビルドされたことを確認してから、 dotnet <assembly.dll> を呼び出してターゲット アプリケーションを実行します。

すべてが成功すると、 MyApp.XmlSerializers.dll という名前のアセンブリが出力フォルダーに生成されます。

おめでとうございます! 今回の成果:

XML シリアル化アセンブリをさらにカスタマイズする (省略可能)

次の XML を MyApp.csproj に追加して、アセンブリの生成をさらにカスタマイズします。

<PropertyGroup>
    <SGenReferences>C:\myfolder\abc.dll;C:\myfolder\def.dll</SGenReferences>
    <SGenTypes>MyApp.MyClass;MyApp.MyClass1</SGenTypes>
    <SGenProxyTypes>false</SGenProxyTypes>
    <SGenVerbose>true</SGenVerbose>
    <SGenKeyFile>mykey.snk</SGenKeyFile>
    <SGenDelaySign>true</SGenDelaySign>
</PropertyGroup>

関連リソース

• XML シリアル化の概要
• XmlSerializer を使用してシリアル化する方法 (C#)
• 方法: XmlSerializer を使用してシリアル化する (Visual Basic)