Chuyển đổi App.Config cho các dự án không phải là Dự án Web trong Visual Studio?

Đối với ứng dụng dựa trên web Visual Studio 2010, chúng tôi có các tính năng Chuyển đổi cấu hình để chúng tôi có thể duy trì nhiều tệp cấu hình cho các môi trường khác nhau. Nhưng tính năng tương tự không có sẵn cho các tệp App.Config cho Windows Services / WinForms hoặc Console Application.

Có một cách giải quyết có sẵn như được đề xuất ở đây: Áp dụng phép thuật XDT cho App.Config .

Tuy nhiên nó không đơn giản và đòi hỏi một số bước. Có cách nào dễ dàng hơn để đạt được điều tương tự cho các tệp app.config không?

Điều này hiện hoạt động với Visual Studio AddIn được xử lý trong bài viết này: SlowCheetah - Cú pháp chuyển đổi Web.config hiện được khái quát hóa cho bất kỳ tệp cấu hình XML nào .

Bạn có thể nhấp chuột phải vào web.config và nhấp vào "Thêm Cấu hình chuyển đổi." Khi bạn làm điều này, bạn sẽ nhận được một web.debug.config và web.release.config. Bạn có thể tạo một web.whthing.config nếu bạn muốn, miễn là tên được xếp cùng với cấu hình cấu hình. Các tệp này chỉ là những thay đổi bạn muốn thực hiện, không phải là bản sao hoàn chỉnh của web.config.

Bạn có thể nghĩ rằng bạn muốn sử dụng XSLT để chuyển đổi web.config, nhưng trong khi họ cảm thấy bằng trực giác thì thực sự rất dài dòng.

Đây là hai biến đổi, một biến đổi sử dụng XSLT và một biến đổi sử dụng cú pháp / không gian tên Biến đổi tài liệu XML. Như với tất cả mọi thứ, có nhiều cách trong XSLT để làm điều này, nhưng bạn có ý tưởng chung. XSLT là ngôn ngữ chuyển đổi cây tổng quát, trong khi triển khai này được tối ưu hóa cho một tập hợp con cụ thể của các kịch bản phổ biến. Nhưng, điều thú vị là mỗi biến đổi XDT là một plugin .NET, vì vậy bạn có thể tự tạo.

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

Hoặc điều tương tự thông qua chuyển đổi triển khai:

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

Tôi đã thử một vài giải pháp và đây là cách đơn giản nhất mà cá nhân tôi tìm thấy.
Dan đã chỉ ra trong các ý kiến ​​rằng bài viết gốc thuộc về Oleg Sych - cảm ơn, Oleg!

Dưới đây là hướng dẫn:

1. Thêm một tệp XML cho mỗi cấu hình cho dự án.

Thông thường, bạn sẽ có Debugvà Releasecấu hình để đặt tên cho tệp của bạn App.Debug.configvà App.Release.config. Trong dự án của tôi, tôi đã tạo một cấu hình cho từng loại môi trường, vì vậy bạn có thể muốn thử nghiệm điều đó.

2. Dỡ bỏ dự án và mở tệp .csproj để chỉnh sửa

Visual Studio cho phép bạn chỉnh sửa các tệp .csproj ngay trong trình soạn thảo, bạn chỉ cần dỡ dự án trước. Sau đó nhấp chuột phải vào nó và chọn Chỉnh sửa <ProjectName> .csproj .

3. Liên kết các tệp. *. Cấu hình thành App.config chính

Tìm phần tập tin dự án có chứa tất cả App.configvà App.*.configtài liệu tham khảo. Bạn sẽ nhận thấy các hành động xây dựng của họ được đặt thành None:

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

Đầu tiên, thiết lập hành động xây dựng cho tất cả chúng Content.
Tiếp theo, làm cho tất cả các tệp cụ thể cấu hình phụ thuộc vào chính App.configđể Visual Studio nhóm chúng giống như các tệp thiết kế và mã phía sau.

Thay thế XML ở trên bằng một cái bên dưới:

<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. Kích hoạt ma thuật biến đổi (chỉ cần thiết cho các phiên bản Visual Studio trước VS2017 )

Vào cuối tập tin sau

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

và trước trận chung kết

</Project>

chèn XML sau:

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

Bây giờ bạn có thể tải lại dự án, xây dựng nó và tận hưởng các App.configbiến đổi!

