当前位置: 首页 > news >正文

GitZip Pro 源码解析:一个 GitHub 文件/文件夹下载扩展是如何工作的(六)设置页、Token 与下载历史

项目地址:fthux/GitZipPro。这一篇聚焦 GitZip Pro 的设置页、GitHub Token、下载历史和统计面板。

前几篇主要围绕 GitHub 页面和下载流程展开。这一篇进入 GitZip Pro 中体量最大的页面:设置页。

设置页由三个文件组成:

source/options.html source/options_init.js source/options.js

其中options_init.js很短,只负责初始化国际化:

(asyncfunctioninitOptionsPage(){awaitGZP_I18N.init();GZP_I18N.applyTranslations();})();

真正的设置逻辑集中在options.js。它既管理普通配置,也管理 GitHub token、忽略规则、下载历史和统计面板。

设置页整体结构

options.js开头会取得大量 DOM 元素:

constthemeSelect=document.getElementById('themeSelect');constlanguageSelect=document.getElementById('languageSelect');constbuttonPositionSelect=document.getElementById('buttonPositionSelect');constnamingPreset=document.getElementById('namingPreset');constgithubToken=document.getElementById('githubToken');consthistoryContent=document.getElementById('history-content');conststatsOverviewGrid=document.getElementById('stats-overview-grid');

这些变量说明设置页不是单一表单,而是多个功能页的组合。

页面菜单切换由activateMenu(target)控制。点击左侧菜单时,它会切换.menu-item的 active 状态,同时展示对应.page。页面也支持 hash 路由,例如#general#token#history

整体结构可以这样理解:

options.html

general
主题/语言/按钮

download
命名/通知/忽略规则

token
GitHub token / OAuth

history
下载历史

stats
下载统计

chrome.storage.local

chrome.storage.local是设置页和其他模块之间的共享层。content.jsdownloader.jsbackground.js都会读取其中一部分配置。

基础设置:主题、语言和按钮位置

设置页使用constants.js中的 key:

constC=globalThis.GZP_CONSTANTS;constSTORAGE=C.STORAGE_KEYS;constDEFAULTS=C.DEFAULTS;

主题切换由applyTheme(theme)处理:

functionapplyTheme(theme){if(theme==='system'){document.documentElement.removeAttribute('data-theme');}else{document.documentElement.setAttribute('data-theme',theme);}}

当用户修改主题时,代码会立即应用到当前 options 页面,并写入 storage:

chrome.storage.local.set({[STORAGE.THEME]:theme});

语言切换则会调用GZP_I18N.setLocale(),并触发页面文案刷新。因为 background 也监听了语言 storage 变化,所以右键菜单文案也能跟着更新。

按钮位置、文件大小显示、双击选择等配置也是同样模式:读取默认值,用户修改后写入 storage,content script 后续读取并应用。

下载命名与通知设置

下载相关设置包括:

  • NAMING_PRESET
  • NAMING_CUSTOM
  • NOTIFY_SHOW
  • NOTIFY_SOUND
  • NOTIFY_OPEN

这些配置最终会被downloader.jsgetSettings()读取。也就是说,options 页面本身不参与下载,但它决定下载器如何命名 zip、是否播放提示音、下载完成后是否通知或打开下载项。

命名规则的变量在下载器中被替换:

{owner} {repo} {branch} {path} {date} {datetime} {ts}

设置页负责让用户选择或填写模板,下载器负责在实际下载时用仓库信息替换这些变量。

忽略规则设置

options.js中定义了IGNORE_PRESETSPRESET_COMBOS。它们对应常见忽略场景,例如版本控制目录、依赖目录、构建产物、日志文件等。

用户选中的预设保存在:

letactiveLabels=newSet();

用户自定义规则保存在:

letcustomRules=[];

当规则变化时,saveIgnoreSettings()会把它们写入:

STORAGE.IGNORE_LABELSSTORAGE.IGNORE_CUSTOM_VARS

下载器后续读取这两个 key,调用compileIgnoreRules()isIgnored()来过滤文件。

这形成了一个跨模块链路:

options.js
选择忽略规则

chrome.storage.local

downloader.js
getSettings()

compileIgnoreRules()

collectFiles() 中过滤文件

GitHub Token 设置

GitZip Pro 支持匿名模式和自定义 token 模式。相关 storage key 包括:

constTOKEN_STORAGE_KEY=STORAGE.GITHUB_TOKEN;constTOKEN_MODE_KEY=STORAGE.TOKEN_ACCESS_MODE;constTOKEN_SCOPE_KEY=STORAGE.TOKEN_SCOPE;

设置页中,用户可以手动输入 token,也可以走 OAuth 流程。OAuth 相关函数包括:

generateCodeVerifier() generateCodeChallenge() getOAuthRedirectUrl() launchIdentityWebAuthFlow() launchPopupOAuthFlow() startGitHubOAuth(scope)

其中generateCodeChallenge()使用crypto.subtle.digest('SHA-256', data)生成 PKCE challenge。这说明 OAuth 流程不是简单跳转,而是带了 PKCE 校验。

token 保存后,downloader.jscontent.js都会读取它:

  • downloader.js用 token 请求文件和目录内容。
  • content.js的文件大小展示也会用 token 请求 GitHub API。

设置页还提供checkRateLimit(),用于查看当前 API rate limit 状态。这部分通过GITHUB_RATE_LIMIT接口判断 token 是否生效。

下载历史

下载历史的 key 是:

constHISTORY_STORAGE_KEY=STORAGE.DOWNLOAD_HISTORY;

