Tampermonkey油猴脚本开发视频教程-3.脚本配置和权限申请UserScript

视频和代码https://www.toolchest.cn/static/mv3.html

脚本头部2个“// ==UserScript==”之间编写脚本相关的配置信息和权限申请等，一般以@开始，称元数据。

3.1元数据参考表

以下是对油猴脚本中常见元数据（21个）的详细说明：

@name

@name 声明了脚本的名称。它可以被其他用户轻松地看到和识别脚本。该项是必填项。

例如：

复制代码// ==UserScript==
// @name         Example Script
// ==/UserScript==

@namespace

@namespace 表示脚本所属的命名空间。当多个脚本使用同一个名称时，可以使用该项防止冲突。该项不是必需的，但强烈建议设置。

例如：

复制代码// ==UserScript==
// @name         Example Script
// @namespace    http://example.com/
// ==/UserScript==

@copyright

@copyright 表示脚本版权信息。如果您希望保留脚本的版权，则应该添加此项。

例如：

复制代码// ==UserScript==
// @name         Example Script
// @copyright    2022, John Doe
// ==/UserScript==

@version

@version 表示脚本的版本号。每次更新时都应该增加版本号以区分不同版本。

例如：

复制代码// ==UserScript==
// @name         Example Script
// @version      1
// ==/UserScript==

@description

@description 是一段简短的描述，用于概述脚本的功能、用途及特点。

例如：

复制代码// ==UserScript==
// @name         Example Script
// @description  This script adds a new button to the page that allows you to easily save content to your account.
// ==/UserScript==

@icon, @iconURL, @defaulticon

@icon 可以设置一个小图标，用于在油猴脚本管理器中显示。它可以是一个 Base64 编码的图片，也可以是一个图片的 URL。

例如：

复制代码// ==UserScript==
// @name         Example Script
// @icon         data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAKklEQVR4Xu3BAQ0AAADCoPdPbQ43oAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA

@iconURL 与 @icon 相同，但需要指定图片的 URL。

例如：

复制代码// ==UserScript==
// @name         Example Script
// @iconURL      https://example.com/icon.png
// ==/UserScript==

@defaulticon 可以设置一个默认的图标，当无法加载指定的图标时会使用该图标。它可以是一个 Base64 编码的图片，也可以是一个图片的 URL。

例如：

复制代码// ==UserScript==
// @name         Example Script
// @defaulticon  data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAKklEQVR4Xu3BAQ0AAADCoPdPbQ43oAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABOxWv8AAEYASURBVHgBpVNTTtRXGMc/7zLZ4jNBGwsxIud5EpQLwYGJyUQ2iJ/gn1UqVG6q3q6qvzF6nLoyZl53bNVdV+ftzznfnHvuODyIkSOhe2AVQQAMMAAEkgACCCCAAAIIIIAAAkgAACCDAkB5w5rpu+jf0yZZ5XOOe9B6DqF6NXr06ZMmTZMmDFjkzRp0yZMZnuvmxeGRkZQf39/QIDAwNebNmzdv36devXr15cvny5YsWLVapUuXLnz55ZVXVtWlSxfv379LYsWLfrnn38aMGCBWLVqFfDhw3brl27dq1atX8+eefLly4s2bNnS7NmzZaWlpdGvXLmSli5dSlJycHdu3aVOnTowOzt7f0tLSNGjRIkJiYGBsbmw+fPnsyMzNXX31lZWVhbm6uXFxcYPHixTt375d77733p0+fRp0+fRpUuXdjq+ffu2HH35YeHh4cLFy+OlpaUpMTBQMBetm/fv2rWrFl27drV69eqbNm3a9evXq19+7dKlS3bu3LkhdFFR0fnz56Njo67bbbttZWVla8+bN09PTx4sQTVqlUOhw4d2bNnVpk2bZnTt3TsWPHMmjTZt26dVtGnTpt29erV+/fsuWLFC
// ==/UserScript==

@icon64, @icon64URL

@icon64 和 @icon 类似，但是图标应该是 64x64 像素大小。它可以是一个 Base64 编码的图片，也可以是一个图片的 URL。

例如：

复制代码// ==UserScript==
// @name         Example Script
// @icon64      data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAACXBIWXMAAAsSAAALEgHS3X78AAAAeUlEQVR4nO3BAQ0AAAD

@icon64URL 与 @icon64 相同，但需要指定图片的 URL。

例如：

复制代码// ==UserScript==
// @name         Example Script
// @icon64URL      https://example.com/icon64.png
// ==/UserScript==

@grant

@grant 声明油猴脚本需要的特权，例如访问 GM_* API （共26个）。如果脚本需要使用任何特权，则必须在此处进行声明。

例如：

复制代码// ==UserScript==
// @name         Example Script
// @grant        GM_setValue
// @grant        GM_getValue
// ==/UserScript==

