更新记录

1.0.0(2026-11-18)

第一版


平台兼容性

uni-app(4.51)

Vue2 Vue3 Chrome Safari app-vue app-nvue Android iOS 鸿蒙
√ √ - - √ √ 6.0 15 √
微信小程序 支付宝小程序 抖音小程序 百度小程序 快手小程序 京东小程序 鸿蒙元服务 QQ小程序 飞书小程序 小红书小程序 快应用-华为 快应用-联盟
- - - - - - - - - - - -

uni-app x(4.51)

Chrome Safari Android iOS 鸿蒙 微信小程序
- - 6.0 15 √ -

其他

多语言 暗黑模式 宽屏模式 蒸汽模式
× × × √

wen-image-archive

图片与文件归档、ZIP / TAR / GZIP / XZ / LZMA / LZO 压缩和校验。

功能介绍

  1. 系统选择器选取图片和文件,查询本机归档资源。
  2. 六种归档或压缩格式,配置压缩级别、文件名与任务限制。
  3. 任务进度、取消、哈希校验及失败后的资源释放。
  4. 归档预览、分享、系统文档目录导出与清理。

平台兼容性

项目 要求
HBuilderX 5.26 或更新版本
uni-app / uni-app x Vue 3;原生 App
Android API 23 起;部分系统能力有更高版本要求
iOS 15.0 起;以设备能力及宿主配置为准
HarmonyOS 使用 app-harmony 源码及其声明的 SDK / 权限
Web / 小程序 不提供原生能力

插件测试使用方法

  1. 在插件市场绑定自己的项目 AppID,将插件导入项目的 uni_modules/wen-image-archive。本地使用时也可直接复制完整插件目录。
  2. 打开“示例项目”,在 HBuilderX 的 manifest 中填写自己的 AppID。需要第三方服务时填写自己申请的配置。
  3. 制作包含本插件的自定义基座,或重新云打包 App。标准基座、WGT 热更新不能增加原生模块。
  4. 安装到真机,授予本次操作所需的系统权限,再使用页面中的功能按钮。
  5. 更换原生依赖、权限或平台配置后重新打包。示例源码和文档不附带 Key、Token、账号密码或签名私钥。

使用示例

import { nativeImageArchiveRequest } from '@/uni_modules/wen-image-archive'

nativeImageArchiveRequest('capabilities', JSON.stringify({}), (raw: string) => {
  const result = JSON.parseObject(raw)
  if (result == null) return
  if (result.getNumber('code') != 0) {
    uni.showToast({ title: result.getString('message') ?? '操作失败', icon: 'none' })
    return
  }
  console.log(result['data'])
})

API 介绍

原生入口接收 operation、JSON 字符串 payload 和回调。回调统一返回 { code, message?, data? };code 为 0 表示成功。

nativeImageArchiveRequest

nativeImageArchiveRequest(operation: string, payload: string, done: (result: string) => void): void

packImageGroups

packImageGroups(groupsJson:string,optionsJson:string,done:(result:string)=>void):void

compressImageGroups

compressImageGroups(groups:UTSJSONObject[],options:UTSJSONObject=

在项目页面中定制

场景预设、按钮排版、页面文案和配色由示例项目的 pages 目录及项目自身的公共文件管理;安装插件不需要接收这些页面。可以直接修改页面,或按自己的设计重新编写。插件只提供原生能力、参数默认值及校验,不再导出业务 PRESETS。

分组归档参数与结果

普通 uni-app 从 client.js 导入 compressImageGroups。source 使用用户授权或应用可读的本机文件 URI,或显式提供的下载地址;name 是归档内文件名,path / targetPath 只是业务元数据。HTTP 与跨来源重定向默认不开放,需要按业务明确配置。

export type ArchiveFormat='zip'|'tar'|'tar.gz'|'gzip'|'tar.lzma'|'lzma'|'tar.xz'|'xz'|'tar.lzo'|'lzo1x';
export interface ArchiveFileInput {name:string;source:string;type?:string;/** Projector destination metadata, never used as an archive path. */path?:string;targetPath?:string;md5?:string;sizeByte?:number;headers?:Record<string,string>}
export interface ArchiveGroupInput {name:string;format?:ArchiveFormat;list:ArchiveFileInput[]}
export interface ArchiveOptions {format?:ArchiveFormat;compressionLevel?:number;bufferKiB?:number;lzmaDictMiB?:number;parallelGroups?:1|2;timeoutMs?:number;downloadRetries?:number;allowHttp?:boolean;allowCrossOriginRedirects?:boolean;maxFileBytes?:number;maxTotalBytes?:number;maxOutputBytes?:number;zipMethod?:'store'|'deflate';tarLongNames?:'pax'|'ustar';errorMode?:'failFast'|'continue'}
export interface ArchiveFileResult {name:string;type:string;path:string;md5:string;sha256:string;sizeByte:number;archivePath:string}
export interface ArchiveSuccess {success:true;name:string;format:string;container:'zip'|'tar';codec:string;jobId:string;outputId:string;filePath:string;fileUri:string;contentUri:string;sizeByte:number;sourceBytes:number;md5:string;sha256:string;compressionRatio:number|null;compressionMs:number;elapsedMs:number;list:ArchiveFileResult[]}
export interface ArchiveError {success:false;name:string;format:string;code:number;message:string}
export type ArchiveResult=ArchiveSuccess|ArchiveError;
export declare function nativeImageArchiveRequest(operation:string,payload:string,done:(raw:string)=>void):void;
export declare function packImageGroups(groupsJson:string,optionsJson:string,done:(raw:string)=>void):void;
export declare function compressImageGroups(groups:ArchiveGroupInput[],options?:ArchiveOptions):Promise<ArchiveResult[]>;

使用注意

  • 不同压缩格式的多文件支持不同,按 capabilities 和参数校验选择。
  • 高压缩率会增加时间与内存消耗,大文件请设置任务限制并观察进度。
  • 只处理用户选取或应用获准访问的文件,云端上传地址和请求凭据默认为空。

隐私、权限声明

1. 本插件需要申请的系统权限列表

<uses-permission android:name="android.permission.INTERNET"/>

iOS 用途说明在 app-ios/Info.plist 中,鸿蒙权限在 app-harmony/module.json5 中;宿主仍需按实际业务说明用途并配置能力。

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明

处理用户选取的图片、文件、归档及校验信息;默认在本机处理,远程下载或上传仅使用用户显式提供的地址。

3. 本插件是否包含广告

不包含广告。

隐私、权限声明

1. 本插件需要申请的系统权限列表:

Android:INTERNET,用于读取用户指定的远程图片或文件。图片和文档通过系统选择器授权访问,插件自身不以申请全部存储空间访问权限作为默认前提。 iOS:通过系统图片、文档选择器或应用已获准访问的文件路径处理文件;插件当前未声明额外的相机、麦克风和定位权限。 HarmonyOS:INTERNET,用于远程资源读取;本机文件通过系统选择器及授权方式访问。

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

插件不采集任何数据

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

无

暂无用户评论。