历史记录主要由 background 在下载完成后写入。options 页面负责读取、展示、删除和清空。

相关函数包括:

loadHistory() saveHistory() renderHistory() deleteSelectedRecords() clearAllHistory() initHistoryPage()

每条历史记录中包含下载时间、仓库、分支、路径、下载文件名、文件列表、文件数量、被忽略数量等信息。buildHistoryTargetUrl(record)可以根据记录还原 GitHub 目标链接,让用户从历史记录回到对应仓库位置。

当 background 保存历史后,会发送GZP_DOWNLOAD_COMPLETE消息。如果 options 页面打开,就可以实时更新;如果没打开,下次进入页面时也会从 storage 读到。

下载统计

统计面板建立在历史记录之上。核心函数是:

aggregateStats(records) filterHistoryRecords(records) renderStats()

filterHistoryRecords()根据时间范围、类型、仓库、分支、关键词等条件过滤记录。aggregateStats()再计算总下载次数、文件数、被忽略数量、总大小、仓库维度和分支维度。最后renderStats()把结果渲染成 KPI 卡片和表格。

这部分没有重新请求网络,而是完全基于本地历史记录计算。

DOWNLOAD_HISTORY

loadHistory()

filterHistoryRecords()

aggregateStats()

renderStats()

KPI / 仓库表格 / 分支表格

首次欢迎弹窗

background.js首次安装时会写入:

'gitzip-pro-show-welcome':true

options 页面启动时执行checkAndShowWelcomeModal()。如果检测到首次使用标记,页面会切换到 token 页面,并显示欢迎弹窗。这样首次用户会被引导到最重要的配置区域。

本篇小结

options.js是 GitZip Pro 的配置和数据展示中心。它不直接参与页面注入,也不直接下载文件,但它决定了其他模块的运行方式:

options.js 写入 storage -> content.js 读取 UI 设置 -> downloader.js 读取下载设置和 token -> background.js 写入历史 -> options.js 再读取历史并渲染统计

下一篇是系列最后一篇,收束到popup.jsi18n.jsbuild.js,看 GitZip Pro 如何处理轻量入口、国际化系统,以及 Chrome / Firefox / Edge 多渠道构建。

完整项目在 fthux/GitZipPro。如果你正在做浏览器扩展的设置页或下载历史功能,可以 Star 后对照源码继续研究。

如果你也好奇这个 Pro 版为什么会做起来,可以接着看这篇项目缘起:用了 GitZip 这么多年,我动手做了一个「Pro」版。

http://www.jsqmd.com/news/1209233/

相关文章:

  • Jupyter Notebook与深度学习实战:从实验到生产部署
  • Ansible Playbook 基础与流程控制-Inventory 主机清单模板-003篇
  • 2026北京医保诈骗罪辩护律师推荐(附真实案例与排名) - GrowUME
  • 2026年7月最新昆明真力时官方售后热线及客户服务网点地址 - 亨得利官方服务中心
  • CPU 端火焰图:逻辑帧时间分解与热点定位
  • 如何在Windows 11 LTSC 24H2上快速安装Microsoft Store的完整指南
  • 年服务超4000人、进面率31%+,江苏粉笔基地班凭什么跑通? - 天涯视角
  • 短线交易实战指南:从选股到风控的完整交易体系搭建
  • LoRA过拟合反复发作?不是参数问题——而是你的训练数据集缺少这6维元数据校验(附Python自动化脚本)
  • 苏州防水补漏 10 个高频问题解答:2026 年最新价格、免砸砖效果、上门检测全说明 - 徽顺虹
  • 2026五家优质的北京美国留学中介推荐,深度评测报告 - 2027品牌AI展
  • MCP 系列(08):企业治理——Registry、路由与可观测性
  • 人工智能专业找工作难吗?本科生该怎么定位
  • 2026年裸眼3D动画制作多少钱
  • 创业做科技行业商学院该读MBA还是MTT-交大安泰与中银科技金融学院分流
  • 雷达中国官方售后服务中心|服务热线及门店官方地址权威信息通告(2026年7月更新) - 亨得利钟表维修中心
  • 2026年杭州装修短视频代运营机构推荐,流量与转化双落地 - 装企精灵GEO
  • Eclipse Java开发环境安装配置全指南(2024最新版)
  • 2026年7月最新劳力士乌鲁木齐高新万达广场维修保养服务电话 - 劳力士官方服务中心
  • 陶雅轩陶瓷是几线品牌?揭秘其在行业中的真实地位 - GrowUME
  • 本地汇总,天津滨海新非急救长途转运救护车租赁,异地就医往返接送服务 - 资讯速览
  • 真力时中国官方售后服务中心|电话和完整地址权威信息通知(2026年7月更新) - 亨得利官方服务中心
  • Day1——Jerry
  • OpenClaw Native 线程完整详解
  • 石家庄五个家庭第一次卖黄金的真实经历:从长安到高新区,我们找到不收折旧费不扣损耗的实体店 - 小城生活闲谈
  • 千问PPT Agent:语义化生成与可编辑结构化PPT
  • 【Figma AI交互避坑白皮书】:92%设计师踩过的3类隐性交互失效陷阱及修复公式
  • 我想创业做一些科技行业-国内哪些商学院的什么项目会对我有帮助-2027选型指南
  • Ubuntu定制安装镜像制作指南:Cubic与chroot方法详解
  • 真力时售后服务中心热线,提供专业腕表维修保养服务权威公示(2026年7月最新) - 亨得利官方服务中心