标签：学习日记

基于XML-RPC的BloggerAPI学习（转自：http://blog.donews.com/softbunny/articles/11032.aspx）

blogger_logo.gif　　 Luliang的mail2blog脚本，通过基于XML-RPC的BloggerAPI来实现的发布blog的功能。

　　BloggerAPI是一套程序接口，用以支持远程操作blog.这个规范现在的版本是1.0，是个试验版本和α版本。但是，规范的研发人员不再对BloggerAPI进一步地开发，他们正在制定一套新的、更稳定的API，新项目的名称为echomoinmoin.gif

.

　　虽然如此，了解一下这个bloggerAPI还是非常有意义的。一方面有很多语言提供了实现包，另一方面很blog工具也提供了相应的包，如MT。需要说明的是，BloggerAPI提供的功能太有限了，只定义了6个方法或函数，所以出了一个RFC叫 MetaWeblog API，对其进行了扩展。我看了一下，MT2.6.4就支持MetaWeblogAPI.

　　下面对二者进行简单地介绍，以后有机会，再跟echo比较一下。：）

BloggerAPI based on XML-RPC

1、方法列表

方法 说明

blogger.newPost 向批定的blog增加新的文章（post）,通常会在增加后即发布。

blogger.editPost 编辑一篇文章(post)，通常会在修改后发布。

blogger.getUsersBlogs 返回一个成员的所有文章的信息。

blogger.getUserInfo 鉴证一个用户并反回其信息（如userid,email等）

blogger.getTemplate 返回指定的blog的主要或文档索引模板

blogger.setTemplate 编辑指定的blog的主要或文档索引模板

2、blogger.newPost

参数说明

参数 说明

appkey (string) 发送这个post的程序的唯一标志

blogid (string) 这个post即将发送到的blog的标志

username (string) 有权post文章的用户名

password (string) 用户密码

content (string) Post的内容

publish (boolean) 是否发布

示例：

请求XML-RPC调用的数据

POST /api/RPC2 HTTP/1.0

User-Agent: Java.Net Wa-Wa 2.0

Host: plant.blogger.com

Content-Type: text/xml

Content-length: 515

<?xml version="1.0"?>

<methodCall>

<methodName>blogger.newPost</methodName>

<params>

<param><value><string>C6CE3FFB3174106584CBB250C0B0519BF4E294</string></value></param>

<param><value><string>744145</string></value></param>

<param><value><string>ewilliams</string></value></param>

<param><value><string>secret</string></value></param>

<param><value><string>Today I had a peanut butter and pickle sandwich

for lunch. Do you like peanut-butter and pickle sandwiches? I do.

They're yummy. Please comment!</string></value></param>

<param><value><boolean>false</boolean></value></param>

</params>

</methodCall>

成功时的应答

HTTP/1.1 200 OK

Connection: close

Content-Length: 125

Content-Type: text/xml

Date: Mon, 6 Aug 20001 19:55:08 GMT

Server: Java.Net Wa-Wa/Linux

<?xml version="1.0"?>

<methodResponse>

<params>

<param>

<value><string>4515151</string></value>

</param>

</params>

</methodResponse>

失败时的应答

错误信息通过XML-RPC <methodResponse>及<fault> 项返回，包含着的 <struct> 有错误码和描述,这是由xml-rpc规范定义.

HTTP/1.1 200 OK

Connection: close

Content-Length: 225

Content-Type: text/xml

Date: Mon, 6 Aug 20001 19:55:08 GMT

Server: Java.Net Wa-Wa/Linux

<?xml version="1.0"?>

<methodResponse>

<fault>

<value>

<struct>

<member>

<name>faultCode</name>

<value><int>4</int></value>

</member>

<member>

<name>faultString</name>

<value><string>java.lang.Exception: java.lang.Exception: Error: AppKey is

invalid or inactive.</string></value>

</member>

</struct>

</value>

</fault>

</methodResponse>

3、blogger.editPost

参数说明

参数 说明

appkey (string) 发送这个post的程序的唯一标志

postid (string) 某篇post的唯一标志

username (string) 有权修改文章的用户名（作者或管理员）

password (string) 用户密码

content (string) Post的内容

publish (boolean) 是否发布

4、blogger.getUserBlogs

参数说明

参数 说明

appkey (string) 发送这个post的程序的唯一标志

username (string) 用户名

password (string) 用户密码

成功应答示例

HTTP/1.1 200 OK

Connection: close

Content-Length: 125

Content-Type: text/xml

Date: Mon, 6 Aug 20001 19:55:08 GMT

Server: Java.Net Wa-Wa/Linux

<?xml version="1.0" encoding="ISO-8859-1"?>

<methodResponse>

<params>

<param>

<value>

<array>

<data>

<value>

<struct>

<member>

<name>url</name>

<value>http://stuff.foo.com/biz</value>

</member>

<member>

<name>blogid</name>

<value>2997323</value>

</member>

<member>

<name>blogName</name>

<value>Blogger Biz Dev</value>

</member>

</struct>

</value>

<value>

<struct>

<member>

<name>url</name>

<value>http://www.blogger.com/</value>

</member>

<member>

<name>blogid</name>

<value>2723</value>

</member>

<member>

<name>blogName</name>

