用 JavaScript 创建 XPCOM 组件

作者： builder
2005-07-08 03:59 PM

随着 Firefox 市场占有率的持续攀升，跨平台组件对象模型（ Cross Platform Component Object Model ）也正在迅速地发展。我们这里将给出一个例子，说明如何使用这种对象模型。

 Mozilla 浏览器正在开启一个使用跨平台组件对象模型（ XPCOM ）的世界。 Mozilla 浏览器还引入了 XPConnect 技术，该技术允许组件在浏览器中执行，而且能够用 JavaScript 进行开发。

XPCOM 组件与微软的 COM 组件的工作类似，通过接口完成客户和组件之间的通信。 XPCOM 的基本接口是 nsISupports 。使用 nsISupports 的 QueryInterface 方法可以得到你指定的接口的信息（包括接口所支持的方法和属性）。

[被屏蔽广告]

JavaScript XPCOM 组件必须使用接口定义语言（ IDL ）才能实现 nsISupport 接口。 IDL 文件被创建并编译成 XPT 类型库。组件注册器根据 XPT 文件中的信息使用 Mozilla 注册组件。一旦组件成功注册，你就可以在自己的代码中使用 XPCOM 组件了。

在这个例子中，我将使用 JavaScript 创建一个示例暴露 reverselt() 方法的 XPCOM 组件。这个方法接受一个字符串类型的参数，并将字符串中字符的顺序进行反转。

XPCOM 组件有三层，这三层分别是 XPCOM 对象层， nsIFactory 层和 nsIModule 层。 XPCOM 对象层是系统的核心；业务逻辑就放在这一层。 nsIFactory 层负责实例化 XPCOM 对象。 nsIModule 层负责注册和提供 nsIFactory 层的抽象。这三层都是必须的，每一层都需要一些方法，从下面的代码可以看到：

const MYCOMPONENT_CONTRACTID = '@mozilla.org/MyComponent;1';
const MYCOMPONENT_CID = Components.ID('{F 443406C -961D-4ecc-BF39-
C0E 9943C 72AE}');
const MYCOMPONENT_IID = Components.interfaces.nsIMyComponent;

function nsMyComponent() { }
nsMyComponent.prototype = {
    reverseIt: function(s) {
        var a = s.split("");
        a = a.reverse();
        return a.join("");
    },
    QueryInterface: function(iid) {
        if (!iid.equals(Components.interfaces.nsISupports) &&
            !iid.equals(MYCOMPONENT_IID))
            throw Components.results.NS_ERROR_NO_INTERFACE;
        return this;
    }
};

var nsMyComponentModule = {
    registerSelf: function(compMgr, fileSpec, location, type) {
        compMgr = compMgr.QueryInterface(Components.interfaces.nsIComponentRegistrar);
        compMgr.registerFactoryLocation(MYCOMPONENT_CID,
                                        "MyComponent test",
                                        MYCOMPONENT_CONTRACTID,
                                        fileSpec,
                                        location,
                                        type);
    },
    getClassObject: function(compMgr, cid, iid) {
        if (!cid.equals(MYCOMPONENT_CID))
            throw Components.results.NS_ERROR_NO_INTERFACE;
        if (!iid.equals(Components.interfaces.nsIFactory))
            throw Components.results.NS_ERROR_NOT_IMPLEMENTED;
        return nsMyComponentFactory;    
    },
    canUnload: function(compMgr) { return true; }
};
var nsMyComponentFactory = {
    createInstance: function(outer, iid) {
        if (outer != null)
            throw Components.results.NS_ERROR_NO_AGGREGATION;
        if (!iid.equals(MYCOMPONENT_IID) &&
            !iid.equals(Components.interfaces.nsISupports))
            throw Components.results.NS_ERROR_INVALID_ARG;
        return new nsMyComponent();
    }
};

function NSGetModule(comMgr, fileSpec) { return nsMyComponentModule; }

XPCOM 组件是以一个人能读懂的名字注册的。 XPCOM 的 Contract ID 与微软 COM 组件中的 ProgID 类似。在我的例子中，这个值是 '@mozilla.org/MyComponent;1' 。

Contract ID 使用命名空间的概念来标识它们自己，所以在 Contract ID 前面加上 '@mozilla.org/' 前缀是很重要的。组件的 ID 是一个唯一标识组件的 128 位的 UUID 。组件对象的 ID() 方法接受一个 UUID 字符串作为参数，并返回一个 nsID 对象，该对象用于注册和实例化。（我使用 Windows 的 guidgen.exe 创建 UUID ）。然后组件有一个接口 ID （ Interface ID, IID ），这个 IID 是在 XPT 文件中所描述的接口的名字。在这个例子中， IID 为 nsIMyComponent 。

如果分析一下代码，你就会发现实际的客户业务逻辑是 nsMyComponent 类的 reverselt() 方法。其余的代码是用来使组件在 XPCOM 中工作的。如果你打算从我的例子代码中创建自己的组件，你除了需要原样拷贝所有的东西之外，还要在 nsMyComponent 类中添加自己的方法和属性。

为了使 XPCOM 系统认识 nsIMyComponent 接口并导出方法，你还必须提供一个 XPT 类型库。提供 XPT 类型库的方法是首先创建一个 IDL 文件，然后使用 xpidl.exe 编译它。下面是 MyComponent 的 IDL ：

#include "nsISupports.idl"

[scriptable, uuid(F 443406C -961D-4ecc-BF39-C0E 9943C 72AE)]
interface nsIMyComponent : nsISupports {
    string reverseIt(in string s);
};

为了在 nsImyComponent 接口上实现 nsISupport 接口 IDL 文件包含 nsISupport.idl 文件。声明 reverselt() 方法，指定它的返回类型和它接受的参数。

我没有找到 xpidl.exe 的一个普通下载，所以我是从 Mozilla.org 下载的零碎文件中创建的。我已经成功地在 Windows 2000 和 XP 上面运行了该程序。你可以在 http://www.geocities.com/phil_perkins_1/articles/XPIDL/xpidl.zip 处找到这个普通下载。如果把它解压到一个独立的目录，你就可以使用 -h 选项获取说明它的用法的有关信息。

为了使该例能够运行，你需要把源代码保存在你的系统中 Mozilla 目录下的“ components ”目录下的“ nsMyComponent.js ”中。然后再在你解压 xpidl.zip 的目录下将 IDL 保存为“ MyComponent.idl ”。从命令行定位到那个目录，然后输入：

xpidl -m typelib -w -v -e [path to IDL file]/MyComponent.xpt [path to IDL file]/MyComponent.idl

This should create a file called "MyComponent.xpt". Copy this file to the "components" directory under Mozilla.

这样就会创建一个叫做“ MyComponent.xpt ”的文件。将这个文件拷贝到 Mozillia 下的“ components ”目录下。

从命令行定位到 Mozilla 目录，然后找到“ regxpcom.exe ”。键入“ regxpcom ”，然后敲回车键。这样就会向 Mozilla 注册你的所有组件。然后你可以打开“ compreg.dat ”文件查看你的组件是否已经成功注册。不要编辑这个文件——这是一个自动生成的文件。如果你的 Mozilla 窗口是打开的，你应该在试图使用新组件之前关闭所有的 Mozilla 窗口。要测试这个组件，将下面的 HTML 保存到一个文件中，然后在 Mozilla 中打开它：

查看 JavaScript 控制台，看是否有什么错误。你可以在 这里 得到本例的源代码。