Revit/AutoCAD のさまざまなバージョンに合わせてコンパイルした XNUMX つのプラグイン プロジェクトを作成します

CAD アプリケーションのプラグインを開発する場合 (私の場合 これらは AutoCAD、Revit、Renga です) 時間が経つと、XNUMX つの問題が現れます。プログラムの新しいバージョンがリリースされ、API が変更され、プラグインの新しいバージョンを作成する必要があります。

プラグインが XNUMX つしかない場合、またはこの問題に関してまだ独学で初心者である場合は、プロジェクトのコピーを作成し、その中の必要な場所を変更して、新しいバージョンのプラグインをアセンブルするだけです。 したがって、その後のコードの変更には人件費の倍増が伴います。

経験と知識を得るにつれて、このプロセスを自動化するいくつかの方法が見つかるでしょう。 私がこの道を歩いてみて、最終的にどうなったのか、そしてそれがどれほど便利かをお伝えしたいと思います。

まず、私が長年使用してきた明白な方法を見てみましょう。

プロジェクトファイルへのリンク

すべてをシンプルかつ視覚的にわかりやすくするために、プラグイン開発の抽象的な例を使用してすべてを説明します。

Visual Studio を開いて (私は Community 2019 バージョンを持っています。はい、ロシア語です)、新しいソリューションを作成しましょう。 彼に電話しましょう MySuperPluginForRevit

Revit バージョン 2015 ～ 2020 用のプラグインを作成する予定です。 したがって、ソリューション (Net Framework クラス ライブラリ) に新しいプロジェクトを作成し、それを呼び出しましょう MySuperPluginForRevit_2015

Revit API へのリンクを追加する必要があります。 もちろん、ローカル ファイルへのリンクを追加することもできます (必要なすべての SDK またはすべてのバージョンの Revit をインストールする必要があります) が、すぐに正しいパスに従って NuGet パッケージに接続します。 かなりの数のパッケージが見つかりますが、ここでは独自のパッケージを使用します。

パッケージを接続したら、項目を右クリックします。リファレンス」を選択し、項目を選択します。Packages.config を PackageReference に移動します...»

この時点で突然パニックになり始めた場合は、パッケージのプロパティ ウィンドウに重要な項目が表示されないためです。ローカルにコピーする"、これは必ず値に設定する必要があります falseその後、パニックにならないでください。プロジェクトのあるフォルダーに移動し、便利なエディター (私は Notepad++ を使用しています) で .csproj 拡張子のファイルを開き、そこでパッケージに関するエントリを見つけます。 彼女は今こんな感じです。

<PackageReference Include="ModPlus.Revit.API.2015">
  <Version>1.0.0</Version>
</PackageReference>

それにプロパティを追加します ランタイム。 次のようになります。

<PackageReference Include="ModPlus.Revit.API.2015">
  <Version>1.0.0</Version>
  <ExcludeAssets>runtime</ExcludeAssets>
</PackageReference>

今後は、プロジェクトをビルドするときに、パッケージのファイルが出力フォルダーにコピーされなくなります。
さらに進んでみましょう。プラグインが Revit API の何かを使用することをすぐに想像してみましょう。Revit API は、新しいバージョンがリリースされるたびに変更されてきました。 または、プラグインを作成する Revit のバージョンに応じて、コード内の何かを変更する必要があるだけです。 コード内のこのような違いを解決するには、条件付きコンパイル シンボルを使用します。 プロジェクトのプロパティを開き、「」タブに移動します組立"そしてフィールドで"条件付きコンパイルの表記法"かきましょう R2015.

このシンボルは、デバッグ構成とリリース構成の両方に追加する必要があることに注意してください。

さて、プロパティウィンドウにいる間、すぐに「」タブに移動しますアプリケーション"そしてフィールドで"デフォルトの名前空間» サフィックスを削除する _2015そのため、名前空間はユニバーサルであり、アセンブリ名に依存しません。

