アセンブリのシャドウコピー

[アーティクル]
08/09/2011

シャドウコピーを使用すると、アプリケーションドメインで使用されているアセンブリを、アプリケーションドメインをアンロードせずに更新できます。この機能は、ASP.NET サイトのような途切れずに稼働させる必要があるアプリケーションに特に役立ちます。

アセンブリが読み込まれるときに共通言語ランタイムがアセンブリファイルをロックするため、アセンブリがアンロードされるまでそのファイルは更新できません。アプリケーションドメインからアセンブリをアンロードする唯一の方法は、アプリケーションドメインをアンロードすることです。このため、通常の状況では、アセンブリを使用しているすべてのアプリケーションドメインがアンロードされるまで、ディスク上でアセンブリを更新できません。

アプリケーションドメインがファイルをシャドウコピーするように構成されている場合は、アプリケーションパスにあるアセンブリが別の場所にコピーされ、その場所から読み込まれます。このコピーはロックされますが、元のアセンブリファイルはロックされず、更新できます。

重要
シャドウコピーできるアセンブリは、アプリケーションディレクトリまたはそのサブディレクトリに格納されているアセンブリに限られます。これらのディレクトリは、アプリケーションドメインが構成されるときに、ApplicationBase プロパティと PrivateBinPath プロパティで指定されます。グローバルアセンブリキャッシュに格納されているアセンブリは、シャドウコピーされません。

シャドウコピーできるアセンブリは、アプリケーションディレクトリまたはそのサブディレクトリに格納されているアセンブリに限られます。これらのディレクトリは、アプリケーションドメインが構成されるときに、ApplicationBase プロパティと PrivateBinPath プロパティで指定されます。グローバルアセンブリキャッシュに格納されているアセンブリは、シャドウコピーされません。

この記事は、次のセクションで構成されています。

「シャドウコピーの有効化と使用」では、シャドウコピーの基本的な使用方法と使用可能なオプションについて説明します。
「起動時のパフォーマンス」では、起動時のパフォーマンスを向上させるために .NET Framework Version 4 のシャドウコピーに対して行われた変更と、旧バージョンの動作に戻す方法について説明します。
「互換性のために残されているメソッド」では、.NET Framework 2.0 のシャドウコピーを制御するプロパティとメソッドに対して行われた変更について説明します。

シャドウコピーの有効化と使用

AppDomainSetup クラスのプロパティを次のように使用して、シャドウコピーのアプリケーションドメインを構成できます。

シャドウコピーを有効にするために、ShadowCopyFiles プロパティを "true" という文字列値に設定します。

既定では、この設定によってアプリケーションパス内のすべてのアセンブリが、ダウンロードキャッシュにコピーされてから読み込まれるようになります。このキャッシュは、共通言語ランタイムが他のコンピューターからダウンロードされたファイルを格納するために保持しているキャッシュと同じです。共通言語ランタイムは、不要になったファイルを自動的に削除します。

必要に応じて、シャドウコピーされるファイルのカスタムの場所を、CachePath プロパティおよび ApplicationName プロパティを使用して設定します。

この場所を表す基本パスを構成するには、ApplicationName プロパティを、サブディレクトリである CachePath プロパティに連結します。アセンブリは、基本パス自体ではなく、このパスのサブディレクトリにシャドウコピーされます。

メモ
ApplicationName プロパティが設定されていない場合は、CachePath プロパティが無視され、ダウンロードキャッシュが使用されます。例外をスローすることはありません。

カスタムの場所を指定した場合は、ディレクトリおよびコピーされたファイルが不要になった時点で、それらを手動で削除する必要があります。これらは自動的に削除されません。

シャドウコピーされるファイルに対してカスタムの場所を設定するのには、いくつかの理由があります。アプリケーションが大量のコピーを生成する場合は、シャドウコピーされるファイルに対してカスタムの場所を設定する必要が生じることがあります。ダウンロードキャッシュには、有効期間ではなくサイズ上の制限があります。このため、共通言語ランタイムがまだ使用中のファイルを削除しようとする可能性があります。カスタムの場所を設定するもう 1 つの理由は、共通言語ランタイムがダウンロードキャッシュに使用するディレクトリの場所に対する書き込みアクセス権を、アプリケーションを実行するユーザーが持っていない場合があることです。

必要に応じて、シャドウコピーされるアセンブリを、ShadowCopyDirectories プロパティを使用して制限します。

アプリケーションドメインに対してシャドウコピーを有効にすると、既定でアプリケーションパス内、つまり、ApplicationBase プロパティと PrivateBinPath プロパティによって指定されるディレクトリ内のすべてのアセンブリがコピーされます。コピーの対象を選択したディレクトリに限定するには、シャドウコピーするディレクトリのみを含めた文字列を作成し、その文字列を ShadowCopyDirectories プロパティに割り当てます。ディレクトリ間は、セミコロン (;) で区切ります。これで、シャドウコピーされるアセンブリが、選択したディレクトリ内のアセンブリのみとなります。

重要
セミコロンは区切り記号文字であるため、ディレクトリパスにセミコロンを含めることはできません。セミコロンのエスケープ文字はありません。

起動時のパフォーマンス

シャドウコピーを使用するアプリケーションドメインが開始する際に、アプリケーションディレクトリ内のアセンブリがシャドウコピーディレクトリにコピーされるとき、または、アセンブリがその場所に既に存在する場合はアセンブリが検証されるときに、遅延が発生します。 .NET Framework 4 より前では、すべてのアセンブリが一時ディレクトリにコピーされていました。各アセンブリが開かれてアセンブリ名が検証され、厳密な名前が検証されました。各アセンブリがチェックされ、シャドウコピーディレクトリにあるコピーよりも後に更新されているかどうかが確認されました。更新されている場合は、シャドウコピーディレクトリにコピーされました。最後に、一時コピーが破棄されました。

.NET Framework 4 以降の起動時の既定の動作では、アプリケーションディレクトリ内の各アセンブリのファイルの日時が、シャドウコピーディレクトリ内のコピーのファイルの日時と直接比較されます。アセンブリが更新されている場合は、旧バージョンの .NET Framework と同じ手順を使用してコピーされます。更新されていない場合は、シャドウコピーディレクトリ内のコピーが読み込まれます。

その結果としてパフォーマンスが最大に向上するのは、アセンブリが頻繁には変更されず、通常はアセンブリの小さなサブセット内で変更が行われるアプリケーションです。アプリケーションのアセンブリの大部分が頻繁に変更される場合は、新しい既定の動作によってパフォーマンスが低下することがあります。 enabled="false" を指定して構成ファイルに <shadowCopyVerifyByTimestamp> 要素を追加することで、以前のバージョンの .NET Framework の起動時の動作に戻すことができます。

互換性のために残されているメソッド

AppDomain クラスには、アプリケーションドメインでのシャドウコピーを制御するために使用できる SetShadowCopyFiles や ClearShadowCopyPath などのいくつかのメソッドがありますが、.NET Framework Version 2.0 では、これらのメソッドが互換性のために残されています。アプリケーションドメインをシャドウコピー対応として構成する場合は、AppDomainSetup クラスのプロパティを使用する方法が推奨されます。