Использование пользовательских преобразований Web.config в MSBUILD

Если вы впервые слышите о преобразованиях web.config, и синтаксис в моем примере выше не самый ясный, то вы найдете страницу MSDN о синтаксисе преобразования полезным чтением.

Так что же не так с использованием по умолчанию?

«Ну и что?»   Вы говорите: « Я использую их каждый день, и они работают нормально» . Основная проблема, которую я имею с «готовым решением», заключается в следующем;

Использование по умолчанию создает новое преобразование конфигурации для каждой конфигурации сборки сайта, на котором они находятся .

При использовании Visual Studio и щелчке правой кнопкой мыши на файле web.config и Add Config Transformations вы получите следующее

Для меня это большая проблема, так как почти во всех местах, где я работал, где используется непрерывная доставка или непрерывная интеграция с веб-сайтами ASP.Net, использовались конфигурации решений для переключения между различными средами сборки, а не конфигурации проекта.

Ваш веб-сайт должен иметь только две конфигурации сборки, которые вы используете для компиляции:

• отлаживать
• Выпуск

Ваша другая среда может быть:

• Местный
• Внутренняя постановка
• Гарантия качества
• Внешняя постановка
• производство
• ??

Но все вышеперечисленные среды будут скомпилированы либо в режиме отладки, либо в режиме выпуска, поэтому путая конфигурации сборки с конфигурациями среды, я чувствую, что вы вводите в настройку сборки какой-то серьезный « запах кода ».

В некоторых средах вы можете использовать то же преобразование web.config

Еще одна проблема, с которой я столкнулся при этой настройке, заключается в том, что она предполагает, что у вас есть разные преобразования для каждой из ваших конфигураций сборки. Что делать, если вы используете одинаковые конфигурации среды для ряда ваших конфигураций сборки? Ваша производственная среда, вероятно, должна быть такой же, как ваша производственная среда, например — я не начинаю знать ваши требования, но я знаю, что мои не такие жесткие, как эта.

В некоторых средах вы можете использовать несколько уровней преобразований web.config, применяемых поверх друг друга.

Другой случай, когда использование по умолчанию может не помечать все ваши блоки, это когда речь идет о объединении нескольких преобразований конфигурации. Возможность применения преобразований в функциональных группах вместо групп среды является очень мощным потенциальным использованием преобразований.

Так, где это оставляет нас?

Для меня это привело к тому, что я сильно хотел найти решение, которое могло бы дать мне такой уровень детализации, при этом все еще используя инструменты преобразования, встроенные в Visual Studio, и все приятные функциональные возможности, основанные на соглашениях, которые приходят с их использованием. До этого момента я был большим поклонником абстрагирования моих конфигов на основе среды, используя что-то похожее на приведенное ниже и меняя строку «\ Live \» во время сборки:

<configuration>
    <appSettings configSource ="Configs\Live\AppSettings.config" />
</configuration>

<UsingTask TaskName="TransformXml"
                        AssemblyFile="$(MSBuildExtensionsPath)\Microsoft\VisualStudio\v10.0\Web\Microsoft.Web.Publishing.Tasks.dll"/>
<Target Name="TransformWebConfig">
    <TransformXml Source="C:\Code\MyProject\Web.config"
                  Transform="C:\Code\MyProject\TransformFile.config"
                  Destination="C:\Code\MyProject\Web.config"
                  StackTrace="true" />
</Target>

<UsingTask TaskName="TransformXml"
                        AssemblyFile="$(MSBuildExtensionsPath)\Microsoft\VisualStudio\v10.0\Web\Microsoft.Web.Publishing.Tasks.dll"/>
<Target Name="TransformWebConfig">
    <ItemGroup>
        <OriginalWebConfig Include="C:\Code\MyProject\Web.config"/>
        <TempWebConfig Include="C:\Code\MyProject\TempWeb.config"/>
    </ItemGroup>
    <Copy SourceFiles="@(OriginalWebConfig)" DestinationFiles="@(TempWebConfig)" />
    <TransformXml Source="C:\Code\MyProject\TempWeb.config"
                            Transform="C:\Code\MyProject\TransformFile.config"
                            Destination="C:\Code\MyProject\Web.config"
                            StackTrace="true" />
    <Delete Files="@(TempWebConfig)" />
</Target>

<!-- Setup the transformation file to use -->
<PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Deploy - Staging|AnyCPU'">
    <WebConfigReplacement>Staging</WebConfigReplacement>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Deploy - Production|AnyCPU'">
    <WebConfigReplacement>Production</WebConfigReplacement>
</PropertyGroup>

<UsingTask TaskName="TransformXml"
                        AssemblyFile="$(MSBuildExtensionsPath)\Microsoft\VisualStudio\v10.0\Web\Microsoft.Web.Publishing.Tasks.dll"/>
<PropertyGroup>
    <TransformInputFile>$(OutputPath)\Deployment\Web.Temp.config</TransformInputFile>
    <TransformFile>$(OutputPath)\Deployment\Web.$(WebConfigReplacement).config</TransformFile>
    <TransformOutputFile>$(OutputPath)\Web.config</TransformOutputFile>
    <StackTraceEnabled>False</StackTraceEnabled>
</PropertyGroup>
<ItemGroup>
    <OriginalWebConfig Include="$(OutputPath)\Web.config"/>
    <TempWebConfig Include="$(OutputPath)\Deployment\Web.Temp.config"/>
</ItemGroup>
<Target Name="TransformWebConfig"
                Condition="'$(Configuration)|$(Platform)' == 'Deploy - Production|AnyCPU' Or '$(Configuration)|$(Platform)' == 'Deploy - Staging|AnyCPU'">
    <!-- Copy our web.config into a temp folder as the 'TransformXml' task has a file lock bug -->
    <Copy SourceFiles="@(OriginalWebConfig)" DestinationFiles="@(TempWebConfig)" />

    <TransformXml Source="$(TransformInputFile)"
                                Transform="$(TransformFile)"
                                Destination="$(TransformOutputFile)"
                                StackTrace="$(StackTraceEnabled)" />
    <Delete Files="@(TempWebConfig)"/>
</Target>