因为经常会用到文件操作相关的功能,而uniapp提供的H5+ IO模块管理本地文件系统,局限性真的非常非常大 ,所以写了一个原生的安卓文件操作插件。
功能包括:创建目录、创建txt文件并写入内容、复制/移动/重命名/删除目录或文件、调用本机应用打开或分享文件、压缩/解压目录或文件、base64数据和本地图片的相互转换、获取文件列表等。
下面放了示例apk的二维码,感兴趣的可以下载体验一下:
插件地址
安卓文件操作插件 - DCloud 插件市场 https://ext.dcloud.net.cn/plugin?id=7983#detail
平台兼容性
Android | iOS |
---|---|
适用版本区间:5.0 - 11.0 支持CPU类型:armeabi-v7a,arm64-v8a,x86 | × |
1、权限接口
1.1 判断并授权所有文件的管理权限
getFileManagePermission(res=>{
console.log(res);
res={
"hasPermission":true/false
}
});
2、文件操作接口
在调用文件操作接口之前,请先获取所有文件的管理权限
2.1 获取公共目录路径
getPublicPath({
type: 0, //见注释1,0:获取外部存储目录路径
},res=>{
console.log(res);
res={
"code": 0,
"message": "获取成功",
"data":"获取的路径"
}
res={
"code": 1,
"message": "获取失败",
}
})
2.2 创建目录
createDirectory({
dirPath:"",//目录,使用绝对路径
},res=>{
console.log(res);
res={
"code": 0,
"message": "目录创建成功",
}
res={
"code": 1,
"message": "目录创建失败",
}
res={
"code": 2,
"message": "目录已存在",
}
})
2.3 创建TXT文件,并写入内容
createTxtFile({
dirPath: "", // 文件所在目录,目录不存在则自动创建,使用绝对路径
fileName: "", // 文件名称,不要添加后缀名,例如:MyTestFile
messages: [], // 文件内容,字符串数组格式,写入时自动换行,例如:["第一条信息","第二条信息"]
append: true, // true:文件已存在时在原文件内追加内容,false:文件已存在时覆盖原文件
},res=>{
console.log(res);
res={
"code": 0,
"message": "文件创建成功"
}
res={
"code": 1,
"message": "文件创建失败"
}
})
2.4 复制目录或文件
copyFile({
fromPath: "", //待复制的目录或文件,使用绝对路径
toPath: "", //要粘贴到的目录,目录不存在时自动创建,使用绝对路径
},res=>{
console.log(res);
res={
"code": 0,
"message": "复制成功",
}
res={
"code": 1,
"message": "复制失败",
}
res={
"code": 2,
"message": "目录或文件不存在",
}
res={
"code": 3,
"message": "其他错误原因",
}
})
2.5 重命名目录或文件
renameFile({
oldPath: "", //待重命名的目录或文件,使用绝对路径
newPath: "", //新目录或文件,使用绝对路径
},res=>{
console.log(res);
res={
"code": 0,
"message": "重命名成功",
}
res={
"code": 1,
"message": "重命名失败",
}
res={
"code": 2,
"message": "目录或文件不存在",
}
})
2.6 移动目录或文件
(本质上是先复制,再删除原文件)
moveFile({
fromPath: "", //待移动的目录或文件,使用绝对路径
toPath: "", //要移动到的目录,目录不存在时自动创建,使用绝对路径
},res=>{
console.log(res);
res={
"code": 0,
"message": "移动成功"
}
res={
"code": 1,
"message": "移动失败",
}
res={
"code": 2,
"message": "目录或文件不存在",
}
})
2.7 删除目录或文件
deleteFile({
path: "", //目录或文件,使用绝对路径
},res=>{
console.log(res);
res={
"code": 0,
"message": "删除成功",
}
res={
"code": 1,
"message": "删除失败",
}
res={
"code": 2,
"message": "目录或文件不存在",
}
})
2.8 获取"当前目录"或"当前文件所在目录"下的所有文件和文件夹列表
getFileList({
path: "", //目录或文件,使用绝对路径
},res=>{
console.log(res);
res={
"code": 0,
"message": "读取成功",
"data":[
{
"name":"文件名",
"path":"文件绝对路劲",
"isFile":"是否是文件",
"isDirectory":"是否是目录",
"lastModified":"最后一次修改时间",
"length":"文件大小",
}
……
]
}
res={
"code": 1,
"message": "读取失败",
}
res={
"code": 2,
"message": "目录或文件不存在",
}
})
2.9 调用本机应用打开文件
openFile({
filePath: '', //文件绝对路径
},res=>{
console.log(res);
res={
"code": 0,
"message": "调用成功",
}
res={
"code": 1,
"message": "调用失败",
}
})
2.10 调用本机应用分享文件
shareFile({
filePath: '', //文件绝对路径
},res=>{
console.log(res);
res={
"code": 0,
"message": "调用成功",
}
res={
"code": 1,
"message": "调用失败",
}
})
2.11 Base64Data转本地图片
调用saveBase64Data方法时,'data:image/jpeg;base64,' 需要替换成''
saveBase64Data({
base64Data: "", //base64数据,去掉开头的数据类型字符串"data:image/jpeg;base64,"
filePath: "",//输出的图片文件路径,使用绝对路径
},res=>{
console.log(res);
res={
"code": 0,
"message": "转换成功",
}
res={
"code": 1,
"message": "转换失败",
}
})
2.12 本地图片转Base64Data
getBase64Data({
filePath: '', //待处理的本地图片文件路径,使用绝对路径
},res=>{
console.log(res);
res={
"code": 0,
"message": "转换成功",
"data":'完整的base64数据'
}
res={
"code": 1,
"message": "转换失败",
}
})
2.13 压缩目录或文件
compressFile({
path:"", //要压缩的目录或文件,使用绝对路径
zipFilePath: "", //压缩完成的Zip文件路径,使用绝对路径,允许重命名压缩文件
},res=>{
console.log(res);
res={
"code": 0,
"message": "压缩成功",
}
res={
"code": 1,
"message": "压缩失败",
}
})
2.14 解压zip文件
extractFile({
zipFilePath: "", //要解压的Zip文件路径,使用绝对路径
dirPath: "", //输出目录,即解压后的目录或文件所在目录,使用绝对路径
rename: "",//重命名解压文件,可选参数
},res=>{
console.log(res);
res={
"code": 0,
"message": "解压成功",
}
res={
"code": 1,
"message": "解压失败",
}
})
2.15 通过安卓存储访问框架打开目录
openDirectoryBySAF({
dirPath: "", //目录,使用绝对路径
},res=>{
console.log(res);
res={
"code": 0,
"message": "打开成功",
}
res={
"code": 1,
"message": "打开失败",
}
})
3、注释
3.1 获取公共目录路径
type | 说明 |
---|---|
0 | 获取外部存储目录 |
1 | 获取应用私有目录 |
2 | 获取公共文档目录 |
3 | 获取公共下载目录 |
4 | 获取DCIM(相册)目录 |
5 | 获取公共图片目录 |
6 | 获取公共视频目录 |
7 | 获取公共音乐目录 |