Agent skill

Content Hash Cache Pattern

by xu-xiang in xu-xiang/everything-claude-code-zh

使用 SHA-256 内容哈希缓存高昂的文件处理结果 —— 与路径无关、自动失效且服务层分离. An agent skill from xu-xiang/everything-claude-code-zh.

MITAuto-check passed

Install Content Hash Cache Pattern

skills CLI
$ npx skills add xu-xiang/everything-claude-code-zh --skill content-hash-cache-pattern -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install xu-xiang/everything-claude-code-zh content-hash-cache-pattern --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/xu-xiang/everything-claude-code-zh.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/content-hash-cache-pattern .claude/skills/content-hash-cache-pattern && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
content-hash-cache-pattern
GitHub stars
2k
Token cost
~994 tokens
SKILL.md length
91 words
Files
1
Skills in repo
78
Repo updated
First seen
Licence
MIT

At a glance

使用 SHA-256 内容哈希缓存高昂的文件处理结果 —— 与路径无关、自动失效且服务层分离. An agent skill from xu-xiang/everything-claude-code-zh.

  • Works in 4 steps: 基于内容哈希的缓存键 → 用于缓存条目的冻结数据类 (Frozen Dataclass) → 基于文件的缓存存储 → …
  • SKILL.md covers 何时激活, 核心模式, 关键设计决策 and 最佳实践, plus 3 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Content Hash Cache Pattern is an agent skill from xu-xiang/everything-claude-code-zh. 使用 SHA-256 内容哈希缓存高昂的文件处理结果 —— 与路径无关、自动失效且服务层分离。

Its SKILL.md is about 990 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

The repository describes itself as: everything-claude-code 中文翻译项目:完整的 Claude Code 配置集合(agents, skills, hooks, commands, rules, MCPs)。源自 Anthropic 黑客松获胜者的实战配置,助力中文工程师高效理解与使用 Claude Code。 The licence is MIT.

Example prompts

  • “/content-hash-cache-pattern”

Requirements

  • Python 3

Workflow steps

4 steps, taken from the step headings in SKILL.md.

  1. 基于内容哈希的缓存键
  2. 用于缓存条目的冻结数据类 (Frozen Dataclass)
  3. 基于文件的缓存存储
  4. 服务层封装 (满足单一职责原则 SRP)

What it can do on your machine

Read from SKILL.md and the folder at commit dfbf946. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are python).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Content Hash Cache Pattern loads about 994 tokens when it runs. Until then it costs about 19 tokens; SKILL.md has 91 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~19
When it runs · the whole SKILL.md, loaded when a task matches
~994

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from xu-xiang/everything-claude-code-zh at commit dfbf946, republished under its MIT licence (© xu-xiang). 91 words, ~994 tokens.

