Преобразование App.Config для проектов, которые не являются веб-проектами в Visual Studio?

Теперь это работает с надстройкой Visual Studio, рассмотренной в этой статье: SlowCheetah - общее преобразование с помощью синтаксиса Web.configized. любой файл конфигурации XML.

Вы можете щелкнуть правой кнопкой мыши свой web.config и выбрать «Добавить преобразования конфигурации». Когда вы это сделаете, вы получите файлы web.debug.config и web.release.config. Вы можете создать web.whatever.config, если хотите, если имя совпадает с профилем конфигурации. Эти файлы - это просто изменения, которые вы хотите внести, а не полная копия вашего web.config.

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

Вот два преобразования, одно с использованием XSLT, а другое с использованием синтаксиса / пространства имен преобразования XML-документа. Как и во всем остальном, в XSLT есть несколько способов сделать это, но вы поняли общую идею. XSLT - это обобщенный язык преобразования дерева, в то время как этот язык развертывания оптимизирован для определенного подмножества общих сценариев. Но самое интересное то, что каждое преобразование XDT - это плагин .NET, так что вы можете создавать свои собственные.

<?xml version="1.0" ?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
<xsl:template match="@*|node()">
  <xsl:copy>           
    <xsl:apply-templates select="@*|node()"/>
  </xsl:copy>
</xsl:template>
<xsl:template match="/configuration/appSettings">
  <xsl:copy>
    <xsl:apply-templates select="node()|@*"/>
    <xsl:element name="add">
      <xsl:attribute name="key">NewSetting</xsl:attribute>
      <xsl:attribute name="value">New Setting Value</xsl:attribute>
    </xsl:element>
  </xsl:copy>
</xsl:template>
</xsl:stylesheet>

Или то же самое через преобразование развертывания:

<configuration xmlns:xdt="http://schemas.microsoft.com/XML-Document-Transform">
   <appSettings>
      <add name="NewSetting" value="New Setting Value" xdt:Transform="Insert"/>
   </appSettings>
</configuration>

Я пробовал несколько решений, и вот самое простое, которое я нашел лично.
Дэн указал в комментариях, что исходное сообщение принадлежит Олегу Сычу - спасибо, Олег!

Вот инструкции:

1. Добавьте в проект XML-файл для каждой конфигурации.

Обычно у вас будут конфигурации Debug и Release, поэтому назовите файлы App.Debug.config и App.Release.config. В своем проекте я создал конфигурацию для каждого типа среды, так что вы можете поэкспериментировать с этим.

2. Выгрузите проект и откройте файл .csproj для редактирования.

Visual Studio позволяет редактировать файлы .csproj прямо в редакторе - вам просто нужно сначала выгрузить проект. Затем щелкните его правой кнопкой мыши и выберите Изменить ‹ProjectName› .csproj.

3. Свяжите файлы конфигурации App. *. Config с основным файлом App.config

Найдите раздел файла проекта, который содержит все ссылки App.config и App.*.config. Вы заметите, что их действия по сборке установлены на None, и это нормально:

<None Include="App.config" />
<None Include="App.Debug.config" />
<None Include="App.Release.config" />

Затем сделайте все специфичные для конфигурации файлы зависимыми от главного App.config, чтобы Visual Studio сгруппировала их так же, как файлы конструктора и файлы кода программной части.

Замените приведенный выше XML на приведенный ниже:

<None Include="App.config" />
<None Include="App.Debug.config" >
  <DependentUpon>App.config</DependentUpon>
</None>
<None Include="App.Release.config" >
  <DependentUpon>App.config</DependentUpon>
</None>

4. Активировать магию преобразований (по-прежнему необходимо для таких версий Visual Studio, как VS2019)

В конце файла после

<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />

и перед финалом

</Project>

вставьте следующий XML-код - обратите внимание, что для правильного преобразования необходимо выполнить два шага:

  <UsingTask TaskName="TransformXml" AssemblyFile="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\Web\Microsoft.Web.Publishing.Tasks.dll" />
  <Target Name="BeforeBuild" Condition="Exists('App.$(Configuration).config')">
    <!-- Generate transformed app config and replace it: will get the <runtime> node and assembly bindings properly populated -->
    <TransformXml Source="App.config" Destination="App.config" Transform="App.$(Configuration).config" />
  </Target>
  <Target Name="AfterBuild" Condition="Exists('App.$(Configuration).config')">
    <!-- Generate transformed app config in the intermediate directory: this will transform sections such as appSettings -->
    <TransformXml Source="App.config" Destination="$(IntermediateOutputPath)$(TargetFileName).config" Transform="App.$(Configuration).config" />
    <!-- Force build process to use the transformed configuration file from now on.-->
    <ItemGroup>
      <AppConfigWithTargetPath Remove="App.config" />
      <AppConfigWithTargetPath Include="$(IntermediateOutputPath)$(TargetFileName).config">
        <TargetPath>$(TargetFileName).config</TargetPath>
      </AppConfigWithTargetPath>
    </ItemGroup>
  </Target>

