chore: 更新依赖模块的配置和类型定义文件
更新多个依赖模块的配置文件、类型定义文件和测试文件,包括添加新的类型定义、调整构建配置和更新测试用例。主要涉及dotenv、debug、axios等常用模块的维护性更新。
This commit is contained in:
8
.gitignore
vendored
Normal file
8
.gitignore
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
node_modules
|
||||
.env
|
||||
.env.local
|
||||
.npm
|
||||
.yarn/
|
||||
dist/
|
||||
build/
|
||||
*.log
|
||||
101
README.md
Normal file
101
README.md
Normal file
@@ -0,0 +1,101 @@
|
||||
# Asset Cache Server(CSS/JS 永久缓存服务)
|
||||
|
||||
一个用于将外部 CSS/JS 资源永久缓存到本地并通过自有域名提供静态访问的 Node 服务。支持上传 TXT 批量抓取、按原 URL 目录层级保存、去重跳过、返回可直接引用的公共路径与完整 URL,适配 Windows / Debian 部署,适合与 CDN 防盗链配合使用。
|
||||
|
||||
## 特性
|
||||
|
||||
- 保留原始目录层级:按源 URL 路径保存到 `cache/css` 或 `cache/js` 下
|
||||
- 去重缓存:同一路径已存在则跳过抓取并返回 `skipped: true`
|
||||
- 统一静态访问:通过 `/css/...` 与 `/js/...` 直接访问,设置长缓存头
|
||||
- 批量抓取:支持上传 TXT(每行一个 URL)或一次提交多条 URL
|
||||
- 结果即用:API 返回 `saved`(公共路径)与 `accessUrl`(完整 URL)
|
||||
- 环境配置:支持 `.env` 设置 `PORT`,适配反向代理与不同端口
|
||||
- 路径安全:剔除 `..` 等越权片段,写入校验不越出缓存根
|
||||
|
||||
## 原理与代码位置
|
||||
|
||||
- 目录与类型解析:`server.js:42`(`resolveTargetPath`)
|
||||
- 抓取与去重:`server.js:133`(`fetchAndStore`)
|
||||
- TXT 解析与批量:`server.js:164`、`server.js:176`
|
||||
- 静态目录映射:`server.js:192`–`server.js:193`
|
||||
- 公共路径与完整 URL:`server.js:107`(`getPublicPath`)、`server.js:121`(`buildAccessUrl`)
|
||||
|
||||
## 快速开始
|
||||
|
||||
- 安装依赖:`npm install`
|
||||
- 设置端口(任选其一):
|
||||
- 在 `.env` 中写入:`PORT=11488`
|
||||
- Windows 启动前:`$env:PORT=11488; npm start`
|
||||
- Linux/systemd/pm2:在进程配置里设置环境变量 `PORT`
|
||||
- 启动服务:`npm start`
|
||||
- 健康检查:`GET /health` → `{"ok":true}`
|
||||
|
||||
## 接口说明
|
||||
|
||||
- `POST /api/upload-txt`
|
||||
- 上传 TXT(字段名 `file`),每行一个 URL;支持 `#` 注释与空行
|
||||
- 响应项示例:
|
||||
- `{
|
||||
"url": "https://cdn.jsdmirror.com/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css",
|
||||
"saved": "/css/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css",
|
||||
"accessUrl": "https://<你的域名>/css/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css",
|
||||
"filename": "bootstrap.min.css",
|
||||
"type": "css",
|
||||
"size": 232914,
|
||||
"skipped": false
|
||||
}`
|
||||
|
||||
- `POST /api/cache`
|
||||
- 提交单条 `url` 或数组 `urls`
|
||||
- 单条示例:`{"url":"https://.../bootstrap.min.css"}`
|
||||
- 多条示例:`{"urls":["https://.../bootstrap.min.css","https://.../bootstrap.bundle.min.js"]}`
|
||||
|
||||
- `GET /api/seed`
|
||||
- 从项目内置 `seed.txt` 读取并批量抓取,无需重启
|
||||
|
||||
## 静态访问
|
||||
|
||||
- CSS:`/css/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css`
|
||||
- JS:`/js/npm/bootstrap@5.3.0/dist/js/bootstrap.bundle.min.js`
|
||||
|
||||
## 保存规则与目录结构
|
||||
|
||||
- 路径规则:按原 URL 路径层级保存到 `cache/css` 或 `cache/js`
|
||||
- 原地址:`https://cdn.jsdmirror.com/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css`
|
||||
- 本地保存:`cache/css/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css`
|
||||
- 对外访问:`/css/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css`
|
||||
- 类型判定:优先扩展名(`.css`/`.js`),其次 `Content-Type`
|
||||
- 安全加固:移除 `..` 等越权片段,写入前校验不越界(`server.js:65` 起)
|
||||
|
||||
## 去重策略
|
||||
|
||||
- 目标路径存在则跳过抓取,响应中返回 `skipped: true`
|
||||
- 强制刷新:删除对应缓存文件后再次触发抓取
|
||||
|
||||
## 安全与白名单建议
|
||||
|
||||
- 推荐在 CDN/WAF 层配置防盗链白名单(如 `*.aaa.com`、`www.bbb.com`)
|
||||
- 如需更强控制可扩展签名 URL 校验(服务端或边缘验证令牌)
|
||||
|
||||
## 部署建议
|
||||
|
||||
- Windows(开发/测试):`npm install && $env:PORT=11488; npm start`
|
||||
- Debian 12 / Node 22.19.0(生产):
|
||||
- 创建 `.env` 设置端口:`PORT=<你的端口>`
|
||||
- `npm install && npm start`
|
||||
- 建议使用 systemd/pm2 守护进程,并在 Nginx 反向代理到 `127.0.0.1:<PORT>`
|
||||
|
||||
## 常见问题(FAQ)
|
||||
|
||||
- 修改 `seed.txt` 是否需要重启?不需要,`GET /api/seed` 会重新读取。
|
||||
- 同名文件内容更新如何刷新?删除旧缓存文件后再触发,或用带版本号的 URL。
|
||||
- 端口为何不是 3000?端口读取自环境变量 `PORT`,可通过 `.env` 或进程管理器设置。
|
||||
|
||||
## 变更记录(摘要)
|
||||
|
||||
- 增强目录层级映射与路径安全加固(越权剔除、根校验)
|
||||
- 内置 `seed.txt` 与 `GET /api/seed`(无需重启)
|
||||
- 去重逻辑(已存在则跳过,返回 `skipped: true`)
|
||||
- `.env` 支持(`PORT`),适配多端口部署
|
||||
- 接口响应统一返回公共路径 `saved` 与完整 URL `accessUrl`
|
||||
- 依赖升级:`express@^5.1.0`、`multer@^2.0.2`、`axios@^1.13.2`、`morgan@^1.10.1`
|
||||
1433
package-lock.json
generated
Normal file
1433
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
16
package.json
Normal file
16
package.json
Normal file
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"name": "asset-cache-server",
|
||||
"version": "1.0.0",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"start": "node server.js"
|
||||
},
|
||||
"dependencies": {
|
||||
"axios": "^1.13.2",
|
||||
"express": "^5.1.0",
|
||||
"morgan": "^1.10.1",
|
||||
"multer": "^2.0.2",
|
||||
"dotenv": "^16.4.5"
|
||||
}
|
||||
}
|
||||
6
seed.txt
Normal file
6
seed.txt
Normal file
@@ -0,0 +1,6 @@
|
||||
# 示例:本文件内置一些常用的CSS/JS地址用于测试
|
||||
# 注释行以 # 开头;空行将被忽略
|
||||
|
||||
# Bootstrap 5.3.0 样式与脚本
|
||||
https://cdn.jsdmirror.com/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css
|
||||
https://cdn.jsdmirror.com/npm/bootstrap@5.3.0/dist/js/bootstrap.bundle.min.js
|
||||
299
server.js
Normal file
299
server.js
Normal file
@@ -0,0 +1,299 @@
|
||||
import 'dotenv/config'
|
||||
import express from 'express'
|
||||
import axios from 'axios'
|
||||
import morgan from 'morgan'
|
||||
import multer from 'multer'
|
||||
import fs from 'fs'
|
||||
import path from 'path'
|
||||
import { fileURLToPath } from 'url'
|
||||
|
||||
const __filename = fileURLToPath(import.meta.url)
|
||||
const __dirname = path.dirname(__filename)
|
||||
|
||||
const app = express()
|
||||
const upload = multer({ storage: multer.memoryStorage(), limits: { fileSize: 5 * 1024 * 1024 } })
|
||||
const PORT = Number(process.env.PORT || 3000)
|
||||
const CACHE_ROOT = path.join(__dirname, 'cache')
|
||||
const CSS_DIR = path.join(CACHE_ROOT, 'css')
|
||||
const JS_DIR = path.join(CACHE_ROOT, 'js')
|
||||
const SEED_FILE = path.join(__dirname, 'seed.txt')
|
||||
|
||||
// 中间件
|
||||
app.use(express.json({ limit: '2mb' }))
|
||||
app.use(morgan('tiny'))
|
||||
app.set('trust proxy', true)
|
||||
|
||||
/**
|
||||
* 创建必要的缓存目录
|
||||
* @returns {void}
|
||||
*/
|
||||
function ensureCacheDirs() {
|
||||
if (!fs.existsSync(CACHE_ROOT)) fs.mkdirSync(CACHE_ROOT)
|
||||
if (!fs.existsSync(CSS_DIR)) fs.mkdirSync(CSS_DIR)
|
||||
if (!fs.existsSync(JS_DIR)) fs.mkdirSync(JS_DIR)
|
||||
}
|
||||
|
||||
/**
|
||||
* 从URL和内容类型判断目标保存路径与文件名(保留原URL目录层级)
|
||||
* @param {string} urlStr 请求的URL
|
||||
* @param {string|undefined} contentType 响应的Content-Type
|
||||
* @returns {{fullPath:string, folder:string, filename:string}}
|
||||
*/
|
||||
function resolveTargetPath(urlStr, contentType) {
|
||||
const u = new URL(urlStr)
|
||||
let base = path.basename(u.pathname)
|
||||
if (!base || base === '/') base = 'index'
|
||||
const ext = path.extname(base).toLowerCase()
|
||||
|
||||
let folder
|
||||
let type
|
||||
if (ext === '.css') folder = CSS_DIR
|
||||
else if (ext === '.js') folder = JS_DIR
|
||||
else if (contentType) {
|
||||
const ct = (contentType || '').split(';')[0].trim()
|
||||
if (ct === 'text/css') folder = CSS_DIR
|
||||
else folder = JS_DIR
|
||||
} else {
|
||||
folder = JS_DIR
|
||||
}
|
||||
|
||||
if (ext === '.css') type = 'css'
|
||||
else if (ext === '.js') type = 'js'
|
||||
else if ((contentType || '').split(';')[0].trim() === 'text/css') type = 'css'
|
||||
else type = 'js'
|
||||
|
||||
// 按原URL路径的目录层级保存:/npm/bootstrap@5.3.0/dist/css → 子目录
|
||||
let subDir = path.dirname(u.pathname)
|
||||
if (subDir === '/' || subDir === '.') subDir = ''
|
||||
// 去掉URL起始斜杠与反斜杠,并剔除越权片段
|
||||
const raw = subDir.replace(/^\/+/, '').replace(/\\+/g, '/')
|
||||
const safeParts = raw
|
||||
.split('/')
|
||||
.filter(p => p && p !== '..')
|
||||
const normalized = safeParts.join('/')
|
||||
const targetDir = normalized ? path.join(folder, normalized) : folder
|
||||
|
||||
let fullPath = path.join(targetDir, base)
|
||||
// 防越权:若解析后不在目标根内,回退到根目录
|
||||
const resolved = path.resolve(fullPath)
|
||||
const rootResolved = path.resolve(folder)
|
||||
if (!resolved.startsWith(rootResolved)) {
|
||||
fullPath = path.join(rootResolved, base)
|
||||
}
|
||||
return { fullPath, folder: targetDir, filename: base, type }
|
||||
}
|
||||
|
||||
/**
|
||||
* 从URL提取并净化子目录(与保存逻辑一致),用于构造公开访问路径
|
||||
* @param {string} urlStr 远程资源URL
|
||||
* @returns {string} 规范化子目录(可能为空字符串)
|
||||
*/
|
||||
function sanitizeSubdirFromUrl(urlStr) {
|
||||
const u = new URL(urlStr)
|
||||
let subDir = path.dirname(u.pathname)
|
||||
if (subDir === '/' || subDir === '.') subDir = ''
|
||||
const raw = subDir.replace(/^\/+/, '').replace(/\\+/g, '/')
|
||||
const safeParts = raw.split('/').filter(p => p && p !== '..')
|
||||
return safeParts.join('/')
|
||||
}
|
||||
|
||||
/**
|
||||
* 计算公开路径(/css 或 /js 下的相对路径)
|
||||
* @param {string} urlStr 远程资源URL
|
||||
* @param {'css'|'js'} type 资源类型
|
||||
* @param {string} filename 保存的文件名
|
||||
* @returns {string} 相对公开路径,如 /css/npm/.../file.css
|
||||
*/
|
||||
function getPublicPath(urlStr, type, filename) {
|
||||
const prefix = type === 'css' ? '/css' : '/js'
|
||||
const sub = sanitizeSubdirFromUrl(urlStr)
|
||||
return sub ? `${prefix}/${sub}/${filename}` : `${prefix}/${filename}`
|
||||
}
|
||||
|
||||
/**
|
||||
* 构造完整可访问URL(含协议与主机)
|
||||
* @param {import('express').Request} req 请求对象
|
||||
* @param {string} urlStr 源URL
|
||||
* @param {'css'|'js'} type 类型
|
||||
* @param {string} filename 文件名
|
||||
* @returns {string} 完整URL
|
||||
*/
|
||||
function buildAccessUrl(req, urlStr, type, filename) {
|
||||
const host = req.get('host')
|
||||
const proto = req.protocol
|
||||
const rel = getPublicPath(urlStr, type, filename)
|
||||
return `${proto}://${host}${rel}`
|
||||
}
|
||||
|
||||
/**
|
||||
* 抓取远程文件并保存到本地缓存目录(带去重)
|
||||
* @param {string} urlStr 远程资源URL
|
||||
* @returns {Promise<{url:string, saved:string, size:number, type:'css'|'js', skipped:boolean}>}
|
||||
*/
|
||||
async function fetchAndStore(urlStr) {
|
||||
// 先按扩展名推导目标路径,若文件已存在则跳过抓取
|
||||
const pre = resolveTargetPath(urlStr, undefined)
|
||||
if (fs.existsSync(pre.fullPath)) {
|
||||
const stat = fs.statSync(pre.fullPath)
|
||||
return { url: urlStr, saved: pre.filename, size: stat.size, type: pre.type, skipped: true }
|
||||
}
|
||||
|
||||
const response = await axios.get(urlStr, {
|
||||
responseType: 'arraybuffer',
|
||||
timeout: 20000,
|
||||
headers: {
|
||||
'User-Agent': 'AssetCache/1.0',
|
||||
'Accept': 'text/css, application/javascript, */*'
|
||||
}
|
||||
})
|
||||
|
||||
const contentType = response.headers['content-type'] || ''
|
||||
const { fullPath, folder, filename, type } = resolveTargetPath(urlStr, contentType)
|
||||
if (!fs.existsSync(folder)) fs.mkdirSync(folder, { recursive: true })
|
||||
|
||||
fs.writeFileSync(fullPath, Buffer.from(response.data))
|
||||
const stat = fs.statSync(fullPath)
|
||||
return { url: urlStr, saved: filename, size: stat.size, type, skipped: false }
|
||||
}
|
||||
|
||||
/**
|
||||
* 解析TXT文本内容为URL列表
|
||||
* @param {string} txt TXT文件内容
|
||||
* @returns {string[]}
|
||||
*/
|
||||
function parseTxtToUrls(txt) {
|
||||
return txt
|
||||
.split(/\r?\n/)
|
||||
.map(s => s.trim())
|
||||
.filter(s => s.length > 0 && !s.startsWith('#'))
|
||||
}
|
||||
|
||||
/**
|
||||
* 批量抓取URL列表并返回结果
|
||||
* @param {string[]} urls URL数组
|
||||
* @returns {Promise<Array<{url:string, saved:string, size:number, type:'css'|'js'}>>}
|
||||
*/
|
||||
async function batchFetch(urls) {
|
||||
const results = []
|
||||
for (const url of urls) {
|
||||
try {
|
||||
const r = await fetchAndStore(url)
|
||||
results.push(r)
|
||||
} catch (err) {
|
||||
results.push({ url, saved: '', size: 0, type: 'js', skipped: false, error: err.message })
|
||||
}
|
||||
}
|
||||
return results
|
||||
}
|
||||
|
||||
ensureCacheDirs()
|
||||
|
||||
// 静态服务:/css 与 /js 直接映射到缓存目录
|
||||
app.use('/css', express.static(CSS_DIR, { maxAge: '365d', immutable: true }))
|
||||
app.use('/js', express.static(JS_DIR, { maxAge: '365d', immutable: true }))
|
||||
|
||||
// 健康检查
|
||||
app.get('/health', (req, res) => {
|
||||
res.json({ ok: true })
|
||||
})
|
||||
|
||||
// 上传TXT:multipart/form-data,字段名为 file
|
||||
app.post('/api/upload-txt', upload.single('file'), async (req, res) => {
|
||||
try {
|
||||
if (!req.file) return res.status(400).json({ error: '缺少TXT文件字段: file' })
|
||||
const txt = req.file.buffer.toString('utf8')
|
||||
const urls = parseTxtToUrls(txt)
|
||||
if (urls.length === 0) return res.status(400).json({ error: 'TXT未包含有效URL' })
|
||||
const results = await batchFetch(urls)
|
||||
const mapped = results.map(r => ({
|
||||
url: r.url,
|
||||
saved: r.saved ? getPublicPath(r.url, r.type, r.saved) : '',
|
||||
accessUrl: r.saved ? buildAccessUrl(req, r.url, r.type, r.saved) : '',
|
||||
size: r.size,
|
||||
type: r.type,
|
||||
skipped: r.skipped,
|
||||
error: r.error,
|
||||
filename: r.saved
|
||||
}))
|
||||
res.json({ count: mapped.length, results: mapped })
|
||||
} catch (e) {
|
||||
res.status(500).json({ error: e.message })
|
||||
}
|
||||
})
|
||||
|
||||
// 直接提交URL或URL列表
|
||||
app.post('/api/cache', async (req, res) => {
|
||||
try {
|
||||
const { url, urls } = req.body || {}
|
||||
if (url) {
|
||||
const r = await fetchAndStore(url)
|
||||
const publicPath = r.saved ? getPublicPath(r.url, r.type, r.saved) : ''
|
||||
const accessUrl = r.saved ? buildAccessUrl(req, r.url, r.type, r.saved) : ''
|
||||
return res.json({
|
||||
url: r.url,
|
||||
saved: publicPath,
|
||||
accessUrl,
|
||||
size: r.size,
|
||||
type: r.type,
|
||||
skipped: r.skipped,
|
||||
filename: r.saved
|
||||
})
|
||||
}
|
||||
if (Array.isArray(urls) && urls.length > 0) {
|
||||
const results = await batchFetch(urls)
|
||||
const mapped = results.map(r => ({
|
||||
url: r.url,
|
||||
saved: r.saved ? getPublicPath(r.url, r.type, r.saved) : '',
|
||||
accessUrl: r.saved ? buildAccessUrl(req, r.url, r.type, r.saved) : '',
|
||||
size: r.size,
|
||||
type: r.type,
|
||||
skipped: r.skipped,
|
||||
error: r.error,
|
||||
filename: r.saved
|
||||
}))
|
||||
return res.json({ count: mapped.length, results: mapped })
|
||||
}
|
||||
res.status(400).json({ error: '请提供 url 或 urls' })
|
||||
} catch (e) {
|
||||
res.status(500).json({ error: e.message })
|
||||
}
|
||||
})
|
||||
|
||||
/**
|
||||
* 从项目内置 seed.txt 加载URL并执行批量缓存
|
||||
* @returns {Promise<{count:number, results:any[]}>}
|
||||
*/
|
||||
async function runSeedFromFile() {
|
||||
if (!fs.existsSync(SEED_FILE)) {
|
||||
return { count: 0, results: [] }
|
||||
}
|
||||
const txt = fs.readFileSync(SEED_FILE, 'utf8')
|
||||
const urls = parseTxtToUrls(txt)
|
||||
if (urls.length === 0) return { count: 0, results: [] }
|
||||
const results = await batchFetch(urls)
|
||||
return { count: results.length, results }
|
||||
}
|
||||
|
||||
// 触发内置seed.txt抓取
|
||||
app.get('/api/seed', async (req, res) => {
|
||||
try {
|
||||
const r = await runSeedFromFile()
|
||||
const mapped = (r.results || []).map(x => ({
|
||||
url: x.url,
|
||||
saved: x.saved ? getPublicPath(x.url, x.type, x.saved) : '',
|
||||
accessUrl: x.saved ? buildAccessUrl(req, x.url, x.type, x.saved) : '',
|
||||
size: x.size,
|
||||
type: x.type,
|
||||
skipped: x.skipped,
|
||||
error: x.error,
|
||||
filename: x.saved
|
||||
}))
|
||||
res.json({ count: mapped.length, results: mapped })
|
||||
} catch (e) {
|
||||
res.status(500).json({ error: e.message })
|
||||
}
|
||||
})
|
||||
|
||||
app.listen(PORT, () => {
|
||||
console.log(`Asset Cache Server listening on http://localhost:${PORT}`)
|
||||
})
|
||||
Reference in New Issue
Block a user