私の場合、最終製品では、すべてのバージョンのプラグインが XNUMX つのフォルダーに入れられるため、アセンブリ名にはフォームの接尾辞が付いたままになります。 _20分。 ただし、ファイルが別のフォルダーに配置されることが想定されている場合は、アセンブリ名からサフィックスを削除することもできます。

ファイルコードに行きましょう Class1.cs Revit のさまざまなバージョンを考慮して、そこでいくつかのコードをシミュレートします。

namespace MySuperPluginForRevit
{
    using Autodesk.Revit.Attributes;
    using Autodesk.Revit.DB;
    using Autodesk.Revit.UI;

    [Regeneration(RegenerationOption.Manual)]
    [Transaction(TransactionMode.Manual)]
    public class Class1 : IExternalCommand
    {
        public Result Execute(ExternalCommandData commandData, ref string message, ElementSet elements)
        {
#if R2015
            TaskDialog.Show("ModPlus", "Hello Revit 2015");
#elif R2016
            TaskDialog.Show("ModPlus", "Hello Revit 2016");
#elif R2017
            TaskDialog.Show("ModPlus", "Hello Revit 2017");
#elif R2018
            TaskDialog.Show("ModPlus", "Hello Revit 2018");
#elif R2019
            TaskDialog.Show("ModPlus", "Hello Revit 2019");
#elif R2020
            TaskDialog.Show("ModPlus", "Hello Revit 2020");
#endif
            return Result.Succeeded;
        }
    }
}

私はすぐに、バージョン 2015 より上の Revit のすべてのバージョン(執筆時点で利用可能でした)を考慮し、同じテンプレートを使用して作成された条件付きコンパイル シンボルの存在をすぐに考慮しました。

メインのハイライトに移りましょう。 Revit 2016 のプラグインのバージョンのみを対象として、ソリューション内に新しいプロジェクトを作成します。数値 2015 を数値 2016 に置き換えて、上記のすべての手順をそれぞれ繰り返します。 Class1.cs 新しいプロジェクトから削除します。

必要なコードを含むファイル - Class1.cs – すでにそれを持っているので、新しいプロジェクトにそれへのリンクを挿入するだけです。 リンクを挿入するには XNUMX つの方法があります。

1. 長さ – プロジェクトを右クリックし、「加える「->」既存の要素"、開いたウィンドウで必要なファイルを見つけ、オプションの代わりに"加える「オプションを選択してください」接続として追加»

1. ショート – ソリューション エクスプローラーで直接、目的のファイル (またはファイル、フォルダー全体) を選択し、Alt キーを押しながらそれを新しいプロジェクトにドラッグします。 ドラッグ中に Alt キーを押すと、マウス カーソルがプラス記号から矢印に変わることがわかります。
   UPD： この段落で少し混乱しました - 複数のファイルを転送するには、長押しする必要があります Shift + Alt!

手順を実行すると、XNUMX番目のプロジェクトにファイルが作成されます Class1.cs 対応するアイコン (青い矢印):

エディター ウィンドウでコードを編集するときに、コードを表示するプロジェクト コンテキストを選択することもできます。これにより、さまざまな条件付きコンパイル シンボルの下で編集中のコードを確認できるようになります。

他のすべてのプロジェクト (2017 年から 2020 年) はこのスキームを使用して作成されます。 ライフハック - ソリューション エクスプローラーでファイルをベース プロジェクトからではなく、既にリンクとして挿入されているプロジェクトからドラッグする場合は、Alt キーを押し続ける必要はありません。

説明されているオプションは、新しいバージョンのプラグインを追加する瞬間、またはプロジェクトに新しいファイルを追加する瞬間までは非常に優れていますが、これはすべて非常に面倒になります。 そして最近、突然、XNUMX つのプロジェクトですべてを整理する方法に気づき、XNUMX 番目の方法に移行しています。

構成の魔法

