Ние правим един плъгин проект с компилация за различни версии на Revit / AutoCAD

Когато разработвате добавки за CAD приложения (в моя случай това са AutoCAD, Revit и Renga) с течение на времето се появява един проблем - излизат нови версии на програми, трябва да се променят техните API и да се правят нови версии на плъгини.

Когато имате само един плъгин или все още сте начинаещ самоук в този бизнес, можете просто да направите копие на проекта, да промените необходимите места в него и да изградите нова версия на плъгина. Съответно последващите промени в кодекса ще доведат до многократно увеличение на разходите за труд.

С натрупването на опит и знания ще намерите няколко начина за автоматизиране на този процес. Минах по този път и искам да ви кажа до какво стигнах и колко е удобно.

Първо, нека разгледаме един метод, който е очевиден и който използвам от дълго време

Връзки към файлове на проекта

И за да направя всичко просто, ясно и разбираемо, ще опиша всичко, използвайки абстрактен пример за разработка на плъгини.

Да отворим Visual Studio (имам версията Community 2019. И да - на руски) и да създадем ново решение. Нека го наречем MySuperPluginForRevit

Ще направим плъгин за Revit за версии 2015-2020. Затова ще създам нов проект в решението (Net Framework Class Library) и ще го нарека MySuperPluginForRevit_2015

Трябва да добавим препратки към API на Revit. Разбира се, можем да добавим връзки към локални файлове (ще трябва да инсталирате всички необходими SDK или всички версии на Revit), но ще продължим направо и ще включим пакета NuGet. Можете да намерите доста пакети, но аз ще използвам своя.

След като свържете пакета, щракнете с десния бутон върху елемента "Позоваването'и изберете елемента от менюто'Преместете packages.config в PackageReference...»

Ако изведнъж започнете да се паникьосвате на това място, тъй като няма да има важен елемент в прозореца със свойства на пакета "копирайте локално”, на което определено трябва да се настроим фалшив, тогава не се паникьосвайте - отидете в папката на проекта, отворете файла с разширение .csproj в удобен за вас редактор (използвам Notepad ++) и намерете запис за нашия пакет там. Сега тя изглежда така:

<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>

Сега, когато създавате проект, файловете от пакета няма да бъдат копирани в изходната папка.
Нека да продължим - само си представете, че нашият плъгин ще използва нещо от API на Revit, което се промени с течение на времето с пускането на нови версии. Е, или просто трябва да променим нещо свое в кода, в зависимост от версията на Revit, за която правим плъгина. За да разрешим такива разлики в кода, ще използваме символи за условна компилация. Отворете свойствата на проекта, отидете на раздела "монтаж"и в полето"Нотиране на условна компилация» пишете R2015.

Обърнете внимание, че символът трябва да се добави както за конфигурацията за отстраняване на грешки, така и за конфигурацията за издание.

Е, докато сме в прозореца със свойства, веднага отиваме в раздела "App"и в полето"Пространство от имена по подразбиране»премахване на суфикса _2015така че нашето пространство от имена да е универсално и независимо от името на сглобката:

В моя случай, в крайния продукт, плъгините от всички версии се добавят към една папка, така че имената на моите асемблирания остават със суфикса на формуляра _20xx. Но можете също така да премахнете суфикса от името на сборката, ако очаквате файловете да се намират в различни папки.

Да отидем на кода на файла 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;
        }
    }
}

Веднага взех предвид всички версии на Revit над версията от 2015 г. (които бяха по време на писането на статията) и веднага взех предвид наличието на условни символи за компилация, които създавам според същия шаблон.

Да преминем към основния акцент. Създаваме нов проект в нашето решение, само за версията на приставката под Revit 2016. Повтаряме всички стъпки, описани по-горе, съответно, замествайки числото 2015 с числото 2016. Но файлът Class1.cs премахнат от новия проект.

Файл с необходимия код - Class1.cs - вече имаме и просто трябва да вмъкнем връзка към него в нов проект. Има два начина за вмъкване на връзки:

1. Дълги - кликнете върху проекта с десния бутон на мишката, изберете елемента "Добави»->«Съществуващ елемент", в прозореца, който се отваря, намерете желания файл и вместо опцията"Добави» изберете опция «Добавяне като връзка»

