App.Config Transformation dla projektów, które nie są projektami sieciowymi w Visual Studio?

W przypadku aplikacji sieci Web Visual Studio 2010 mamy funkcje Transformacji konfiguracji, dzięki którym możemy utrzymywać wiele plików konfiguracyjnych dla różnych środowisk. Ale ta sama funkcja nie jest dostępna dla plików App.Config dla usług Windows / WinForms lub aplikacji konsolowej.

Dostępne jest obejście, jak sugerowano tutaj: Zastosowanie magii XDT do App.Config .

Nie jest to jednak proste i wymaga szeregu kroków. Czy istnieje łatwiejszy sposób na osiągnięcie tego samego w przypadku plików app.config?

Działa to teraz z dodatkiem Visual Studio AddIn opisanym w tym artykule: SlowCheetah - Web.config Składnia transformacji uogólniona dla dowolnego pliku konfiguracyjnego XML .

Możesz kliknąć prawym przyciskiem myszy plik web.config i kliknąć „Dodaj transformacje konfiguracji”. Gdy to zrobisz, otrzymasz web.debug.config i web.release.config. Jeśli chcesz, możesz utworzyć plik web.whokolwiek.config, o ile nazwa jest zgodna z profilem konfiguracji. Te pliki to tylko zmiany, które chcesz wprowadzić, a nie pełna kopia pliku web.config.

Możesz pomyśleć, że chcesz użyć XSLT do przekształcenia pliku web.config, ale choć intuicyjnie mają rację, w rzeczywistości jest bardzo gadatliwy.

Oto dwie transformacje, jedna przy użyciu XSLT i ta sama przy użyciu składni / przestrzeni nazw XML Document Transform. Podobnie jak w przypadku wszystkich rzeczy w XSLT jest wiele sposobów na zrobienie tego, ale masz ogólny pomysł. XSLT jest uogólnionym językiem transformacji drzewa, podczas gdy to wdrożenie jest zoptymalizowane pod kątem określonego podzestawu typowych scenariuszy. Ale fajne jest to, że każda transformacja XDT jest wtyczką .NET, więc możesz stworzyć własną.

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

Lub to samo poprzez transformację wdrażania:

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

Wypróbowałem kilka rozwiązań i oto najprostsze, jakie osobiście znalazłem.
Dan zauważył w komentarzach, że oryginalny post należy do Olega Sycha - dzięki, Oleg!

Oto instrukcje:

1. Dodaj plik XML dla każdej konfiguracji do projektu.

Zazwyczaj będziesz mieć Debugi Releasekonfiguracje, więc nazwij swoje pliki App.Debug.configi App.Release.config. W moim projekcie stworzyłem konfigurację dla każdego rodzaju środowiska, więc możesz z tym eksperymentować.

2. Zwolnij projekt i otwórz plik .csproj do edycji

Visual Studio umożliwia edytowanie plików .csproj bezpośrednio w edytorze - wystarczy najpierw rozładować projekt. Następnie kliknij go prawym przyciskiem myszy i wybierz opcję Edycja <Nazwa projektu> .csproj .

3. Powiąż pliki aplikacji. *. Config z głównym plikiem App.config

Znajdź sekcję pliku projektu, która zawiera wszystkie App.configi App.*.configodniesienia. Zauważysz, że ich działania kompilacji są ustawione na None:

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

Najpierw ustaw akcję budowania dla wszystkich Content.
Następnie uzależnij wszystkie pliki specyficzne od konfiguracji od głównego, App.configaby program Visual Studio grupował je tak, jak robi to pliki projektanta i kodu.

Zamień XML powyżej na poniższy:

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

4. Aktywuj magię transformacji (konieczne tylko dla wersji Visual Studio wcześniejszych niż VS2017 )

Na końcu pliku po

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

i przed finałem

</Project>