ここを読み終えたあなたは、「この記事ではすぐに XNUMX 番目の方法について説明しているのに、なぜ最初の方法について説明したのですか?!」と叫ぶかもしれません。 そして、なぜ条件付きコンパイル シンボルが必要なのか、そしてプロジェクトのどの部分が異なるのかを明確にするためにすべてを説明しました。 そして今、実装する必要があるプロジェクトの違いが正確に明確になり、残りのプロジェクトは XNUMX つだけになります。

そして、すべてをより明確にするために、新しいプロジェクトを作成するのではなく、最初の方法で作成した現在のプロジェクトに変更を加えます。

したがって、まず最初に、メイン プロジェクト (ファイルが直接含まれているプロジェクト) を除くすべてのプロジェクトをソリューションから削除します。 それらの。 バージョン 2016 ～ 2020 のプロジェクト。 ソリューションが含まれるフォルダーを開き、そこにあるこれらのプロジェクトのフォルダーを削除します。

私たちの決定には XNUMX つのプロジェクトが残っています - MySuperPluginForRevit_2015。 そのプロパティを開き、次の操作を行います。

1. タブ「アプリケーション"アセンブリ名からサフィックスを削除します _2015 （理由は後ほど明らかになる）
2. タブ「組立» 条件付きコンパイルのシンボルを削除します。 R2015 対応するフィールドから

注: Visual Studio の最新バージョンにはバグがあります。条件付きコンパイル シンボルは利用可能であっても、プロジェクト プロパティ ウィンドウに表示されません。 この問題が発生した場合は、.csproj ファイルから手動でそれらを削除する必要があります。 ただし、まだ取り組む必要があるので、読み続けてください。

ソリューション エクスプローラー ウィンドウでサフィックスを削除してプロジェクトの名前を変更します。 _2015 次に、プロジェクトをソリューションから削除します。 これは完璧主義者の秩序と感情を維持するために必要です。 ソリューションのフォルダーを開き、同じ方法でそこにあるプロジェクト フォルダーの名前を変更し、プロジェクトをソリューションに再度読み込みます。

構成マネージャーを開きます。 米国構成 リリース 原則的には不要ですので削除させていただきます。 すでに馴染みのある名前で新しい構成を作成します R2015, R2016、... R2020。 他の構成から設定をコピーする必要はなく、プロジェクト構成を作成する必要もないことに注意してください。

プロジェクトが含まれるフォルダーに移動し、使いやすいエディターで .csproj 拡張子の付いたファイルを開きます。 ちなみに、Visual Studio で開くこともできます。プロジェクトをアンロードすると、目的の項目がコンテキスト メニューに表示されます。

エディターが調整とプロンプトの両方を提供するため、Visual Studio で編集することをお勧めします。

ファイルには要素が表示されます プロパティグループ – 一番上に一般的なものがあり、その後に条件が続きます。 これらの要素は、プロジェクトのビルド時にプロジェクトのプロパティを設定します。 条件のない最初の要素は一般的なプロパティを設定し、条件付きの要素はそれに応じて構成に応じて一部のプロパティを変更します。

共通の (最初の) 要素に移動します プロパティグループ そして物件を見てみると アセンブリ名 – これはアセンブリの名前であり、サフィックスを付けないでください。 _2015。 サフィックスがある場合は、それを削除します。

条件付きの要素の検索

<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">

必要ないので削除します。

条件付き要素

<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">

コード開発とデバッグの段階で作業するために必要になります。 ニーズに合わせてプロパティを変更できます。別の出力パスを設定したり、条件付きコンパイル シンボルを変更したりできます。

新しい要素を作成しましょう プロパティグループ 私たちの構成では。 これらの要素では、次の XNUMX つのプロパティを設定するだけです。