1. Кратко - направо в изследователя на решения изберете желания файл (или дори файлове. Или дори цели папки) и го плъзнете в нов проект, като държите натиснат клавиша Alt. При плъзгане ще видите, че когато натиснете клавиша Alt, курсорът на мишката ще се промени от знак плюс на стрелка.
   UPS: Направих малко объркване в този параграф - за да прехвърлите няколко файла, трябва да стегнете Shift + Alt!

След процедурата ще имаме файл във втория проект Class1.cs със съответната икона (синя стрелка):

Когато редактирате код в прозореца на редактора, можете също да изберете в контекста на кой проект да се покаже кодът, което ще ви позволи да видите кода, който се редактира с различни условни символи за компилация:

По тази схема създаваме всички останали проекти (2017-2020 г.). Life hack - ако плъзгате файлове в разтвора Explorer не от основния проект, а от проекта, където те вече са вмъкнати като връзка, тогава не можете да задържите клавиша Alt!

Описаната опция е доста добра, докато не се добави нова версия на плъгина или докато не се добавят нови файлове към проекта - всичко това става много мрачно. И наскоро внезапно разбрах как да подредя всичко с един проект и преминаваме към втория метод.

Конфигурационна магия

След като прочетете тук, можете да възкликнете: „Какво, по дяволите, описахте първия метод, ако статията е веднага за втория?!“. И описах всичко, за да стане по-ясно защо се нуждаем от символи за условна компилация и на какви места нашите проекти се различават. И сега ни става по-ясно какви разлики в проекта трябва да реализираме, оставяйки само един проект.

И за да направим всичко по-очевидно, няма да създаваме нов проект, а ще направим промени в текущия ни проект, създаден по първия начин.

Така че, първо, премахваме всички проекти от решението, с изключение на основния (съдържащ директно файловете). Тези. проекти за версии 2016-2020. Отворете папката с решението и изтрийте папките на тези проекти там.

Имаме един останал проект в решението - MySuperPluginForRevit_2015. Отворете неговите свойства и:

1. В раздела „App» премахнете наставката от името на сборката _2015 (по-късно ще стане ясно защо)
2. В раздела „монтаж»премахнете символа за условна компилация R2015 от съответното поле

Забележка: Има проблем в най-новата версия на Visual Studio - символите за условна компилация не се показват в прозореца със свойства на проекта, въпреки че са налични. Ако имате този проблем, тогава трябва да ги премахнете ръчно от .csproj файла. Все още обаче трябва да работим в него, така че прочетете.

Преименувайте проекта в прозореца на Solution Explorer, като премахнете суфикса _2015 и след това премахнете проекта от решението. Това е необходимо за поддържане на ред и чувства на перфекционисти! Отворете папката на нашето решение, преименувайте папката на проекта по същия начин и заредете проекта обратно в решението.

Отворете мениджъра на конфигурацията. Конфигурация за САЩ Освободете по принцип няма да е необходим, затова го изтриваме. Създаваме нови конфигурации с имена, които вече са ни познати R2015, R2016, ..., R2020. Имайте предвид, че не е необходимо да копирате настройки от други конфигурации и не е необходимо да създавате конфигурации на проекти:

Отиваме в папката с проекта и отваряме файла с разширение .csproj в удобен за вас редактор. Между другото, можете също да го отворите в Visual Studio - трябва да разтоварите проекта и тогава правилният елемент ще бъде в контекстното меню:

Редактирането във Visual Studio е дори за предпочитане, тъй като редакторът едновременно подравнява и подсказва.

Във файла ще видим елементите PropertyGroup - най-отгоре е общото, а след това идват с условията. Тези елементи задават свойствата на проекта, когато той е изграден. Първият елемент, който е без условия, задава общи свойства, а елементите с условия, съответно, променят някои свойства в зависимост от конфигурациите.

Отидете до общия (първи) елемент PropertyGroup и разгледайте имота Име на сборка - това е името на сборката и трябва да го имаме без суфикс _2015. Ако има суфикс, премахнете го.

Намиране на елемент с условие

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

Не ни трябва - изтриваме го.

Елемент с условие

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

ще са необходими за работа на етапа на разработка и отстраняване на грешки в кода. Можете да промените неговите свойства, за да отговарят на вашите нужди - да зададете различни изходни пътища, да промените символите за условна компилация и т.н.

Сега създаваме нови елементи PropertyGroup за нашите конфигурации. В тези елементи просто трябва да зададем четири свойства:

