SP2010 AJAX第3部分–使用带有HTTP处理程序的jQuery AJAX

1. 将jQuery精简为基本要素 (技术)
2. 使用JavaScript Client OM处理列表 (技术)
3. 结合使用jQuery AJAX和HTTP处理程序（技术） - 本文
4. 从HTTP处理程序返回JSON (技术)
5. 为客户端OM和jQuery启用Intellisense (小费)
6. 调试jQuery / JavaScript (小费)
7. 构建AJAX应用程序时的有用工具 (小费)
8. 将现有应用程序迁移到jQuery / AJAX

到目前为止，我们’我们使用jQuery进行页面操作，并使用Client OM与SharePoint进行通信。今天，我想谈谈其他事情，我认为这可能是本系列中最重要的文章。 jQuery和Client OM不太可能处理AJAX风格的SharePoint开发人员需要处理的每种情况。可以肯定的是，客户端OM令人惊讶地广泛，其处理方式不仅仅是从列表中获取项目。– that said, it’并非服务器API的完整镜像，无论如何，在编写与客户端代码对话的服务器代码时（例如JavaScript） 有时您需要完全控制围栏的两侧。那么，如何构建AJAX风格 不使用客户端OM的SharePoint应用程序（出于某种原因）？

让’首先考虑服务器端-有两种选择： 

• 编写WCF服务（或者，实际上，‘classic’ .asmx web service)
• 编写HTTP处理程序
• 编写其他形式的服务器代码（与其他形式一样），它们通过HTTP生成响应
  • 例如从技术上讲，一个好的旧.aspx页可以用作服务器端组件。但是，由于其他一些原因，与其他选项相比，这是一个糟糕的选择（稍后会提到）

可以说，纯粹的路线是开发WCF服务–确实是SharePoint 2010’客户端OM的实现是WCF服务。如果你’重新体验过WCF，这可能对您来说是一个不错的选择。但是，我认为HTTP处理程序要简单一百倍，并且WCF的功能（例如传输灵活性，传递大文件的能力，安全性等）通常不需要“internal to the farm”SP2010 / AJAX应用。当然如果你’重新构建一个公开的API以向世界公开股票报价，那么情况可能会有所不同。另外，一种深奥的方法可能是使用常规的.aspx页之类的东西–但是，ASP.Net Web表单页面（即非MVC）的效率会降低，因为该页面将经历整个ASP.Net生命周期（Init，OnPreRender，Render等），’页面上没有任何ASP.Net控件。换句话说，我们将ASP.Net页用于其设计之外的其他用途。

因此，HTTP处理程序是一种简单有效的方法 建立AJAX风格的应用程式。对某些人来说’是一项新技术，对其他人来说，’s old news – but it’我认为这种方法是解锁编写AJAX应用程序功能的关键，无论是否’在SharePoint或纯.Net之上。

这项技术的妙处在于无限的可能性– you can AJAX-ify 任何东西，因为您将在处理程序中编写C＃代码，然后只需从jQuery调用它即可。显然，这不能说是关于‘provided’API，例如客户端OM。对了我’d有兴趣听到关于WCF与HTTP处理程序的反对意见。

就客户端而言，如果我们正在谈论JavaScript（如本系列文章所述），那么我们需要一种调用方法‘HTTP resources’就像上面提到的JavaScript方法一样。这已经有很多年了，但是jQuery的出现意味着它’s 道路 比以前更简单–jQuery提供了几种AJAX方法来通过URL调用服务器资源，并将响应传递回JavaScript。一旦从服务器调用中获得了值（稍后将对此进行更多介绍），您只需使用第1部分中介绍的方法（用于更新页面的基本jQuery方法）即可向用户显示反馈，而无需重新加载页面。 jQuery AJAX方法是：

$ .get（）	使用HTTP GET请求URL–在下面调用.ajax（）
$ .post（）	使用HTTP POST请求URL–在下面调用.ajax（）
$ .ajax（）	允许完全控制–公开全套参数
$ .getJson（）	请求URL GET并使用$ .parseJSON解析JSON格式的响应

创建一个HTTP处理程序（服务器）

所以，我们’ve希望建立结合jQuery的HTTP处理程序’AJAX方法是一项强大的技术– now let’看一下细节。

HTTP处理程序

HTTP处理程序是一个.Net类，它实现 System.Web.IHttpHandler – the ProcessRequest（） 方法是主要方法。在这里，您将编写代码来确定请求处理程序的URL时返回的内容。因此，如果指向.aspx页的URL返回HTML，则可以返回所需的任何内容–一个简单的字符串，一些更复杂的XML或JSON（本系列的下一篇文章）。一个返回字符串的简单处理程序如下所示：