• 出力パス - 出力フォルダ。 デフォルト値を設定しました ビンR20xx
• 定数の定義 – 条件付きコンパイルのシンボル。 値を指定する必要があります トレース;R20хх
• ターゲットフレームワークのバージョン – プラットフォームのバージョン。 Revit API のバージョンが異なると、異なるプラットフォームを指定する必要があります。
• アセンブリ名 – アセンブリ名 (つまり、ファイル名)。 アセンブリの正確な名前を記述することもできますが、汎用性を考慮して値を記述することをお勧めします。 $(アセンブリ名)_20хх。 これを行うために、以前にアセンブリ名から接尾辞を削除しました。

これらすべての要素の最も重要な特徴は、まったく変更せずに他のプロジェクトに簡単にコピーできることです。 この記事の後半で、.csproj ファイルのすべての内容を添付します。

さて、プロジェクトのプロパティを理解しました。それは難しいことではありません。 しかし、プラグイン ライブラリ (NuGet パッケージ) をどうするか。 さらに見てみると、含まれているライブラリが要素で指定されていることがわかります。 アイテムグループ。 しかし不運です。この要素は条件を要素として誤って処理します。 プロパティグループ。 おそらくこれは Visual Studio の不具合ですが、複数の要素を指定すると アイテムグループ 構成条件を指定し、内部に NuGet パッケージへのさまざまなリンクを挿入すると、構成を変更すると、指定されたすべてのパッケージがプロジェクトに接続されます。

元素が私たちを助けてくれる 選択する、通常のロジックに従って機能します if-then-else.

要素の使用 選択する、異なる構成に対して異なる NuGet パッケージを設定します。

すべてのコンテンツ csproj