Теперь вы можете перезагрузить проект, собрать его и наслаждаться App.config преобразованиями!

К вашему сведению

Убедитесь, что ваши App.*.config файлы правильно настроены следующим образом:

<?xml version="1.0" encoding="utf-8"?>
<configuration xmlns:xdt="http://schemas.microsoft.com/XML-Document-Transform">
     <!--magic transformations here-->
</configuration>

Другое решение, которое я нашел, - НЕ использовать преобразования, а просто иметь отдельный файл конфигурации, например. app.Release.config. Затем добавьте эту строку в свой файл csproj.

  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
    <AppConfig>App.Release.config</AppConfig>
  </PropertyGroup>

Это не только создаст правильный файл myprogram.exe.config, но и если вы используете проект установки и развертывания в Visual Studio для создания MSI, это заставит проект развертывания использовать правильный файл конфигурации при упаковке.

Вдохновленный Олегом и другими в этом вопросе, я принял решение https://stackoverflow.com/a/5109530/2286801 еще на шаг, чтобы включить следующее.

• Работает с ClickOnce
• Работает с проектами установки и развертывания в VS 2010.
• Работает с VS2010, 2013, 2015 (не тестировал 2012 год, хотя тоже должен работать).
• Работает с Team Build. (Вы должны установить A) Visual Studio или B) Microsoft.Web.Publishing.targets и Microsoft.Web.Publishing.Tasks.dll)

Это решение работает, выполняя преобразование app.config перед первым обращением к app.config в процессе MSBuild. Он использует файл внешних целей для упрощения управления несколькими проектами.

Инструкции:

Аналогичные шаги для другого решения. Я процитировал то, что осталось прежним, и включил его для полноты и простоты сравнения.

0. Добавьте в проект новый файл под названием AppConfigTransformation.targets.

<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <!-- Transform the app config per project configuration.-->
  <PropertyGroup>
    <!-- This ensures compatibility across multiple versions of Visual Studio when using a solution file.
         However, when using MSBuild directly you may need to override this property to 11.0 or 12.0 
         accordingly as part of the MSBuild script, ie /p:VisualStudioVersion=11.0;
         See http://blogs.msdn.com/b/webdev/archive/2012/08/22/visual-studio-project-compatability-and-visualstudioversion.aspx -->
    <VisualStudioVersion Condition="'$(VisualStudioVersion)' == ''">10.0</VisualStudioVersion>
  </PropertyGroup>

  <Import Project="$(MSBuildExtensionsPath)\Microsoft\VisualStudio\v$(VisualStudioVersion)\Web\Microsoft.Web.Publishing.targets" />

  <Target Name="SetTransformAppConfigDestination" BeforeTargets="PrepareForBuild" 
          Condition="exists('app.$(Configuration).config')">
    <PropertyGroup>
      <!-- Force build process to use the transformed configuration file from now on. -->
      <AppConfig>$(IntermediateOutputPath)$(TargetFileName).config</AppConfig>
    </PropertyGroup>
    <Message Text="AppConfig transformation destination: = $(AppConfig)" />
  </Target>

  <!-- Transform the app.config after the prepare for build completes. -->
  <Target Name="TransformAppConfig" AfterTargets="PrepareForBuild" Condition="exists('app.$(Configuration).config')">
    <!-- Generate transformed app config in the intermediate directory -->
    <TransformXml Source="app.config" Destination="$(AppConfig)" Transform="app.$(Configuration).config" />
  </Target>

</Project>

1. Добавьте в проект XML-файл для каждой конфигурации.

Обычно у вас есть конфигурации отладки и выпуска, поэтому назовите свои файлы App.Debug.config и App.Release.config. В своем проекте я создал конфигурацию для каждого типа среды, так что вы можете поэкспериментировать с этим.

2. Выгрузите проект и откройте файл .csproj для редактирования.

Visual Studio позволяет редактировать .csproj прямо в редакторе - вам просто нужно сначала выгрузить проект. Затем щелкните его правой кнопкой мыши и выберите «Изменить .csproj».

3. Привязать файлы конфигурации App. *. К основному файлу App.config

Найдите раздел файла проекта, содержащий все ссылки на App.config и App. *. Config, и замените его следующим образом. Вы заметите, что мы используем None вместо Content.

<ItemGroup>
  <None Include="app.config"/>
  <None Include="app.Production.config">
    <DependentUpon>app.config</DependentUpon>
  </None>
  <None Include="app.QA.config">
    <DependentUpon>app.config</DependentUpon>
  </None>
  <None Include="app.Development.config">
    <DependentUpon>app.config</DependentUpon>
  </None>