wstaw następujący kod XML:

  <UsingTask TaskName="TransformXml" AssemblyFile="$(MSBuildExtensionsPath)\Microsoft\VisualStudio\v$(VisualStudioVersion)\Web\Microsoft.Web.Publishing.Tasks.dll" />
  <Target Name="CoreCompile" Condition="exists('app.$(Configuration).config')">
    <!-- Generate transformed app config in the intermediate directory -->
    <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>

Teraz możesz ponownie załadować projekt, zbudować go i cieszyć się App.configtransformacjami!

Do Twojej wiadomości

Upewnij się, że twoje App.*.configpliki mają odpowiednią konfigurację:

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

Innym rozwiązaniem, które znalazłem, jest NIE używanie transformacji, ale tylko oddzielny plik konfiguracyjny, np. App.Release.config. Następnie dodaj tę linię do pliku csproj.

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

Spowoduje to nie tylko wygenerowanie właściwego pliku myprogram.exe.config, ale jeśli do generowania MSI używasz Instalatora i projektu wdrażania w programie Visual Studio, wymusi on, aby projekt wdrożenia używał poprawnego pliku konfiguracji podczas pakowania.

Z mojego doświadczenia wynika, że ​​muszę dostosować do środowiska takie jak parametry połączenia, ustawienia i często ustawienia smpt. System konfiguracji pozwala określić te rzeczy w osobnych plikach. Możesz więc użyć tego w app.config / web.config:

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

Zazwyczaj umieszczam te sekcje dotyczące konfiguracji w osobnych plikach, w podfolderze o nazwie ConfigFiles (w zależności od katalogu głównego rozwiązania lub na poziomie projektu). Plik definiuję według konfiguracji, np. Smtp.config.Debug i smtp.config.Release.

Następnie możesz zdefiniować zdarzenie przed kompilacją:

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

W rozwoju zespołu możesz to jeszcze bardziej ulepszyć, włączając do konwencji% COMPUTERNAME% i / lub% USERNAME%.

Oczywiście oznacza to, że pliki docelowe (x.config) NIE powinny być poddawane kontroli źródła (ponieważ są generowane). Nadal powinieneś dodać je do pliku projektu i ustawić właściwość typu wyniku na „kopiuj zawsze” lub „kopiuj, jeśli nowszy”.

Prosty, rozszerzalny i działa dla wszystkich typów projektów Visual Studio (konsola, winforms, wpf, web).

Zainspirowany przez Olega i innych w tym pytaniu, podjąłem rozwiązanie https://stackoverflow.com/a/5109530/2286801 o krok dalej, aby umożliwić następujące.

• Działa z ClickOnce
• Współpracuje z projektami instalacji i wdrażania w VS 2010
• Działa z VS2010, 2013, 2015 (nie testowałem 2012, chociaż powinien również działać).
• Działa z Team Build. (Musisz zainstalować A) Visual Studio lub B) Microsoft.Web.Publishing.targets i Microsoft.Web.Publishing.Tasks.dll)

To rozwiązanie działa, wykonując transformację app.config przed odwołaniem do app.config po raz pierwszy w procesie MSBuild. Wykorzystuje zewnętrzny plik celów do łatwiejszego zarządzania wieloma projektami.

Instrukcje:

Podobne kroki do drugiego rozwiązania. Przytoczyłem to, co pozostaje niezmienne, i załączyłem to dla kompletności i łatwiejszego porównania.

0. Dodaj nowy plik do projektu o nazwie 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. Dodaj plik XML dla każdej konfiguracji do projektu.

Zazwyczaj będziesz mieć konfiguracje debugowania i wydania, więc nazwij swoje pliki App.Debug.config i App.Release.config. W moim projekcie stworzyłem konfigurację dla każdego rodzaju środowiska, więc możesz z tym eksperymentować.

2. Zwolnij projekt i otwórz plik .csproj do edycji