<value>Blogger News</value>

</member>

</struct>

<value>

<struct>

<member>

<name>url</name>

<value>http://www.geocities.com/rafting/</value>

</member>

<member>

<name>blogid</name>

<value>223723</value>

</member>

<member>

<name>blogName</name>

<value>RaftingBlog</value>

</member>

</struct>

</value>

</value>

</data>

</array>

</value>

</param>

</params>

</methodResponse>

5、blogger.getUserInfo

参数说明

参数 说明

appkey (string) 发送这个post的程序的唯一标志

username (string) 用户名

password (string) 用户密码

成功应答示例

HTTP/1.1 200 OK

Connection: close

Content-Length: 125

Content-Type: text/xml

Date: Mon, 6 Aug 20001 19:55:08 GMT

Server: Java.Net Wa-Wa/Linux

<?xml version="1.0" encoding="ISO-8859-1"?>

<methodResponse>

<params>

<param>

<value>

<struct>

<member>

<name>nickname</name>

<value>Ev.</value>

</member>

<member>

<name>userid</name>

<value>1</value>

</member>

<member>

<name>url</name>

<value>http://www.evhead.com</value>

</member>

<member>

<name>email</name>

<value>ev@pyra.com</value>

</member>

<member>

<name>lastname</name>

<value>Williams</value>

</member>

<member>

<name>firstname</name>

<value>Evan</value>

</member>

</struct>

</value>

</param>

</params>

</methodResponse>

6、blogger.getTemplate

参数说明

参数 说明

appkey (string) 发送这个post的程序的唯一标志

blogid (string) 这个post即将发送到的blog的标志

username (string) 有权post文章的用户名

password (string) 用户密码

templateType (string) 指定返回哪个模板，目前只能是 "main" 或 "archiveIndex".

成功时的应答，....表示此处内容被我省略。

<?xml version="1.0" encoding="ISO-8859-1"?<<methodResponse<<params<<param<<value<<HTML<

<HEAD<

<TITLE<<$BlogTitle$<: <$BlogDescription$<</TITLE<

</BODY<

</HTML<

</value<</param<</params<</methodResponse<

7、blogger.setTemplate

参数说明

参数 说明

appkey (string) 发送这个post的程序的唯一标志

blogid (string) 这个post即将发送到的blog的标志

username (string) 有权post文章的用户名

password (string) 用户密码

template (string) 模板文本（通常是HTML）.必须包含 和标签，因它们需要发布。 （？我的mainindex里没有啊）

templateType (string) 指定返回哪个模板，目前只能是 "main" 或 "archiveIndex".

请求格式示例

POST /api/RPC2 HTTP/1.0

User-Agent: Java.Net Wa-Wa 2.0

Host: plant.blogger.com

Content-Type: text/xml

Content-length: 515

<?xml version="1.0"?>

<methodCall>

<methodName>blogger.setTemplate</methodName>

<params>

<param><value><string>C6CE3FFB3174106584CBB250C0B0519BF4E294</string></value></param>

<param><value><string>744154</string></value></param>

<param><value><string>ewilliams</string></value></param>

<param><value><string>secret</string></value></param>

<param><value><string><html><head><title><$BlogTitle$></title></head><body><Blogger><BlogDateHeader><h1><$BlogDateHeaderDate$></h1></BlogDateHeader><$BlogItemBody$><br></Blogger></body></html></string></value></param>

<param><value><string>main</string></value></param>

</params>

</methodCall>

MetaWeblog API

这个rfc的最新发布是在08/26/2003.

1、什么是MetaWeblog API

　　MetaWeblog API (MWA)是一套编程接口，允许外面的程序能取得和设置blog文章的文本或属性。它基于流行的XML-RPC通信协议,后者在很多的流行的开发环境中都有了实现的包。

2、MetaWeblog API与Blogger API 的关系

　　MetaWeblog API是对Blogger API增强, Blogger API只能取得或设置blog文章的文本内容(hedong问，能取得吗？).在2002年春天MWA面世,在此以前许多blog工具能存储许多扩展数据，但不能访问或编辑这些数据，因为没有一个通过的API。

　　到2003年夏天，在本文的写作期间，大部分流行的blog工具和编辑器，能同时支持Blogger API 和MetaWeblog API.

3、MetaWeblog API和 RSS 2.0 的关系

MetaWeblog API利用XML-RPC来描述一篇blog文章. 我们使用了RSS2.0中对一个项的术语来描述一篇blog文章的元数据，而不是重新发明一套。请参照RSS2.0中对文章的title, link 、description，author, comments, enclosure, guid等的定义或命名。更进一步，由于RSS2.0是可扩展的，因而MetaWeblog API也是可扩展的. 我们在MWA中设计了一些用以表述属性和命名空间的约定。

4、基本函数(entry-points)

1)metaWeblog.newPost (blogid, username, password, struct, publish) returns string

2)metaWeblog.editPost (postid, username, password, struct, publish) returns true

3)metaWeblog.getPost (postid, username, password) returns struct

blogid, username, password 和publish参数的含义同 Blogger API. newPost返回的字符串表示post_id,同Blogger API定义的一样. 而那个struct就是MWA的精华所在。

5、数据结构

