BlogEngine.Net架构与源代码分析系列part6:开放API

MetaWeblog与BlogImporter

一款优秀的Blog系统少不了一些公开的API。BlogEngine.Net实现了标准的MetaWeblog API接口来允许用户通过客户端软件来发布自己的Blog,此外它还实现了将其它Blog系统中的文章(标准格式的BlogML或Rss)导入到BlogEngine.Net中来的BlogImporter接口,在这篇文章里我将对这些开放部分进行详细的介绍,对于涉及到的一些相关知识点也给出链接或做简单的描述。

MetaWeblog API使用标准的Http协议封装的XMLRPC实现(类似于WebService中的Soap协议)

1.首先让我们了解一下什么是MetaWeblog API

MetaWeblog API (MWA)是一套编程接口,允许外面的程序能取得和设置Blog文章的文本或属性。它是建立在XMLRPC接口之上,并且已经有了很多的实现。

2.MetaWeblog API有三个基本的函数规范:

metaWeblog.newPost (blogid, username, password, struct, publish) 返回一个字符串,可能是Blog的ID。

metaWeblog.editPost (postid, username, password, struct, publish) 返回一个Boolean值,代表是否修改成功。

metaWeblog.getPost (postid, username, password) 返回一个Struct。

其中blogid、username、password分别代表Blog的id(注释:如果你有两个Blog,blogid指定你需要编辑的blog)、用户名和密码。由于篇幅有限,关于MetaWeblog API的更多信息请参考文末的链接部分。

3.BlogEngine.Net中的MetaWeblog API的实现分析

BlogEngine.Net的XMLRPC调用主要是由BlogEngine.Core.API.MetaWeblog命名空间下的几个类型来完成的。

首先客户端软件通过Http协议向MetaWeblogHandler提交了一个标准的XML请求,MetaWeblogHandler是一个HttpHandler,之后MetaWeblogHandler执行ProcessRequest来处理这个请求,最后将处理结果再封装为XML返回给客户端软件。

下面让我对这部分涉及到的几个类型做一个简单的介绍:

MetaWeblogHandler:不用说了,处理的主逻辑部分,ProcessRequest是处理的入口点,将一些具体处理的部分委托给一些私有成员,例如:

internal string NewPost(string blogID, string userName, string password,
MWAPost sentPost, bool publish)

XMLRPCRequest:是对一个HttpRequest信息提取以后的封装,里面是一些解析XML提取信息的相关属性与方法,例如远程调用方法名,参数,文章信息等。

XMLRPCResponse:与XMLRPCRequest是对应的,它的Response方法会将执行结果生成XML并传递给HttpResponse之后返回给客户端。

还有一些类似于MWABlogInfo,例如MWAMediaObject,MWAPost等的结构是对于业务对象类型数据提取信息的封装,主要是为了交换信息而定义的。

从BlogEngine.Net的实现上看,它支持很多标准的协议,这些协议很多都是基于XML进行通信的,而BlogEngine.Net一般都是通过HttpHandler来处理这些标准的。

时间: 2024-08-03 20:05:45

BlogEngine.Net架构与源代码分析系列part6:开放API的相关文章

BlogEngine.Net架构与源代码分析系列part1:开篇介绍

最近我要开始这个系列了,这是我的第一个系列.关于BlogEngine.Net我想说的是,它设计的真的很棒,代码简洁但是功能很多,真是麻雀虽小,五脏俱全啊,而且具有了很多Web2.0的特征,甚至它的每一行代码都值得我们去研究一下,它的开发团队很棒.实际上很多国外的个人Blog都是采用BlogEngine.Net加上自定义皮肤实现的,如果您是一个Blog的开发者,这更是您的必备参考! 很多兄弟都推荐BlogEngine.Net看一看,甚至www.asp.net也把它放在了很重要的位置.前一阶段我仔细

BlogEngine.Net架构与源代码分析系列part8:扩展

DataStore分析 本系列的第四篇文章我给大家做了关于BlogEngine.Net全局配置的分析.在这篇文章里我将会对BlogEngine.Net中比较经典的部分DataStore做一个简单的分析,这个DataStore主要完成了BlogEngine.Net三大扩展特性(Extension,Widget,Theme)的数据存储部分,它提供了一个扩展特性统一的存储模型.DataStore是建立在Provider存储(本系列第三篇文章中介绍过)的上层,本文研究的内容会和后面讲到的扩展部分的文章有