<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="15.0"  ">Debug</Configuration>
    <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
    <ProjectGuid>{5AD738D6-4122-4E76-B865-BE7CE0F6B3EB}</ProjectGuid>
    <OutputType>Library</OutputType>
    <AppDesignerFolder>Properties</AppDesignerFolder>
    <RootNamespace>MySuperPluginForRevit</RootNamespace>
    <AssemblyName>MySuperPluginForRevit</AssemblyName>
    <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
    <FileAlignment>512</FileAlignment>
    <Deterministic>true</Deterministic>
  </PropertyGroup>
  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
    <DebugSymbols>true</DebugSymbols>
    <DebugType>full</DebugType>
    <Optimize>false</Optimize>
    <OutputPath>binDebug</OutputPath>
    <DefineConstants>DEBUG;R2015</DefineConstants>
    <ErrorReport>prompt</ErrorReport>
    <WarningLevel>4</WarningLevel>
  </PropertyGroup>
  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'R2015|AnyCPU' ">
    <OutputPath>binR2015</OutputPath>
    <DefineConstants>TRACE;R2015</DefineConstants>
    <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
    <AssemblyName>$(AssemblyName)_2015</AssemblyName>
  </PropertyGroup>
  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'R2016|AnyCPU' ">
    <OutputPath>binR2016</OutputPath>
    <DefineConstants>TRACE;R2016</DefineConstants>
    <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
    <AssemblyName>$(AssemblyName)_2016</AssemblyName>
  </PropertyGroup>
  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'R2017|AnyCPU' ">
    <OutputPath>binR2017</OutputPath>
    <DefineConstants>TRACE;R2017</DefineConstants>
    <TargetFrameworkVersion>v4.5.2</TargetFrameworkVersion>
    <AssemblyName>$(AssemblyName)_2017</AssemblyName>
  </PropertyGroup>
  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'R2018|AnyCPU' ">
    <OutputPath>binR2018</OutputPath>
    <DefineConstants>TRACE;R2018</DefineConstants>
    <TargetFrameworkVersion>v4.5.2</TargetFrameworkVersion>
    <AssemblyName>$(AssemblyName)_2018</AssemblyName>
  </PropertyGroup>
  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'R2019|AnyCPU' ">
    <OutputPath>binR2019</OutputPath>
    <DefineConstants>TRACE;R2019</DefineConstants>
    <TargetFrameworkVersion>v4.7</TargetFrameworkVersion>
    <AssemblyName>$(AssemblyName)_2019</AssemblyName>
  </PropertyGroup>
  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'R2020|AnyCPU' ">
    <OutputPath>binR2020</OutputPath>
    <DefineConstants>TRACE;R2020</DefineConstants>
    <TargetFrameworkVersion>v4.7</TargetFrameworkVersion>
    <AssemblyName>$(AssemblyName)_2020</AssemblyName>
  </PropertyGroup>
  <ItemGroup>
    <Reference Include="System" />
    <Reference Include="System.Core" />
    <Reference Include="System.Xml.Linq" />
    <Reference Include="System.Data.DataSetExtensions" />
    <Reference Include="Microsoft.CSharp" />
    <Reference Include="System.Data" />
    <Reference Include="System.Net.Http" />
    <Reference Include="System.Xml" />
  </ItemGroup>
  <ItemGroup>
    <Compile Include="Class1.cs" />
    <Compile Include="PropertiesAssemblyInfo.cs" />
  </ItemGroup>
  <Choose>
    <When Condition=" '$(Configuration)'=='R2015' ">
      <ItemGroup>
        <PackageReference Include="ModPlus.Revit.API.2015">
          <Version>1.0.0</Version>
          <ExcludeAssets>runtime</ExcludeAssets>
        </PackageReference>
      </ItemGroup>
    </When>
    <When Condition=" '$(Configuration)'=='R2016' ">
      <ItemGroup>
        <PackageReference Include="ModPlus.Revit.API.2016">
          <Version>1.0.0</Version>
          <ExcludeAssets>runtime</ExcludeAssets>
        </PackageReference>
      </ItemGroup>
    </When>
    <When Condition=" '$(Configuration)'=='R2017' ">
      <ItemGroup>
        <PackageReference Include="ModPlus.Revit.API.2017">
          <Version>1.0.0</Version>
          <ExcludeAssets>runtime</ExcludeAssets>
        </PackageReference>
      </ItemGroup>
    </When>
    <When Condition=" '$(Configuration)'=='R2018' ">
      <ItemGroup>
        <PackageReference Include="ModPlus.Revit.API.2018">
          <Version>1.0.0</Version>
          <ExcludeAssets>runtime</ExcludeAssets>
        </PackageReference>
      </ItemGroup>
    </When>
    <When Condition=" '$(Configuration)'=='R2019' ">
      <ItemGroup>
        <PackageReference Include="ModPlus.Revit.API.2019">
          <Version>1.0.0</Version>
          <ExcludeAssets>runtime</ExcludeAssets>
        </PackageReference>
      </ItemGroup>
    </When>
    <When Condition=" '$(Configuration)'=='R2020' or '$(Configuration)'=='Debug'">
      <ItemGroup>
        <PackageReference Include="ModPlus.Revit.API.2020">
          <Version>1.0.0</Version>
          <ExcludeAssets>runtime</ExcludeAssets>
        </PackageReference>
      </ItemGroup>
    </When>
  </Choose>
  <Import Project="$(MSBuildToolsPath)Microsoft.CSharp.targets" />
</Project>

条件の XNUMX つで XNUMX つの構成を指定したことに注意してください。 または。 このようにして、構成中に必要なパッケージが接続されます。 デバッグ.

そしてここではほぼすべてが完璧です。 プロジェクトをロードして戻し、必要な構成を有効にし、ソリューション (プロジェクトではなく) のコンテキスト メニューで項目「」を呼び出します。すべての NuGet パッケージを復元する「そしてパッケージがどのように変化するかがわかります。

そして、この段階で行き詰まりました。すべての構成を一度に収集するには、バッチアセンブリ（メニュー「」）を使用できます。組立「->」バッチビルド")、ただし、構成を切り替える場合、パッケージは自動的には復元されません。 そして、プロジェクトを組み立てるとき、理論的にはそうなるはずですが、これも起こりません。 標準的な手段を使用してこの問題を解決する方法は見つかりませんでした。 そしておそらく、これも Visual Studio のバグです。