　　在newPost和editPost中，内容信息不再跟BloggerAPI中那是一个字符串，而是一个数据结构。这个数据结构的成员，就是rss2.0中定义的ITEM的元素。参见后面附表。

　　当一个元素有属性时，用一个数据结构（属性做成员）传递属性及其相应的值。如enclosure元素，用一个包含url, length 和type的结构传递属性。

对source元素，数据结构的成员为url 和name，前者为source的属性后者为source值。

对categories元素，传递一个字符串数组。在服务器端，如果传来的category不存在，则忽略不报错，且只保存有效的那些category.(hedong，好象没说domain属性的事啊）

　　服务器必须忽略所有不能理解的元素。

在调用 metaWeblog.newPost 或 metaWeblog.editPost时，如果数据结构中含有一个名叫flNotOnHomePage的 boolean 值，则主页不显示此文章而只在分类中显示。

6、其它函数

1）metaWeblog.newMediaObject (blogid, username, password, struct) returns struct

　　参数的struct，至少包含name, type and bits三个元素。

name是个字符串，可以用来作存储对象的文件名或用于对象列表的显示。它决定weblog如何引用这个对象。如果name和weblog已有一个对象重名，则替换掉已有的对象。

type是个字符串，表示对象的类型，必须是个标准的MIME类型，如 audio/mpeg or image/jpeg or video/quicktime.

bits是个base64-编码的二进制值，包含着对象的内容。

这个结构可以含有其它的元素，这些元素可以或不能被内容管理系统保存.

当调用失败时，抛出error.当成功时，返回的strcut中，至少要有一个元素url，用以指明这个对象如何被访问。其值只能是一个HTTP url或FTP url.

2）metaWeblog.getCategories (blogid, username, password) returns struct

返回的struct中，为每个分类提供一个子结构，子结构中至少包含三个元素：description, httpurl 和 rssurl.

3）metaWeblog.getRecentPosts (blogid, username, password, numberOfPosts) returns array of structs

　　返回是一个结构数组，盛放着最新发布的文章信息。每个结构的内容同metaWeblog.getPost返回内容相同.

　　numberOfPosts指明要取回的按发布时间倒序计数的文章数量，当值超过总文章数时，返回全部文章信息。

7、传送带属性的元素

　　除了enclosure和source元素有专门规定外，其它元素按下列规则处理：

1)如果一个元素有属性，则用一个struct来表示，各属性为struct的子元素。

2)如果一个元素同时有属性和值，则用一个一个struct来表示，各属性为struct的子元素，再增加一个叫_value的子元素，表示元素的值。这也就要求，元素的属性名不能为_value.

8、传送某命名空间的元素

　　RSS 2.0允许使用命名空间. 如果你要传送的元素是一个命名空间的一部分，那就在传递给 newPost 或 editPost 的struct中增加一个子struct,以指明命名空间的URL为名，以要传送的元素值为子元素。

9、说明

　　在MWA中不要明确要求传送appkey值，如果应用程序要传送appkey,则在struct中增加一个名为appkey的元素，并赋之以相关的值。

附表：RSS2.0中ITEM的元素列表　　

元素(Element) 描述(Description) 例子(Example) 重要性 属性

title 项(item)的标题 Venice Film Festival Tries to Quit Sinking 必备

link 项的URL http://www.nytimes.com/2002/09/07/movies/07FEST.html 必备

description 项的大纲 Some of the most heated chatter at the Venice Film Festival this week was about the way that the arrival of the stars at the Palazzo del Cinema was being staged. 必备

author 该项作者的email oprah@oxygen.net 可选

category 包含该项的一个或几个分类(catogory) Simpsons Characters 可选 domain可选，指分类法的URL

comments 该项的评论(comments)页的URL http://www.myblog.org/cgi-local/mt/mt-comments.cgi?entry_id=290 可选

enclosure 描述该附带的媒体对象 可选 url/length/type皆必备,type须是标准MIME类型

guid 项的唯一标志符串 http://inessential.com/2002/09/01.php#a2 可选 isPermaLink可选，默认为真，指明guid是否为一永久URL。

pubDate 项的发布时间 Sun, 19 May 2002 15:21:36 GMT 可选

source 该项来自的RSS道 Quotes of the Day 可选 Url必备

附：MWAAPI清单

   1. metaWeblog.newPost (blogid, username, password, struct, publish) returns string

   2. metaWeblog.editPost (postid, username, password, struct, publish) returns true

   3. metaWeblog.getPost (postid, username, password) returns struct

   4. metaWeblog.newMediaObject (blogid, username, password, struct) returns struct

   5. metaWeblog.getCategories (blogid, username, password) returns struct

   6. metaWeblog.getRecentPosts (blogid, username, password, numberOfPosts) returns array of structs

Trackback: http://tb.donews.net/TrackBack.aspx?PostId=11032

[点击此处收藏本文]   发表于 2004年04月07日 10:24 PM

１、Blogger API（http://www.blogger.com/developers/api/1_docs/）

Blogger API

By Evan Williams, 8/7/01

Update: 8/13/01 -Ev.

Update: 6/27/03 -Jason Shellen

Welcome to the Blogger API. This site is for independent developers and partners who are interested in hooking into Blogger with other programs, interfaces, or environments.