FYI

Đảm bảo rằng các App.*.configtệp của bạn có thiết lập đúng như thế này:

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

Một giải pháp khác tôi đã tìm thấy là KHÔNG sử dụng các phép biến đổi mà chỉ có một tệp cấu hình riêng, ví dụ như app.Release.config. Sau đó thêm dòng này vào tệp csproj của bạn.

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

Điều này sẽ không chỉ tạo đúng tệp myprogram.exe.config mà nếu bạn đang sử dụng Cài đặt và triển khai dự án trong Visual Studio để tạo MSI, nó sẽ buộc dự án triển khai sử dụng tệp cấu hình chính xác khi đóng gói.

Theo kinh nghiệm của tôi, những thứ tôi cần để tạo môi trường cụ thể là những thứ như chuỗi kết nối, cài đặt ứng dụng và cài đặt smpt thường. Hệ thống cấu hình cho phép chỉ định những điều này trong các tệp riêng biệt. Vì vậy, bạn có thể sử dụng điều này trong app.config / web.config:

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

Những gì tôi thường làm là đặt các phần dành riêng cho cấu hình này trong các tệp riêng biệt, trong thư mục con có tên là ConfigFiles (trong thư mục gốc của giải pháp hoặc ở cấp độ dự án, tùy thuộc). Tôi xác định một tệp cho mỗi cấu hình, ví dụ: smtp.config.Debug và smtp.config.Release.

Sau đó, bạn có thể xác định một sự kiện xây dựng trước như vậy:

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

Trong quá trình phát triển nhóm, bạn có thể điều chỉnh điều này hơn nữa bằng cách bao gồm% COMPUTERNAME% và / hoặc% USERNAME% trong quy ước.

Tất nhiên, điều này ngụ ý rằng các tệp đích (x.config) KHÔNG nên được đặt trong kiểm soát nguồn (vì chúng được tạo). Bạn vẫn nên thêm chúng vào tệp dự án và đặt thuộc tính loại đầu ra của chúng thành 'sao chép luôn' hoặc 'sao chép nếu mới hơn'.

Đơn giản, có thể mở rộng và nó hoạt động cho tất cả các loại dự án Visual Studio (console, winforms, wpf, web).

Lấy cảm hứng từ Oleg và những người khác trong câu hỏi này, tôi đã đưa ra giải pháp https://stackoverflow.com/a/5109530/2286801 một bước nữa để kích hoạt tính năng sau.

• Hoạt động với ClickOnce
• Hoạt động với các dự án Thiết lập và Triển khai trong VS 2010
• Hoạt động với VS2010, 2013, 2015 (không thử nghiệm 2012 mặc dù cũng hoạt động tốt).
• Làm việc với Team Build. (Bạn phải cài đặt A) Visual Studio hoặc B) Microsoft.Web.Publishing.target và Microsoft.Web.Publishing.T Nhiệm.dll)

Giải pháp này hoạt động bằng cách thực hiện chuyển đổi app.config trước khi app.config được tham chiếu lần đầu tiên trong quy trình MSBuild. Nó sử dụng một tệp mục tiêu bên ngoài để quản lý dễ dàng hơn trên nhiều dự án.

Hướng dẫn:

Các bước tương tự với các giải pháp khác. Tôi đã trích dẫn những gì vẫn giữ nguyên và bao gồm nó để hoàn thiện và so sánh dễ dàng hơn.

0. Thêm một tệp mới vào dự án của bạn có tên là AppConfigTransatures.t Target

<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. Thêm một tệp XML cho mỗi cấu hình cho dự án.

Thông thường, bạn sẽ có cấu hình Gỡ lỗi và Phát hành, vì vậy hãy đặt tên cho tệp của bạn là App.Debug.config và App.Release.config. Trong dự án của tôi, tôi đã tạo một cấu hình cho từng loại môi trường để bạn có thể muốn thử nghiệm điều đó.

2. Dỡ bỏ dự án và mở tệp .csproj để chỉnh sửa

Visual Studio cho phép bạn chỉnh sửa .csproj ngay trong trình soạn thảo, bạn chỉ cần dỡ dự án trước. Sau đó nhấp chuột phải vào nó và chọn Chỉnh sửa .csproj.

3. Liên kết các tệp. *. Cấu hình thành App.config chính