在此示例中，我们声明了两个特权，分别是 GM_setValue 和 GM_getValue。这些特权允许脚本读取和写入浏览器存储。

@author

@author 表示脚本作者的名称。

例如：

复制代码// ==UserScript==
// @name         Example Script
// @author       John Doe
// ==/UserScript==

@homepage, @homepageURL, @website, @source

@homepage, @homepageURL, @website 和 @source 都是用于指向脚本相关网站的元数据。它们都是可选项。

例如：

复制代码// ==UserScript==
// @name         Example Script
// @homepage     http://example.com/
// @homepageURL  http://example.com/
// @website      http://example.com/
// @source       http://github.com/example/example-script
// ==/UserScript==

@antifeature

@antifeature 此标记允许脚本开发人员披露他们是否通过脚本获利。例如，GreasyFork需要它。

语法：<标记> <类型> <描述>

例如：

// @antifeature       ads         展示广告
// @antifeature       tracking    包含一些数据分析相关功能
// @antifeature       miner       使用计算机资源挖矿

@require

@require 允许在运行脚本之前加载其他脚本，以便扩展功能。

例如：

复制代码// ==UserScript==
// @name         Example Script
// @require      https://example.com/script1.js
// @require      https://example.com/script2.js
// ==/UserScript==

@resource

@resource 允许将资源包含在油猴脚本中，以便在脚本中使用，需要和GM_getResourceURL,GM_getResourceText配合使用。

例如：

复制代码// ==UserScript==
// @name         Example Script
// @resource icon1       http://www.tampermonkey.net/favicon.ico
// @resource html        http://www.tampermonkey.net/index.html
// @resource xml         http://www.tampermonkey.net/crx/tampermonkey.xml
// ==/UserScript==

@include, @match, @exclude

@include, @match 和 @exclude 声明了脚本应该运行的网址范围。

例如：

复制代码// ==UserScript==
// @name         Example Script
// @match        *
// @exclude      https://www.example.com/login
// ==/UserScript==

在此示例中，我们使用 @include 和 @exclude 声明了脚本应该运行的 URL 范围。

@run-at

@run-at 声明了脚本应该何时运行。

// @run-at document-start

脚本将尽快注入。

// @run-at document-body

如果 body 元素存在，则将注入脚本。

// @run-at document-end

脚本将在调度 DOMContentLoaded 事件时或之后注入。

// @run-at document-idle

脚本将在调度 DOMContentLoaded 事件后注入。如果未给出标记，则这是默认值。@run-at

// @run-at context-menu

如果在浏览器上下文菜单中单击该脚本（仅限基于 Chrome 的桌面浏览器），则会注入该脚本。

例如：

复制代码// ==UserScript==
// @name         Example Script
// @run-at       document-end
// ==/UserScript==

在此示例中，我们使用 @run-at 声明了脚本应在文档结束时运行。

@sandbox

@sandbox 表示脚本应该运行在一个沙箱中，以限制脚本的访问权限。

例如：

复制代码// ==UserScript==
// @name         Example Script
// @sandbox      true
// ==/UserScript==

在此示例中，我们使用 @sandbox 声明了脚本应该运行在沙箱中，以限制其访问范围。

@noframes

@noframes 此标记使脚本在主页上运行，但不在 iframe 上运行。

例如：

复制代码// ==UserScript==
// @name         Example Script
// @noframes
// ==/UserScript==

在此示例中，我们使用 @noframes 声明了脚本不应在框架中运行。

@updateURL

用户脚本的更新 URL。注意：需要标记才能使更新检查正常工作。@version

@downloadURL

定义检测到更新时将从中下载脚本的 URL。如果使用值 none，则不会执行更新检查。

@supportURL

定义用户可以在其中报告问题并获得个人支持的 URL。

@unwrap

将没有任何包装器和沙箱的用户脚本注入页面，这可能对脚本很有用。

3.2案例中的元数据说明

// ==UserScript==
// @name         去除知乎侧边栏
// @namespace    https://www.zhihu.com/
// @version      1.0
// @description  去除知乎页面右侧的侧边栏，让页面更简洁。
// @author       Your Name
// @match        https://www.zhihu.com/*
// @grant        none
// ==/UserScript==

在这个具体的油猴脚本中：

@name 指定了脚本名称为 “去除知乎侧边栏”。
@namespace 指定了命名空间为 “知乎 - 有问题，就会有答案”。
@version 指定了脚本版本号为 “1.0”。
@description 指定了脚本描述为 “去除知乎页面右侧的侧边栏，让页面更简洁。”。
@author 指定了脚本作者为 “Your Name”。
@match 指定了脚本匹配的网址为 “知乎 - 有问题，就会有答案*”，即所有的知乎网页。
@grant 指定了不需要使用额外权限。

视频和代码https://www.toolchest.cn/static/mv3.html