Please Note: While we will continue to support the Blogger API we will not be developing it further. We are working along with others in the blogging industry to produce a new, more robust API. You can view the current state of the Echo Project here. For further updates, stay tuned to the bloggerDev mail list and www.blogger.com/developers/.

DISCLAIMER: The current state of this interface is experimental and alpha. I'm sure something's broken and other things will change. Your help in figuring these things out are appreciated, but no guarantees are made about reliability, robustness, or longevity. Use at your own risk.

Protocols

The Blogger API is currently implemented for XML-RPC. There may be others some day.

Methods

These are the available methods:

blogger.newPost: Makes a new post to a designated blog. Optionally, will publish the blog after making the post.

blogger.editPost: Edits a given post. Optionally, will publish the blog after making the edit.

blogger.getUsersBlogs: Returns information on all the blogs a given user is a member of.

blogger.getUserInfo: Authenticates a user and returns basic user info (name, email, userid, etc.).

blogger.getTemplate: Returns the main or archive index template of a given blog.

blogger.setTemplate: Edits the main or archive index template of a given blog.

More Info

There is a mailing list.

There is also a node in the XML-RPC directory pointing to implementations and such.

AppKeys

Good news, friends! We no longer require appkey registration to use the Blogger API. If you send us an appkey of 0123456789ABCDEF, then everything will work fine.

Each API request requires an application key ("appkey"), which is a unique identifier for each application using the interface. You can register an application and get a key with this form. You can distribute appkeys with source code that uses the API. Please use different keys for different apps. Appkeys will be used for tracking, stats, and, potentially, other stuff.

Acknowledgements

The Blogger API implementation uses the Helma XML-RPC library for Java. Also?: Tomcat. And lots of help from some of the people over here.

Copyright © 2001 Pyra Labs

２、有没有与网志交互的 Web Services APIs？（http://hanhan.blog.ccidnet.com/blog/ccid/do_showone/tid_18919.html）

有没有与网志交互的 Web Services APIs？

作者: hanhan11 发表日期: 2006-01-20 17:19 文章属性: 原创 复制链接 

许多网志引 擎都提供属于自己的 Web service 接口，通过编程与网志交互，但目前还没有出现一种标准化的东西。

.Text 和 dasBlog 两者都提供某些 .asmx 端点，可以通过 SOAP 来实现编辑功能，但其接口是不同的。Blogger.com 提供基于 XML-RPC 的交互式 API （Blogger API）。Userland Software 对Blogger API 的功能进行了增强，并把它叫做 MetaWeblog API。这些可能是当今公认的网志 APIs，但仍然不是所有网志引擎都支持的。还有一个用于添加评论的独力的 API 叫做 Comment API，同样，它也不是被普遍支持。

　　Atom 组正在努力解决这些问题，Atom API 定义了一个标准的网志 API 用于发布和编辑网志内容。有关信息请参考 The Atom Project 网站。 

阅读全文(192) | 回复(0) | 推送 | 举报 

３、wordpress的XML-RPC开发（http://wuhongsheng.com/blog/archives/2006/268/）

February 5, 2006

wordpress的XML-RPC开发

Filed under: 技术 — 吴洪声 @ 11:17 pm

wordpress支持使用xml-rpc进行开发。但网络上很少有相关的资料。这两天在做一个离线写blog的东东，研究到了这个东西，顺便做一下记录。

wordpress的xml-rpc支持多种API，根据从xmlrpc.php里面提取的数据，支持的API有：

// Blogger API

‘blogger.getUsersBlogs’ => ‘this:blogger_getUsersBlogs’,

‘blogger.getUserInfo’ => ‘this:blogger_getUserInfo’,

‘blogger.getPost’ => ‘this:blogger_getPost’,

‘blogger.getRecentPosts’ => ‘this:blogger_getRecentPosts’,

‘blogger.getTemplate’ => ‘this:blogger_getTemplate’,

‘blogger.setTemplate’ => ‘this:blogger_setTemplate’,

‘blogger.newPost’ => ‘this:blogger_newPost’,

‘blogger.editPost’ => ‘this:blogger_editPost’,

‘blogger.deletePost’ => ‘this:blogger_deletePost’,

// MetaWeblog API (with MT extensions to structs)

‘metaWeblog.newPost’ => ‘this:mw_newPost’,

‘metaWeblog.editPost’ => ‘this:mw_editPost’,

‘metaWeblog.getPost’ => ‘this:mw_getPost’,

‘metaWeblog.getRecentPosts’ => ‘this:mw_getRecentPosts’,

‘metaWeblog.getCategories’ => ‘this:mw_getCategories’,

‘metaWeblog.newMediaObject’ => ‘this:mw_newMediaObject’,

// MetaWeblog API aliases for Blogger API

// see http://www.xmlrpc.com/stories/storyReader$2460

‘metaWeblog.deletePost’ => ‘this:blogger_deletePost’,

‘metaWeblog.getTemplate’ => ‘this:blogger_getTemplate’,

‘metaWeblog.setTemplate’ => ‘this:blogger_setTemplate’,

‘metaWeblog.getUsersBlogs’ => ‘this:blogger_getUsersBlogs’,

// MovableType API

‘mt.getCategoryList’ => ‘this:mt_getCategoryList’,