</ItemGroup>

4. Activate transformations magic

В конце файла после

<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />

и перед финалом

</Project>

вставьте следующий XML:

<Import Project="AppConfigTransformation.targets" />

Выполнено!

По моему опыту, вещи, которые мне нужно сделать зависящими от среды, - это такие вещи, как строки подключения, настройки приложений и часто настройки smpt. Система конфигурации позволяет указывать эти вещи в отдельных файлах. Таким образом, вы можете использовать это в своем app.config / web.config:

 <appSettings configSource="appsettings.config" />
 <connectionStrings configSource="connection.config" />
 <system.net>
    <mailSettings>
       <smtp configSource="smtp.config"/>
    </mailSettings>
 </system.net>

Обычно я помещаю эти разделы, относящиеся к конфигурации, в отдельные файлы, во вложенную папку с именем ConfigFiles (в зависимости от того, в корне решения или на уровне проекта). Я определяю файл для каждой конфигурации, например smtp.config.Debug и smtp.config.Release.

Затем вы можете определить событие перед сборкой следующим образом:

copy $(ProjectDir)ConfigFiles\smtp.config.$(ConfigurationName) $(TargetDir)smtp.config

В командной разработке вы можете настроить это дальше, включив в соглашение% COMPUTERNAME% и / или% USERNAME%.

Конечно, это означает, что целевые файлы (x.config) НЕ следует помещать в систему управления версиями (поскольку они создаются). Вы все равно должны добавить их в файл проекта и установить для их свойства типа вывода значение «всегда копировать» или «копировать, если новее».

Простой, расширяемый и работает для всех типов проектов Visual Studio (консоль, winforms, wpf, веб).

Вы можете использовать отдельный файл конфигурации для каждой конфигурации, например app.Debug.config, app.Release.config, а затем используйте переменную конфигурации в файле проекта:

<PropertyGroup>
    <AppConfig>App.$(Configuration).config</AppConfig>
</PropertyGroup>

Затем будет создан правильный файл ProjectName.exe.config в зависимости от конфигурации, которую вы создаете.

Я написал красивое расширение для автоматизации преобразования app.config, подобное встроенному в проект веб-приложения Преобразование конфигурации

Самым большим преимуществом этого расширения является то, что вам не нужно устанавливать его на всех сборочных машинах.

Установите «Инструмент преобразования конфигурации» в Visual Studio из Marketplace и перезапустите VS. Вы также сможете увидеть преобразование предварительного просмотра меню для app.config.

https://marketplace.visualstudio.com/items?itemName=GolanAvraham.ConfigurationTransform

Небольшое улучшение решения, которое сейчас, кажется, публикуется повсюду:

<UsingTask TaskName="TransformXml" AssemblyFile="$(MSBuildExtensionsPath)\Microsoft\VisualStudio\v$(VisualStudioVersion)\Web\Microsoft.Web.Publishing.Tasks.dll" />

• то есть, если вы не планируете навсегда оставаться с текущей версией VS

Так что в итоге я выбрал немного другой подход. Я выполнил шаги Дэна через шаг 3, но добавил еще один файл: App.Base.Config. Этот файл содержит параметры конфигурации, которые вы хотите использовать в каждом сгенерированном App.Config. Затем я использую BeforeBuild (с добавлением Юрия к TransformXml), чтобы преобразовать текущую конфигурацию с базовой конфигурацией в файл App.config. Затем процесс сборки использует преобразованный файл App.config как обычно. Тем не менее, одна неприятность заключается в том, что вы как бы хотите исключить постоянно меняющийся App.config из системы управления версиями впоследствии, но другие файлы конфигурации теперь зависят от него.

  <UsingTask TaskName="TransformXml" AssemblyFile="$(MSBuildExtensionsPath)\Microsoft\VisualStudio\v$(VisualStudioVersion)\Web\Microsoft.Web.Publishing.Tasks.dll" />
  <Target Name="BeforeBuild" Condition="exists('app.$(Configuration).config')">
    <TransformXml Source="App.Base.config" Transform="App.$(Configuration).config" Destination="App.config" />
  </Target>

Я создал другую альтернативу тому, что опубликовал Вишал Джоши, в котором снято требование изменить действие сборки на Content, а также реализована базовая поддержка развертывания ClickOnce. Я говорю «базовый», потому что я не тестировал его полностью, но он должен работать в типичном сценарии развертывания ClickOnce.

Решение состоит из одного проекта MSBuild, который после импорта в существующий проект приложения Windows (* .csproj) расширяет процесс сборки, чтобы предусмотреть преобразование app.config.

Вы можете прочитать более подробное объяснение на странице Visual Studio App.config XML Transformation и файл проекта MSBuild можно загрузить с GitHub.