• Изходен път - изходна папка. Зададох стойност по подразбиране binR20xx
• Определете константи са символи за условна компилация. Трябва да се настрои на TRACE;R20xx
• TargetFrameworkVersion – платформена версия. Различните версии на Revit API изискват различни платформи да бъдат зададени.
• Име на сборка – име на сборка (т.е. име на файл). Можете да напишете директно желаното име на сборка, но за универсалност ви съветвам да напишете стойността $(AssemblyName)_20xx. За да направим това, преди това премахнахме суфикса от името на сборката

Най-важната характеристика на всички тези елементи е, че те могат просто да бъдат копирани в други проекти, без изобщо да се променят. По-късно в статията ще прикача цялото съдържание на .csproj файла.

Е, разбрахме свойствата на проекта - не е трудно. Но какво да правим с включените библиотеки (NuGet пакети). Ако погледнем по-нататък, ще видим, че включените библиотеки са определени от елементите ItemGroup. Но тук е проблемът - този елемент неправилно обработва условия като елемент PropertyGroup. Може би това е дори бъг на Visual Studio, но ако зададете няколко елемента ItemGroup с условия за конфигурация и вмъкнете различни връзки към NuGet пакети вътре, след което при промяна на конфигурацията всички посочени пакети са свързани към проекта.

На помощ ни идва елемент Изберете, който работи по познатата ни логика ако-тогава-друго.

Използване на елемент Изберете, задайте различни 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>

Моля, обърнете внимание, че в едно от условията посочих две конфигурации чрез ИЛИ. По този начин необходимият пакет ще бъде свързан по време на конфигурацията Debug.

И тук сме почти идеални. Зареждаме проекта обратно, включваме конфигурацията, от която се нуждаем, извикваме в контекстното меню на решението (не проекта) елемента "Възстановете всички NuGet пакети” и вижте как се променят нашите пакети.

И на този етап стигнах до задънена улица - за да съберем всички конфигурации наведнъж, можем да използваме партидния монтаж (меню "монтаж»->«Партиден монтаж“), но при превключване на конфигурации пакетите не се възстановяват автоматично. И при сглобяването на проекта това също не се случва, въпреки че на теория трябва. Не намерих решение на този проблем със стандартни средства. И най-вероятно това също е грешка на Visual Studio.

Следователно, за партиден монтаж беше решено да се използва специална автоматизирана система за монтаж Nuke. Наистина не исках това, тъй като смятам, че е излишно по отношение на разработката на плъгини, но в момента не виждам друго решение. И на въпроса "Защо Nuke?" Отговорът е прост - използваме го на работа.

И така, отидете в папката на нашето решение (не на проекта), задръжте клавиша Превключване и щракнете с десния бутон върху празно място в папката - в контекстното меню изберете елемента "Отворете прозореца на PowerShell тук".

Ако не сте инсталирали бомбата, тогава първо напишете командата

dotnet tool install Nuke.GlobalTool –global

Сега напишете команда бомбата и ще бъдете подканени да конфигурирате бомбата за текущия проект. Не знам как да го напиша правилно на руски - на английски ще бъде написано Не можах да намеря .nuke файл. Искате ли да настроите компилация? [да/не]

Натиснете клавиша Y и след това ще има директни настройки. Искаме да използваме най-простата опция MSBuild, така че отговаряме както на екранната снимка:

Нека отидем в Visual Studio, което ще ни подкани да презаредим решението, тъй като към него е добавен нов проект. Презаредете решението и вижте, че имаме проект изграждане на в който се интересуваме само от един файл - 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 и отново пишем командата бомбата (можете да напишете командата бомбата посочване на необходимото Цел. Но ние имаме един Целкойто стартира по подразбиране). След натискане на клавиша Enter ще се почувстваме като истински хакери, защото, като във филм, нашият проект ще бъде автоматично сглобен за различни конфигурации.

Между другото, можете да използвате PowerShell директно от Visual Studio (меню "Преглед»->«Други прозорци»->«Конзола за управление на пакети”), но всичко ще бъде черно и бяло, което не е много удобно.

Това завършва моята статия. Сигурен съм, че можете сами да разберете опцията за AutoCAD. Надявам се, че представеният тук материал ще намери своите "клиенти".

Спасибо за внимание!

Източник: www.habr.com