互換性チェック ツール

互換性チェックツールを使用すると、指定されたベースライ ンリリースまたは更新に対して、メタデータの互換性に影響する変更を検出できます。 このように下位互換性を確保します。 Microsoft では、メタデータの互換性確保にこのツールを使用します。

互換性チェックツールは、プラットフォーム更新プログラム 34 の開発ツールの 1 つとして使用できます。 この方法を使用すると、更新プログラムを顧客にインストール、プッシュ配信する前に、ソリューションに旧版のリリースとの下位互換性を持たせることができます。

ツールによって検出される内容

このツールでは、現在のバージョンのメタデータとベースライン バージョンのメタデータが比較されます。 Microsoft が破損を判断してツールに追加したメタデータの変更を検出して報告します。

ツールが検出する互換性を破る変更のリストについては、この記事で後述するツールが検出する互換性を破る変更のリスト セクションを参照してください。

ツールで検出されないもの

このツールでは、データの比較によって識別できる、互換性に影響する変更のみが検出されます。 たとえば、次のような場合に発生する可能性のある、互換性に影響する変更は検出されません。

• 保護されたメソッドまたはパブリック メソッドへの参照が削除されます。
• メソッドの責任が変更されます。

ツールの使用

このツールを使用すると、新しいバージョンが置き換えるバージョンに対して持つメタデータの互換性の問題を検出することができます。 Microsoft は、このツールを使用して、新たな月次更新が前回の月次更新と比較してどのような互換性に影響する変更があったかを検出します。

使用状況

CompatibilityChecker.exe -BaselineDirectory=\<Path to baseline metadata\> -CurrentDirectory=\<Path to current metadata\> -ModuleName=\<Module name\> -OutputFile=\<Output file path\> -LogFile=\<Log file path\>

例

CompatibilityChecker.exe -BaselineDirectory="\\servername\archive\Build1\BaselineMetadata" -CurrentDirectory="E:\\MyCode\\retail\\amd64\\BaselineMetadata" -ModuleName="Directory"
-OutputFile="E:\\Logs\\Directory\\Diagnostics.xml" -LogFile="E:\\Logs\\Directory\\Checkerlog.txt"

説明

このツールは、現在のメタデータと指定されたベースラインのメタデータを比較することで、互換性に影響する変更を識別します。

次のパスを指定する必要があります。

• BaselineDirectory – ベースラインとなるメタデータのパス。
• CurrentDirectory – 現在の (新しい) メタデータのパス。
• OutputFile – 互換性に影響する変更の一覧を含むファイルのパス。

次のルールが適用されます。

• ツールを実行する前に、現在のメタデータをコンパイルする必要があります。
• OutputFile – ファイルには、ツールが識別した互換性に影響する変更のリストが含まれています。
• BaselineDirectory ディレクトリが存在し、指定されたモジュールとその依存関係 (モジュールに依存関係がある場合) のメタデータが必要です。
• BaselineDirectory および currentdirectory のメタデータパスには、 staticmetadata のメタデータを含める必要があります。 このメタデータは、指定したパスの staticmetadata という名前のフォルダに存在する必要があります。
• モデルの無視リストにエントリを追加することで、ツールが識別したすべての互換性に影響する変更を抑制することができます。 このファイルは、モデルの AxIgnoreDiagnosticList フォルダに存在します。

ツールが検出した互換性に影響のある変更の一覧

クラス メンバー

• 保護されたクラス メンバまたはパブリック クラス メンバのアクセス モディファイアの変更 (メンバを読み取り専用にすることも含む) – コンシューマーは、フィールドからの読み取りや、フィールドへの値の割り当てを行っている場合があります。
• パブリックまたは保護されたクラス レベルのメンバーを削除するか名前を変更する – ユーザーは、拡張クラスでこれらのメンバーを使用している可能性があります。

メソッド

• 保護メソッドまたはパブリック メソッド のメソッドシグネチャを変更すると、メソッドのラッパーと呼び出し元が破損します。
• 保護メソッドまたはパブリック メソッドを使用しない – コンシューマーは、メソッドをラップまたは上書きする場合があります。

クラスおよびインターフェイス

• クラスに最終化する – ユーザーが派生タイプを作成した可能性があります。
• クラスの抽象化 – コンシューマーがクラスのインスタンスを作成している場合があります。
• クラスに抽象メソッドを追加する: ユーザーは、派生タイプを作成した可能性があります。
• メソッドをインターフェイスに追加する: 消費者は、独自の種類でインターフェイスを実装した可能性があります。
• パブリック クラスを古い形式にし、クラスのインスタンス化を停止する: ユーザーは、インスタンス メソッドをオーバーライド、折り返し、またはサブスクライブしている可能性があります。

委任

• シグネチャにおける変更 – ユーザーは、動的に登録をしている場合があります。

テーブル

次のいずれかの変更を行うと、テーブルの拡張子とテーブルのフィールドに対するテーブル参照が壊れることになります。

• テーブル フィールド、フィールド グループ、インデックス、テーブルのマッピング、テーブルの関連付けを削除または名前変更する
• これらテーブルのプロパティ変更: Extends、SupportInheritance、TableType、SaveDataPerCompany.Yes、SaveDataPerPartition
• これらのテーブル フィールドのプロパティの変更: ExtendedDataType、Scale、文字列サイズ
• 次のテーブル インデックス プロパティを変更する：AllowDuplicates.No または indextype

フォーム

次のいずれかの変更を行うと、コントロールまたはメソッドを参照するフォームの拡張機能が解除されます。

• フォーム コントロール、フォーム データソース、フォーム データソース フィールドの削除または名前の変更。
• メソッドに対して中断するすべての変更は、フォーム メソッドについても中断されます。

列挙 (列挙)

• 次のプロパティの変更：IsExtensible または Value

拡張データ型 (EDTs)

• これらプロパティの変更：Extends、EnumType、Scale

エンティティ

• テーブルに対して中断するすべての変更は、エンティティについても中断されます。
• パブリック エンティティの名前変更。

ラベル (複数)

• ラベルの変更または削除 – ユーザーがラベル テキストと渡されたパラメータの現在のコンテキストでラベルを使用している可能性があります。 既存のラベルを変更するのではなく、新しいラベルを追加することを推奨します。

申請の要素

• 要素を削除する – ユーザーは、要素の存在にコンパイル時の依存関係を持っている可能性があります。