‘mt.getRecentPostTitles’ => ‘this:mt_getRecentPostTitles’,

‘mt.getPostCategories’ => ‘this:mt_getPostCategories’,

‘mt.setPostCategories’ => ‘this:mt_setPostCategories’,

‘mt.supportedMethods’ => ‘this:mt_supportedMethods’,

‘mt.supportedTextFilters’ => ‘this:mt_supportedTextFilters’,

‘mt.getTrackbackPings’ => ‘this:mt_getTrackbackPings’,

‘mt.publishPost’ => ‘this:mt_publishPost’,

// PingBack

‘pingback.ping’ => ‘this:pingback_ping’,

‘pingback.extensions.getPingbacks’ => ‘this:pingback_extensions_getPingbacks’,

‘demo.sayHello’ => ‘this:sayHello’,

‘demo.addTwoNumbers’ => ‘this:addTwoNumbers’

其中最后两个API为用于测试的DEMO。

根据XML-RPC的约定，客户端必须向服务器作以下post：

POST /RPC2 HTTP/1.0

User-Agent: Frontier/5.1.2 (WinNT)

Host: betty.userland.com

Content-Type: text/xml

Content-length: 181

<?xml version="1.0"?>

<methodCall>

<methodName>examples.getStateName</methodName>

<params>

<param>

<value><i4>41</i4></value>

</param>

</params>

</methodCall>

User-Agent和Host项是必须的。

Content-Type的值必须是text/xml.

Content-Length必须指定，而且必须是正确的值。

下面是一个例子：

POST /api/RPC2 HTTP/1.0

User-Agent: Java.Net Wa-Wa 2.0

Host: plant.blogger.com

Content-Type: text/xml

Content-length: 515

<?xml version="1.0"?>

<methodCall>

<methodName>blogger.newPost</methodName>

<params>

<param><value><string>C6CE3FFB3174106584CBB250C0B0519BF4E294</string></value></param>

<param><value><string>744145</string></value></param>

<param><value><string>ewilliams</string></value></param>

<param><value><string>secret</string></value></param>

<param><value><string>Today I had a peanut butter and pickle

sandwich

for lunch. Do you like peanut-butter and pickle sandwiches? I do.

They’re yummy. Please comment!</string></value></param>

<param><value><boolean>false</boolean></value></param>

</params>

</methodCall>

服务器返回的数据：

HTTP/1.1 200 OK

Connection: close

Content-Length: 125

Content-Type: text/xml

Date: Mon, 6 Aug 20001 19:55:08 GMT

Server: Java.Net Wa-Wa/Linux

<?xml version="1.0"?>

<methodResponse>

<params>

<param>

<value><string>4515151</string></value>

</param>

</params>

</methodResponse>

如果出现错误，服务器会返回以下内容：

HTTP/1.1 200 OK

Connection: close

Content-Length: 225

Content-Type: text/xml

Date: Mon, 6 Aug 20001 19:55:08 GMT

Server: Java.Net Wa-Wa/Linux

<?xml version="1.0"?>

<methodResponse>

<fault>

<value>

<struct>

<member>

<name>faultCode</name>

<value><int>4</int></value>

</member>

<member>

<name>faultString</name>

<value><string>java.lang.Exception: java.lang.Exception: Error:

AppKey is

invalid or inactive.</string></value>

</member>

</struct>

</value>

</fault>

</methodResponse>

wordpress, xml rpc

No Comments »

No comments yet.

RSS feed for comments on this post. TrackBack URI

Leave a comment

　　想做的太多了：把“１２３行动！”的总体规划好好做一下，学建模（AndroMDA与ArgoUML），设计模式，学习日记重构，太多的事想做了，还要......

　　想做太多是做不成的，现在把这个目标的第２和３步实现。

　　１、先把要用到的技术要点初步掌握；

