jjzjj

javascript - Firefox 扩展如何最好地避免污染全局命名空间？

coder 2024-12-23 原文

在为 Firefox 开发扩展时，我一直在研究全局命名空间污染，我想在我的扩展中尽可能避免它。有几种解决方案，但一般来说，这些解决方案似乎只为您的扩展声明一个全局变量，并将所有内容放入其中。因此，您只需向全局命名空间添加一个额外的变量，这还算不错。

顺便说一句，有人向我提出了一个解决方案，可以避免将任何 额外变量放入全局命名空间；将所有内容包装在一个函数中。这里的问题是在您的 XUL 覆盖层中没有任何东西可以引用。您必须在叠加层中声明元素，然后在 JS 中添加大量的 addEventListener 来替换像 oncommand="..." 这样的东西在 XUL 中。我不想这样做；我绝对希望我的 XUL 在 XUL 本身中包含事件，因为我认为它看起来更干净，所以这不是适合我的解决方案。因此，我至少需要 1 个全局变量来引用 XUL oncommand="..." 属性。

所以共识似乎是为您的扩展设置一个(且只有一个)变量，并将所有代码放入其中。这就是问题所在:通常，人们建议将该变量命名为一个漂亮的长且唯一的名称，以便与其他变量发生冲突的可能性几乎为零。因此，如果我的扩展 ID 是 myextension@mycompany.com，我可以将我的变量命名为 myextensionAtMycompanyDotCom 或 com.mycompany.myextension。这有助于避免全局命名空间中的冲突，但有一个问题；该变量名又长又笨重。我的 XUL 将在 oncommand="myextensionAtMycompanyDotCom.doSomeEvent" 的行中充斥着对事件处理程序的引用。无法避免在我的 XUL 覆盖中引用全局命名空间，因为覆盖只是添加到浏览器窗口的 DOM 中；它没有自己的命名空间，所以我们不能以某种方式将扩展的变量范围限制在我们自己的覆盖范围内。因此，在我看来，有四种解决方案:

1。只需在 XUL 中使用长变量名

这会导致相当笨拙、冗长的 XUL 代码，例如:

<statusbarpanel id="myStatusBar" onmousedown="myextensionAtMycompanyDotCom.onMyStatusBarClick();">

2。在短变量名中加入随机性元素

我们为我们的扩展想出了一个更好的短变量名，比方说 myExt，并添加一些随机字符以使其几乎肯定是唯一的，例如 myExtAX8T9。然后在 XUL 中，我们有:

<statusbarpanel id="myStatusBar" onmousedown="myExtAX8T9.onMyStatusBarClick();">

显然，这会导致代码变得相当丑陋甚至令人困惑，因为随机字符看起来很奇怪，并使其看起来像某种临时变量。

3。根本不要声明任何全局变量

您可以将所有内容都封装在函数中。当然，这意味着您的 XUL 中没有任何可引用的内容，因此每个事件都必须在您的 JavaScript 代码中使用 addEventListener 附加到 XUL 元素。我不喜欢这个解决方案，因为如上所述，我认为在 XUL 代码中引用事件比搜索大量 JS 代码来查找哪些事件附加到哪些 XUL 元素更清晰。

4。只需在 XUL 中使用一个简短的变量名

我可以调用我的扩展的变量 myExt，然后我得到很好的 XUL 代码，如:

<statusbarpanel id="myStatusBar" onmousedown="myExt.onMyStatusBarClick();">

当然，这个短名称更有可能与全局命名空间中的其他名称发生冲突，因此并不理想。

