如何编写Greasemonkey用户脚本

1. 每个用户脚本后缀名必须是.user.js，例如：helloworld.user.js，其内容：

// ==UserScript==
// @name          Hello World
// @namespace     http://diveintogreasemonkey.org/download/
// @description   example script to alert "Hello world!" on every page
// @include       *
// @exclude       http://diveintogreasemonkey.org/*
// @exclude       http://www.diveintogreasemonkey.org/*
// ==/UserScript==

alert('Hello world!');

 

2. 分析一下用户脚本元数据

       用//==UserScript==与//==/UserScript==用于标识脚本的起始，其中包含6行元数据描述。这段注释可以放在脚本的任何位置，但是一般来说是放在脚本的顶部。

//@name Hello World

      这是定义你脚本的名子，它将显示在安装对话框中，以及在“Manage User Scripts”对话框。这个名子应该简短并且能够表达脚本的含义。这个元数据可以被省略，如果省略，默认是脚本文件名减去.user.js扩展名。

 

//@namespace http://diveintogreasemonkey.org/download/

       这个元数据一般是URL，用于区分具有相同名子的脚本，如果你有一个域名，你可以使用域名，否则你可以用tag:URI。这个元数据也可以被省略，如果省略，默认使用下载脚本的域名。

 

//@description  example script to alert "Hello world!" on every page

       这个元数据用于定义可读的描述信息，最好不要超过两句。这个信息将会显示在安装对话框和“Manage User Scripts”对话框。当然，这个元数据可以被省略，默认值是空字符串。

 

// @include       *
// @exclude       http://diveintogreasemonkey.org/*
// @exclude       http://www.diveintogreasemonkey.org/*

    @include与@exclude用于定义脚本可以用于哪些站点，*是通配符。上面的例子就是说，脚本可以用在所有站点，除了http://diveintogreasemonkey.org/*与http://www.diveintogreasemonkey.org/*。这两个元数据都可以被省略，如果这两个元数据没有被定义，那么脚本将被用于所有站点。

 

3. 编写用户脚本

alert('Hello world!');

        当然，以上就是脚本的真正逻辑。其实为了避免你的脚本程序与要注入的页面中原有的脚本冲突，Greasemonkey在幕后帮你做了很多事情，他把你的代码包装成匿名函数，虽然你可以忽略这些，但是这里却有个潜在的问题，你所定义的变量或函数不可以被其它的脚本调用。举例来说：

function helloworld() {
    alert('Hello world!');
}

window.setTimeout("helloworld()", 60);

      以上的脚本一定会报错（"helloworld is not defined" )，这是因为当一个用户脚本执行完一次后，变量或函数便失效，这就意味着当你期待使用window.setTimeout函数调用你自己的函数时，便会报错。解决的办法是你可以将你的函数定义成window对象的属性，例如：

 

window.helloworld = function() {
    alert('Hello world!');
}

window.setTimeout("helloworld()", 60);

 

       然后，这并不是一个最好的解决方案，因为很有可能你要注入脚本的页面中也定义了相同名称的window对象属性，这样就会引起冲突，最好的方案是你定义一个匿名函数，并将其作为参数传递给window.setTimeout。例如：

window.setTimeout(function() { alert('Hello world!') }, 60);