WebMethod 属性

Posted 2020-10-07 单纯的桃子

将 WebMethod 属性 (Attribute) 附加到 Public 方法表示希望将该方法公开为 XML Web services 的一部分。您还可以使用该属性 (Attribute) 的属性 (Property) 进一步配置 XML Web services 方法的行为。

WebMethod 属性 (Attribute) 提供以下属性 (Property)：

• BufferResponse

• CacheDuration

• Description

• EnableSession

• MessageName

• TransactionOption

BufferResponse

WebMethod 属性 (Attribute) 的 BufferResponse 属性 (Property) 启用对 XML Web services 方法响应的缓冲。当设置为 true（默认设置）时，ASP.NET 在将响应向下发送到客户端之前对整个响应进行缓冲。缓冲非常有效，它通过最小化辅助进程和 IIS 进程之间的通信来帮助提高性能。当设置为 false 时，ASP.NET 以 16KB 的块区缓冲响应。通常，只有在不想将响应的全部内容一次缓冲到内存时，才将该属性 (Property) 设置为 false。例如，您在反写一个集合，该集合正在以流的形式从数据库输出其项。除非另外指定，默认值为 true。

CacheDuration

WebMethod 属性 (Attribute) 的 CacheDuration 属性 (Property) 启用对 XML Web services 方法结果的缓存。ASP.NET 将缓存每个唯一参数集的结果。该属性 (Property) 的值指定 ASP.NET 应该对结果进行多少秒的缓存处理。值为零，则禁用对结果进行缓存。除非另外指定，默认值为零。

Description说明

WebMethod 属性 (Attribute) 的 Description 属性 (Property) 提供 XML Web services 方法的说明，该说明将显示在服务帮助页上。除非另外指定，默认值为空字符串。

EnableSession

WebMethod 属性 (Attribute) 的 EnableSession 属性 (Property) 启用 XML Web services 方法的会话状态。一旦启用，XML Web services 就可以从 HttpContext.Current.Session 中直接访问会话状态集合，或者，如果它是从 WebService 基类继承的，则可以使用 WebService.Session属性来访问会话状态集合。除非另外指定，默认值为 false。

MessageName

WebMethod 属性 (Attribute) 的 MessageName 属性 (Property) 使 XML Web services 能够唯一确定使用别名的重载方法。除非另外指定，默认值是方法名称。当指定 MessageName 时，结果 SOAP 消息将反映该名称，而不是实际的方法名称。

TransactionOption

WebMethod 属性 (Attribute) 的 TransactionOption 属性 (Property) 使 XML Web services 方法可以作为事务的根对象参与。虽然可以将 TransactionOption 属性 (Property) 设置为 TransactionOption 枚举的任意值，但 XML Web services 方法仅有两个可能的行为：它不参与事务（Disabled、NotSupported、Supported）或它创建一个新事务（Required、RequiresNew）。除非另外指定，默认值为 TransactionOption.Disabled。

除了任何 XML Web services 方法的必备条件外，您还需要添加一个对 System.EnterpriseServices.dll 的引用。该命名空间包含了公开在 COM+ Services 中找到的分布式事务模型的方法和属性 (Property)。System.EnterpriseServices.ContextUtil 类允许您使用 SetAbort 或 SetComplete方法选择事务。