Google Wave API开发概览

原创

mars1021 2021-08-10 09:46:39 ©著作权

文章标签 wave google wave python html javascript 文章分类 代码人生

©著作权归作者所有：来自51CTO博客作者mars1021的原创作品，请联系作者获取转载授权，否则将追究法律责任

Google Wave已经公测一个月了，再全世界范围内都掀起了一股索要Google Wave的热潮。做为一个有思想的程序员，除了为Google Wave自身的新特性感动兴奋和赞叹以外，我们还好奇Google Wave 提供的API能干些什么。

　　说一句题外话：Google Wave计划引入类似IPhone的应用商店(AppStore)的模式，提高开发着的积极性，为开发者带来收入。嘿嘿，所以无论从兴趣上，还是从现实上，研究开发Google Wave的第三方应用都是有价值的！　o(∩_∩)o

　　如果您没有接触过Google Wave，流牛木马在这里推荐您先阅读这两个网页，再来看流牛木马的开发讲解。

关于Google Wave是什么： Google Wave，新Web时代的沟通平台（多图，视频）

关于Google Wave能干什么： Google Wave试用体验与Google的野心

如果您已经了解完Google Wave的基础，OK，我们开始吧。

Google Wave API能干什么？

开发机器人(Robots API)
      您刚才从上面的文章了解到，Wave是用来多人协作的。在多人协作的工作中，有一些工作是可以交给程序来做的。比如，或许您想在Wave中敲入 : ) 时，机器人可以自动帮你转换成图片；在比如，或许当您想当你编辑完Wave进行保存时，机器人可以自动帮你翻译为制定的语言；或许您想当您在Wave中分享代码时，机器人能够帮你把代码高亮；或许您还想当您新建Wave，机器人可以自动帮你将信息发布到Twitter上(或让机器人通过邮件/短信方式通知其他参与者？)等等等等。
     要完成上面例子中的功能，您只需要把相应的Wave机器人像普通的参与者(participants)一样添加到Wave中，机器人就可以工作了。机器人可以和普通人类参与者一样，监听Wave的各种状态、阅读、修改Wave的信息。
     简单地说：人类能在Wave上干什么，机器人就能在Wave上干同样的事——只要您为它编写好程序逻辑。
     很好玩吧？嗯，Google Wave API当中的第一套API就是关于机器人的。使用这些API, 您可以发挥出您的编程特长，写出完成各种各样功能的机器人, 提交到官方，供全世界的Wave用户使用。
开发嵌入Wave的网页部件(Gadgets API)
     当您看完上面两篇介绍Wave的文章时，您一定会感到非常惊叹。同时也许您也会想：好像功能还不太全，我能不能再给他补充一些的功能？比如画板、投票、统计、电话会议、地图标记等团队协作中常用的功能，Wave都没有自带。再如常见的“奥运倒计时”“天气预报”等无聊功能，再如一些“中国特色”的功能，比如偷菜、斗地主、抢车位……
     是的，就是这样。Wave提供了一些列优秀的特性，通过API, 您可以充分发挥您的想象，让您开发的Gadgets使用这些特性，更加完美。
     相信大家对Gadgets已经很熟悉了，前段时间流行过；不过值得注意的是：使用了Wave API、引入了Wave的一些特性、并嵌入到Wave里的Gadgets, 可比传统网页上的Gadgets惊艳多了！
将Wave嵌入其他网页(Embed API)：
这个API是最简单的，但很可能是将来使用的人最多的。它的功能很简单：将已有的一个Wave嵌入到其他网页：比如您的博客。不过现阶段这个API用处不大，因为Wave用户太少了，并且IE是不支持Google Wave的——就算您嵌入到您的博客文章里，能看到的人也是少数。

Google Wave 各种API的开发示例

Robots API
    在了解Robots API之前，您必须了解Google的云计算平台——Google App Engine (GAE)，因为Google 只支持您将机器人部署在GAE上。GAE的开发和使用非常简单，流牛木马在这里就不介绍了，请读者自行阅读这里、这里和这里，如果还不明白，可以直接咨询我。 o(∩_∩)o
    GAE目前只支持两种语言： Java和Python。我非常喜欢Python的优雅。下面就举一个Python的例子好了(其实Java我也不会*_*)。
    使用Python和Robots API开发Wave的机器人，需要以下步骤：
    1. 搭建Google AppEngine的开发环境
    2. checkout Robots API的代码，并import到项目中
    3. 添加事件的Handler (处理函数)
    4. 部署。
实例代码：

