ISAPI 筛选器 <isapiFilters>

概述

<isapiFilters> 元素可用于在 Internet Information Services (IIS) 7 服务器上管理 ISAPI 筛选器。 要增强 Web 服务器功能,可以添加 ISAPI 筛选器。 例如,你可能具有一个 ISAPI 筛选器,用于捕获有关 HTTP 请求的信息,并将信息保存到数据库。

注意

尽管 IIS 7 支持 ISAPI 筛选器,但 Microsoft 建议使用模块来扩展 Web 服务器功能,而不是使用 ISAPI 筛选器。

<isapiFilters> 元素可以包含一个或多个 <filter> 元素,其中每一个定义了为服务器或网站启用的一个 ISAPI 筛选器。 它还可以包含一个 <remove> 元素,可用于移除从配置层次结构中的较高层次继承的特定 ISAPI 筛选器。 <isapiFilters> 元素还可以包含一个 <clear> 元素,可用于移除从配置层次结构中的较高层次继承的所有 ISAPI 筛选器。

兼容性

版本 说明
IIS 10.0 <isapiFilters> 元素在 IIS 10.0 中未进行修改。
IIS 8.5 <isapiFilters> 元素在 IIS 8.5 中未进行修改。
IIS 8.0 <isapiFilters> 元素在 IIS 8.0 中未进行修改。
IIS 7.5 <isapiFilters> 元素未在 IIS 7.5 中进行修改。
IIS 7.0 <isapiFilters> 元素是在 IIS 7.0 中引入的。
IIS 6.0 <isapiFilters> 元素取代了 IIS 6.0 的 FilterEnableCacheFilterPath 元数据库属性。

安装

要使用 <isapiFilters> 元素,必须在 IIS 7 及更高版本服务器上安装 ISAPI 筛选器模块。 为此,请按照以下步骤操作。

Windows Server 2012 或 Windows Server 2012 R2

  1. 在任务栏上,单击 “服务器管理器”。
  2. 在“服务器管理器”中,单击“管理”菜单,然后单击“添加角色和功能”。
  3. 在“添加角色和功能”向导中,单击“下一步”。 选择安装类型,然后单击“下一步”。 选择目标服务器,然后单击“下一步”。
  4. 在“服务器角色”页上,依次展开“Web 服务器 (IIS)”、“Web 服务器”和“应用程序开发”,然后选择“ISAPI 筛选器”。 单击 “下一步”
    Screenshot of I S A P I Filters selected in a Windows Server 2012 Interface. .
  5. 在“选择功能”页上,单击“下一步”
  6. “确认安装选择”页上,单击“安装”
  7. 在“结果” 页面中单击“关闭”

Windows 8 或 Windows 8.1

  1. 在“开始”屏幕上,将指针一直移动到左下角,右键单击“开始”按钮,然后单击“控制面板”
  2. 在“控制面板”中,单击“程序与功能”,然后单击“打开或关闭 Windows 功能”。
  3. 依次展开“Internet 信息服务”、“万维网服务”和“应用程序开发功能”,然后选择“ISAPI 文件”。
    Screenshot of I S A P I Filters selected in a Windows 8 interface.
  4. 单击“确定”。
  5. 单击“关闭” 。

Windows Server 2008 或 Windows Server 2008 R2

  1. 在任务栏上,单击“开始”,指向“管理工具”,然后单击“服务器管理器”。
  2. 在“服务器管理器”层次结构窗格中,展开“角色”,然后单击“Web 服务器(IIS)”。
  3. 在“Web 服务器(IIS)”窗格中,滚动到“角色服务”部分,然后单击“添加角色服务”。
  4. 在“添加角色服务向导”的“选择角色服务”页上,选择“ISAPI 筛选器”,然后单击“下一步”。
    Screenshot of I S A P I Filters selected in a Windows Server 2008 interface.
  5. “确认安装选择”页中,单击“安装”
  6. 在“结果” 页面中单击“关闭”

Windows Vista 或 Windows 7

  1. 在任务栏上,单击“开始”,然后单击“控制面板”。
  2. 在“控制面板”中,单击“程序与功能”,然后单击“打开或关闭 Windows 功能”。
  3. 在“Windows 功能”对话框中,依次展开“Internet Information Services”、“万维网服务”、“应用程序开发功能”。
    Screenshot of I S A P I Filters selected in a Windows Vista or Windows 7 interface.
  4. 选择“ISAPI 筛选器”,然后单击“确定”。

操作方式

如何添加 ISAPI 筛选器

  1. 打开 Internet Information Services (IIS) 管理器:

    • 如果使用的是 Windows Server 2012 或 Windows Server 2012 R2:

      • 在任务栏上,单击“服务器管理器”,单击“工具”,然后单击“Internet Information Services (IIS)管理器”
    • 如果使用的是 Windows 8 或 Windows 8.1:

      • 按住 Windows 键,按字母 X,然后单击“控制面板”。
      • 单击“管理工具”,然后双击“Internet 信息服务(IIS)管理器”。
    • 如果使用的是 Windows Server 2008 或 Windows Server 2008 R2:

      • 在任务栏上,单击“开始”,指向“管理工具”,然后单击“Internet Information Services (IIS)管理器”
    • 如果使用的是 Windows Vista 或 Windows 7:

      • 在任务栏上,单击“开始”,然后单击“控制面板”。
      • 双击“管理工具”,然后双击“Internet 信息服务(IIS)管理器”。
  2. 在“连接”窗格中,转到要为其配置 ISAPI 筛选器的连接或站点。

  3. 在“主页”窗格中,双击“ISAPI 筛选器”。
    Screenshot of I S A P I Filters selected in the Default Web Site Home pane.

  4. 在“操作”窗格中,单击“添加...”。

  5. 在“添加 ISAPI 筛选器”对话框的“筛选器名称”文本框中,键入 ISAPI 筛选器的友好名称。

  6. 在“可执行文件”框中,键入 ISAPI 筛选器文件位置的文件系统路径,或单击省略号 (...) 导航到包含 ISAPI 筛选器文件的文件夹,然后单击“确定”。
    Screenshot of a blank Add I S A P I Filter dialog.

