使用T4模板生成不同部署环境下的配置文件

忘是亡心i 2022-07-13 10:58 165阅读 0赞

在开发企业级应用的时候，通常会有不同的开发环境，比如有开发环境，测试环境，正式环境，生产环境等。在一份代码部署到不同环境的时候，不同环境的配置文件可能需要根据目标环境不同而不同。比如在开发环境中，数据库使用的是开发环境的数据库，消息队列也使用的部署在开发机上的消息队列，传统的方式是，由发布或者配置管理员来维护这些不同环境的配置文件。通常，手工的针对不同的环境去修改配置文件容易产生错误。

有很多种不同的方式来针对不同的部署环境生成配置，最笨的方法就是可以维护几套不同的配置文件，然后在编译事件中根据编译环境变量来[复制对应的配置文件][Link 1]；还可以使用MSBuild中的PostBuild事件脚本去修改原始的配置文件，替换其中与目标环境相关的变量或者参数；还有一些工具，比如[ConfigGen][]，能够根据额外的环境相关配置文件，来替换原始的配置文件。这里展示如何使用T4模板来生成不同的配置文件的。

# 例子 #

T4模板是一种很流行的代码生成引擎。.NET 里面的EntityFramework似乎也是使用该引擎来生成ORM代码的。在Visual Studio能够识别和支持T4模板文件。Visual Studio有一些Addin，比如[T4 Editor][] 能够很方便的辅助编写T4模板文件。为了演示如何根据使用T4模板生成配置文件，首先创建一个简单的控制台应用程序：

1. 打开Visual Studio创建一个控制台应用程序

2. 在默认的app.config配置文件中，添加一个数据库连接字符串，比如：

<?xml version="1.0" encoding="utf-8" ?>
    <configuration>
        <connectionStrings>
            <add name="Northwind"
                connectionString="Data Source=.;Initial Catalog=Northwind;Integrated Security=True"
                providerName="System.Data.SqlClient" />
        </connectionStrings>
    </configuration>

3. 然后添加一个新的名为App.tt的文本文件，将App.config 中的内容复制过来，然后做一些修改，如下：

<#@ template="" language="C#" #>
    <#@ output="" extension= ".config" #>
    <?xml version="1.0" encoding="utf-8" ?>
    <configuration>
        <connectionStrings>
            <add name="Northwind"
                connectionString="Data Source=.;Initial Catalog=Northwind;Integrated Security=True"
                providerName="System.Data.SqlClient" />
        </connectionStrings>
    </configuration>

保存，就可以看到App.config已经在App.tt下面了，Visual Studio能够识别.tt文件，并且使用App.tt文件来生成App.config文件。App.config文件本身没有发生变化，只是现在存在与App.tt中了。注意到，这里的数据库是本地的数据库。

4. 修改App.tt，使得数据库连接字符串以参数的形式存在，如下：

<#@ template language="C#" #>
    <#@ output extension= ".config" #>
    <?xml version="1.0" encoding="utf-8" ?>
    <configuration>
        <connectionStrings>
            <add name="Northwind"
                connectionString="<#= this.NorthwindConnectionString #>"
                providerName="System.Data.SqlClient" />
            </connectionStrings>
    </configuration>
    <#+ 
        string NorthwindConnectionString = "Data Source=.;Initial Catalog=Northwind;Integrated Security=True";
      #>

在这个版本的App.tt中，NorthwindConnectionString现在是一个模板中的私有字段了。我们给他进行初始化，并且作为模板中参数的值。

5. 现在，添加一个新的名为Dev.tt的模板文件，内容如下：

<#
        this.NorthwindConnectionString = "Data Source=DEV-SERVER;Initial Catalog=Northwind;Integrated Security=True";
       #>
    <#@ include file="App.tt" #>

这个模板文件包含了App.tt模板文件。这个里面的字符串配置会覆盖App.tt中的字符串配置，这里可以看到，数据库连接到了名为DEV-SERVER的服务器上。当保存Dev.tt的时候，Visual Studio会自动产生Dev.Config文件，然后将其添加到Dev.tt文件中。Deve.config文件内容如下：

<?xml version="1.0" encoding="utf-8" ?>
    <configuration>
        <connectionStrings>
            <add name="Northwind"
                connectionString="Data Source=DEV-SERVER;Initial Catalog=Northwind;Integrated Security=True"
                providerName="System.Data.SqlClient" />
        </connectionStrings>
    </configuration>

