欢迎加入【开源鸿蒙PC社区】，一起共建鸿蒙化C/C++三方库生态。
前言
tokei（トケイ / 時計，日语"时钟"之意）是一个由 XAMPPRocky 开发的快速的代码统计命令行工具 ，旨在快速统计项目中的代码行数、注释行数和空白行数，支持超过 150 种编程语言，是 cloc/sloccount 的优秀替代方案。
前置条件
系列索引
| 篇章 | 标题 | 内容 |
|---|---|---|
| 第一篇 | 概述与环境配置 | Lycium 概念、构建机要求、OHOS SDK 配置 |
| 第二篇 | 项目结构与适配目录创建 | 目录结构、community vs thirdparty、创建适配目录 |
| 第三篇 | HPKBUILD 编写详解 | 元数据字段、过程函数、三种构建系统写法 |
| 第四篇 | 构建执行与产物获取 | 构建流程、日志分析、多库递归、HAP 集成 |
| 第五篇 | 流程图与角色职责 | 完整流程图、各角色职责、协作时序 |
| 第六篇 | 关键注意事项与最佳实践 | 依赖管理、架构超集、日志调试、外部适配仓 |
| 第七篇 | 快速参考与模板 | 入门步骤、模板、完整案例、检查清单 |
| 第八篇「番外」 | 扩展lycium框架使其满足rust三方库适配 | 不改变框架原有设计，增加Rust三方库适配能力 |
一、环境配置
1 OpenHarmony SDK 安装
1.1 下载 SDK（环境搭建）
- 在浏览器中打开 DCP 每日构建列表 ：https://dcp.openharmony.cn/workbench/cicd/dailybuild/dailylist
- 在列表中按本机操作系统选择对应产物（名称随版本变化，以页面为准）：
| 开发机系统 | 选择产物（关键词） |
|---|---|
| Windows / Linux | ohos-sdk-full（OHOS 全量 SDK，用于交叉编译） |
| macOS | mac-sdk-full（Mac 版 SDK 包） |
下载到本机后解压（请将下面文件名替换为你实际下载的包名）：
bash
cd ~
# Linux / macOS 示例（包名以 DCP 页面为准）
tar -zvxf <你下载的-sdk-xxx>.tar.gzWindows 请使用资源管理器或 7-Zip 等工具解压对应 .zip / .tar.gz 包。
说明 ：每日构建会更新版本与文件名，不要固定使用旧文档中的直链 ；以 DCP 页面上当前可下载的 SDK 包为准。解压后若顶层目录名不是
ohos-sdk，可将该目录移动或软链为~/ohos-sdk（或 Windows 下放到固定路径），与下文OHOS-SDK配置一致。
再进入 ohos-sdk 根目录 解压（文件名以 darwin 目录下为准，下例版本号仅作演示）：
bash
cd ~/ohos-sdk # Linux / macOS；Windows 请先 cd 到 OHOS_SDK 目录
unzip native-darwin-arm64-6.0.0.46-Beta1.zip
unzip toolchains-darwin-arm64-6.0.0.46-Beta1.zipWindows 可对两个 zip 右键解压到当前文件夹 ，或使用 tar/Expand-Archive 等工具解压到 ohos-sdk 根目录。
解压完成后，应得到 native/、toolchains/ 等目录（含 llvm、sysroot、hnpcli 等），再配置 2.1.3 中的环境变量。
1.2 SDK 目录结构
ohos-sdk/
├── native/
│ ├── llvm/bin/ # 编译器工具链
│ ├── sysroot/ # 系统根目录（头文件和库）
│ └── build-tools/ # 构建工具
└── toolchains/
└── hnpcli # HNP打包工具1.3 环境变量配置
编辑 ~/.zshrc（如果使用 zsh）或 ~/.bash_profile（如果使用 bash）：
bash
# OpenHarmony SDK 路径
export OHOS_SDK=~/ohos-sdk
# 添加到 PATH
export PATH="$OHOS_SDK/native/llvm/bin:$PATH"
export PATH="$OHOS_SDK/native/build-tools/cmake/bin:$PATH"
export PATH="$OHOS_SDK/toolchains/bin:$PATH"
# 验证
source ~/.zshrc # 或 source ~/.bash_profile1.4 验证 SDK 配置
bash
# 检查 SDK 路径
echo $OHOS_SDK
# 检查工具是否在 PATH 中
which clang
which cmake
which hnpcli
# 检查 SDK 工具目录
ls $OHOS_SDK/native/llvm/bin/
ls $OHOS_SDK/native/build-tools/cmake/bin/
ls $OHOS_SDK/toolchains/
# 验证工具版本
clang --version
cmake --version
hnpcli --version2 Rust 工具链安装
2.1 安装 Rust
bash
# 安装 Rust（如果未安装）
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/env
# 验证安装
rustc --version
cargo --version2.2 配置 Rust 环境变量
编辑 ~/.zshrc（如果使用 zsh）或 ~/.bash_profile（如果使用 bash）：
bash
# Rust 环境变量（通常由 rustup 自动添加）
source ~/.cargo/env
# 验证
source ~/.zshrc # 或 source ~/.bash_profile
rustc --version
cargo --version二、适配步骤
1. 分析tokei构建特性
tokei 由Rust语言编写，使用Cargo作为构建系统。
核心特性
-
极速性能
基于 Rust 开发，利用多线程并行扫描与高效的语法分析算法，可在毫秒级内完成大型仓库的代码统计，性能远超同类的
cloc/sloccount工具。 -
支持 150+ 编程语言
内置丰富的语言数据库（
languages.json），覆盖主流编程语言、脚本语言、标记语言、配置文件格式等，能准确识别每种语言的注释语法和文件扩展名。 -
精确的统计分类
- 准确区分代码行数（Code） 、注释行数（Comments） 、空白行数（Blanks），按语言分组展示统计结果；
- 支持按文件类型排序、按语言名称排序等多种展示方式，统计结果一目了然。
-
灵活的统计范围
- 支持统计单个文件、指定目录、整个项目仓库；
- 自动忽略
.gitignore中配置的文件和目录，无需手动排除； - 支持通过
--files选项列出每个文件的详细统计信息； - 支持
--sort参数按代码行数、文件名等维度排序输出。
-
多种输出格式
默认以美观的终端表格输出统计结果，同时支持 JSON、YAML、CBOR 等结构化格式输出，方便集成到 CI/CD 流水线或其他工具中进行二次处理。
-
轻量无依赖
编译后为单一二进制文件，无外部运行时依赖，即下即用。
2. 创建适配项目
参考前置条件列表完成lycium_plusplus交叉框架编译环境搭建，以及lycium_plusplus交叉框架代码克隆，在lycium_plusplus/RustAdapt创建目标库tokei适配目录为ohos-tokei。
为什么是
ohos-tokei？为了和源库名称做区分，表示该库用于ohos设备。
ohos-tokei创建可以借助编辑器工具（如VSCode）或者使用文件夹在lycium_plusplus/RustAdapt目录下创建目标库适配目录ohos-tokei，也可以执行以下命令进行创建。
shell
# 我将交叉编译框架克隆在根目录，此处可改为正确的目录地址
cd ~/lycium_plusplus/RustAdapt
mkdir ohos-tokei3. 编写HPKBUILD
然后将lycium/template/HPKBUILD.cargo拷贝到RustAdapt/ohos-tokei目录下，并重命名为HPKBUILD，HPKBUILD是lycium交叉编译框架完成编译构建的核心配置文件，定义包的元信息、依赖、构建和打包逻辑。需要根据模板在HPKBUILD开头声明tokei的基本信息，这些字段被lycium用于下载、组织和记录：
bash
# lycium_plusplus/RustAdapt/ohos-tokei/HPKBUILD
pkgname=tokei # 库名
pkgver=14.0.0 # 库版本
pkgrel=0 # 发布号
pkgdesc="Count your code, quickly." # 库描述
url="https://github.com/XAMPPRocky/tokei" # 官网链接
archs=("arm64-v8a") # cpu 架构
license=("MIT OR Apache-2.0")
depends=() # 依赖库的目录名 必须保证被依赖的库的archs是当前库的archs的超集
makedepends=("cargo" "rustc") # 构建库时的依赖工具->需要用户安装的工具
source="https://github.com/XAMPPRocky/tokei/archive/refs/tags/v${pkgver}.tar.gz" # 库源码下载链接
downloadpackage=true # 是否自动下载压缩包，如若不写默认 true. (应对一些特殊情况，代码只能 git clone (项目中依赖 submoudle ))
autounpack=true # 是否自动解压，如若不写默认 true, 如果为 false 则需要用户在 prepare 函数中自行解压
buildtools=cargo # 编译方法: cmake(默认) | configure | cargo | 其它则不在此注入 buildargs，由 build() 自行处理
builddir=tokei-${pkgver} # 源码压缩包解压后目录名 编译目录名
packagename=$builddir.tar.gz # 压缩包名| 字段 | 配置值 | 用途 |
|---|---|---|
pkgname |
tokei |
pkgname=tokei：包名，用于在 LYCIUM_ROOT/usr/ 下创建安装目录、标识依赖关系。 |
pkgver |
14.0.0 |
pkgver=14.0.0：上游版本号，与 https://github.com/XAMPPRocky/tokei 仓库最新发行版本保持一致。 |
pkgrel |
0 |
pkgrel=0：包发布号，当同一上游版本需要重新打包时递增，首次适配为 0。 |
pkgdesc |
- | 包的简短描述，取自 tokei 官方 README。 |
url |
- | 上游项目主页 URL。 |
archs |
("arm64-v8a") |
archs=("arm64-v8a")：声明支持的架构数组。此处仅列出 arm64-v8a，但代码内部实际也处理了 armeabi-v7a 和 x86_64，此处是声明"主要支持"而非"仅支持"。当前鸿蒙 PC 设备为 arm64 架构，因此必须配置arm64-v8a。 |
license |
("MIT OR Apache-2.0") |
tokei 采用 MIT OR Apache-2.0 协议 |
depends |
() |
无运行时依赖。 |
makedepends |
("cargo" "rustc") |
makedepends=("cargo" "rustc")：编译时依赖。Rust 工具链是构建前提。 |
source |
refs/tags/${pkgver}.tar.gz |
源码包下载地址。使用 ${pkgver} 变量拼接，下载 tokei 14.0.0 的 release tarball。 |
downloadpackage |
true |
downloadpackage=true：告诉 lycium 构建系统自动下载 source 指定的源码包。如果设置为false需要在目标库目录下手动下载源码包。 |
autounpack |
true |
autounpack=true：下载后自动解压，无需手动解压步骤。如果设置为false需要手动解压。 |
buildtools |
cargo |
buildtools=cargo：声明构建工具类型。lycium 据此选择 Cargo 构建流程（而非 make/cmake 等）。 |
builddir |
tokei-${pkgver} |
builddir=tokei-${pkgver}：解压后的源码目录名。prepare()/build()/package() 均通过 cd $builddir 进入此目录。 |
packagename |
${builddir}.tar.gz |
packagename=${builddir}.tar.gz：源码包文件名，用于校验/定位。 |
还需要修改package函数中编译完成后的二进制文件名称，tokei项目编译完成后，会产出一个名为tokei的二进制文件，此处需要将cp target/${OHOS_RUST_TARGET}/release/xxx改为cp target/${OHOS_RUST_TARGET}/release/tokei并复制到安装目录。
sh
# 打包安装
package() {
# 进入 Rust 项目目录（和编译时同一个目录）
cd $builddir
# 定义安装路径：鸿蒙库的安装目录
DEST="$LYCIUM_ROOT/usr/$pkgname/$ARCH"
# 创建安装目录bin 文件夹
mkdir -p $DEST/bin/
# 【关键】把编译好的 Rust 程序 → 复制到目标目录的 bin 文件夹
cp target/${OHOS_RUST_TARGET}/release/tokei "$DEST/bin/"
cd $OLDPWD
}4 HNP 打包配置
在lycium_plusplus/RustAdapt/ohos-tokei目录下创建hnp.json文件，因为在HPKBUILD中存在archive函数，用于将产物打包为 output/<arch>/<pkgname>_<ver>.tar.gz，或执行 HNP 打包，详细介绍可参考系列索引-构建执行与产物获取。
json
{
"type": "hnp-config",
"name": "tokei",
"version": "14.0.0",
"install": {}
}5 交叉编译并解决可能存在的问题
HPKBUILD中函数不做改变，在lycium_plusplus/lycium目录下打开终端工具，输入./build.sh ohos-tokei进行第一次交叉编译。
如果提示ALL JOBS DONE!!!表示当前交叉编译没有问题，编译后的产物，可以在lycium/usr/目录和out/arm64-v8目录下查看。
三、 在鸿蒙PC上验证交叉编译后的tokei命令是否可用
将lycium_plusplus/lycium/usr/tokei/arm64-v8a/bin/tokei二进制文件传到鸿蒙PC上，方式有多种，可以通过聊天软件。macos设备可以在App Store下载【鸿蒙星河互联】，通过分享方式将tokei二进制文件发送到鸿蒙PC设备上，这种方式需要鸿蒙PC开启华为分享为所有人可见。在鸿蒙PC右下角会弹出接受弹窗，选择"接受"或者"另存为"，接受tokei二进制文件。接受后的二进制文件是不可以直接运行的，哪怕使用chmod +x tokei这种方式授权也是无法运行的。需要给二进制文件进行签名后才可以，在鸿蒙 PC 侧执行前涉及二进制签名流程，可参考《鸿蒙PC端二进制文件签名命令行使用指南》。打开鸿蒙PC终端，输入以下命令为tokei签名授权。
sh
# 进入tokei所在目录
cd Desktop
# 执行签名
binary-sign-tool sign -inFile tokei -outFile tokei -selfSign "1"
# 授予权限
chmod +x tokei
# 查看tokei版本
./tokei --version
# 查看tokei帮助
./tokei --help
# 统计当前目录代码
./tokei
四、 FAQ
执行签名命令出现"zsh: command not found: binary-sign-tool"提示。
需要在应用市场搜索DevBox并安装，DevBox提供了一些开发者常用命令，主要包含文件和目录操作命令、网络命令、构建命令、签名工具等。
