自定义标头 <customHeaders>

项目
03/25/2024

概述

元素 <customHeaders> 的 <httpProtocol> 元素指定 Internet Information Services (IIS) 7 将在 Web 服务器的 HTTP 响应中返回的自定义 HTTP 标头。

注意

HTTP 标头是在 Web 服务器的响应中返回的名称和值对。自定义响应标头与默认 HTTP 标头一起发送到客户端。重定向响应标头仅在发生重定向时才在响应中返回，与此不同的是，自定义响应标头在每个响应中都返回。

兼容性

版本	说明
IIS 10.0	`<customHeaders>` 元素在 IIS 10.0 中未进行修改。
IIS 8.5	`<customHeaders>` 元素在 IIS 8.5 中未进行修改。
IIS 8.0	`<customHeaders>` 元素在 IIS 8.0 中未进行修改。
IIS 7.5	`<customHeaders>` 元素在 IIS 7.5 中未进行修改。
IIS 7.0	IIS 7.0 中引入了 `<httpProtocol>` 元素的 `<customHeaders>` 元素。
IIS 6.0	`<customHeaders>` 元素取代了 IIS 6.0 的 HttpCustomHeaders 元数据库对象。

安装

在 IIS 7 的默认安装中包含 <httpProtocol> 元素的 <customHeaders> 元素。

操作方式

如何为网站或应用程序设置自定义 HTTP 标头

打开 Internet Information Services (IIS) 管理器：
- 如果使用的是 Windows Server 2012 或 Windows Server 2012 R2：
  - 在任务栏上，单击“服务器管理器”，单击“工具”，然后单击“Internet Information Services (IIS)管理器”。
- 如果使用的是 Windows 8 或 Windows 8.1：
  - 按住 Windows 键，按字母 X，然后单击“控制面板”。
  - 单击“管理工具”，然后双击“Internet Information Services (IIS) 管理器”。
- 如果使用的是 Windows Server 2008 或 Windows Server 2008 R2：
  - 在任务栏上，单击“开始”，指向“管理工具”，然后单击“Internet Information Services (IIS)管理器”。
- 如果使用的是 Windows Vista 或 Windows 7：
  - 在任务栏上，单击“开始”，然后单击“控制面板”。
  - 双击“管理工具”，然后双击“Internet Information Services (IIS) 管理器”。
在“连接”窗格中，转到要为其设置自定义 HTTP 标头的站点、应用程序或目录。
在“主页”窗格中，双击“HTTP 响应标头”。
在“HTTP 响应标头”窗格的“操作”窗格中，单击“添加...”。
在“添加自定义 HTTP 响应标头”对话框中，设置自定义标头的名称和值，然后单击“确定”。

配置

特性

无。

子元素

元素	说明
`add`	可选元素。将自定义响应标头添加到 `<customHeaders>` 集合。
`clear`	可选元素。从 `<customHeaders>` 集合中移除对自定义响应标头的所有引用。
`remove`	可选元素。从 `<customHeaders>` 集合中移除对自定义响应标头的引用。

配置示例

以下配置示例设置自定义 HTTP 标头和值。

<configuration>
   <system.webServer>
      <httpProtocol>
         <customHeaders>
            <add name="X-Custom-Name" value="MyCustomValue" />
         </customHeaders>
      </httpProtocol>
   </system.webServer>
</configuration>

注意

以下默认 <httpProtocol> 元素是在 IIS 7 的 ApplicationHost.config 文件中配置的。

<httpProtocol>
   <customHeaders>
      <clear />
      <add name="X-Powered-By" value="ASP.NET" />
   </customHeaders>
   <redirectHeaders>
      <clear />
   </redirectHeaders>
</httpProtocol>

代码示例

以下代码示例设置自定义 HTTP 标头和值。

AppCmd.exe

appcmd.exe set config "Default Web Site" -section:system.webServer/httpProtocol /+"customHeaders.[name='X-Custom-Name',value='MyCustomValue']"

C#

using System;
using System.Text;
using Microsoft.Web.Administration;

internal static class Sample
{
   private static void Main()
   {
      using (ServerManager serverManager = new ServerManager())
      {
         Configuration config = serverManager.GetWebConfiguration("Default Web Site");
         ConfigurationSection httpProtocolSection = config.GetSection("system.webServer/httpProtocol");
         ConfigurationElementCollection customHeadersCollection = httpProtocolSection.GetCollection("customHeaders");

         ConfigurationElement addElement = customHeadersCollection.CreateElement("add");
         addElement["name"] = @"X-Custom-Name";
         addElement["value"] = @"MyCustomValue";
         customHeadersCollection.Add(addElement);

         serverManager.CommitChanges();
      }
   }
}

VB.NET

Imports System
Imports System.Text
Imports Microsoft.Web.Administration

Module Sample

   Sub Main()
      Dim serverManager As ServerManager = New ServerManager
      Dim config As Configuration = serverManager.GetWebConfiguration("Default Web Site")
      Dim httpProtocolSection As ConfigurationSection = config.GetSection("system.webServer/httpProtocol")
      Dim customHeadersCollection As ConfigurationElementCollection = httpProtocolSection.GetCollection("customHeaders")

      Dim addElement As ConfigurationElement = customHeadersCollection.CreateElement("add")
      addElement("name") = "X-Custom-Name"
      addElement("value") = "MyCustomValue"
      customHeadersCollection.Add(addElement)

      serverManager.CommitChanges()
   End Sub

End Module

JavaScript

var adminManager = new ActiveXObject('Microsoft.ApplicationHost.WritableAdminManager');
adminManager.CommitPath = "MACHINE/WEBROOT/APPHOST/Default Web Site";
var httpProtocolSection = adminManager.GetAdminSection("system.webServer/httpProtocol", "MACHINE/WEBROOT/APPHOST/Default Web Site");
var customHeadersCollection = httpProtocolSection.ChildElements.Item("customHeaders").Collection;

var addElement = customHeadersCollection.CreateNewElement("add");
addElement.Properties.Item("name").Value = "X-Custom-Name";
addElement.Properties.Item("value").Value = "MyCustomValue";
customHeadersCollection.AddElement(addElement);

adminManager.CommitChanges();

VBScript

Set adminManager = WScript.CreateObject("Microsoft.ApplicationHost.WritableAdminManager")
adminManager.CommitPath = "MACHINE/WEBROOT/APPHOST/Default Web Site"
Set httpProtocolSection = adminManager.GetAdminSection("system.webServer/httpProtocol", "MACHINE/WEBROOT/APPHOST/Default Web Site")
Set customHeadersCollection = httpProtocolSection.ChildElements.Item("customHeaders").Collection

Set addElement = customHeadersCollection.CreateNewElement("add")
addElement.Properties.Item("name").Value = "X-Custom-Name"
addElement.Properties.Item("value").Value = "MyCustomValue"
customHeadersCollection.AddElement(addElement)

adminManager.CommitChanges()