HarmonyOS Next开发学习手册——获取并使用公共目录
通过 ArkTS 接口获取并访问公共目录目录环境能力接口(ohos.file.environment)提供获取公共目录路径的能力,支持三方应用在公共文件用户目录下进行文件访问操作。
约束限制
[*]使用此方式,需确认设备具有以下系统能力:SystemCapability.FileManagement.File.Environment.FolderObtain。
if (!canIUse('SystemCapability.FileManagement.File.Environment.FolderObtain')) {
console.error('this api is not supported on this device');
return;
}
[*]公共目录获取接口仅用于获取公共目录路径,不对公共目录访问权限进行校验。若需访问公共目录需申请对应的公共目录访问权限。三方应用必要访问公共目录时,需通过弹窗授权向用户申请授予 Download 目录权限、Documents 目录权限或 Desktop 目录权限,具体参考 访问控制-向用户申请授权。
"requestPermissions" : [
"ohos.permission.READ_WRITE_DOWNLOAD_DIRECTORY",
"ohos.permission.READ_WRITE_DOCUMENTS_DIRECTORY",
"ohos.permission.READ_WRITE_DESKTOP_DIRECTORY",
]
示例
[*]获取公共目录路径。
import { BusinessError } from '@kit.BasicServicesKit';
import { Environment } from '@kit.CoreFileKit';
function getUserDirExample() {
try {
const downloadPath = Environment.getUserDownloadDir();
console.info(`success to getUserDownloadDir: ${downloadPath}`);
const documentsPath = Environment.getUserDocumentDir();
console.info(`success to getUserDocumentDir: ${documentsPath}`);
const desktopPath = Environment.getUserDesktopDir();
console.info(`success to getUserDesktopDir: ${desktopPath}`);
} catch (error) {
const err: BusinessError = error as BusinessError;
console.error(`failed to get user dir, because: ${JSON.stringify(err)}`);
}
}
[*]以 Download 目录为例,访问 Download 目录下的文件。
import { BusinessError } from '@kit.BasicServicesKit';
import { Environment } from '@kit.CoreFileKit';
import { fileIo as fs } from '@kit.CoreFileKit';
import { common } from '@kit.AbilityKit';
function readUserDownloadDirExample() {
// 检查是否具有 READ_WRITE_DOWNLOAD_DIRECTORY 权限,无权限则需要向用户申请授予权限。
try {
// 获取 Download 目录
const downloadPath = Environment.getUserDownloadDir();
console.info(`success to getUserDownloadDir: ${downloadPath}`);
const context = getContext() as common.UIAbilityContext;
const dirPath = context.filesDir;
console.info(`success to get filesDir: ${dirPath}`);
// 查看 Download 目录下的文件并拷贝到沙箱目录中
let fileList: string[] = fs.listFileSync(downloadPath);
fileList.forEach((file, index) => {
console.info(`${downloadPath} ${index}: ${file}`);
fs.copyFileSync(`${downloadPath}/${file}`, `${dirPath}/${file}`);
});
// 查看沙箱目录下对应的文件
fileList = fs.listFileSync(dirPath);
fileList.forEach((file, index) => {
console.info(`${dirPath} ${index}: ${file}`);
});
} catch (error) {
const err: BusinessError = error as BusinessError;
console.error(`Error code: ${err.code}, message: ${err.message}`);
}
}
[*]以 Download 目录为例,保存文件到 Download 目录。
import { BusinessError } from '@kit.BasicServicesKit';
import { Environment } from '@kit.CoreFileKit';
import { fileIo as fs } from '@kit.CoreFileKit';
function writeUserDownloadDirExample() {
// 检查是否具有 READ_WRITE_DOWNLOAD_DIRECTORY 权限,无权限则需要向用户申请授予权限。
try {
// 获取 Download 目录
const downloadPath = Environment.getUserDownloadDir();
console.info(`success to getUserDownloadDir: ${downloadPath}`);
// 保存 temp.txt 到 Download 目录下
const file = fs.openSync(`${downloadPath}/temp.txt`, fs.OpenMode.CREATE | fs.OpenMode.READ_WRITE);
fs.writeSync(file.fd, 'write a message');
fs.closeSync(file);
} catch (error) {
const err: BusinessError = error as BusinessError;
console.error(`Error code: ${err.code}, message: ${err.message}`);
}
}
通过 C/C++ 接口获取并使用公共目录
除了通过 ArkTS 访问公共目录的方式,也可通过 C/C++ 接口进行目录访问,具体可以参考 Environment。
约束限制
[*]使用此接口,需确认设备具有以下系统能力:SystemCapability.FileManagement.File.Environment.FolderObtain。
[*]三方应用必要访问公共目录时,需通过弹窗授权向用户申请授予 Download 目录权限、Documents 目录权限或 Desktop 目录权限,具体参考访问控制-向用户申请授权。
接口说明
接口的具体说明,请参考API参考
接口名称描述FileManagement_ErrCode OH_Environment_GetUserDownloadDir (char **result)获取用户Download目录沙箱路径。只支持2in1设备FileManagement_ErrCode OH_Environment_GetUserDesktopDir (char **result)获取用户Desktop目录沙箱路径。只支持2in1设备FileManagement_ErrCode OH_Environment_GetUserDocumentDir (char **result)获取用户Document目录沙箱路径。只支持2in1设备 开发步骤
在CMake脚本中链接动态库
CMakeLists.txt中添加以下lib。
target_link_libraries(sample PUBLIC libohenvironment.so libhilog_ndk.z.so)
添加头文件
#include <filemanagement/environment/oh_environment.h>
#include <filemanagement/fileio/oh_fileio.h>
#include <hilog/log.h>
[*]调用 OH_Environment_GetUserDownloadDir 接口获取用户 Download 目录沙箱路径,在接口中使用malloc申请的内存必要在使用完后开释因此必要free对应的内存。示例代码如下所示:
void GetUserDownloadDirExample()
{
char *downloadPath = nullptr;
FileManagement_ErrCode ret = OH_Environment_GetUserDownloadDir(&downloadPath);
if (ret == 0) {
OH_LOG_INFO(LOG_APP, "Download Path=%{public}s", downloadPath);
free(downloadPath);
} else {
OH_LOG_ERROR(LOG_APP, "GetDownloadPath fail, error code is %{public}d", ret);
}
}
[*]调用 OH_Environment_GetUserDownloadDir 接口获取用户 Download 目录沙箱路径,并查看 Download 目录下的文件。示例代码如下所示:
void ScanUserDownloadDirPathExample()
{
// 获取 download 路径
char *downloadPath = nullptr;
FileManagement_ErrCode ret = OH_Environment_GetUserDownloadDir(&downloadPath);
if (ret == 0) {
OH_LOG_INFO(LOG_APP, "Download Path=%{public}s", downloadPath);
} else {
OH_LOG_ERROR(LOG_APP, "GetDownloadPath fail, error code is %{public}d", ret);
return;
}
// 查看文件夹下的文件
struct dirent **namelist = {nullptr};
int num = scandir(downloadPath, &namelist, nullptr, nullptr);
if (num < 0) {
free(downloadPath);
OH_LOG_ERROR(LOG_APP, "Failed to scan dir");
return;
}
for (int i = 0; i < num; i++) {
OH_LOG_INFO(LOG_APP, "%{public}s", namelist->d_name);
}
free(downloadPath);
free(namelist);
}
[*]调用 OH_Environment_GetUserDownloadDir 接口获取用户 Download 目录沙箱路径,并保存 temp.txt 到 Download 目录下。示例代码如下所示:
void WriteUserDownloadDirPathExample()
{
// 获取 download 路径
char *downloadPath = nullptr;
FileManagement_ErrCode ret = OH_Environment_GetUserDownloadDir(&downloadPath);
if (ret == 0) {
OH_LOG_INFO(LOG_APP, "Download Path=%{public}s", downloadPath);
} else {
OH_LOG_ERROR(LOG_APP, "GetDownloadPath fail, error code is %{public}d", ret);
return;
}
// 保存文件到 download 目录下
std::string filePath = std::string(downloadPath) + "/temp.txt";
free(downloadPath);
std::ofstream outfile;
outfile.open(filePath.c_str());
if (!outfile) {
OH_LOG_ERROR(LOG_APP, "Failed to open file");
return;
}
std::string msg = "Write a message";
outfile.write(msg.c_str(), sizeof(msg));
outfile.close();
}
鸿蒙全栈开发全新学习指南
有很多小伙伴不知道学习哪些鸿蒙开发技术?不知道必要重点把握哪些鸿蒙应用开发知识点?而且学习时频繁踩坑,最终浪费大量时间。以是要有一份实用的鸿蒙(HarmonyOS NEXT)学习门路与学习文档用来跟着学习好坏常有须要的。
针对一些列因素,整理了一套纯血版鸿蒙(HarmonyOS Next)全栈开发技术的学习门路,包罗了鸿蒙开发必把握的焦点知识要点,内容有(ArkTS、ArkUI开发组件、Stage模型、多端摆设、分布式应用开发、WebGL、元服务、OpenHarmony多媒体技术、Napi组件、OpenHarmony内核、OpenHarmony驱动开发、系统定制移植等等)鸿蒙(HarmonyOS NEXT)技术知识点。
本门路共分为四个阶段:
第一阶段:鸿蒙初中级开发必备技能
https://img-blog.csdnimg.cn/direct/50513a90f3bf4d169cc892232794263c.png#pic_center
第二阶段:鸿蒙南北双向高工技能底子:gitee.com/MNxiaona/733GH
https://img-blog.csdnimg.cn/direct/350e757aac894a3cb655cf334e1df47b.png
第三阶段:应用开发中高级就业技术
https://img-blog.csdnimg.cn/direct/55709e9664824aebb329325124ad7dd2.png
第四阶段:全网首发-工业级南向设备开发就业技术:gitee.com/MNxiaona/733GH
https://img-blog.csdnimg.cn/direct/9655f4c1cf1249559ba98372e17c6a17.png
《鸿蒙 (Harmony OS)开发学习手册》(共计892页)
如何快速入门?
1.基本概念
2.构建第一个ArkTS应用
3.……
https://img-blog.csdnimg.cn/direct/41127b7024bf4c2aacf98f6e5d8aaf4e.png
开发底子知识:gitee.com/MNxiaona/733GH
1.应用底子知识
2.配置文件
3.应用数据管理
4.应用安全管理
5.应用隐私保护
6.三方应用调用管控机制
7.资源分类与访问
8.学习ArkTS语言
9.……
https://img-blog.csdnimg.cn/direct/47ff5221520f4fd29b4b344040b6c910.png
基于ArkTS 开发
1.Ability开发
2.UI开发
3.公共变乱与通知
4.窗口管理
5.媒体
6.安全
7.网络与链接
8.电话服务
9.数据管理
10.后台任务(Background Task)管理
11.设备管理
12.设备使用信息统计
13.DFX
14.国际化开发
15.折叠屏系列
16.……
https://img-blog.csdnimg.cn/direct/dde1b78b86224ce5ae8dbc84fea54eba.png
鸿蒙开发面试真题(含参考答案):gitee.com/MNxiaona/733GH
https://img-blog.csdnimg.cn/direct/6ecd0695d29b44b3acd452cb350131f1.png
鸿蒙入门讲授视频:
https://img-blog.csdnimg.cn/direct/6c4a4627851541cabe0f7614bcb2c0e8.png
美团APP实战开发讲授:gitee.com/MNxiaona/733GH
https://img-blog.csdnimg.cn/direct/84ad2d4eaec84d16acfeab591834605d.png
写在最后
[*]如果你觉得这篇内容对你还蛮有资助,我想邀请你帮我三个小忙:
[*]点赞,转发,有你们的 『点赞和评论』,才是我创造的动力。
[*]关注小编,同时可以期待后续文章ing
页:
[1]