cn-font-split
TypeScript icon, indicating that this package has built-in type declarations

4.11.2 • Public • Published

中文 Web Font 切割工具

updateTime author npmVersion

CodeFactor NPM License

中文网字计划 Github 在线使用

简介

cn-font-split中文网字计划 所使用的字体分包工具,通过高性能的各种技术将庞大的字体包拆分为适合网络分发的版本。经过四个版本的字体研究与代码迭代,这项技术在我们的网站中得到了充分的应用,实现了中文字体在 Web 领域的加载速度与效率的双飞跃。

比快更快,比强更强。

  • 🚀 自研多线程+ (WebAssemblyNative) 分包速度极快;
  • 💻 坚持 Web 平台为基底,兼容性极强,浏览器、Node、Deno,统统可以运行。
  • 🔧 功能齐全完备,支持生成文字图片预览,支持完整全字符,支持复杂字形!

我们正在对 cn-font-split 的实战效果进行测试,并积极提升分包效果!

Opentype Feature 测试情况 支持 95 | 部分支持 9| 等待测试 20

详见兼容性章节

Nodejs Deno Chrome FireFox Safari Bun
✅^18.0.0 ⏺️ ^14.0.0 ✅^1.30.0 ✅^102 ✅^114 ✅^15 ⏺️ ^1.0.4

新版本功能

  1. ✅ 🔒 完备测试与版本发布流程!
  2. ✅ 🚀 多线程压缩,核心越多,速度越快!(1310ms -> 760ms)
  3. ✅ 🚀 使用 WASM 和原生工具解析与分包,提升打包速度。
  4. ✅ 🔒 依赖检查与重构,安全版本。
  5. ✅ 📦 更加可控的分包方式,支持细颗粒度的字符拆分。
  6. ✅ 🔔 支持 OTF 格式字体打包,支持复杂字形渲染。
  7. ✅ 🏞️ 字体预览图生成
  8. ✅ ⌨️ 支持 Nodejs、Deno、Bun、Browser,随处可使用!
  9. ✅ 🥳 不止中文,只要是包内的字符,统统分包

成品预览

成品可以查看我的字体库网站:点我进入中文字计划网站

里面的字体都是可以免费商用的,我对其进行了切割并且放置在了 GithubGitee 上,如果需要可以直接获取文件。

中文网字计划

快速使用

Nodejs 版本推荐使用 大于 18 的版本。如低级版本或者其他的设备环境,参考兼容性章节

安装

❗ 注意您安装的版本不是 beta 版本。如果是 beta 版本可能会引起一些问题。

npm install @konghayao/cn-font-split
npm install @konghayao/cn-font-split -g # 如果使用命令行,推荐全局安装

命令行使用

# -i 输入 -o 输出
cn-font-split -i=../demo/public/SmileySans-Oblique.ttf -o=./temp

# 参数与正常 js 操作是一样的,深层json则需要使用 . 来赋值
cn-font-split -i=../demo/public/SmileySans-Oblique.ttf -o=./temp --renameOutputFont=[hash:10][ext] --css.fontWeight=700

# 显示输入参数说明,虽然会显示 typescript 类型。。。
cn-font-split -h

写打包代码

import { fontSplit } from '@konghayao/cn-font-split';
// import { fontSplit } from "@konghayao/cn-font-split/dist/browser/index.js";
// import { fontSplit } from "https://cdn.jsdelivr.net/npm/@konghayao/cn-font-split@4.8.3/dist/browser/index.js";

fontSplit({
    FontPath: './fonts/SourceHanSerifCN-Bold.ttf', // 部分 otf 文件会报错,最好使用 ttf 版本的字体
    destFold: './build',
    chunkSize: 70 * 1024, // 如果需要的话,自己定制吧
    testHTML: true, // 输出一份 html 报告文件
    reporter: true, // 输出 json 格式报告
    previewImage: {}, // 只要填入 这个参数,就会进行图片预览文件生成,文件为 SVG 格式
    threads: {}, // 默认开启多线程,速度飞快
    css: {
        // 覆盖默认的 css 设置,一般不需要进行更改
        // fontFamily: "站酷庆科黄油体",
        // fontWeight: 400,
    },
    // 自定义分包输出的文件名为 10 位短哈希,或者使用自增索引: '[index][ext]'
    renameOutputFont: '[hash:10][ext]',
    // renameOutputFont: ({ transferred, ext, index }) => {
    //   return index.toString(36) + ext
    // } // 或者也可以像这样传入一个函数返回自定义的文件名
});

打包成品目录

- build
    ... // 很多字体分包,hash 命名
    - index.html // 用于展示打包分析报告, 需要开一个服务端口进行查看
    - reporter.json // 打包信息
    - result.css // css 入口,引入这个 css 文件即可使用字体包

更多 demo

  1. Nodejs 使用
  2. Deno 使用
  3. Bun 使用
  4. 浏览器使用