那么，我是不是漏掉了什么？除了我上面提出的 4 种解决方案之外，还有其他选择吗？如果不是，那 4 个中最好的是什么(考虑到 #3 对我来说基本上是不能接受的)，为什么？

最佳答案

我们使用这篇博文中描述的 JavaScript 模块模式:http://www.adequatelygood.com/2010/3/JavaScript-Module-Pattern-In-Depth .您可以按照说明导出要在 XUL 处理程序中使用的符号。

此外，我们使用一个反向的主机名作为模块名前缀，以确保我们控制命名空间:

/* Set up the global namespace. */
if (typeof(com) == "undefined") var com = {};
if (!com.salsitasoft) com.salsitasoft = {};

/* Main namespace. */
com.salsitasoft.myExtensionGlobalStuffGoesHere = (function (my) {
  return my;
})(com.salsitasoft.myExtensionGlobalStuffGoesHere || {});

更新:我将其更改为将 com.salsitasoft.myExtensionGlobalStuffGoesHere 传递给闭包(如果它已经存在)，以便命名空间可以分布在多个文件中。

关于javascript - Firefox 扩展如何最好地避免污染全局命名空间？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/6676906/

javascript命名codeXULfirefoxnamespacesfirefox-addonjsm

有关javascript - Firefox 扩展如何最好地避免污染全局命名空间？的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri，根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法？ - 2

    总的来说，我对ruby​​还比较陌生，我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础，我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  3. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声？ - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点？我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等)，但我确实想创建一个输出文件。

  4. ruby-on-rails - 如何验证 update_all 是否实际在 Rails 中更新 - 2

    给定这段代码defcreate@upgrades=User.update_all(["role=?","upgraded"],:id=>params[:upgrade])redirect_toadmin_upgrades_path,:notice=>"Successfullyupgradeduser."end我如何在该操作中实际验证它们是否已保存或未重定向到适当的页面和消息？ 最佳答案 在Rails3中，update_all不返回任何有意义的信息，除了已更新的记录数(这可能取决于您的DBMS是否返回该信息)。http://ar.ru

  5. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗？当我运行compasswatch时，它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行？文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们？我自己编译的.sass文件编译成compiled/t

  6. ruby - 如何将脚本文件的末尾读取为数据文件(Perl 或任何其他语言) - 2

    我正在寻找执行以下操作的正确语法(在Perl、Shell或Ruby中):#variabletoaccessthedatalinesappendedasafileEND_OF_SCRIPT_MARKERrawdatastartshereanditcontinues. 最佳答案 Perl用__DATA__做这个:#!/usr/bin/perlusestrict;usewarnings;while(){print;}__DATA__Texttoprintgoeshere 关于ruby-如何将脚

  7. ruby - 如何指定 Rack 处理程序 - 2

    Rackup通过Rack的默认处理程序成功运行任何Rack应用程序。例如:classRackAppdefcall(environment)['200',{'Content-Type'=>'text/html'},["Helloworld"]]endendrunRackApp.new但是当最后一行更改为使用Rack的内置CGI处理程序时，rackup给出“NoMethodErrorat/undefinedmethod`call'fornil:NilClass”:Rack::Handler::CGI.runRackApp.newRack的其他内置处理程序也提出了同样的反对意见。例如Rack

  8. ruby - 如何每月在 Heroku 运行一次 Scheduler 插件？ - 2

    在选择我想要运行操作的频率时，唯一的选项是“每天”、“每小时”和“每10分钟”。谢谢!我想为我的Rails3.1应用程序运行调度程序。 最佳答案 这不是一个优雅的解决方案，但您可以安排它每天运行，并在实际开始工作之前检查日期是否为当月的第一天。 关于ruby-如何每月在Heroku运行一次Scheduler插件？，我们在StackOverflow上找到一个类似的问题： https://stackoverflow.com/questions/8692687/

  9. ruby-on-rails - 如何从 format.xml 中删除 <hash></hash> - 2

    我有一个对象has_many应呈现为xml的子对象。这不是问题。我的问题是我创建了一个Hash包含此数据，就像解析器需要它一样。但是rails自动将整个文件包含在.........我需要摆脱type="array"和我该如何处理？我没有在文档中找到任何内容。 最佳答案 我遇到了同样的问题；这是我的XML:我在用这个:entries.to_xml将散列数据转换为XML，但这会将条目的数据包装到中所以我修改了:entries.to_xml(root:"Contacts")但这仍然将转换后的XML包装在“联系人”中，将我的XML代码修改为

  10. ruby - 如何使用文字标量样式在 YAML 中转储字符串？ - 2

    我有一大串格式化数据(例如JSON)，我想使用Psychinruby​​同时保留格式转储到YAML。基本上，我希望JSON使用literalstyle出现在YAML中:---json:|{"page":1,"results":["item","another"],"total_pages":0}但是，当我使用YAML.dump时，它不使用文字样式。我得到这样的东西:---json:!"{\n\"page\":1,\n\"results\":[\n\"item\",\"another\"\n],\n\"total_pages\":0\n}\n"我如何告诉Psych以想要的样式转储标量？解

随机推荐