可以看到，这个配置文件和App.config的内容很相似，只是数据库服务器变成了DEV-SERVER.

6. 在Visual Studio中，设置Dev.config文件的Copy to Output Directory属性为Copy if newer，这样Visual Studio就会将该文件拷贝到编译后的目录中。

7. 修改部署脚本，将Dev.config拷贝到开发环境，而不是默认的 app.config。部署脚本也需要根据应用程序的不同，将Dev.config重新名为目标应用程序能够识别的配置文件。比如本例中的ConsoleApplication1.exe.config

8. 重复5-7步创建针对不同部署环境的config文件。

# 改进 #

有时候，把所有的配置项都放在一个文件里面会使得整个文件看起来比较乱，所以可以对配置文件进行一些改进。 比如可以把针对数据库连接字符串的配置connectionStrings移到一个单独的文件里面，把AppSetting子项移到一个单独的文件里。

一般的配置文件,Web.config 如下，这里面appSettings里面存了RabbitMQ消息队列的配置，ConnectStrings里面存放了数据库连接字符串：

<?xml version="1.0" encoding="utf-8" ?>
    <configuration>
      <appSettings>
        <add key="RabbitMQHost" value="192.168.1.1"/>
        <add key="RabbitMQUserName" value="admin"/>
        <add key="RabbitMQUserPwd" value="11111" />
      </appSettings>
      
      <connectionStrings>
        <add name="Northwind"
            connectionString="Data Source=DEV-SERVER;Initial Catalog=Northwind;Integrated Security=True"
            providerName="System.Data.SqlClient" />
      </connectionStrings>
    </configuration>

一种更好的做法是，将 appSettings 和 connectionStrings 放到各自的配置文件中，Web.config如下：

<?xml version="1.0" encoding="utf-8" ?>
    <configuration >
      
      <appSettings file="Config\AppSetting.config">
      </appSettings>
    
      <connectionStrings configSource="Config\ConnectionString.config">
      </connectionStrings>
      
    </configuration>

在项目下创建了一个名为Config的文件夹，专门用来存放子项配置。AppSetting.config内容如下：

<?xml version="1.0" encoding="utf-8" ?>
    <appSettings>
      <add key="RabbitMQHost" value="192.168.1.1"/>
      <add key="RabbitMQUserName" value="admin"/>
      <add key="RabbitMQUserPwd" value="11111" />
    </appSettings>

ConnectionString.config 内容如下：

<?xml version="1.0" encoding="utf-8" ?>
    <connectionStrings>
      <add name="Northwind"
          connectionString="Data Source=DEV-SERVER;Initial Catalog=Northwind;Integrated Security=True"
          providerName="System.Data.SqlClient" />
    </connectionStrings>

经过这样修改之后，主Web.config配置文件看起来比较简洁，这里面可以放一些与部署平台无关的配置，比如注册的一些HttpHandler之类的。而另外一些和部署平台有关的配置子项，如前面例子中的AppSetting，ConnectionString则可以做成T4模板文件，根据不同的部署环境生成对应的配置项。最后需要注意的是，在编译的时候在编译事件中，需要将子项及其所在的文件夹一并复制到发布后的目录下。这样系统才能根据相对主配置文件的路径找到子项的配置文件。

# 总结 #

本文介绍了一种使用T4模板文件，在不同环境下自动生成相应配置文件的方法，并介绍了对配置文件的改进，即把子配置项移到独立的配置文件中，然后在将子项配置文件修改为模板文件的方法，这些方法在编译和部署的时候，都需要编写相应的脚本，利用编译工具的环境变量，将对应环境的配置文件复制到编译后的目录下。这种方式教传统的同一份代码发布到不同的环境后，手动去维护和修改各个环境下的配置能够减少错误的发生和工作量。希望本文介绍的内容对大家在不同环境下生成配置文件有所借鉴和帮助。

[Link 1]: http://www.hanselman.com/blog/ManagingMultipleConfigurationFileEnvironmentsWithPreBuildEvents.aspx
[ConfigGen]: http://configgen.codeplex.com/
[T4 Editor]: http://www.olegsych.com/2009/04/t4-editor-by-tangible-engineering/