BlogEngine.Net架构与源代码分析系列part2:业务对象

共同的父类BusinessBase 上篇文章朋友的评论给了我很大的动力写这个系列的文章,看来大家都比较关注这个系列.为了后续文章做一个铺垫,我在这篇文章的前半部分讲解一下BlogEngine.Net的整体架构,后半部分主要是对于BusinessBase类的分析. 下载源代码以后打开解决方案,我们发现从项目的组织结构上BlogEngine.Net分成两个项目:一个是BlogEngine.Core,顾名思意,它就是BlogEngine.Net的核心逻辑层.所有的业务逻辑和一些功能都在这个项目中体现,

BlogEngine.Net架构与源代码分析系列part15:总结篇

本文是这个系列的总结篇,在这篇文章里,仅从我个人的角度发表一下对BlogEngine.Net的一些看法.内容包括BlogEngine.Net的优缺点,性能问题,如何阅读源代码等. 重申一下写这个系列的目的 1.使自己更加深入的理解BlogEngine.Net的架构,对BlogEngine.Net的代码能够更深刻的掌握. 2.给那些想学习BlogEngine.Net的源代码,但是不知道从何开始或者比较迷茫的朋友们一个学习指南. 3.在博客园上永远的保存下来,方便你我查看.因为这方面的资料实在太少了

BlogEngine.Net架构与源代码分析系列part11:开发扩展(下)

自定义Theme 个性化的主题是一个完善的Blog系统中所必备的,同时也是一个亮点.在这篇文章里我将给大家展示一下BlogEngine.Net的第三个开发特性,那就是自定义的Theme.本文的重点放在BlogEngine.Net的开发规范和实现原理上.如果您对BlogEngine.Net的架构很了解的话,那么开发一个自己的Theme是一件很简单的事情,如果您不是很了解,那么你也可以按照本文讲述的规范开发出一个自定义的Theme来. BlogEngine.Net中的Theme 在BlogEngin

BlogEngine.Net架构与源代码分析系列part4:Blog全局设置

BlogSettings 这已经是本系列的第四篇了,以前我多数时间是看文章,自己写起来才感觉到当博主不容易啊,所以我们无论评论也好,阅读也好,都要尊重博主的劳动成果.闲话少说,在这篇文章中我们将对BlogEngine.Net的全局配置进行一下分析与探讨.关于配置这一部分单独拿出来做一篇文章实在有些牵强,但是我总觉得这个配置部分比较独立,而且BlogEngine.Net的设计和实现都有很多可以参考的地方. 在一个企业级应用系统中,对一些系统全局参数进行配置是必不可少的,那么我们是怎么处理这些配置的

BlogEngine.Net架构与源代码分析系列part13:实现分析(上)

HttpHandlers与HttpModules 这已经是系列的第13篇了,实际上到现在为止您应该对BlogEngine.Net的整体设计有了一定的把握,对部分实现细节有了比较深刻的认识,在阅读BlogEngine.Net时希望坚持到最后,并把握住宏观,深入到微观.本文将详细介绍BlogEngine.Net中的HttpHandlers与HttpModules,主要说明它们要实现的功能以及如何使用,并对几个必要的HttpHandler或HttpModule进行比较细致的分析. HttpHandle

BlogEngine.Net架构与源代码分析系列part9:开发扩展(上)

Extension与管理上的实现 从这篇文章开始的连续三篇文章我将向大家展示BlogEngine.Net中的三大开发扩展特性,它们分别是Extension,Widget和Theme.程序员可以在符合一定标准条件下开发自己的扩展,然后将扩展像插件一样(Plug'n play)与BlogEngine.Net进行集成,来达到个性化的应用.本文将详细介绍第一种扩展Extension的开发标准,管理部分介绍等. 声明一下 上一篇文章的回复中有人提到希望我写一下自己的看法和BlogEngine.Net的优缺

BlogEngine.Net架构与源代码分析系列part7:Web2.0特性

Pingback&Trackback 今天这篇文章主要向大家讲述一下Blog系统中应用最多的,具有Web2.0特性的,也是一种标准化的--Pingback&Trackback.分析一下BlogEngine.Net提供的比较全面的Pingback&Trackback支持.本文内容相对来说比较独立,如果您对整个系列感兴趣请参照这里. Pingback&Trackback参考 简单地说,Pingback&Trackback是博客在链接.引用其他博客内容时通知对方博客的一种