Firefox扩展开发学习杂记

Made In Zeal 转载请保留原始链接：http://www.zeali.net/entry/567

最近玩了一把Firefox的扩展开发，感觉不错。倒腾出来一个ChinaStock，有兴趣的可以瞧瞧（现在还被放在Sandbox里面，必须登录才能下载安装；同时因为被放在sandbox里面，暂时还不能被自动更新版本）。如果您愿意的话，也可以直接在本站下载安装。

扩展开发中用得着的扩展（有点拗口）：

Extension Developer's Extension (xpi download / install address) 快速将扩展目录打包成xpi文件，在不重启Firefox的情况下重新载入所有扩展以及其他实用小功能。必备！如果不使用该扩展快速重载扩展的话，每次修改代码之后都必须从Firefox的菜单栏选择“退出”关闭Firefox再打开才有99%的几率保证该Chrome内容是最新修改后的，那叫一个痛苦。即使设置参数 nglayout.debug.disable_xul_cache = true ，也只是减少了修改窗口或对话框之后的重启而已。

Chrome List + Extension Manager Extended 学习其他人写的扩展总是最快入门的方法。 Chrome List 提供了扩展浏览功能，可以查看扩展安装之后存在的问题和jar包里面的源代码；Extension Manager Extended 则扩展了Firefox的扩展软件列表功能，直接显示每个扩展的ID，通过右键可以直接打开扩展存放的目录，再不需要去资源管理器找深埋在 Application Data/Mozilla/Firefox/Profiles/!@#$%^.default/extensions 里的jar包，也不需要去猜测使用UUID作为ID的扩展到底对应在哪个子目录了。

DebugLogger + Console² DebugLogger 是 dump() 的优化版本。可以按照每个项目分别查看各自的dump信息。像 Firebug 这样的大师级扩展属于开发必备不需多讲，这个 DebugLogger 相较而言属于轻量级并且原始的调试辅助工具。配合它，至少不需要再用alert来简单粗暴了。 Console² 则是错误控制台的加强版，实现了 Firefox 3 错误控制台的一些特性。

现有HTML代码的利用：

虽然并不被鼓励，但对于更熟悉HTML语法的开发者来说， 最快捷编写扩展界面的方法是在 XUL 中引入HTML命名空间（为根标签增加属性 xmlns:html="http://www.w3.org/1999/xhtml"），然后给所有使用到的HTML标签添加 html: 前缀（比如 <div>...</div> 应该写成 <html:div>...</html:div>）即可。当然，因为 XUL 是基于 XML 的语言，所以所有的标签属性都应该是小写格式，并且空tag必须进行关闭。

相应的，由于上述定义方式下HTML 元素标签定义不在主命名空间内，当进行 DOM 操作的 js 代码在创建HTML 元素的时候，也不能直接使用 createElement ，而必须使用 createElementNS 。比如 document.createElementNS("http://www.w3.org/1999/xhtml","html:div");

关于扩展ID：

每个扩展软件都必须有个唯一的标识ID，建议是使用UUID，也可以使用形如 [e-mail]（必须有@符号但不必是真实的域名） 的字符串。生成UUID的方法很多：windows下可以安装微软自己提供的GUID Generator，*nix 下直接敲命令 uuidgen ，或者访问这里在线生成一个。个人觉得虽然UUID不会造成ID冲突，但 @ 形式的可读性更强一些，否则不靠前面提到的扩展帮忙要把ID跟功能对应起来还真是件费力的事情。

扩展描述的本地化：

在 Firefox 扩展管理器中，每个扩展的名字下面都有一段简短的描述(description)，这段描述来自扩展根目录下的 install.rdf 文件。将这段描述进行本地化处理的方法是在扩展目录下创建子目录 defaults/preferences ，在子目录下新建一个 js 文件 myextname.js ，包含以下内容：

pref("extensions.ReplaceWithExtensionIDHere.description", "chrome://myextname/locale/myextname.properties");

同时在 locale 语言包文件 myextname.properties 中添加一行：

extensions.ReplaceWithExtensionIDHere.description = 经过本地化的描述内容

扩展的打包发布：

如果使用 Extension Developer's Extension提供的extension builder 进行打包，它会在build的过程中自动将chrome.manifest中的目录配置替换成jar:chrome的形式，而不需要自己来回切换不同的chrome.manifest配置。当然前提是你的扩展工作目录按照约定的结构进行组织。如果你没有把content / skin / locale 目录放在工作根目录而是放在了 chrome 子目录下的话，打包之后xpi文件会同时包含jar文件和chrome整个目录。生成xpi文件之后，到 Firefox Add-ons 的开发者工具界面进行注册/登录/上传即可。

参考文档：

• 在决定开始开发Firefox扩展之前，先看看如何 Setting up extension development environment绝对是磨刀不误砍柴工的

• 按照 Getting started with extension development的步骤，很快可以写出自己的第一个扩展。当然，这也只是程序员都知道的 Hello world 而已

• 也可以看看中文版本的 使用 XUL 实现浏览器扩展 1 , 2，如果对XUL本身还有疑惑，应该看看该文最后的参考链接

• 要进行完整的语言本地化处理，可以参考Firefox 扩展中文化实例教程