メインコンテンツまでスキップ

V1.1 から V2.0 へのエクステンションの移行

Next Design V2.0 では、.NET DLL によるエクステンションの実行メカニズムに影響する次の変更を行いました。

  • アプリケーションの動作フレームワークを .NET Framework 4.6.2 から .NET Core 3.1 に変更しました
  • エクステンションのライブラリロード機構を変更しました

これらの変更により、V1.1 で開発したエクステンションを V2.0 で使用するための移行が必要となります。

info
  • 移行なしでも V1.1 のエクステンションが動作する場合がありますが、エクステンションの意図しない動作や、将来のバージョンアップに備えるためにも移行することを検討してください。

エクステンションの .NET Core への移植

多くのエクステンションは、.NET Framework から .NET Core に比較的簡単に移植できます。
ここでは、Visual Studio を用いたライブラリ移植のシナリオを説明します。

info
  • V2.0 ではより簡単にエクステンションを開発できるコマンドラインツールを提供しています。
  • ここで説明する移植先のプロジェクトの作成は、コマンドラインツールで代替することもできます。
  • 詳しくは、NDExtを参照してください。
  1. .NET Core 3.1 をターゲットとする新しいプロジェクトを作成します。
.NET Core 3.1 プロジェクトを作成する
.NET Core 3.1 プロジェクトを作成するには、Visual Studioのプロジェクト作成時に次の手順で行います。

.NET Core 3.1 プロジェクトを作成する

ターゲットフレームワークの選択
  • プロジェクト作成時の追加情報で、ターゲットフレームワークに.NET Core 3.1を選択してください。
  1. 作成したプロジェクトに NuGet を用いて、以下の依存パッケージを追加します。
    • NextDesign.Desktop
NuGetで依存パッケージを追加する
プロジェクトへの依存パッケージの追加は次の手順で行います。

NuGetパッケージ管理を起動する

依存パッケージをインストールする

操作手順
  1. プロジェクトのコンテキストメニューから NuGet パッケージの管理を起動します。
  2. 参照タブでNextDesign.Desktopを検索して選択します。
  3. インストールボタンを押下してインストールを開始します。
tip
  • 現在の NextDesign.Desktop パッケージの最新バージョンは 2.0.0.11125 です

  1. 元のエクステンションに 依存ライブラリがある場合は、それらの参照を追加します。

    • NuGet パッケージによる参照の追加
      • 依存パッケージが .NET Core 3.1 に未対応の場合は、.NET Core 3.1 をサポートするバージョンにバージョンアップしてください
      • ほとんどの場合において、.NET Core 3.1 に対応するバージョンが提供されています
    • ライブラリ参照による参照の追加
      • 依存ライブラリが .NET Core 3.1 に未対応の場合は、ライブラリ提供元より .NET Core 3.1 に対応する新しいライブラリを入手して更新してください。
    • プロジェクト参照による参照の追加
      • 依存先プロジェクトが、.NET Core 3.1 または .NET Standard 2.0 でない場合は、依存先プロジェクトも移植（または、移行）してください。

  2. 作成したプロジェクトに、元のエクステンションのソースコード、マニフェストファイル、リソースファイルを追加します。

    • .NET Core プロジェクトの場合は、プロジェクトフォルダ配下にファイルを配置すれば自動的に追加されます
    • AssemblyInfo.cs ファイルは移行不要です
    • マニフェストファイルやその他のリソースファイルのプロパティは必要に応じて元のエクステンションと同様に設定してください

  3. 作成したプロジェクトのプロパティでアセンブリバージョン等の各種情報を設定します。

アセンブリ名、規定の名前空間を指定する
Visual Studio プロジェクトのプロパティの`アプリケーション`で設定します。

アセンブリ名、規定の名前空間を指定する

note
  • 元のエクステンションと同様に設定します。
バージョン、作成者を指定する
Visual Studio プロジェクトのプロパティの`パッケージ`で設定します。

バージョン、作成者を指定する

note
  • 元のエクステンションの AssemblyInfo.cs の定義内容を移行します

  1. エクステンションが次のV2.0で変更されたAPIを使用している場合は、該当箇所を修正します。

  2. エクステンションが次のV2.0で利用できない機能/APIを使用している場合は、該当箇所を修正します。

  3. 依存パッケージのバージョンアップによりビルドが通らない箇所があれば修正します。

tip

V2 エクステンションのビルドと配布

.NET Core ライブラリプロジェクトは、ビルド時に NuGet によりパッケージ参照したライブラリを出力しません。 そのため、エクステンションを配布する際には、エクステンションの依存ライブラリを収集する必要があります。
ここでは、依存ライブラリの収集方法を説明します。

info
  • コマンドラインツールでエクステンションの配布パッケージを作成することができます。
  • 詳しくは、NDExtを参照してください。
  1. 依存ライブラリの収集はdotnet publish コマンドを使用します。
    • Visual Studioを使用する場合は、ビルドイベントでコマンドを実行すると便利です。
      • プロジェクトのプロパティで、ビルド イベントを開きます。
      • ビルド後イベントのコマンドラインに以下のコマンドを設定します。
        • dotnet publish --no-build
      • ${ビルドの出力フォルダ}/publish フォルダに依存ライブラリ、およびアセンブリメタデータの記述ファイルが出力されます。
tip
  • ビルド後イベントで dotnet publish コマンドを実行する場合は、必ず"--no-build"オプションを指定してください。
    • "--no-build"オプションを指定していない場合、ビルドプロセスが無限ループします。
  1. プロジェクトのビルドを実行します。
tip
  • エクステンション側で特別な理由がない限りは、ビルドのプラットフォームには"Any CPU"を指定することを推奨します。

  1. ${ビルドの出力フォルダ}/publish フォルダ以下の配布に不要なライブラリを削除します。

    • NextDesign.Core.dll
    • NextDesign.Desktop.dll
    • シンボル(.pdb)ファイル

  2. publish フォルダの全てのファイルを配布してください。

    • アセンブリメタデータ記述ファイル(.deps.json)を必ず含めてください。
    • マニフェスト、その他必要なファイルがあれば、ここに含めてください。
に最終更新