.NET Framework アプリを単一ファイル化するのに ILRepack を使う... が、似たような NuGet パッケージがいっぱいあるぞ問題

.NET Framework でも単一ファイル化

.NET Core 3.x および、その後継である .NET 5 や 6 などの SDK では、ビルド後に出力される .dll ファイル群をまとめてひとつの実行ファイルに変換する、「単一ファイル生成」の機能が備わっている。

しかしながら .NET Framework アプリで同じように「単一ファイル化」したい場合、SDK によるサポートはない。

このような場合は、ILMerge であるとか ILRepack といったツールを使うことで、.NET Framework アプリでも単一ファイル化が実現できる。

ただし、ILMerge はすでに開発が停止しているようだ。

なので、実質的には ILRepack の一択なのだろうと思われる。

nuget.org で "ILRepack" を検索してみたら...

ということで、自分の .NET Framework ベースのプロダクトでも単一ファイル化を行ないたく、nuget.org で ILRepack のパッケージを探してみた。

そうしたところ、なんだか似たような名前の、紛らわしい NuGet パッケージが複数、検索結果にでてきてしまった。

いったいどれを選択するのが正解なのだろう?

とりあえず ILRepack.Lib.MSBuild.Task でよさそう

とりあえず、現在時点での自分の見解を先に書いておくと、ILRepack.Lib.MSBuild.Task を使っておくと良さそうだ。

但し、nuget.org で検索語句 "ILRepack" でヒットしたすべての NuGet パッケージを試したわけではなく、

• 上記 ILRepack.Lib.MSBuild.Task と、
• ILRepack.MSBuild.Task (パッケージ名が凄く紛らわしいが、パッケージ名に "Lib" が入っているかどうかで区別できる) と、
• 検索結果トップの ILRepack

の、以上たかだか 3 パッケージしか評価していない。

その上での私見なので、そこはご勘弁頂きたい。

自分が試した範疇では、.NET Framework アプリのプロジェクトに ILRepack.Lib.MSBuild.Task NuGet パッケージを追加し、Release ビルドするだけで、出力フォルダ内に散在していた .dll 群がまとめられて単一ファイル化した実行ファイルを生成できるようになった。

他のパッケージは?

さて、自分が試してみた残る 2 つのパッケージについてはどうか。

まず、パッケージ名がそのものズバリの ILRepack。

この NuGet パッケージは ILRepack.exe を収録しているのみであった。

MSBuild タスクや MSBuild スクリプトは収録されていないため、かなり扱いにくい。

ということでこの時点で選外とした。

次いで、ILRepack.MSBuild.Task。

こちらは MSBuild タスク定義までが収録されている。

MSBuild スクリプトまでは収録されていないため、このパッケージをプロジェクトに追加しただけでは、単一ファイル化は実行されない。

とはいえ、下記のような MSBuild スクリプトをプロジェクトファイル (.csproj) 内の末尾に書き足すことで、単一ファイル化が実現できた。

  ...

  <Target Name="MakeSingleBinary" AfterTargets="PostBuildEvent" Condition="false">

    <PropertyGroup>

      <ILRepackDir>$(ProjectDir)..\_dist\</ILRepackDir>

    </PropertyGroup>

    <MakeDir Directories="$(ILRepackDir)" />

    <ILRepack OutputType="$(OutputType)" 

              MainAssembly="$(AssemblyName).exe" 

              OutputAssembly="$(ILRepackDir)$(AssemblyName).exe" 

              InputAssemblies="*.dll" 

              WilcardInputAssemblies="true" 

              WorkingDirectory="$(TargetDir)" />

  </Target>

</Project>

だがしかし、NuGet パッケージのメタデータに含まれる依存関係に、どういうわけか Microsoft.Buid.Framework が指定されてしまっており、おそらくはこれが原因であろう、フレームワーク提供の .dll ファイル群 (例えば System.Net.Http.dll のような) までもが出力フォルダ内にぶちまけられてしまっていた。

それを雑に、出力フォルダ内のすべての .dll をまとめる対象に指定してしまったものだがら、それら本来ならばランタイム環境から提供されるので収録不要な .dll ファイル群もすべて含んだ単一ファイル化がなされてしまった。

単一ファイル化後のファイルサイズでいうと、ILRepack.Lib.MSBuild.Task を使った場合は 6 KB ほどだったプログラムが、ILRepack.MSBuild.Task を使った場合は 1 MB を超えてしまった。

おまけに、フレームワーク提供の .dll 間での InternalVisibleTo 関係も壊れてしまうため、プログラムに依っては、その実行時に
「System.MethodAccessException: Attempt by method '...' to access method '...' failed」

例外を吐いて死んでしまうようになってしまった。

以上のとおり、ILRepack.MSBuild.Task も扱いにくいことが判明し、採用は見送りとした。

まとめ

ということで、.NET Framework アプリを単一ファイル化したい場合は、ILRepack.Lib.MSBuild.Task NuGet パッケージを使っておくのが無難そうだ。

ただし同じような名前のパッケージがあるので、取り違えに注意されたし。