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

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

Кога имате само еден додаток или сè уште сте самоук почетник во ова прашање, можете едноставно да направите копија од проектот, да ги промените потребните места во него и да составите нова верзија на приклучокот. Според тоа, последователните промени на кодот ќе повлечат повеќекратно зголемување на трошоците за работна сила.

Како што стекнувате искуство и знаење, ќе најдете неколку начини за автоматизирање на овој процес. Го одев овој пат и сакам да ви кажам со што завршив и колку е погодно.

Прво, да погледнеме метод кој е очигледен и кој го користам долго време.

Врски до проектните датотеки

И за да биде сè едноставно, визуелно и разбирливо, ќе опишам сè користејќи апстрактен пример за развој на приклучоци.

Ајде да отвориме Visual Studio (ја имам верзија на Заедницата 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>

Сега, кога се гради проект, датотеките од пакетот нема да се копираат во излезната папка.
Ајде да одиме понатаму - веднаш да замислиме дека нашиот приклучок ќе користи нешто од Revit API, кое се менуваше со текот на времето кога беа објавени новите верзии. Па, или само треба да смениме нешто во кодот во зависност од верзијата на Revit за која го правиме додатокот. За да ги решиме таквите разлики во кодот, ќе користиме симболи за условна компилација. Отворете ги својствата на проектот, одете на табулаторот „Собрание„и на терен“Условна ознака за компилација„Ајде да напишеме R2015.

Забележете дека симболот мора да се додаде и за конфигурациите за Debug и Release.

Па, додека сме во прозорецот со својства, веднаш одиме на табулаторот „Апликација„и на терен“Стандарден именски простор» отстранете ја наставката _2015така што нашиот именски простор е универзален и независен од името на склопот:

Во мојот случај, во финалниот производ, приклучоците од сите верзии се ставаат во една папка, така што моите имиња на склопови остануваат со наставката на формуларот _20хх. Но, можете исто така да ја отстраните наставката од името на склопот ако датотеките се претпоставува дека се наоѓаат во различни папки.

Ајде да одиме на кодот на датотеката Класа 1.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. Но, датотеката Класа 1.cs избришете од новиот проект.

Датотека со потребната шифра - Класа 1.cs – веќе го имаме и само треба да вметнеме линк до него во нов проект. Постојат два начина за вметнување врски:

1. Долго – кликнете со десното копче на проектот и изберете „Додадете»->«Постоечки елемент", во прозорецот што се отвора, пронајдете ја потребната датотека и наместо опцијата "Додадете"избери ја опцијата"Додај како врска»

1. Кратко – директно во истражувачот на решенија, изберете ја саканата датотека (или дури и датотеки, па дури и цели папки) и повлечете ја во нов проект додека го држите копчето Alt. Како што влечете, ќе видите дека кога ќе го притиснете копчето Alt, курсорот на глувчето ќе се промени од знак плус во стрелка.
   UPD: Направив мала конфузија во овој пасус - за да префрлите неколку датотеки треба да држите притиснато Shift + Alt!

По спроведувањето на постапката ќе имаме досие во вториот проект Класа 1.cs со соодветната икона (сина стрелка):

Кога уредувате код во прозорецот на уредувачот, можете исто така да изберете во кој контекст на проектот да се прикаже кодот, што ќе ви овозможи да го видите кодот што се уредува под различни симболи за условна компилација:

Ние ги создаваме сите други проекти (2017-2020) користејќи ја оваа шема. Лајф хак - ако влечете датотеки во Solution Explorer не од основниот проект, туку од проектот каде што веќе се вметнати како врска, тогаш не мора да го држите копчето Alt!

Опишаната опција е доста добра до моментот на додавање нова верзија на приклучокот или до моментот на додавање нови датотеки во проектот - сето ова станува многу досадно. И неодамна одеднаш наеднаш сфатив како сето тоа да го средам со еден проект и преминуваме на вториот метод

Магијата на конфигурациите

Откако ќе завршите со читањето овде, можете да извикнете: „Зошто го опишавте првиот метод, ако написот е веднаш за вториот?!“ И опишав сè за да биде појасно зошто ни се потребни симболи за условна компилација и на кои места се разликуваат нашите проекти. И сега ни станува појасно какви точно разлики во проекти треба да реализираме, оставајќи само еден проект.

И за да биде сè поочигледно, нема да создадеме нов проект, туку ќе направиме промени во нашиот сегашен проект создаден на прв начин.

Значи, пред сè, ги отстрануваме сите проекти од решението освен главниот (што ги содржи директно датотеките). Оние. проекти за верзии 2016-2020. Отворете ја папката со решението и избришете ги папките на овие проекти таму.

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

1. На јазичето "Апликација„Отстранете ја наставката од името на склопот _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;R20хх
• TargetFrameworkVersion – верзија на платформата. Различни верзии на Revit API бараат да се специфицираат различни платформи.
• Име на Собранието – име на склопот (т.е. име на датотека). Можете да го напишете точното име на склопот, но за разновидност препорачувам да ја напишете вредноста $(AssemblyName)_20хх. За да го направите ова, претходно ја отстранивме наставката од името на склопот

Најважната карактеристика на сите овие елементи е што тие едноставно можат да се копираат во други проекти без воопшто да се менуваат. Подоцна во статијата ќе ја прикачам целата содржина на датотеката .csproj.

Добро, ги сфативме својствата на проектот - не е тешко. Но, што да правиме со библиотеките со приклучоци (пакети NuGet). Ако погледнеме понатаму, ќе видиме дека вклучените библиотеки се наведени во елементите Група на ставки. Но, лоша среќа - овој елемент погрешно ги обработува условите како елемент PropertyGroup. Можеби ова е дури и грешка на Visual Studio, но ако наведете неколку елементи Група на ставки со услови за конфигурација и внесете различни врски до пакетите 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.

Затоа, за сериско склопување, беше одлучено да се користи специјален автоматизиран систем за склопување Нуклеарка. Јас всушност не го сакав ова бидејќи мислам дека е претерано во однос на развојот на приклучоците, но во моментов не гледам друго решение. И на прашањето „Зошто Нук?“ Одговорот е едноставен - го користиме на работа.

Значи, одете во папката на нашето решение (не проектот), држете го клучот Префрлат и кликнете со десното копче на празен простор во папката - во контекстното мени изберете ја ставката “Отворете го прозорецот PowerShell овде".

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

dotnet tool install Nuke.GlobalTool –global

Сега напишете ја командата нуклеарка и ќе ви биде побарано да го конфигурирате нуклеарка за тековниот проект. Не знам како да го напишам ова поправилно на руски - на англиски ќе биде напишано Не можам да ја најдам датотеката .nuke. Дали сакате да поставите градба? [y/n]

Притиснете го копчето 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