配置

可以在服务器级别和站点级别添加 ISAPI 筛选器。 如果在服务器级别添加 ISAPI 筛选器,筛选器将截获向服务器发出的所有请求。 如果将 ISAPI 筛选器添加到特定站点,筛选器将截获向该站点发出的所有请求。

使用 ApplicationHost.config 文件,可以在服务器级别配置 <isapiFilters> 元素,使用相应的 Web.config 文件,则可以在站点级别配置。

特性

无。

子元素

元素 说明
clear 可选元素。

从 ISAPI 筛选器集合中移除对 ISAPI 筛选器的所有引用。
filter 可选元素。

将 ISAPI 筛选器添加到 ISAPI 筛选器集合。
remove 可选元素。

从 ISAPI 筛选器集合中移除对 ISAPI 筛选器的引用。

配置示例

以下配置示例将名为 SalesQueryIsapi 的 ISAPI 筛选器添加到网站或应用程序。 该示例命名并启用具有 nameenabled 属性的 ISAPI 筛选器。 它还使用 enableCache 属性来禁用 HTTP.sys 缓存,并使用 path 属性来指定 ISAPI DLL 的位置。

<configuration>
   <system.webServer>
      <isapiFilters>
         <filter 
            name="SalesFilter" 
            enabled="true" 
            enableCache="false" 
            path="C:\Inetpub\filters\SalesFilter.dll" />
      </isapiFilters>
   </system.webServer>
</configuration>

代码示例

以下示例在服务器上配置名为 SalesQueryIsapi 的 ISAPI 筛选器。 每个示例都使用name 属性指定 ISAPI 筛选器的名称,使用 enableCache 属性禁用 HTTP.sys 缓存,使用 path 属性指定 ISAPI DLL 的位置。

AppCmd.exe

appcmd.exe set config -section:system.webServer/isapiFilters /+"[name='SalesQueryIsapi',path='c:\Inetpub\www.contoso.com\filters\SalesQueryIsapi.dll',enabled='True',enableCache='True']" /commit:apphost

注意

使用 AppCmd.exe 配置这些设置时,必须确保将 commit 参数设置为 apphost。 这会将配置设置提交到 ApplicationHost.config 文件中的相应位置部分。

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.GetApplicationHostConfiguration();
         ConfigurationSection isapiFiltersSection = config.GetSection("system.webServer/isapiFilters");
         ConfigurationElementCollection isapiFiltersCollection = isapiFiltersSection.GetCollection();

         ConfigurationElement filterElement = isapiFiltersCollection.CreateElement("filter");
         filterElement["name"] = @"SalesQueryIsapi";
         filterElement["path"] = @"c:\Inetpub\www.contoso.com\filters\SalesQueryIsapi.dll";
         filterElement["enabled"] = true;
         filterElement["enableCache"] = true;
         isapiFiltersCollection.Add(filterElement);

         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.GetApplicationHostConfiguration
      Dim isapiFiltersSection As ConfigurationSection = config.GetSection("system.webServer/isapiFilters")
      Dim isapiFiltersCollection As ConfigurationElementCollection = isapiFiltersSection.GetCollection
      Dim filterElement As ConfigurationElement = isapiFiltersCollection.CreateElement("filter")
      filterElement("name") = "SalesQueryIsapi"
      filterElement("path") = "c:\Inetpub\www.contoso.com\filters\SalesQueryIsapi.dll"
      filterElement("enabled") = True
      filterElement("enableCache") = True
      isapiFiltersCollection.Add(filterElement)
      serverManager.CommitChanges()
   End Sub
End Module

JavaScript

var adminManager = new ActiveXObject('Microsoft.ApplicationHost.WritableAdminManager');
adminManager.CommitPath = "MACHINE/WEBROOT/APPHOST";
var isapiFiltersSection = adminManager.GetAdminSection("system.webServer/isapiFilters", "MACHINE/WEBROOT/APPHOST");
var isapiFiltersCollection = isapiFiltersSection.Collection;

var filterElement = isapiFiltersCollection.CreateNewElement("filter");
filterElement.Properties.Item("name").Value = "SalesQueryIsapi";
filterElement.Properties.Item("path").Value = "c:\\Inetpub\\www.contoso.com\\filters\\SalesQueryIsapi.dll";
filterElement.Properties.Item("enabled").Value = true;
filterElement.Properties.Item("enableCache").Value = true;
isapiFiltersCollection.AddElement(filterElement);

adminManager.CommitChanges();

VBScript

Set adminManager = createObject("Microsoft.ApplicationHost.WritableAdminManager")
adminManager.CommitPath = "MACHINE/WEBROOT/APPHOST"
Set isapiFiltersSection = adminManager.GetAdminSection("system.webServer/isapiFilters", "MACHINE/WEBROOT/APPHOST")
Set isapiFiltersCollection = isapiFiltersSection.Collection

Set filterElement = isapiFiltersCollection.CreateNewElement("filter")
filterElement.Properties.Item("name").Value = "SalesQueryIsapi"
filterElement.Properties.Item("path").Value = "c:\\Inetpub\\www.contoso.com\\filters\\SalesQueryIsapi.dll"
filterElement.Properties.Item("enabled").Value = True
filterElement.Properties.Item("enableCache").Value = True
isapiFiltersCollection.AddElement filterElement

adminManager.CommitChanges()