Если вы используете TFS онлайн (облачная версия) и хотите преобразовать App.Config в проекте, вы можете сделать следующее, не устанавливая никаких дополнительных инструментов. Из VS => Выгрузить проект => Редактировать файл проекта => Перейти в конец файла и добавить следующее:

<UsingTask TaskName="TransformXml" AssemblyFile="$(MSBuildExtensionsPath)\Microsoft\VisualStudio\v$(VisualStudioVersion)\Web\Microsoft.Web.Publishing.Tasks.dll" />
<Target Name="AfterBuild" Condition="Exists('App.$(Configuration).config')">
<TransformXml Source="App.config" Transform="App.$(Configuration).config" Destination="$(OutDir)\$(AssemblyName).dll.config" />

AssemblyFile и Destination работают для локального использования и для онлайн-сервера TFS (облачного).

Предлагаемое решение не будет работать, если на библиотеку классов с файлом конфигурации ссылается другой проект (в моем случае это была библиотека рабочего проекта Azure). Он не скопирует корректный преобразованный файл из папки obj в папку bin\##configuration-name##. Чтобы он работал с минимальными изменениями, вам нужно изменить AfterCompile target на BeforeCompile:

<Target Name="BeforeCompile" Condition="exists('app.$(Configuration).config')">

Примечание. Из-за репутации я не могу комментировать bdeem сообщение. Вместо этого я публикую свои выводы в качестве ответа.

После bdeem сообщения, я сделал следующее (по порядку):

1. Я модифицировал [project].csproj файл. Добавлены теги <Content Include="" /> в ItemGroup для различных config файлов и поставлены в зависимость от исходного config файла.

Примечание. Использование <None Include="" /> не работает с преобразованием.

<!-- App.config Settings -->
<!-- Create App.($Configuration).config files here. -->
<Content Include="App.config" />
<Content Include="App.Debug.config">
  <DependentUpon>App.config</DependentUpon>
</Content>
<Content Include="App.Release.config">
  <DependentUpon>App.config</DependentUpon>
</Content>

2. Внизу файла [project].csproj (перед закрывающим тегом </Project>) я импортировал файл ${MSBuildToolsPath\Microsoft.CSharp.targets, добавил UsingTask для преобразования XML и добавил Target, чтобы скопировать преобразованный файл App.config в место вывода.

Примечание: Target также перезапишет App.Config в локальном каталоге, чтобы сразу увидеть изменения, работающие локально. Target также использует свойство Name="Afterbuild", чтобы файлы конфигурации можно было преобразовать после создания исполняемых файлов. По непонятным мне причинам при использовании конечных точек WCF, если я использую Name="CoreCompile", я получаю предупреждения об атрибутах службы. Name="Afterbuild" решил это.

  <!-- Task to transform the App.config using the App.($Configuration).config file. -->
  <UsingTask TaskName="TransformXml" AssemblyFile="$(MSBuildExtensionsPath)\Microsoft\VisualStudio\v$(VisualStudioVersion)\Web\Microsoft.Web.Publishing.Tasks.dll" />

  <!-- Only compile the App.config if the App.($Configuration).config file exists. -->
  <!-- Make sure to use the AfterBuild name instead of CoreCompile to avoid first time build errors and WCF endpoint errors. -->
  <Target Name="AfterBuild" Condition="exists('App.$(Configuration).config')">
    <!-- Generate transformed App.config in the intermediate output directory -->    
    <TransformXml Source="App.config" Destination="$(IntermediateOutputPath)$(TargetFileName).config" Transform="App.$(Configuration).config" />
    
    <!-- Modify the original App.config file with the transformed version. -->
    <TransformXml Source="App.config" Destination="App.config" Transform="App.$(Configuration).config" />

    <!-- Force build process to use the transformed configuration file from now on. -->
    <ItemGroup>
      <AppConfigWithTargetPath Remove="App.config" />
      <AppConfigWithTargetPath Include="$(IntermediateOutputPath)$(TargetFileName).config">
        <TargetPath>$(TargetFileName).config</TargetPath>
      </AppConfigWithTargetPath>
    </ItemGroup>
  </Target>
</Project>

3. Вернулся в Visual Studio и перезагрузил измененные файлы.

4. Вручную добавил в проект App.*.config файлы. Это позволило им сгруппироваться под исходным App.config файлом.

Примечание. Убедитесь, что файлы App.*.config имеют правильную структуру XML.

<?xml version="1.0" encoding="utf-8"?>

<!-- For more information on using web.config transformation visit https://go.microsoft.com/fwlink/?LinkId=125889 -->

<configuration xmlns:xdt="http://schemas.microsoft.com/XML-Document-Transform">
  <connectionStrings>
    <add name="myConn" connectionString=""; Initial Catalog=; User ID=; Password=;" xdt:Transform="SetAttributes" xdt:Locator="Match(name)" />
  </connectionStrings>
</configuration>

5. Перестроил проект.