提高你的字体加载速度

  1. 切割分包大小适当:我的建议是设置 50-100KB 左右范围进行打包,这样单个包的大小不会太大,HTTP/2 的加载速度也够快。cn-font-split 的默认值是 70 KB 能够满足大多数场景。
  2. 使用支持并发加载的 CDN: JSDelivr、ESM.sh 等公益 CDN 都进行了并发数限制,一旦你的网站一次性加载字体包太多就中断 CDN。后面我使用了 Netlify 进行私有化部署,速度是瞬间加载!使用 ImageKit CDN 进行字体加载,也是瞬间完成!
  3. 一定要配置 HTTP 缓存条件:在有缓存时,用户打开你的网站是可以达到 50ms 内瞬间加载完所有字体包的。由于字体文件配置一次就基本上不会进行改动,所以可以持久缓存。
  4. 文档站点的预加载:如果网站有条件,可以在首页或者是所有页面,在浏览器空闲的时候,使用 js 的 fetch (force-cache) 请求所有的字体包。这样浏览器会把字体都加入进缓存中,从而保证其它页面的文字也能迅速加载。至于分包的具体名称,可以使用 reporter.json 文件查看。
  5. 字体文件下载抢占 JS 请求问题(出现概率低):字体文件如果在入口 HTML 文件中加载,那么浏览器会查看 HTML 中需要使用的字,并加载字体,但是在 JS 中使用数据请求就会出现问题。已经发出的字体下载占用了浏览器的下载并发数,进而推迟 JS 下载。我的建议是使用 JS 添加 link 标签动态导入 css 的方式延迟大概 150ms 即可。

开发相关

  1. 本仓库为 Monorepo,需要使用 pnpm 链接 workspace
  2. 项目源文件在 packages/subsets,通过 workspace 进行模块化链接。
  3. 所有使用的指令必须使用 pnpm 相关的方法,防止 workspace 的兼容问题
  4. 仓库中引用的部分 npm 包在我的其它仓库中,因为适应性问题进行了一部分源代码的修改。

一些特殊情况

  1. 不支持 woff 和 eot 文件:
    1. eot 在 Web 端支持度极低,故不支持
    2. woff 类型的压缩率和普及率远不及 woff2,提供的字体源也很少使用 woff(一般有 otf 或者 ttf),故不支持。
  2. 强制使用分包时,源字体没有某些字形,导致一个包内没有被分满。
    1. 例如:使用一个只有大致 6373 字符的字体,但是采用 Noto-Serif-SC 分包策略,那么部分包内会有缺失字体的现象,这是正常的。
    2. 这个特性,插件将不会进行干涉。
    3. 建议较全的字体包可以使用 Google 字体的中文分包方式,而小字体包使用自动分包策略就好了。

兼容性提醒

🚀 Nodejs

version: ✅^18.0.0 ⏺️ ^14.0.0 可以使用一些 polyfill Nodejs 使用

  1. Nodejs 几乎不需要进行适配,可以直接使用,效率不要
  2. Nodejs 18 以下的代码需要支持 esm、fetch、worker_threads 等高级特性,如果不支持部分特性,可以找找社区的 polyfill 插件。polyfill 示例

Browser

version: ✅ Chrome 102; FireFox 114; Safari 15 浏览器使用

  1. 浏览器需要 支持 module worker(多线程必须)、支持 WebAssembly 相关功能
  2. 在网页中引入时,不要对项目成品文件再次打包(会导致奇奇怪怪的依赖问题)
  3. 可以使用 CDN 导入 /dist/browser/index.js 文件,这个是支持的。
  4. 浏览器版本可以直接在浏览器运行分包任务,比其他生态环境要方便得多,项目组会一直支持。

🚀 Deno

version: ✅^1.30.0 Deno 使用

  1. 1.30.0 为不自动本地安装的版本,后续版本中使用了本地 npm 路径导入,导致部分情况下性能衰弱。可以参考 deno run -A --no-npm index.mjs 避免。

Bun

version: ⏺️^1.0.4 Bun 使用

  1. Bun 现在的版本只能跑在 Linux 和 Mac 平台,Windows 似乎官方在支持
  2. Bun 在我的 Mac 上运行良好,但是到某些 Linux 平台上,Web Worker 就会出问题。
  3. Bun 运行速度比 Nodejs 要快 30% 左右(保守估计)。

感谢

  1. 项目核心插件为 Harfbuzz 项目,源项目使用 C 与 C++ 构建了一个字体布局工具,然后提供了 WASM 的打包方法。项目重新构建并提供了 Typescript 版本的 API 封装,使得代码可以更好地融入生态中。
  2. opentype.js 这个项目为第二解析引擎,主要处理 feature 关系判断和文本转化为 SVG 的任务,在渲染方面给我们的支持很多。
  3. wawoff2 项目将 Google 的 woff2 格式转换功能代码编译成为了 wasm,为我们的字体压缩提供了非常简便的 API。但是 wawoff2 项目的导出方式为 js 嵌入 wasm,极大影响了 js 打包和使用,故项目也重新构建并发布出适合的版本。
  4. @napi-rs/ttf2woff2 使得 Nodejs 平台和 Bun 平台可以以极快的原生速度压缩字体文件,效率极高。
  5. 多线程采用了 workerpool 的解决方案,多线程的加持下,速度快了非常多。

开源许可证

Apache-2.0

Package Sidebar

Install

npm i cn-font-split

Weekly Downloads

0

Version

4.11.2

License

Apache-2.0

Unpacked Size

2.55 MB

Total Files

181

Last publish

Collaborators

  • konghayao