相关函数四个:
GM_setValue
GM_getValue
GM_listValues
GM_deleteValue
当然,还有存储内容变动时相关的函数
GM_addValueChangeListener
GM_removeValueChangeListener
GM_setValue
官网用法:
GM_setValue(name, value)
Set the value of 'name' to the storage.
翻译······
其实也没有必要翻译了,一看就懂。
假设代码 GM('myName', 'woonigh')
在Tampermonkey管理的存储中,把名字是myName
的存储,设置值为 'woonigh'。
GM_getValue
官方用法
GM_getValue(name, defaultValue)
Get the value of 'name' from the storage.
也简单,
GM_getValue('myName', 'woonigh')
就是把名字是 myName
的存储的值读取出来,
如果找不到myName
的值呢?
那就用默认的值 'woonigh'
GM_listValues
官网:
GM_listValues()
List all names of the storage.
这个没有参数,就是把所有存储的名字罗列出来。
返回结果是 Array
这个一般也比较少用到。
一般的小脚本,都只有几个存储数据,谁心里还没点数~
甚至不用Tampermonkey的存储功能也是很正常的事。
需要用到这个功能的,只有2中情况
- 你的应用很大,需要做存储数据管理
- 你的应用数据很乱
我猜测,更多的情况是第二种。这个时候,你就要思考下怎样优化自己的应用了。
这个函数给我的感觉是,聊胜于无
GM_deleteValue
官网:
GM_deleteValue(name)
Deletes 'name' from storage.
望文生义,
假设代码 GM_deleteValue('myName')
就是删除名字叫做 myName
的存储。
和上面 GM_listValues
一样,多用于数据管理。两者是一对。
需要用到的情况也和上面的一样。需要想想是否需要优化自己的应用了。
值变动相关的功能
GM_addValueChangeListener
官网:
GM_addValueChangeListener(name, function(name, old_value, new_value, remote)
Adds a change listener to the storage and returns the listener ID.
'name' is the name of the observed variable.
The 'remote' argument of the callback function shows whether this value was modified from the instance of another tab (true) or within this script instance (false).
Therefore this functionality can be used by scripts of different browser tabs to
communicate with each other.
翻译:
GM_addValueChangeListener(name, function(name, old_value, new_value, remote)
对指定名字的存储值进行变动监听,并且返回监听器的ID
回调函数的 remote
参数用于区分这个值的改变,是本标签页(false
)引起的,还是其他标签页(true
)引起的
因此,本功能可以被同一个浏览器的不同标签页之间的脚本使用,进行交流
对于这个功能,应用场景文档已经说的非常清楚了。
就是不同标签之间交流沟通的。数据和状态变动都可以。
GM_removeValueChangeListener
官网:
GM_removeValueChangeListener(listener_id)
Removes a change listener by its ID.
翻译
GM_removeValueChangeListener(listener_id)
根据监听器的 ID,把监听器移除
如果不熟悉的孩子,可能有些疑惑,这个 listener_id
是什么玩意?哪里来的?
这就要和前面 GM_addValueChangeListener
功能对应起来了,它的返回值就是一个监听的的ID。所以 这俩货是要配对使用的。
示例代码
乖o(*^@^*)o
,拿着叔叔的代码,一边玩去吧~~
// 存储中 增加一个存储量,名字叫 'myName', 值是'woonigh'
let my_name = GM_setValue('myName', 'Woonigh');
// 读取存储中的,名字叫 'hisName' 的值, 如果没有这个名字的存储的话,那返回来的值就叫 'Tony'
let his_name = GM_getValue('hisName', 'Tony');
// 把存储中所有的存储名字罗列出来
let all_value_names = GM_listValues();
console.log(all_value_names); // 输出 ["myName"]
// 给名字叫 'myName' 的存储添加一个监听器
let listener1 = GM_addValueChangeListener('myName', function (name, old_value, new_value, remote) {
console.log(`
发生变化的存储名是: ${name},
${name} 原来的值是 ${old_value},
${name} 新的值是 ${new_value},
这个值的变动是由${remote ? '本标签页' : '其他标签页'} 引起的。
`);
});
GM_setValue('myName', 'Maxwell');
// 把 id 是listener1 的监听器移除
GM_removeValueChangeListener(listener1);
// 把名字叫 'myNamae' 的存储删除掉
GM_deleteValue('myName');