using System;

using System.Web;

namespace COB.SPSaturday.Demos.Handlers

{

    public class DemoHandler : IHttpHandler

    {

        public bool IsReusable

        {

            // Return false in case your Managed Handler cannot be reused for another request.

            // Usually this would be false in case you have some state information preserved per request.

            get { return true; }

        }

        public void ProcessRequest(HttpContext context)

        {

            context.Response.Write("From the handler 在  " + DateTime.Now);

        }

    }

}

.Net框架需要先了解这种处理程序，然后才能使用。这里有两个选择–将.ashx文件与上面的.cs文件相关联（在这种情况下，处理程序由.ashx的路径调用），或添加一个web.config条目来告诉.Net如何将请求路由到您的类（处理程序由您在这种情况下在web.config中定义的任何路径调用）。

使用.ashx

在项目中创建一个扩展名为.ashx的文件（除非我一直缺少它，否则没有VS项目模板），并使用WebHandler指令指向您的实现。之所以可行，是因为.ashx是特殊扩展名，.Net知道通过查找该类来解析类。 WebHandler 指示：

<%@ Assembly 名称="COB.SPSaturday.Demos，版本= 1.0.0.0，文化=中性，PublicKeyToken = 23afbf06fd91fa64" %>

<%@ WebHandler Language="C#" Class="COB.SPSaturday.Demos.Handlers.DemoHandler" CodeBehind="DemoHandler.cs" %>

使用web.config条目

添加条目（例如，通过 SPWebConfigModification） 像这样–请注意，您可以指定一个自定义路径/扩展名’出于任何原因而更可取：

<handlers>

    <!-- other handlers here -->

    <add name="DemoHandler" path="/_layouts/COB/DemoHandler.cob" verb="*" type="COB.SPSaturday.Demos.Handlers.DemoHandler, COB.SPSaturday.Demos，版本= 1.0.0.0，文化=中性，PublicKeyToken = 23afbf06fd91fa64" />

</handlers>

大多数人选择.ashx路由，因为它避免为应用程序使用的每个处理程序在web.config中定义某些内容。

调用HTTP处理程序（客户端）

之前，我们详细介绍了jQuery’向服务器发出请求的四种核心方法。这里’s一个示例（使用.get（）方法）：

<fieldset id="fldDemo1">

    <legend>Demo 1 - simple handler</legend>

    <div id="demo1Row" class="demoRow">

            <div class="demoControls">

                <button id="btnDemo1" type="button">Call handler</button>

            </div>

            <div class="demoResults">

                <span id="demo1Result" />

            </div>

            <div class="clearer" />

    </div>

    </fieldset>

    <script type="text/javascript">

    $('#btnDemo1'）。click(function () {

        $.get('/_layouts/COB/DemoHandler.cob',

            function (data) {

                $('#demo1Result'）。html(data);

            }）;

    }）;

    </script>

如您所见，关键是采用从服务器传递到jQuery回调的data属性，并使用jQuery’使用.html（）之类的方法操纵页面的能力。嘿，presto，您现在无需完全回发就可以执行任何您想做的事情！

需要注意的是，如果您’在处理程序中重新修改数据时，一个好的做法是使其成为.post（）请求，而不是.get（）–当然，默认情况下，SharePoint不允许对GET请求进行更新，因此您 必须 无论如何都要做一些事情来解决（贫民窟替代品被设置 SPWeb.AllowUnsafeUpdates = true）。

付诸实践

现在我们’在了解了这些机制之后，请考虑一下在现实世界中如何推广使用：

• 返回数据：
  • 如果你’重新返回非结构化数据（例如字符串），事情就很简单了（注：我省略提及的另一个jQuery AJAX方法是 $ .load（） 进一步简化事情的方法）
  • 对于结构化数据（例如，对象），通常以JSON序列化字符串的形式返回–通常是XML首选的，但是XML也有很多示例
  • 由于设置页面元素的HTML非常简单，因此’试图让处理程序返回大量的硬编码HTML字符串（例如，当我们’重新更新页面的较大复杂区域）–确实我提到这是一个“SP2010 / jQuery / AJAX幸存者’s 技术”在我的SharePoint周六演讲中。这很好，但是更好的方法是使用新的jQuery模板功能– Jan Tielen’s jQuery模板和SharePoint 2010入门 是一个很棒的帖子。
• 保理
  • 构造代码的一种好方法是让处理程序实现多个方法（例如，用于相关功能），并在AJAX请求中传递querystring参数以指示要执行的方法。你当然不’不需要为您可能实现的每种方法提供处理程序。

下次 - 从HTTP处理程序返回JSON