SharePoint 2010 - 创建补充 web.config 文件

Question

我目前正在为 SharePoint 2010 开发一项新功能。在部署我的功能的同时，我想在我的 SharePoint 应用程序 web.config 中的 <appSettings/> 部分添加一些设置。

我在 MSDN 上找到了一些关于在部署期间添加补充 .config 文件的信息，但我无法让它工作。这种方法对我来说似乎是最干净的，因为我可以将所有更改放在一个文件中，并将它们与我的应用程序的其余部分一起部署。

我已按照文档中的建议创建了一个 webconfig.MyApp.xml 文件，并将其部署到 <SharePoint 14 hive>\Config 文件夹，但我的更改并未传播到我的应用程序 web.config。

以下是我的补充配置文件中的示例 sn-p。

<?xml version="1.0" encoding="utf-8" ?>
<actions>
    <add path="configuration/appSettings">
        <add key="MyFeatureKey" value="MyFeatureValue" />
    </add>
</actions>

我希望避免手动编辑 web.config，因为这些更改在 SharePoint 维护等期间很容易丢失。

如果您对部署 web.config 更改的替代可维护方法有任何想法，我愿意倾听。

更新： 到目前为止给出的答案都很棒，我相信它们会起作用。但我正在寻找一种可以打包在我的单个 WSP 中并无需任何额外步骤即可部署的解决方案。

Answer 1

正如 Russ 和 breischl 所建议的，您可以利用 SPWebApplication 对象的 WebConfigModifications 属性。要将其与您的功能一起部署，请将您的代码放入功能接收器中。这样，您可以在安装该功能时自动修改 web.config。

在您的功能接收器中，不要忘记调用您的 SPWebApplication 对象的 ApplyWebConfigModifications() 属性。

示例： http://weblogs.asp.net/wesleybakker/archive/2009/01/21/web.config-modifications-with-a-sharepoint-feature.aspx

您可以将功能和功能接收器程序集打包在一个 wsp 包中。

Answer 2

关于您的补充文件未应用于 web.config：来自MSDN：“您可以通过运行 copyappbincontent Stsadm 命令行操作追溯应用更改到服务器的 web.config 文件。您必须运行该操作在部署中的每个前端 Web 服务器上。”

Answer 3

创建补充配置文件时，web.config 修改不会自动合并，直到您调用 stsadm -o copyappbincontent。

您也可以强制此命令通过FeatureReceiver 运行。

在探索了反射器中的stsadm 工具后，我发现copyappbincontent 操作调用了SPWebApplication.WebService.ApplyApplicationContentToLocalServer()'

public override void FeatureActivated(SPFeatureReceiverProperties properties)
{
    var webApp = (SPWebApplication)properties.Feature.Parent;
    webApp.WebService.ApplyApplicationContentToLocalServer();
}

感谢 @Jason Weber 解决这个问题，但不幸的是，他将答案放在了评论中而不是问题中。

Answer 4

将其放入名为 AddWebConfigMods.ps1 的文件中

Param ($weburl, $WebConfigModifications )

$url = New-Object System.Uri($webUrl)

[System.Reflection.Assembly]::LoadWithPartialName("Microsoft.SharePoint") | Out-Null
$webApp = [Microsoft.SharePoint.Administration.SPWebApplication]::Lookup($url)


#delete mods by the owners being added
$ownerstodelete = $WebConfigModifications | Group-Object owner | Select-Object Name

foreach($owner in $ownerstodelete)
{
    $modstodelete = @()
    foreach($mod in $webApp.WebConfigModifications)
    {
        if($mod.Owner -eq $owner.Name)
        {
            $modstodelete += $mod
        }
    }

    Write-Host ("Deleting " + $modstodelete.Count + " mods for owner: " + $owner)

    foreach($delmod in $modstodelete)
    {
        Write-Host (" + Deleting " + $delmod.Value)
        $webApp.WebConfigModifications.Remove($delmod) | Out-Null
    }
}

#this is where we start to add mods
$i = 0;

Write-Host ("Adding " + $WebConfigModifications.Count + " webconfig modifications to " + $weburl) 

foreach($modEntry in $WebConfigModifications)
{
    Write-Host (" + Adding " + $modEntry.Value)

    $mod = New-Object Microsoft.SharePoint.Administration.SPWebConfigModification
    $mod.Path = $modEntry.Path
    $mod.Name = $modEntry.Name
    $mod.Sequence = $i++
    $mod.Owner = $modEntry.Owner
    $mod.Type = $modEntry.Type
    $mod.Value = $modEntry.Value

    $webApp.WebConfigModifications.Add($mod)

}

$webApp.Update()
$webApp.WebService.ApplyWebConfigModifications()

然后用你的配置创建一个 csv 文件，像这样

Name,Path,Owner,Type,Value
system.serviceModel,configuration,alinean-common,EnsureSection,<system.serviceModel/>
connectionStrings,configuration,alinean-common,EnsureSection,<connectionStrings />
appSettings,configuration,alinean-common,EnsureSection,<appSettings />
serviceHostingEnvironment,configuration/system.serviceModel,alinean-common,EnsureChildNode,<serviceHostingEnvironment aspNetCompatibilityEnabled='true'/>

然后在另一个 ps1 脚本中，最好是用于部署解决方案的脚本，导入 csv 配置选项并调用在第一个代码块中创建的函数：

#read config mods from CSVs
$mods = Import-CSV .\config\admin-common.webconfigmods.csv

Write-Host "Applying configuration modifications"
#add web config mods to sharepoint using powershell script
&.\AddWebConfigMods "[sharepoint site url]" $mods
&stsadm -o execadmsvcjobs