　　２、学习一下相关网站的同步操作流程（如：www.43things.com）(实现学习日记和我的blog的双向绑定:http://www.123go.org.cn/disGoalContentAction.do?goalID=1547&naviStr=a10)；

　　３、系统设计，用ArgoUML认真设计一下，我发现这样很对我的口味，像设置RSS Feed这样的小功能我也用它设计了一下；

　　４、实现。

　　

　　技术要点：

　　１）、关于item的内容，请看基于XML-RPC的BloggerAPI学习（http://www.123go.org.cn/disDiaryContentAction.do?searchDiaryID=1771&goalID=1554&naviStr=a10a21547ah1726）

　　２）Currently, w.bloggar is compatible with all tools that implements Blogger API, metaWeblog API, MovableType API and b2 API; all based on the XML-RPC definition. （http://www.123go.org.cn/disDiaryContentAction.do?searchDiaryID=1771&goalID=1622&naviStr=a10a21547ah1625）

　　可见基础是xml-rpc,可以用“XML-RPC 之 Apache XML-RPC 实例 及规范(转帖２篇)”（http://www.123go.org.cn/disDiaryContentAction.do?searchDiaryID=1771&goalID=1771&naviStr=a10a21547）这篇文章并结合“一个使用了xml_rpc和 Rome 0.6 for RSS / Atom feed generation开源blog ”（http://www.123go.org.cn/disDiaryContentAction.do?searchDiaryID=1716&goalID=1716&naviStr=a10a21547）这个开源Blog系统来学习XML-RPC的使用。

　　现在，我基本上可以在Linux下进行写程序了。就用这个功能来进行在linux开发的实践之一吧。

XML-RPC 之 Apache XML-RPC 实例 （转自：http://spaces.msn.com/lzhuacuo/blog/cns!18730E989D068035!507.entry?_c11_blogpart_blogpart=blogview&_c=blogpart#permalink）

 

XML-RPC 之 Apache XML-RPC 实例

作者：王恩建 来源：http://www.sentom.net

XML-RPC 是工作在 Internet 上的远程过程调用协议。通俗点讲，就是使用 HTTP 协议交互，交互的载体是 XML 文件。XML-RPC 具体的规范说 明请参考这里。

图片来自XML-RPC官方网站

XML-RPC 规范定义了六种数据类型，下表是这六种数据类型与 Java 的数据类型对应表。

XML-RPC Java

<i4> 或 <int> int

<boolean> boolean

<string> java.lang.String

<double> double

<dateTime.iso8601> java.util.Date

<struct> java.util.Hashtable

<array> java.util.Vector

<base64> byte[ ]

XML-RPC 规范的各种平台都有具体实现，XML-RPC 规范的 Java 实现都有好几种，这里我们选择了 Apache XML-RPC。

XML-RPC 服务端实现

先定义一个简单业务对象 MyHandler，远程客户端将调用该对象的方法，具体代码如下：

package net.sentom.xmlrpc;

public class MyHandler {

public String sayHello(String str){

return "Hello," + str;

}

}

然后定义一个 Servlet 名叫 MyXmlRpcServer，远程客户端通过 HTTP-POST 访问该 Servlet。

package net.sentom.xmlrpc;

import java.io.IOException;

import java.io.OutputStream;

import javax.servlet.ServletException;

import javax.servlet.http.HttpServlet;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import org.apache.xmlrpc.XmlRpcServer;

public class MyXmlRpcServer extends HttpServlet {

public void doPost(HttpServletRequest request, HttpServletResponse response)

throws ServletException, IOException {

XmlRpcServer xmlrpc = new XmlRpcServer();

xmlrpc.addHandler("myHandler", new MyHandler());

byte[] result = xmlrpc.execute(request.getInputStream());

response.setContentType("text/xml");

response.setContentLength(result.length);

OutputStream out = response.getOutputStream();

out.write(result);

out.flush();

}

}

需要特别说明是：

xmlrpc.addHandler("myHandler", new MyHandler());

为了便于理解，这里可以看成普通的：

MyHandler myHandler = new MyHandler();

最后在web.xml文件中加入以下几行：

<servlet>

    <servlet-name>MyXmlRpcServer</servlet-name>

    <servlet-class>net.sentom.xmlrpc.MyXmlRpcServer</servlet-class>

</servlet>

<servlet-mapping>

    <servlet-name>MyXmlRpcServer</servlet-name>

    <url-pattern>/MyXmlRpcServer</url-pattern>

</servlet-mapping>

XML-RPC 客户端实现

客户端相对简单一些，先来一个 Java 客户端实现 MyXmlRpcClient:

package net.sentom.xmlrpc;

import java.io.IOException;

import java.net.MalformedURLException;

import java.util.Vector;

import org.apache.xmlrpc.XmlRpcClient;

import org.apache.xmlrpc.XmlRpcException;

public class MyXmlRpcClient {

public static void main(String[] args) {

try {

XmlRpcClient xmlrpc = new XmlRpcClient("http://localhost:8080/XMLRPC/MyXmlRpcServer");

Vector params = new Vector();

params.addElement("Tom");

String result = (String) xmlrpc.execute("myHandler.sayHello",params);

System.out.println(result);

} catch (MalformedURLException e) {

System.out.println(e.toString());

} catch (XmlRpcException e) {

System.out.println(e.toString());

} catch (IOException e) {

e.printStackTrace();

}

}

http://localhost:8080/XMLRPC/MyXmlRpcServer 为 MyXmlRpcServer 的访问URL。

String result = (String) xmlrpc.execute("myHandler.sayHello",params);

再来一个 Python 客户端实现

import xmlrpclib

url = 'http://localhost:8080/XMLRPC/MyXmlRpcServer';

server = xmlrpclib.Server(url);

print server.myHandler.sayHello('Tom');

 

 

 

添加评论

9:12  |  固定链接 | 引用通告 (0) | 记录它 | Open Source

 

 

固定链接  关闭

 

http://spaces.msn.com/lzhuacuo/blog/cns!18730E989D068035!507.entry

 

 

 

 

 

 

 

XML-RPC规范(中文版) （转自：http://spaces.msn.com/lzhuacuo/blog/cns!18730E989D068035!504.entry?_c11_blogpart_blogpart=blogview&_c=blogpart#permalink）

 

XML-RPC规范(中文版)

把这篇文章转到blog里，希望rainbowsoft能看见有朝一日给blog写支持客户端post的功能时能用上

 

Tue, Jun 15, 1999; by Dave Winer. （翻译:滴水 最后修改时间:2005-3-15 后续完善）

更新 6/30/03 DW

更新 10/16/99 DW

更新 1/21/99 DW

本规范说明的XML-RPC协议实现UserLand Frontier 5.1。

关于非技术性说明，请访问XML-RPC for Newbies。

文档提供了实现XML-RPC所需要的所有信息。

前言

XML-RPC是一种基于Internet的远程函数调用协议。

XML-RPC消息都是HTTP-POST请求。请求的主要部分的XML。服务器端执行后的返回结果同样也是XML格式。

函数调用的参数可以是scalars, numbers, strings, dates等等；也可以是混合型的记录和结构体。

Request请求样式

下面是一个XML-RPC请求的例子：

POST /RPC2 HTTP/1.0

User-Agent: Frontier/5.1.2 (WinNT)

Host: betty.userland.com

Content-Type: text/xml

Content-length: 181

<?xml version="1.0"?>

<methodCall>

   <methodName>examples.getStateName</methodName>

   <params>

      <param>

         <value><i4>41</i4></value>

         </param>

      </params>

   </methodCall>

关于请求头

第一行的URI格式不是特定的。可以为空，如果服务器只处理XML-RPC请求甚至可以只是简单的一个斜线。可是，如果服务器除了XML-RPC外还提供其他的HTTP请求，URI可以帮助我们把请求指向特定的XML-RPC服务。

User-Agent和Host项是必须的。

Content-Type的值必须是text/xml.

Content-Length必须指定，而且必须是正确的值。

有效的格式

XML-RPC具有和XML一样的有效格式，并且是一个<methodCall>结构。

<methodCall>必须包含一个值为字符型的<methodName>子元素，用来表明被调用的方法。这个字符必须符合以下规定：大小写字母、数字0-9、下划线、点、冒号和斜线。至于怎么解释这个字符串将有服务器端来决定。

例如，methodName可以是一个包含执行request请求的文件的名字，可以是数据表中列的名字，还可以是表示目录和文件结构的路径。

如果远程调用接受参数，<methodCall>就必须包含<params>子元素。<params>可以包含任意个<param>元素，每个<param>包含一个<value>子元素。

Scalar <value>s <value>

<value>值被嵌入类型标签中，支持的类型如下表:

Tag Type Example

<i4> or <int> four-byte signed integer -12

<boolean> 0 (false) or 1 (true) 1

<string> string hello world

<double> double-precision signed floating point number -12.214

<dateTime.iso8601> date/time 19980717T14:08:55

<base64> base64-encoded binary eW91IGNhbid0IHJlYWQgdGhpcyE=

如果没有指定类型，默认为字符串。

<struct>s

参数值可以是<struct>。

每个<struct>包含若干<member>，每个<member>包含一个<name>和一个<value>.

如果所示为包含两个值的<struct>

<struct>

   <member>

      <name>lowerBound</name>

      <value><i4>18</i4></value>

      </member>

   <member>

      <name>upperBound</name>

      <value><i4>139</i4></value>

      </member>

   </struct>

<struct>是可以递归使用的，任何<value>都里还可以<struct>或其他任何类型，包括后面将要说明的<array>。

<array>s

值可以个<array>

一个<array>简单的有一个<data>元素。<data>可以是任何合法类型。

下面是一个有4个值的array：

<array>

   <data>

      <value><i4>12</i4></value>

      <value><string>Egypt</string></value>

      <value><boolean>0</boolean></value>

      <value><i4>-31</i4></value>

      </data>

   </array>

<array> elements do not have names.

<array> 元素没有名字。

你可以混合使用上面列出的几种类型。

<arrays>可以递归使用，其值可以是<array>或其他类型，包括上面说明的<strut>。

Response应答样式

下面是一个 XML-RPC请求：

HTTP/1.1 200 OK

Connection: close

Content-Length: 158

Content-Type: text/xml

Date: Fri, 17 Jul 1998 19:55:08 GMT

Server: UserLand Frontier/5.1.2-WinNT

<?xml version="1.0"?>

<methodResponse>

   <params>

      <param>

         <value><string>South Dakota</string></value>

         </param>

      </params>

   </methodResponse>

Respnse应答格式

除非底层操作出现错，否则总是返回200 OK.

Content-Type是text/xml。必须设置Content-Length，并且必须是正确的值。

应到内容是一个简单的XML，可是是<methodResponse>包含一个<params>,<params>包含一个<param>,<param>包含一个<value>。

<methodResponse>可能含有一个<fault>标签。<fault>的值为<struct>类型,<struct>有两个元素，值为<int>的<faultCode>和值为<string>的<faultString>。

<methodResponse>不能既有<fault>又有<params>。

Fault example

HTTP/1.1 200 OK

Connection: close

Content-Length: 426

Content-Type: text/xml

Date: Fri, 17 Jul 1998 19:55:02 GMT

Server: UserLand Frontier/5.1.2-WinNT

<?xml version="1.0"?>

<methodResponse>

   <fault>

      <value>

         <struct>

            <member>

               <name>faultCode</name>

               <value><int>4</int></value>

               </member>

            <member>

               <name>faultString</name>

               <value><string>Too many parameters.</string></value>

               </member>

            </struct>

         </value>

      </fault>

   </methodResponse>

Strategies/Goals

Firewalls. The goal of this protocol is to lay a compatible foundation across different environments, no new power is provided beyond the capabilities of the CGI interface. Firewall software can watch for POSTs whose Content-Type is text/xml.

Discoverability. We wanted a clean, extensible format that's very simple. It should be possible for an HTML coder to be able to look at a file containing an XML-RPC procedure call, understand what it's doing, and be able to modify it and have it work on the first or second try.

Easy to implement. We also wanted it to be an easy to implement protocol that could quickly be adapted to run in other environments or on other operating systems.

Updated 1/21/99 DW

The following questions came up on the UserLand discussion group as XML-RPC was being implemented in Python.

The Response Format section says "The body of the response is a single XML structure, a <methodResponse>, which can contain a single <params>..." This is confusing. Can we leave out the <params>?

No you cannot leave it out if the procedure executed successfully. There are only two options, either a response contains a <params> structure or it contains a <fault> structure. That's why we used the word "can" in that sentence.

Is "boolean" a distinct data type, or can boolean values be interchanged with integers (e.g. zero=false, non-zero=true)?

Yes, boolean is a distinct data type. Some languages/environments allow for an easy coercion from zero to false and one to true, but if you mean true, send a boolean type with the value true, so your intent can't possibly be misunderstood.

What is the legal syntax (and range) for integers? How to deal with leading zeros? Is a leading plus sign allowed? How to deal with whitespace?

An integer is a 32-bit signed number. You can include a plus or minus at the beginning of a string of numeric characters. Leading zeros are collapsed. Whitespace is not permitted. Just numeric characters preceeded by a plus or minus.

What is the legal syntax (and range) for floating point values (doubles)? How is the exponent represented? How to deal with whitespace? Can infinity and "not a number" be represented?

There is no representation for infinity or negative infinity or "not a number". At this time, only decimal point notation is allowed, a plus or a minus, followed by any number of numeric characters, followed by a period and any number of numeric characters. Whitespace is not allowed. The range of allowable values is implementation-dependent, is not specified.

What characters are allowed in strings? Non-printable characters? Null characters? Can a "string" be used to hold an arbitrary chunk of binary data?

Any characters are allowed in a string except < and &, which are encoded as < and &. A string can be used to encode binary data.

Does the "struct" element keep the order of keys. Or in other words, is the struct "foo=1, bar=2" equivalent to "bar=2, foo=1" or not?

The struct element does not preserve the order of the keys. The two structs are equivalent.

Can the <fault> struct contain other members than <faultCode> and <faultString>? Is there a global list of faultCodes? (so they can be mapped to distinct exceptions for languages like Python and Java)?

A <fault> struct may not contain members other than those specified. This is true for all other structures. We believe the specification is flexible enough so that all reasonable data-transfer needs can be accomodated within the specified structures. If you believe strongly that this is not true, please post a message on the discussion group.

There is no global list of fault codes. It is up to the server implementer, or higher-level standards to specify fault codes.

What timezone should be assumed for the dateTime.iso8601 type? UTC? localtime?

Don't assume a timezone. It should be specified by the server in its documentation what assumptions it makes about timezones.

Additions

<base64> type. 1/21/99 DW.

Updated 6/30/03 DW

Removed "ASCII" from definition of string.

Changed copyright dates, below, to 1999-2003 from 1998-99.

Copyright and disclaimer

? Copyright 1998-2003 UserLand Software. All Rights Reserved.

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and these paragraphs are included on all such copies and derivative works.

This document may not be modified in any way, such as by removing the copyright notice or references to UserLand or other organizations. Further, while these copyright restrictions apply to the written XML-RPC specification, no claim of ownership is made by UserLand to the protocol it describes. Any party may, for commercial or non-commercial purposes, implement this protocol without royalty or license fee to UserLand. The limited permissions granted herein are perpetual and will not be revoked by UserLand or its successors or assigns.

This document and the information contained herein is provided on an "AS IS" basis and USERLAND DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

 

 

 

添加评论

9:09  |  固定链接 | 引用通告 (0) | 记录它 | Open Source

 

 

固定链接  关闭

 

http://spaces.msn.com/lzhuacuo/blog/cns!18730E989D068035!506.entry

 

 

 

 

 

 

 

XML-RPC

 

XML-RPC

 

 

 

\

http://www.xmlrpc.com/

Java Technology and Web Services

http://java.sun.com/webservices/index.jsp

Web services are Web-based enterprise applications that use open, XML-based standards and transport protocols to exchange data with calling clients. Java 2 Platform, Enterprise Edition (J2EE) provides the APIs and tools you need to create and deploy interoperable Web services and clients.

Java Technology and Web Services is organized into these subcategories:

Java Web Services Developer Pack (Java WSDP)

Java API for XML-Based RPC (JAX-RPC)

Java API for XML Registries (JAXR)

Java API for XML Processing (JAXP)

Java Architecture for XML Binding (JAXB)

SOAP with Attachments API for Java (SAAJ)

XML and Web Services Security

Java API for XML-Based RPC >

http://java.sun.com/xml/downloads/jaxrpc.html#jaxrpcspec10

Java API for XML-Based RPC (JAX-RPC) Specification 2.0

 

 

 

添加评论

8:35  |  固定链接 | 引用通告 (0) | 记录它 | Open Source