HttpListenerElement 类

定义

命名空间:

System.Net.Configuration

程序集:

System.dll

表示配置文件中的 HttpListener 元素。 此类不能被继承。

public ref class HttpListenerElement sealed : System::Configuration::ConfigurationElement

public sealed class HttpListenerElement : System.Configuration.ConfigurationElement

type HttpListenerElement = class
    inherit ConfigurationElement

Public NotInheritable Class HttpListenerElement
Inherits ConfigurationElement

继承

Object

ConfigurationElement

HttpListenerElement

注解

此类对应于 <httpListener> 元素 (网络设置) 配置元素。 此类提供对可存储在配置文件中的信息的编程访问。

属性 UnescapeRequestUrl 指示是否 HttpListener 使用原始非转义 URI 而不是转换后的 URI，其中转换了任何百分比编码值并执行其他规范化步骤。

当 HttpListener 实例通过 http.sys 服务接收请求时，它会创建 http.sys 提供的 URI 字符串的实例，并将其公开为 HttpListenerRequest.Url 属性。

http.sys 服务公开两个请求 URI 字符串：

• 原始 URI

• 转换后的 URI

原始 URI 是 HTTP 请求的请求行中提供的 System.Uri：

GET /path/

Host: www.contoso.com

http.sys 为上述请求提供的原始 URI 是“/path/”。 这表示 HTTP 谓词后面的字符串，因为它是通过网络发送的。

http.sys 服务使用 HTTP 请求行中提供的 URI 和 Host 标头根据请求中提供的信息创建转换后的 URI，以确定要将请求转发到的源服务器。 这种判断是通过将请求中的信息与一组已注册的 URI 前缀进行比较做出的。 HTTP 服务器 SDK 文档将此转换后的 URI 称为 HTTP_COOKED_URL 结构。

为了能够将请求与已注册的 URI 前缀进行比较，需要对请求完成一些规范化操作。 对于上面的示例，转换后的 URI 如下所示：

http://www.contoso.com/path/

http.sys 服务将 Uri.Host 属性值与请求行中的字符串相组合，以创建转换后的 URI。 此外， http.sys 和 System.Uri 类还执行以下操作：

• 取消转义所有百分比编码值。

• 将百分比编码的非 ASCII 字符转换为 UTF-16 字符表示形式。 请注意，支持 UTF-8 和 ANSI/DBCS 字符以及 Unicode 字符（使用 %uXXXX 格式的 Unicode 编码）。

• 执行其他规范化步骤，例如路径压缩。

由于请求不包含任何有关百分比编码值使用的编码的信息，因此仅仅是通过分析百分比编码值可能无法确定正确的编码。

因此 http.sys 提供了两个注册表项用于修改进程：

注册表项	默认值	说明
EnableNonUTF8	1	如果为零，则 http.sys 仅接受 UTF-8 编码的 URL。 如果不为零，则 http.sys 还接受请求中 ANSI 编码或 DBCS 编码的 URL。
FavorUTF8	1	如果不为零，则 http.sys 始终首先尝试将 URL 解码为 UTF-8；如果这种转换失败并且 EnableNonUTF8 不为零，则 Http.sys 随后会尝试将 URL 解码为 ANSI 或 DBCS。 如果为零（并且 EnableNonUTF8 不为零），则 http.sys 会尝试将 URL 解码为 ANSI 或 DBCS；如果不成功，则尝试进行 UTF-8 转换。

当 HttpListener 收到请求时，它将使用 http.sys 中转换的 URI 作为 Url 属性的输入。

除了 URI 中的字符和数字外，还需要指定支持字符。 例如，以下 URI 用于检索客户编号“1/3812”的客户信息：

http://www.contoso.com/Customer('1%2F3812')/

请注意 Uri (%2F) 中的百分比编码斜杠。 这种编码是必要的，因为在本例中，斜杠字符代表数据而不是路径分隔符。

将字符串传递给 Uri 构造函数会生成以下 URI：

http://www.contoso.com/Customer('1/3812')/

将路径拆分为多个段会生成以下元素：

