MSDN Visual系列：在SharePoint中创建自定义HttpHandler

原文：http://msdn2.microsoft.com/en-us/library/bb457204.aspx

ASP.NET编程可以支持创建自定义的HttpHandler组件，用来提供更灵活有效的方式处理那些并不返回标准的HTML页面的请求。比如，HttpHandler组件非常适合用来给用户返回纯文本，XML，或二进制数据流。

HttpHandler组件开发技术不但在传统的ASP.NET应用程序中很有用，而且，在基于SharePoint技术(包括Microsoft Windows SharePoint Services 3.0和Office SharePoint Server 2007)的商业解决方案中，该组件同样很有价值。

创建一个HttpHandler组件最简单的方式就是创建一个扩展名为.ashx的源文件。然后，我们需要在文件内容顶部增加一个@WebHandler声明，后面跟一个实现了IHttpHandler接口的类的名字。任何实现了IHttpHandler接口的类必须提供一个IsReusable方法和ProcessRequest方法的实现。如果我们需要在该HttpHandler组件使用到SharePoint对象模型中的内容，我们可以再增加一个@Assembly声明，添加到Microsoft.SharePoint.dll的引用。

<%@ Assembly Name="Microsoft.SharePoint, [full assembly name]" %> 
<%@ WebHandler Language="C#" Class="HelloHttpHandler" %>
using System;
using System.Web;
using Microsoft.SharePoint;

public class HelloHttpHandler : IHttpHandler {
  public bool IsReusable {
    get { return false; }
  }
  public void ProcessRequest(HttpContext context) {
    SPSite siteColl = SPContext.Current.Site;
    SPWeb site = SPContext.Current.Web;
    context.Response.ContentType = "text/plain"
    context.Response.Write("Hello HttpHandler from the site " +
                           site.Title + 
                           " at " +
                           site.Url);   
  }
}

在通过创建一个.ashx文件的方式定义好一个HttpHandler组件后，我们必须将其部署到\LAYOUTS目录中。这一点和部署一个普通的自定义后台应用的页面完全相同。最佳的做法是在\LAYOUTS目录下创建一个项目专用或公司专用的目录，把所有需要部署的文件都放到这个目录中。这样可以在我们部署一个自定义应用时很好的避免文件名冲突。

当我们将.ashx文件部署到\LAYOUTS目录下的某个文件夹后，我们就可以在服务器场中任何站点下使用相对路径访问到。例如：

   http://MyWebServer/sites/Sales/_layouts/Litware/HelloHttpHandler.ashx

作为一个标准的后台应用页面，HttpHandler组件可以得到借助使用SharePoint对象模型得到当前SPSite对象(使用SPContext.Current.Site)和SPWeb对象(使用SPContext.Current.Web)。

我们可以通过调用context.Respone.Write或context.Response.BinaryWrite来write内容给调用者。我们也可以通过System.IO命名空间下的各种可用的类直接write数据到ASP.NET输出流。

最后要说的是，我们常常会被要求指定一个值给ASP.NET Response对象的ContentType属性。上面的示例展示了使用"text/plain"型的ContentType,指定返回纯文本型的数据。我们可以使用"text/xml"来返回XML文档型数据。还有其它的ContentType值类型可以供我们利用，如Microsoft Word文档，PDF文件，视频或音频媒体文件等。大家尽情发挥吧！

查看视频