harmony 鸿蒙开发用户文件管理器（仅对系统应用开放）
开发用户文件管理器（仅对系统应用开放）
OpenHarmony预置了FileManager文件管理器。系统应用开发者也可以根据需要，按以下指导自行开发文件管理器。
开发步骤
开发用户文件管理器的相关API详细介绍请参见API参考。
- 权限配置和导入模块。 申请ohos.permission.FILE_ACCESS_MANAGER和ohos.permission.GET_BUNDLE_INFO_PRIVILEGED权限，配置方式请参见申请应用权限。
说明：
ohos.permission.FILE_ACCESS_MANAGER是使用文件访问框架接口的基础权限。
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED权限可以用于查询系统内当前支持的文件管理服务端应用信息。
- 导入依赖模块。
import { fileAccess } from '@kit.CoreFileKit';
import { fileExtensionInfo } from '@kit.CoreFileKit';
其中fileAccess提供了文件基础操作的API，fileExtensionInfo提供了应用开发的关键结构体。
- 查询设备列表。 开发者可以获取当前系统所有文件管理服务端管理的设备属性，也可以获取某个文件管理服务端管理的设备属性。应用开发者可以按需过滤设备。
在文件访问框架中，使用RootInfo用于表示设备的属性信息。以下示例可以获取所有设备的RootInfo。
import { common } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { Filter } from '@kit.CoreFileKit';
// context是EntryAbility传过来的context，确保this.getUIContext().getHostContext()返回结果为UIAbilityContext
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
// 创建连接系统内所有文件管理服务端的helper对象
let fileAccessHelperAllServer: fileAccess.FileAccessHelper;
function createFileAccessHelper(context: common.UIAbilityContext): void {
try {
fileAccessHelperAllServer = fileAccess.createFileAccessHelper(context);
if (!fileAccessHelperAllServer) {
console.error("createFileAccessHelper interface returns an undefined object");
}
} catch (err) {
let error: BusinessError = err as BusinessError;
console.error("createFileAccessHelper failed, errCode:" + error.code + ", errMessage:" + error.message);
}
}
let rootInfos: Array<fileAccess.RootInfo> = [];
async function getRoots(): Promise<void>{
let rootIterator: fileAccess.RootIterator;
let isDone: boolean = false;
try {
rootIterator = await fileAccessHelperAllServer.getRoots();
if (!rootIterator) {
console.error("getRoots interface returns an undefined object");
return;
}
while (!isDone) {
let result = rootIterator.next();
console.info("next result = " + JSON.stringify(result));
isDone = result.done;
if (!isDone)
rootInfos.push(result.value);
}
} catch (err) {
let error: BusinessError = err as BusinessError;
console.error("getRoots failed, errCode:" + error.code + ", errMessage:" + error.message);
}
}
浏览目录。 在文件访问框架中，使用FileInfo表示一个文件（目录）的基础信息。开发者可以使用listfile接口遍历下一级所有文件（目录）的迭代器对象；也可以通过scanfile过滤指定目录，获取满足条件的迭代器对象。
listfile和scanfile接口当前支持RootInfo对象调用，可用于支撑遍历下一级文件或过滤整个目录树。同时，接口也支持FileInfo对象调用，用于支撑遍历下一级文件或过滤指定目录。
import { BusinessError } from '@kit.BasicServicesKit';
import { Filter } from '@kit.CoreFileKit';
// 从根目录开始
let rootInfos = [];
//rootInfos 从getRoots()获取
let rootInfo: fileAccess.RootInfo = rootInfos[0];
let fileInfos: Array<fileAccess.FileInfo> = [];
let isDone: boolean = false;
let filter: Filter = {suffix : [".txt", ".jpg", ".xlsx"]}; // 设定过滤条件
try {
let fileIterator = rootInfo.listFile(); // 遍历设备rootinfos[0]的根目录，返回迭代器对象
// let fileIterator = rootInfo.scanFile(filter); // 过滤设备rootinfos[0]满足指定条件的文件信息，返回迭代对象
if (!fileIterator) {
console.error("listFile interface returns an undefined object");
}
while (!isDone) {
let result = fileIterator.next();
console.info("next result = " + JSON.stringify(result));
isDone = result.done;
if (!isDone)
fileInfos.push(result.value);
}
} catch (err) {
let error: BusinessError = err as BusinessError;
console.error("listFile failed, errCode:" + error.code + ", errMessage:" + error.message);
}
// 从指定的目录开始
let fileInfoDir: fileAccess.FileInfo = fileInfos[0]; // fileInfoDir 表示某个目录信息
let subFileInfos: Array<fileAccess.FileInfo> = [];
let isDone02: boolean = false;
let filter02: Filter = {suffix : [".txt", ".jpg", ".xlsx"]}; // 设定过滤条件
try {
let fileIterator = fileInfoDir.listFile(); // 遍历特定的目录fileinfo，返回迭代器对象
// let fileIterator = rootInfo.scanFile(filter02); // 过滤特定的目录fileinfo，返回迭代器对象
if (!fileIterator) {
console.error("listFile interface returns an undefined object");
}
while (!isDone02) {
let result = fileIterator.next();
console.info("next result = " + JSON.stringify(result));
isDone02 = result.done;
if (!isDone02)
subFileInfos.push(result.value);
}
} catch (err) {
let error: BusinessError = err as BusinessError;
console.error("listFile failed, errCode:" + error.code + ", errMessage:" + error.message);
}
- 操作文件或目录。 开发者可以集成文件访问框架的接口，完成一些用户行为，比如删除文件（目录）、重命名文件（目录）、新建文件（目录）、移动文件（目录）等。以下示例展示了如何创建一个文件，其他接口请参见API参考。
import { BusinessError } from '@kit.BasicServicesKit';
// 以本地设备为例
// 创建文件
// 示例代码sourceUri是Download目录的fileinfo中的URI
// 开发者应根据自己实际获取fileinfo的URI进行开发
async function creatFile(): Promise<void> {
let sourceUri: string = "file://docs/storage/Users/currentUser/Download";
let displayName: string = "file1";
let fileUri: string = '';
try {
// fileAccessHelperAllServer 参考 fileAccess.createFileAccessHelper 示例代码获取
fileUri = await fileAccessHelperAllServer.createFile(sourceUri, displayName);
if (!fileUri) {
console.error("createFile return undefined object");
}
console.info("createFile sucess, fileUri: " + JSON.stringify(fileUri));
} catch (err) {
let error: BusinessError = err as BusinessError;
console.error("createFile failed, errCode:" + error.code + ", errMessage:" + error.message);
};
}
监听设备上下线
开发设备上下线的相关API详细介绍请参见API参考。
notify接口不仅可以用来监听目录的变化，还能监听设备上线，下线功能。
- 权限配置和导入模块。
申请ohos.permission.FILE_ACCESS_MANAGER和ohos.permission.GET_BUNDLE_INFO_PRIVILEGED权限，配置方式请参见访问控制授权申请。
说明：
ohos.permission.FILE_ACCESS_MANAGER是使用文件访问框架接口的基础权限。
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED权限可以用于查询系统内当前支持的文件管理服务端应用信息。
- 导入依赖模块。
import { fileAccess } from '@kit.CoreFileKit';
import { fileExtensionInfo } from '@kit.CoreFileKit';
其中fileAccess提供了文件基础操作的API，fileExtensionInfo提供了应用开发的关键结构体。
- 提供监听回调方法。
const callbackDir1 = (NotifyMessageDir: fileAccess.NotifyMessage) => {
if (NotifyMessageDir != undefined) {
console.log('NotifyType: ' + NotifyMessageDir.type + 'NotifyUri:' + NotifyMessageDir.uris[0]);
} else {
console.error("NotifyMessageDir is undefined");
}
}
- 注册监听设备和取消设备监听。
开发者可以根据提供的DEVICES_URI，传入方法registerObserver()中，就能监听设备上下线状态。传入方法unregisterObserver()中，就能取消设备上线，下线状态。
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
//提供监听回调方法
const callbackDir1 = (NotifyMessageDir: fileAccess.NotifyMessage) => {
if (NotifyMessageDir != undefined) {
console.log('NotifyType: ' + NotifyMessageDir.type + 'NotifyUri:' + NotifyMessageDir.uris[0]);
} else {
console.error("NotifyMessageDir is undefined");
}
}
// context是EntryAbility传过来的context，确保this.getUIContext().getHostContext()返回结果为UIAbilityContext
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
// 创建连接系统内所有文件管理服务端的helper对象
let fileAccessHelperAllServer: fileAccess.FileAccessHelper;
function createFileAccessHelper(context: common.UIAbilityContext): void {
try {
fileAccessHelperAllServer = fileAccess.createFileAccessHelper(context);
if (!fileAccessHelperAllServer) {
console.error("createFileAccessHelper interface returns an undefined object");
}
} catch (err) {
let error: BusinessError = err as BusinessError;
console.error("createFileAccessHelper failed, errCode:" + error.code + ", errMessage:" + error.message);
}
}
//注册监听设备,开发者可以根据提供的DEVICES_URI传入registerObserver()方法中，就能监听设备上线，下线状态。
async function UnregisterObserver03() {
try {
// 监听设备的上下线
fileAccessHelperAllServer.registerObserver(fileAccess.DEVICES_URI, true, callbackDir1);
} catch (err) {
let error: BusinessError = err as BusinessError;
console.error("unregisterObserver failed, errCode:" + error.code + ", errMessage:" + error.message);
}
}
//取消设备监听,开发者可以根据提供的DEVICES_URI传入unregisterObserver()方法中，就能取消设备上线，下线状态。
async function UnregisterObserver04() {
try {
// 取消监听设备的上下线
fileAccessHelperAllServer.unregisterObserver(fileAccess.DEVICES_URI, callbackDir1);
} catch (err) {
let error: BusinessError = err as BusinessError;
console.error("unregisterObserver failed, errCode:" + error.code + ", errMessage:" + error.message);
}
}
你可能感兴趣的鸿蒙文章
harmony 鸿蒙Core File Kit（文件基础服务）
0
赞
- 所属分类： 后端技术
- 本文标签：
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