Customer('1

3812')

这不是请求发送者的意图。

如果 属性 UnescapeRequestUrl 设置为 false，则当 收到请求时 HttpListener ，它将使用原始 URI 而不是 从 http.sys 转换的 URI 作为属性的 Url 输入。

构造函数

HttpListenerElement()

初始化 HttpListenerElement 类的新实例。

属性

CurrentConfiguration	获取对顶级 Configuration 实例的引用，该实例表示当前 ConfigurationElement 实例所属的配置层次结构。 (继承自 ConfigurationElement)
ElementInformation	获取包含 ConfigurationElement 对象的不可自定义的信息和功能的 ElementInformation 对象。 (继承自 ConfigurationElement)
ElementProperty	获取表示 ConfigurationElement 对象本身的 ConfigurationElementProperty 对象。 (继承自 ConfigurationElement)
EvaluationContext	获取 ConfigurationElement 对象的 ContextInformation 对象。 (继承自 ConfigurationElement)
HasContext	获取一个值，该值指示 CurrentConfiguration 属性是否为 null。 (继承自 ConfigurationElement)
Item[ConfigurationProperty]	获取或设置此配置元素的属性或特性。 (继承自 ConfigurationElement)
Item[String]	获取或设置此配置元素的属性、特性或子元素。 (继承自 ConfigurationElement)
LockAllAttributesExcept	获取被锁定的特性的集合。 (继承自 ConfigurationElement)
LockAllElementsExcept	获取被锁定的元素的集合。 (继承自 ConfigurationElement)
LockAttributes	获取被锁定的特性的集合。 (继承自 ConfigurationElement)
LockElements	获取被锁定的元素的集合。 (继承自 ConfigurationElement)
LockItem	获取或设置一个值，该值指示是否已锁定该元素。 (继承自 ConfigurationElement)
Properties	获取属性的集合。 (继承自 ConfigurationElement)
Timeouts	获取用于 HttpListener 对象的默认超时元素。
UnescapeRequestUrl	获取一个值，该值指示 HttpListener 是否使用未经转义的原始 URI，而非经过转换的 URI。

方法

DeserializeElement(XmlReader, Boolean)	从配置文件读取 XML。 (继承自 ConfigurationElement)
Equals(Object)	将当前的 ConfigurationElement 实例与指定的对象进行比较。 (继承自 ConfigurationElement)
GetHashCode()	获取表示当前 ConfigurationElement 实例的唯一值。 (继承自 ConfigurationElement)
GetTransformedAssemblyString(String)	返回指定程序集名称的转换版本。 (继承自 ConfigurationElement)
GetTransformedTypeString(String)	返回指定类型名称的转换版本。 (继承自 ConfigurationElement)
GetType()	获取当前实例的 Type。 (继承自 Object)
Init()	将 ConfigurationElement 对象设置为其初始状态。 (继承自 ConfigurationElement)
InitializeDefault()	用于初始化 ConfigurationElement 对象的默认值集。 (继承自 ConfigurationElement)
IsModified()	指示自上次保存或加载该配置元素后并在派生类中实现该元素时，该元素是否已被修改。 (继承自 ConfigurationElement)
IsReadOnly()	获取一个值，该值指示 ConfigurationElement 对象是否为只读。 (继承自 ConfigurationElement)
ListErrors(IList)	将此 ConfigurationElement 对象以及所有子元素中无效属性的错误添加到传递的列表中。 (继承自 ConfigurationElement)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
OnDeserializeUnrecognizedAttribute(String, String)	获取一个值，该值指示反序列化过程中是否遇到未知特性。 (继承自 ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	获取一个值，该值指示反序列化过程中是否遇到未知元素。 (继承自 ConfigurationElement)
OnRequiredPropertyNotFound(String)	找不到所需属性时引发异常。 (继承自 ConfigurationElement)
PostDeserialize()	反序列化后调用。 (继承自 ConfigurationElement)
PreSerialize(XmlWriter)	在序列化之前调用。 (继承自 ConfigurationElement)
Reset(ConfigurationElement)	重置 ConfigurationElement 对象的内部状态，包括锁和属性集合。 (继承自 ConfigurationElement)
ResetModified()	在派生类中实现时，将 IsModified() 方法的值重置为 false。 (继承自 ConfigurationElement)
SerializeElement(XmlWriter, Boolean)	当在派生类中实现后，将此配置元素的内容写入配置文件。 (继承自 ConfigurationElement)
SerializeToXmlElement(XmlWriter, String)	当在派生类中实现后，将此配置元素的外部标记写入配置文件。 (继承自 ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	将属性设置为指定值。 (继承自 ConfigurationElement)
SetReadOnly()	设置 ConfigurationElement 对象及所有子元素的 IsReadOnly() 属性。 (继承自 ConfigurationElement)
ToString()	返回表示当前对象的字符串。 (继承自 Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	修改 ConfigurationElement 对象以移除所有不应该保存的值。 (继承自 ConfigurationElement)

另请参阅

• HttpListener
• Url
• 网络设置架构
• <httpListener> 元素 (网络设置)