更新记录
0.0.2(2025-09-15) 下载此版本
修复路径问题
0.0.1(2025-09-15) 下载此版本
支持根据已有配置重命名插件
平台兼容性
HbuilderX/cli最低兼容版本 |
---|
3.6.9 |
HBuilderX插件通用注意事项
HBuilderX-2.7.12以下版本安装插件市场内的插件后,卸载时需手动卸载,详细教程参考:如何手动卸载插件
# APK 重命名插件使用说明
插件简介
这是一个专为 HBuilderX 开发的插件,用于自动重命名 UniApp 云打包后的 APK 文件。插件可以根据配置自动将 APK 文件重命名为更规范的格式,并复制到指定目录。
功能特性
- ✅ 自动读取 UniApp 项目的 manifest.json 配置
- ✅ 支持自定义 APK 文件命名规则
- ✅ 支持日期时间戳自动添加
- ✅ 支持只处理最新生成的 APK 文件
- ✅ 自动创建目标目录并清空旧文件
- ✅ 文件名冲突自动处理(添加序号)
- ✅ 详细的处理日志输出
安装方法
- 将插件文件夹复制到 HBuilderX 的插件目录
- 在 HBuilderX 中启用插件
- 重启 HBuilderX
配置说明
1. 创建配置文件
在项目根目录创建 apk-config.json
文件:
{
"packageName": "com.example.app",
"versionName": "1.0.0",
"isDate": true,
"isLastDate": true,
"date": ""
}
2. 配置参数说明
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
packageName |
string | 否 | "com.example.app" | 应用包名,用于 APK 文件命名 |
versionName |
string | 否 | manifest.json 中的版本号 | 应用版本号 |
isDate |
boolean | 否 | true | 是否在文件名中添加日期时间戳 |
isLastDate |
boolean | 否 | true | 是否只处理最新生成的 APK 文件 |
date |
string | 否 | "" | 自定义日期字符串,当 isDate 为 false 时使用 |
使用方法
方法一:通过 HBuilderX 右键菜单
- 在 HBuilderX 中打开 UniApp 项目
- 完成云打包后,在编辑器右键菜单中找到"重命名 APK"选项
- 点击执行重命名操作
方法二:通过命令行
# 在项目根目录执行
node main.js
文件路径说明
默认路径配置
- 源目录:
unpackage/release/apk/
- UniApp 云打包生成的 APK 文件目录 - 目标目录:
unpackage/apkremix/
- 重命名后的 APK 文件输出目录 - 配置文件:
apk-config.json
- 插件配置文件
自定义路径
可以通过构造函数参数自定义路径:
const plugin = new ApkRenamePlugin({
workspacePath: "/path/to/your/project",
configPath: "/path/to/your/config.json",
releaseDir: "/path/to/release/apk",
targetDir: "/path/to/output",
});
命名规则
默认命名格式
{packageName}-{versionName}-{timestamp}.apk
示例
- 包名:
com.example.app
- 版本:
1.0.0
- 时间戳:
20241201143025
(2024 年 12 月 1 日 14 点 30 分 25 秒)
最终文件名: com.example.app-1.0.0-20241201143025.apk
自定义命名
当 isDate
为 false
且 date
字段有值时:
{packageName}-{versionName}-{date}.apk
当 isDate
为 false
且 date
字段为空时:
{packageName}-{versionName}.apk
处理流程
- 读取配置: 从
apk-config.json
读取配置参数 - 读取 manifest: 从
manifest.json
读取应用信息 - 准备目录: 创建并清空目标目录
- 扫描 APK: 扫描源目录中的所有 APK 文件
- 筛选文件: 根据
isLastDate
配置决定处理哪些文件 - 重命名复制: 按照命名规则重命名并复制到目标目录
- 冲突处理: 如果文件名已存在,自动添加序号
日志输出
插件会输出详细的处理日志,包括:
- 📁 路径信息
- 📱 APK 文件处理状态
- ⚠️ 警告信息
- ❌ 错误信息
- ✔ 成功信息
- 🎉 完成统计
常见问题
Q: 插件无法找到 APK 文件?
A: 请确保已经完成 UniApp 云打包,并且 APK 文件位于 unpackage/release/apk/
目录中。
Q: 如何修改输出目录?
A: 可以通过构造函数参数或修改代码中的 targetDir
配置来指定自定义输出目录。
Q: 如何处理多个 APK 文件?
A: 将 isLastDate
设置为 false
,插件将处理源目录中的所有 APK 文件。
Q: 文件名冲突怎么办?
A: 插件会自动检测文件名冲突,并在重复文件名后添加序号(如 _1
, _2
等)。
开发信息
- 插件 ID: your.extension.id
- 插件名称: rename-apk
- 版本: 0.0.1
- 兼容性: HBuilderX 2.7.0+
- 依赖: plugin-manager
更新日志
v0.0.1
- 初始版本发布
- 支持基本的 APK 重命名功能
- 支持配置文件自定义
- 支持日期时间戳添加
- 支持最新文件筛选
技术支持
如有问题或建议,请通过以下方式联系:
- 查看 HBuilderX 官方文档: https://hx.dcloud.net.cn
- 提交 Issue 到项目仓库