そこで、バッチ組立には特別な自動組立システムを使用することにしました。 電子レンジで調理する。 プラグイン開発の観点からはやりすぎだと思うので、実際にはこれを望んでいませんでしたが、現時点では他の解決策が見つかりません。 そして、「なぜ核攻撃をするのか？」という質問には、 答えは簡単です。仕事で使っているからです。

したがって、ソリューションのフォルダー (プロジェクトではなく) に移動し、キーを押したままにします。 シフト フォルダー内の空きスペースを右クリックし、コンテキスト メニューで項目「」を選択します。ここでPowerShellウィンドウを開きます'。

インストールされていない場合 核兵器、次に最初にコマンドを書きます

dotnet tool install Nuke.GlobalTool –global

次にコマンドを書きます 核兵器 設定を求めるプロンプトが表示されます 核兵器 現在のプロジェクトの場合。 これをロシア語でより正確に書く方法がわかりません。英語では、「.nuke ファイルが見つかりませんでした」と書かれます。 ビルドをセットアップしますか? [はい/いいえ]

Y キーを押すと、直接設定項目が表示されます。 次を使用する最も単純なオプションが必要です MSBuild, したがって、スクリーンショットのように答えます。

Visual Studio に移動しましょう。新しいプロジェクトがソリューションに追加されているため、ソリューションを再読み込みするように求められます。 ソリューションをリロードすると、プロジェクトがあることがわかります。 ビルド この中で私たちが興味があるのは XNUMX つのファイルだけです - Build.cs

このファイルを開いて、すべての構成のプロジェクトをビルドするスクリプトを作成します。 または、ニーズに合わせて編集できる私のスクリプトを使用してください。

using System.IO;
using Nuke.Common;
using Nuke.Common.Execution;
using Nuke.Common.ProjectModel;
using Nuke.Common.Tools.MSBuild;
using static Nuke.Common.Tools.MSBuild.MSBuildTasks;

[CheckBuildProjectConfigurations]
[UnsetVisualStudioEnvironmentVariables]
class Build : NukeBuild
{
    public static int Main () => Execute<Build>(x => x.Compile);

    [Solution] readonly Solution Solution;

    // If the solution name and the project (plugin) name are different, then indicate the project (plugin) name here
    string PluginName => Solution.Name;

    Target Compile => _ => _
        .Executes(() =>
        {
            var project = Solution.GetProject(PluginName);
            if (project == null)
                throw new FileNotFoundException("Not found!");

            var build = new List<string>();
            foreach (var (_, c) in project.Configurations)
            {
                var configuration = c.Split("|")[0];

                if (configuration == "Debug" || build.Contains(configuration))
                    continue;

                Logger.Normal($"Configuration: {configuration}");

                build.Add(configuration);

                MSBuild(_ => _
                    .SetProjectFile(project.Path)
                    .SetConfiguration(configuration)
                    .SetTargets("Restore"));
                MSBuild(_ => _
                    .SetProjectFile(project.Path)
                    .SetConfiguration(configuration)
                    .SetTargets("Rebuild"));
            }
        });
}

PowerShell ウィンドウに戻り、コマンドを再度記述します。 核兵器 (コマンドを書くこともできます) 核兵器 必須であることを示す ターゲット。 しかし、私たちにはXNUMXつあります ターゲット、デフォルトで実行されます）。 Enter キーを押すと、映画のようにプロジェクトがさまざまな構成に合わせて自動的に組み立てられるため、本物のハッカーになったような気分になります。

ちなみに、Visual Studio から PowerShell を直接使用することもできます (メニュー「ビュー「->」その他の窓口「->」パッケージマネージャーコンソール") しかし、すべてが白黒になるため、あまり便利ではありません。

これで私の記事は終わります。 AutoCAD のオプションをご自身で見つけられると思います。 ここで紹介した資料が「顧客」を見つけることを願っています。

ありがとうございました！

出所： habr.com