Visual Studio pozwala edytować .csproj bezpośrednio w edytorze - wystarczy najpierw rozładować projekt. Następnie kliknij go prawym przyciskiem myszy i wybierz Edytuj .csproj.

3. Powiąż pliki aplikacji. *. Config z głównym plikiem App.config

Znajdź sekcję pliku projektu zawierającą wszystkie odwołania do App.config i App. *. Config i zamień w następujący sposób. Zauważysz, że używamy None zamiast Treści.

<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. Aktywuj magię transformacji

Na końcu pliku po

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

i przed finałem

</Project>

wstaw następujący kod XML:

<Import Project="AppConfigTransformation.targets" />

Gotowy!

Możesz użyć oddzielnego pliku konfiguracyjnego dla każdej konfiguracji, np. App.Debug.config, app.Release.config, a następnie użyć zmiennej konfiguracyjnej w pliku projektu:

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

Spowoduje to utworzenie poprawnego pliku ProjectName.exe.config w zależności od konfiguracji, w której budujesz.

Napisałem ładne rozszerzenie do automatyzacji transformacji app.config, takie jak wbudowane w Web Application Project Configuration Transform

Największą zaletą tego rozszerzenia jest to, że nie trzeba go instalować na wszystkich komputerach

Zainstaluj „Narzędzie do transformacji konfiguracji” w Visual Studio z Marketplace i zrestartuj VS. Zobaczysz także transformację podglądu menu dla app.config.

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

Skończyłem więc z nieco innym podejściem. Postępowałem zgodnie z krokami Dana przez krok 3, ale dodałem inny plik: App.Base.Config. Ten plik zawiera ustawienia konfiguracji, które chcesz w każdej wygenerowanej aplikacji. Konfiguracji. Następnie używam BeforeBuild (z dodatkiem Yuri do TransformXml), aby przekształcić bieżącą konfigurację z konfiguracją Base w App.config. Proces kompilacji używa następnie przekształconego pliku App.config w normalny sposób. Jednak jedną z irytacji jest to, że chcesz w jakiś sposób wykluczyć ciągle zmieniający się plik App.config z kontroli źródła, ale inne pliki konfiguracyjne są teraz od niego zależne.

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

Tylko mała poprawka do rozwiązania, które wydaje się być teraz wszędzie wszędzie:

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

• to znaczy, chyba że planujesz pozostać przy obecnej wersji VS na zawsze

Stworzyłem inną alternatywę dla tej opublikowanej przez Vishala Joshi, w której usunięto wymóg zmiany działania kompilacji na Treść, a także zaimplementowałem podstawową obsługę wdrażania ClickOnce. Mówię podstawowy, ponieważ nie przetestowałem go dokładnie, ale powinien działać w typowym scenariuszu wdrażania ClickOnce.

Rozwiązanie składa się z pojedynczego projektu MSBuild, który po zaimportowaniu do istniejącego projektu aplikacji systemu Windows (* .csproj) rozszerza proces kompilacji o transformację app.config.

Bardziej szczegółowe objaśnienie można przeczytać na stronie Visual Studio App.config XML Transformation i plik projektu MSBuild może być pobrać z GitHub .

Jeśli korzystasz z TFS online (wersja w chmurze) i chcesz przekształcić App.Config w projekcie, możesz wykonać następujące czynności bez instalowania dodatkowych narzędzi. Od VS => Zwolnij projekt => Edytuj plik projektu => Idź na dół pliku i dodaj:

<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 and Destination działa na użytek lokalny i serwer TFS online (Cloud).

proponowane rozwiązanie nie będzie działać, gdy do biblioteki klas z plikiem konfiguracyjnym zostanie odwołany inny projekt (w moim przypadku była to biblioteka projektów roboczych Azure). Nie skopiuje poprawnego transformowanego pliku z objfolderu do bin\##configuration-name##folderu. Aby działało z minimalnymi zmianami, musisz zmienić AfterCompilecel na BeforeCompile:

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