Download SKILL.mdSave it as .claude/skills/content-hash-cache-pattern/SKILL.md (or your agent's skills folder).
name
content-hash-cache-pattern
description
使用 SHA-256 内容哈希缓存高昂的文件处理结果 —— 与路径无关、自动失效且服务层分离。
origin
ECC

内容哈希文件缓存模式 (Content-Hash File Cache Pattern)

使用 SHA-256 内容哈希(而非文件路径)作为缓存键,缓存高昂的文件处理结果(如 PDF 解析、文本提取、图像分析)。与基于路径的缓存不同,这种方法在文件移动/重命名后依然有效,并在内容变化时自动失效。

何时激活

  • 构建文件处理流水线(Pipeline),如 PDF、图像或文本提取
  • 处理成本高昂且需要重复处理相同文件
  • 需要提供 --cache/--no-cache 命令行选项
  • 希望在不修改现有纯函数(Pure Functions)的情况下为其添加缓存功能

核心模式

1. 基于内容哈希的缓存键

使用文件内容(而非路径)作为缓存键:

python
import hashlib
from pathlib import Path

_HASH_CHUNK_SIZE = 65536  # 大文件采用 64KB 分块读取

def compute_file_hash(path: Path) -> str:
    """计算文件内容的 SHA-256 哈希值(针对大文件进行分块)。"""
    if not path.is_file():
        raise FileNotFoundError(f"File not found: {path}")
    sha256 = hashlib.sha256()
    with open(path, "rb") as f:
        while True:
            chunk = f.read(_HASH_CHUNK_SIZE)
            if not chunk:
                break
            sha256.update(chunk)
    return sha256.hexdigest()

为什么使用内容哈希? 文件重命名/移动 = 缓存命中。内容更改 = 自动失效。无需索引文件。

2. 用于缓存条目的冻结数据类 (Frozen Dataclass)
python
from dataclasses import dataclass

@dataclass(frozen=True, slots=True)
class CacheEntry:
    file_hash: str
    source_path: str
    document: ExtractedDocument  # 缓存的结果内容
3. 基于文件的缓存存储

每个缓存条目存储为 {hash}.json —— 通过哈希实现 O(1) 查询,无需索引文件。

python
import json
from typing import Any

def write_cache(cache_dir: Path, entry: CacheEntry) -> None:
    cache_dir.mkdir(parents=True, exist_ok=True)
    cache_file = cache_dir / f"{entry.file_hash}.json"
    data = serialize_entry(entry)
    cache_file.write_text(json.dumps(data, ensure_ascii=False), encoding="utf-8")

def read_cache(cache_dir: Path, file_hash: str) -> CacheEntry | None:
    cache_file = cache_dir / f"{file_hash}.json"
    if not cache_file.is_file():
        return None
    try:
        raw = cache_file.read_text(encoding="utf-8")
        data = json.loads(raw)
        return deserialize_entry(data)
    except (json.JSONDecodeError, ValueError, KeyError):
        return None  # 将损坏的缓存视为未命中
4. 服务层封装 (满足单一职责原则 SRP)

保持处理函数为纯函数。将缓存逻辑作为独立的服务层添加。

python
def extract_with_cache(
    file_path: Path,
    *,
    cache_enabled: bool = True,
    cache_dir: Path = Path(".cache"),
) -> ExtractedDocument:
    """服务层逻辑:检查缓存 -> 提取内容 -> 写入缓存。"""
    if not cache_enabled:
        return extract_text(file_path)  # 纯函数,不感知缓存逻辑

    file_hash = compute_file_hash(file_path)

    # 检查缓存
    cached = read_cache(cache_dir, file_hash)
    if cached is not None:
        logger.info("Cache hit: %s (hash=%s)", file_path.name, file_hash[:12])
        return cached.document

    # 缓存未命中 -> 提取 -> 存储
    logger.info("Cache miss: %s (hash=%s)", file_path.name, file_hash[:12])
    doc = extract_text(file_path)
    entry = CacheEntry(file_hash=file_hash, source_path=str(file_path), document=doc)
    write_cache(cache_dir, entry)
    return doc

关键设计决策

决策理由
SHA-256 内容哈希与路径无关,内容更改时自动失效
{hash}.json 文件命名O(1) 查询速度,无需维护索引文件
服务层封装 (Wrapper)满足单一职责原则(SRP):提取逻辑保持纯净,缓存作为独立关注点
手动 JSON 序列化对冻结数据类的序列化拥有完全控制权
损坏返回 None优雅降级,在下次运行时重新处理
cache_dir.mkdir(parents=True)在首次写入时延迟创建目录

最佳实践

  • 哈希内容而非路径 —— 路径会变,内容身份(Identity)不变。
  • 对大文件进行分块哈希 —— 避免将整个文件加载进内存。
  • 保持处理函数纯净 —— 它们不应知道任何关于缓存的信息。
  • 记录缓存命中/未命中日志 —— 使用截断后的哈希值以便调试。
  • 优雅处理缓存损坏 —— 将无效的缓存条目视为未命中,绝不要因此崩溃。

应避免的反模式 (Anti-Patterns)

python
# 错误做法:基于路径的缓存(文件移动/重命名后失效)
cache = {"/path/to/file.pdf": result}

# 错误做法:在处理函数内部添加缓存逻辑(违反 SRP)
def extract_text(path, *, cache_enabled=False, cache_dir=None):
    if cache_enabled:  # 该函数现在有了双重职责
        ...

# 错误做法:对嵌套的冻结数据类直接使用 dataclasses.asdict()
# (在处理复杂的嵌套类型时可能会出现问题)
data = dataclasses.asdict(entry)  # 推荐使用手动序列化

适用场景

  • 文件处理流水线(PDF 解析、OCR、文本提取、图像分析)
  • 受益于 --cache/--no-cache 选项的命令行工具 (CLI)
  • 在不同运行周期中会出现相同文件的批处理任务
  • 在不修改现有纯函数的情况下为其添加缓存功能

不适用场景

  • 必须保持绝对实时的数据(实时数据流)
  • 缓存条目体积极其庞大(此时应考虑流式处理)
  • 结果取决于文件内容以外的参数(例如不同的提取配置)

© xu-xiang, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in skills/content-hash-cache-pattern of xu-xiang/everything-claude-code-zh.

Open the folder on GitHubat commit dfbf946

Compare with similar skills

Content Hash Cache Pattern next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Content Hash Cache Pattern compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Content Hash Cache Pattern this skillxu-xiang/everything-claude-code-zh2k—~994Automated safety check: PassMIT
Content-Hash File Cache Patternaffaan-m/ECC275k5 repos~1.4kAutomated safety check: PassMIT
Content Hash Cache Patternaffaan-m/ECC275k—~1.1kAutomated safety check: PassMIT
Content Hash Cache Patternaffaan-m/ECC275k3 repos~1kAutomated safety check: PassMIT
Springboot Patternsaffaan-m/ECC275k5 repos~2.5kAutomated safety check: PassMIT
Redis Patternsaffaan-m/ECC275k1 repos~3kAutomated safety check: PassMIT

Similar skills

  • Caches slow file processing results in Python keyed by a SHA-256 hash of the file content, so renames still hit the cache and edits invalidate it automatically.

    275k GitHub starsUsed in 5 repos~1.4k tokens
    DevelopmentAuto-check passed
  • SHA-256コンテンツハッシュを使用して、高コストなファイル処理結果をキャッシュします — パス非依存、自動無効化、サービスレイヤーの分離。

    275k GitHub stars~1.1k tokensUpdated 3 days ago
    Auto-check passed
  • 使用SHA-256内容哈希缓存昂贵的文件处理结果——路径无关、自动失效、服务层分离. An agent skill from affaan-m/ECC.

    275k GitHub starsUsed in 3 repos~1k tokens
    Auto-check passed
  • Spring Boot architecture patterns, REST API design, layered services, data access, caching, async processing, and logging.

    275k GitHub starsUsed in 5 repos~2.5k tokens
    Backend & APIsAuto-check passed
  • Redis Patterns

    affaan-m/ECC

    Redis data structure patterns, caching strategies, distributed locks, rate limiting, pub/sub, and connection management for production applications.

    275k GitHub starsUsed in 1 repo~3k tokens
    Backend & APIsAuto-check passed
  • Golang Patterns

    affaan-m/ECC

    Go-specific design patterns and best practices including functional options, small interfaces, dependency injection, concurrency patterns, error handling, and package organization.

    275k GitHub stars~1.1k tokensUpdated 3 days ago
    DevelopmentAuto-check passed

More from xu-xiang/everything-claude-code-zh

All 78 skills in this repo
  • Configure Ecc

    xu-xiang/everything-claude-code-zh

    Everything Claude Code 的交互式安装程序 — 引导用户选择并安装技能和规则到用户级或项目级目录,验证路径,并可选择优化已安装文件。

    2k GitHub starsUsed in 1 repo~2.1k tokens
    Auto-check passed
  • Continuous Learning V2

    xu-xiang/everything-claude-code-zh

    基于本能(Instinct)的学习系统,通过钩子(hooks)观察会话,创建带有置信度评分的原子本能,并将其演化为技能(Skills)、命令(Commands)或智能体(Agents)。v2.1 版本增加了项目作用域(project-scoped)的本能,以防止跨项目污染。

    2k GitHub stars~2.1k tokensUpdated 7 mo ago
    Auto-check passed
  • API Design

    xu-xiang/everything-claude-code-zh

    生产级 API 的 REST API 设计模式,包括资源命名、状态码、分页、过滤、错误响应、版本控制和速率限制. An agent skill from xu-xiang/everything-claude-code-zh.

    2k GitHub stars~2.7k tokensUpdated 7 mo ago
    Auto-check passed
  • Backend Patterns

    xu-xiang/everything-claude-code-zh

    后端架构模式、API 设计、数据库优化以及适用于 Node.js、Express 和 Next.js API 路由的服务端最佳实践。

    2k GitHub stars~3.2k tokensUpdated 7 mo ago
    Auto-check passed
  • Backend Patterns

    xu-xiang/everything-claude-code-zh

    后端架构模式、API 设计、数据库优化以及 Node.js、Express 和 Next.js API 路由的服务端最佳实践。

    2k GitHub stars~3.1k tokensUpdated 7 mo ago
    Auto-check passed
  • Backend Patterns

    xu-xiang/everything-claude-code-zh

    后端架构模式、API 设计、数据库优化以及针对 Node.js、Express 和 Next.js API 路由的服务端最佳实践。

    2k GitHub stars~3.2k tokensUpdated 7 mo ago
    Auto-check passed

Questions about Content Hash Cache Pattern

What does Content Hash Cache Pattern do?

使用 SHA-256 内容哈希缓存高昂的文件处理结果 —— 与路径无关、自动失效且服务层分离. An agent skill from xu-xiang/everything-claude-code-zh. Content Hash Cache Pattern is an agent skill from xu-xiang/everything-claude-code-zh.

How do I install Content Hash Cache Pattern in Claude Code?

Run `npx skills add xu-xiang/everything-claude-code-zh --skill content-hash-cache-pattern -a claude-code`. Or copy the skill folder (skills/content-hash-cache-pattern in xu-xiang/everything-claude-code-zh) into .claude/skills/content-hash-cache-pattern in your project. Claude Code loads it when a task matches its description.

How do I install Content Hash Cache Pattern in Codex?

Run `npx skills add xu-xiang/everything-claude-code-zh --skill content-hash-cache-pattern -a codex`. Or copy the skill folder (skills/content-hash-cache-pattern in xu-xiang/everything-claude-code-zh) into .agents/skills/content-hash-cache-pattern in your project. Codex loads it when a task matches its description.

Can I use Content Hash Cache Pattern in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add xu-xiang/everything-claude-code-zh --skill content-hash-cache-pattern -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/content-hash-cache-pattern, .gemini/skills/content-hash-cache-pattern, .github/skills/content-hash-cache-pattern and .opencode/skills/content-hash-cache-pattern in your project.

What does Content Hash Cache Pattern need to run?

SKILL.md names no scripts, command-line tools or credentials: Content Hash Cache Pattern is instructions for the agent only. Our summary lists: Python 3.

Does Content Hash Cache Pattern access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Content Hash Cache Pattern safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Content Hash Cache Pattern use?

Content Hash Cache Pattern is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Content Hash Cache Pattern use?

About 994 tokens (SKILL.md is roughly 4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Content Hash Cache Pattern?

Skills that share tags, products or a category with Content Hash Cache Pattern: Content-Hash File Cache Pattern (affaan-m/ECC, 275k stars), Content Hash Cache Pattern (affaan-m/ECC, 275k stars), Content Hash Cache Pattern (affaan-m/ECC, 275k stars) and Springboot Patterns (affaan-m/ECC, 275k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Content Hash Cache Pattern?

xu-xiang (a GitHub user) maintains it in xu-xiang/everything-claude-code-zh, which has 1,973 GitHub stars. The repository holds 78 skills in this directory. The repository was last updated on March 5, 2026.

Source: xu-xiang/everything-claude-code-zh on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.