Chrome 扩展开发 API实战:Extension(五)

Chrome.bookmarks API 技术文档

1. 引言

在开发 Chrome 扩展程序时,书签的管理是一项常见需求。chrome.bookmarks API 提供了一套强大的接口,允许开发者创建、查询、更新、移动和删除书签。本文将详细介绍如何使用该 API 来操作浏览器中的书签。


2. 权限声明

在 manifest.json 文件中声明 bookmarks 权限。例如:

复制代码
{
  "name": "My Extension",
  "permissions": [
    "bookmarks"
  ]
}

声明了该权限后,扩展程序可以正常访问浏览器中的书签功能。


3. chrome.bookmarks.get

3.1 方法功能

根据指定的 ID 或 ID 列表检索书签节点。

3.2 使用方法

复制代码
chrome.bookmarks.get("1", function(bookmarkArray) {
  console.log("Bookmark nodes:", bookmarkArray);
});

3.3 参数详解

  • idOrIdList (必填):字符串或字符串数组,指定要检索的书签节点 ID。
  • callback (必填):函数,接收返回的书签节点数组。

3.4 实际样例

通过 ID 检索单个书签:

复制代码
chrome.bookmarks.get("1", function(bookmarkArray) {
  console.log("Bookmark nodes:", bookmarkArray);
});

3.5 注意事项

  • 如果指定的 ID 无效,回调函数将接收到一个空数组。
  • ID 可以是多个,支持同时检索多个书签节点。

4. chrome.bookmarks.getChildren

4.1 方法功能

检索指定书签文件夹下的所有直接子节点。

4.2 使用方法

复制代码
chrome.bookmarks.getChildren("1", function(children) {
  console.log("Child nodes:", children);
});

4.3 参数详解

  • id (必填):字符串,指定书签文件夹的 ID。
  • callback (必填):函数,接收返回的书签子节点数组。

4.4 实际样例

获取文件夹内的子节点:

复制代码
chrome.bookmarks.getChildren("1", function(children) {
  console.log("Child nodes:", children);
});

4.5 注意事项

  • 此方法只返回直接子节点,不包括子节点的子节点。
  • 如果 ID 对应的节点不是文件夹,则返回空数组。

5. chrome.bookmarks.getRecent

5.1 方法功能

获取最近添加的书签。

5.2 使用方法

复制代码
chrome.bookmarks.getRecent(5, function(recentBookmarks) {
  console.log("Recent bookmarks:", recentBookmarks);
});

5.3 参数详解

  • numberOfItems (必填):整数,指定要检索的书签数量。
  • callback (必填):函数,接收返回的书签节点数组。

5.4 实际样例

获取最近添加的 5 个书签:

复制代码
chrome.bookmarks.getRecent(5, function(recentBookmarks) {
  console.log("Recent bookmarks:", recentBookmarks);
});

5.5 注意事项

  • 结果顺序按添加时间倒序排列。
  • 此方法返回的结果仅与添加时间相关,与访问时间无关。

6. chrome.bookmarks.getSubTree

6.1 方法功能

检索指定书签节点及其子节点。

6.2 使用方法

复制代码
chrome.bookmarks.getSubTree("1", function(subTree) {
  console.log("Subtree:", subTree);
});

6.3 参数详解

  • id (必填):字符串,指定书签节点的 ID。
  • callback (必填):函数,接收返回的书签子树。

6.4 实际样例

获取一个节点及其所有子节点:

复制代码
chrome.bookmarks.getSubTree("1", function(subTree) {
  console.log("Subtree:", subTree);
});

6.5 注意事项

  • 返回结果包括指定节点本身及其所有子节点。
  • 子节点的层级结构在返回的数组中按层次完整保留。

7. chrome.bookmarks.getTree

7.1 方法功能

检索整个书签树。

7.2 使用方法

复制代码
chrome.bookmarks.getTree(function(tree) {
  console.log("Bookmark tree:", tree);
});

7.3 参数详解

  • callback (必填):函数,接收返回的书签树。

7.4 实际样例

获取完整书签结构:

复制代码
chrome.bookmarks.getTree(function(tree) {
  console.log("Bookmark tree:", tree);
});

7.5 注意事项

  • 此方法返回根节点及其所有子节点。
  • 书签树结构对于分析复杂的书签组织非常有用。

8. 示例:书签管理工具

以下代码展示了如何创建一个简单的书签管理工具:

复制代码
// Display all bookmarks
chrome.bookmarks.getTree(function(tree) {
  console.log("Bookmark tree:", tree);
});

// Create a new bookmark
chrome.bookmarks.create({
  title: "New Bookmark",
  url: "https://example.com"
}, function(newBookmark) {
  console.log("Created bookmark:", newBookmark);
});

// Update an existing bookmark
chrome.bookmarks.update("1", { title: "Updated Bookmark", url: "https://updated.com" }, function(updatedBookmark) {
  console.log("Updated bookmark:", updatedBookmark);
});

// Delete a bookmark
chrome.bookmarks.remove("1", function() {
  console.log("Bookmark removed.");
});

9. 总结

本文详细介绍了 chrome.bookmarks API 的功能及其用法,涵盖了创建、查询、更新、移动和删除书签的操作。通过这些 API,开发者可以轻松管理浏览器中的书签。此外,我们探讨了多个实际应用场景,包括书签层级管理和组织优化。后续文章将深入探讨复杂书签结构的管理和批量操作的实现,敬请期待。

相关推荐
张紫娃8 小时前
Chrome插件-Stylus(屏蔽博客广告)
前端·chrome·stylus
MyBili18 小时前
Chrome网页应用安装全攻略:把常用网站变成桌面独立应用
chrome·谷歌浏览器·效率工具·pwa·浏览器技巧·网页应用·网页变桌面应用
Flynt1 天前
我让 AI 给掘金首页做了次性能体检:LCP 8.9 秒是真的,但它判读错了一处
chrome·性能优化·mcp
Frag0ut1 天前
Chrome 2026打印与PDF处理全攻略:网页存证与文档输出实战进阶指南
chrome·pdf·批量打印·打印设置·网页存证·打印排版
Frag0ut1 天前
Chrome 2026浏览器AI助手全攻略:智能问答与内容创作实战进阶指南
人工智能·chrome·ai助手·本地大模型·浏览器ai·网页智能总结·侧边栏ai
HarmonSir1 天前
《Chrome CDP 系列》网络监听与拦截:Network / Fetch
chrome
一条破秋裤2 天前
【1115】【多线程】【笔记】
前端·chrome·笔记
stormsha2 天前
我的抓取脚本凭什么从不抢你的鼠标
前端·chrome
梯度下降者2 天前
解决Chrome路径错误问题
chrome·selenium·解决方案·webdriverexception·路径错误
MyBili4 天前
Chrome开发者工具入门:从看懂页面到高效调试
前端·chrome·谷歌浏览器·开发工具·chrome devtools·网页调式·网络请求分析