Tìm phần tệp dự án chứa tất cả các tham chiếu App.config và App. *. Config và thay thế như sau. Bạn sẽ nhận thấy chúng tôi sử dụng Không thay vì Nội dung.

<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. Kích hoạt ma thuật biến đổi

Vào cuối tập tin sau

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

và trước trận chung kết

</Project>

chèn XML sau:

<Import Project="AppConfigTransformation.targets" />

Làm xong!

Bạn có thể sử dụng một tệp cấu hình riêng cho mỗi cấu hình, ví dụ: app.Debug.config, app.Release.config và sau đó sử dụng biến cấu hình trong tệp dự án của bạn:

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

Điều này sau đó sẽ tạo tệp ProjectName.exe.config chính xác tùy thuộc vào cấu hình bạn đang xây dựng.

Tôi đã viết phần mở rộng đẹp để tự động chuyển đổi app.config giống như phần mở rộng được xây dựng trong Chuyển đổi cấu hình dự án ứng dụng web

Ưu điểm lớn nhất của tiện ích mở rộng này là bạn không cần cài đặt nó trên tất cả các máy xây dựng

Cài đặt "Công cụ chuyển đổi cấu hình" trong Visual Studio từ Marketplace và khởi động lại VS. Bạn cũng có thể thấy chuyển đổi xem trước trình đơn cho app.config.

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

Vì vậy, tôi đã kết thúc một cách tiếp cận hơi khác nhau. Tôi đã làm theo các bước của Dan qua bước 3, nhưng đã thêm một tệp khác: App.Base.Config. Tệp này chứa các cài đặt cấu hình bạn muốn trong mỗi App.Config được tạo. Sau đó, tôi sử dụng BeforeBuild (với sự bổ sung của Yuri vào TransformXml) để chuyển đổi cấu hình hiện tại với cấu hình Base thành App.config. Quá trình xây dựng sau đó sử dụng App.config đã chuyển đổi như bình thường. Tuy nhiên, một điều khó chịu là bạn muốn loại trừ App.config luôn thay đổi khỏi kiểm soát nguồn sau đó, nhưng các tệp cấu hình khác hiện phụ thuộc vào nó.

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

Chỉ cần một chút cải tiến cho giải pháp dường như được đăng ở mọi nơi bây giờ:

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

• nghĩa là, trừ khi bạn dự định ở lại với phiên bản VS hiện tại của bạn mãi mãi

Tôi đã tạo một giải pháp thay thế khác cho bài được đăng bởi Vishal Joshi trong đó yêu cầu thay đổi hành động xây dựng thành Nội dung được loại bỏ và cũng triển khai hỗ trợ cơ bản cho việc triển khai ClickOnce. Tôi nói cơ bản, vì tôi đã không kiểm tra kỹ lưỡng nhưng nó sẽ hoạt động trong kịch bản triển khai ClickOnce điển hình.

Giải pháp này bao gồm một dự án MSBuild duy nhất đã được nhập vào dự án ứng dụng windows tồn tại (* .csproj) mở rộng quy trình xây dựng để xem xét chuyển đổi app.config.

Bạn có thể đọc phần giải thích chi tiết hơn tại Visual Studio App.config XML Transform và tệp dự án MSBuild có thể được tải xuống từ GitHub .

Nếu bạn sử dụng TFS trực tuyến (phiên bản Đám mây) và bạn muốn chuyển đổi App.Config trong dự án, bạn có thể thực hiện các thao tác sau mà không cần cài đặt thêm bất kỳ công cụ nào. Từ VS => Dỡ bỏ dự án => Chỉnh sửa tệp dự án => Đi đến cuối tệp và thêm vào như sau:

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

Hội đồng và Điểm đến hoạt động để sử dụng cục bộ và máy chủ TFS trực tuyến (Đám mây).

giải pháp đề xuất sẽ không hoạt động khi một thư viện lớp với tệp cấu hình được tham chiếu từ một dự án khác (trong trường hợp của tôi đó là thư viện dự án công nhân Azure). Nó sẽ không sao chép tập tin chuyển đổi chính xác từ objthư mục vào bin\##configuration-name##thư mục. Để làm cho nó hoạt động với những thay đổi tối thiểu, bạn cần thay đổi AfterCompilemục tiêu thành BeforeCompile:

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