from waveapi import events
from waveapi import model
from waveapi import robot

def OnParticipantsChanged(properties, context):

       """当参与者发生变化时，执行的函数"""

       added = properties['participantsAdded']

       for p in added:

         Notify(context)

def OnRobotAdded(properties, context):

       """当机器人刚被添加时，执行的事件"""

       root_wavelet = context.GetRootWavelet()

       root_wavelet.CreateBlip().GetDocument().SetText("我是机器人，我开始工作了！")

def Notify(context):

       root_wavelet = context.GetRootWavelet()

       root_wavelet.CreateBlip().GetDocument().SetText("有新朋友来了！")

if __name__ == '__main__':
      """为这个机器的属性(profile)赋值。分别是:机器人名称、机器人头像、版本号、地址"""

       myRobot = robot.Robot('appName', 

           image_url='http://appName.appspot.com/icon.png',

           version='1',

           profile_url='http://appName.appspot.com/')
      """以下是添加Handler,对[参与者变化]和[机器人添加]这两个事件赋予相应的处理函数。"""
  myRobot.RegisterHandler(events.WAVELET_PARTICIPANTS_CHANGED, OnParticipantsChanged)

       myRobot.RegisterHandler(events.WAVELET_SELF_ADDED, OnRobotAdded)

       myRobot.Run()

Gadgets API
     如果您有过开发传统Gadgets的经历，您开发Gadgets会觉得非常信息：在开发常规Gadgets时那些与后台交互的数据操作，全部由Wave的API来实现了，方便到家！
     大家知道，Gadgets主要就是Javascript。那么好，开发Wave的Gadgets也只需要以下两个步骤：
     1. 首先是一个Gadgets
     2. 引入Wave Gadgets API(纯Javascript),在您的Gadgets中使用这些Javascript函数，与Wave进行交互。

下面的示例代码展示的Gadgets中，提供了两个按钮：点击第一个按钮可以将当前count变量的值加1，并更新保存到Wave中；第二个按钮重置count的值为0. 注意：这里的count您可以理解为“服务器变量”，它由Wave的api来记录。

<?xml version="1.0" encoding="UTF-8" ?>
     <Module>
     <ModulePrefs title="State Example" height="120">

     <Require feature="wave" /> 

     </ModulePrefs>

     <Content type="html">

     <![CDATA[ 

     <div id="content_div" style="height: 50px;"></div>

     <script type="text/javascript">
     var div = document.getElementById('content_div');
     //用户点击按钮时， 在本wave中获取到[count]变量的值，加1，记录。
     function buttonClicked() {
     var value = parseInt(wave.getState().get('count', '0'));
     wave.getState().submitDelta({'count': value + 1});
     }
     //当状态变更时，在wave中获取到[count]变量的值，并显示。如果[count]变量不存在，显示为0.
     function stateUpdated() {
     if(!wave.getState().get('count')) {
     div.innerHTML = "The count is 0."
     }
     else {
     div.innerHTML = "The count is " + wave.getState().get('count');
     }
     }
     //初始化：判断这个Gadgets是不是包含在Wave的容器内，如果是则进行初始化。
     function init() {
     if (wave && wave.isInWaveContainer()) {
     wave.setStateCallback(stateUpdated);
     }
     }
     gadgets.util.registerOnLoadHandler(init);
     //重置[count]变量的值为0
     function resetCounter(){
     wave.getState().submitDelta({'count': '0'});
     }
     </script>
     <input type=button value="Click Me!" id="butCount" onClick="buttonClicked()">
     <input type=button value="Reset" id="butReset" onClick="resetCounter()">
     ]]>
     </Content>
     </Module>

Embed API
呵呵，这个就非常没技术含量了，直接上示例代码：

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"

         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:v="urn:schemas-microsoft-com:vml">

       <head>

         <meta http-equiv="content-type" content="text/html; charset=utf-8"/>

         <title>Google Wave Embed API Example: Simple Wave</title>

         <script src="http://wave-api.appspot.com/public/embed.js" type="text/javascript"></script>

         <script type="text/javascript">
     //寥寥数行，就把一个已有的Wave插入到了某网页的一个叫做"waveframe"的div中

         function initialize() {

           var wavePanel = new WavePanel('http://wave.google.com/a/wavesandbox.com/');

           wavePanel.loadWave('wavesandbox.com!w+waveID');

           wavePanel.init(document.getElementById('waveframe'));

         }

         </script>

       </head>

       <body onload="initialize()">

         <div id="waveframe" style="width: 500px; height: 100%"></div>

       </body>
</html>