Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
DCloud
unidocs-uni-app-x-zh
提交
280c66e9
U
unidocs-uni-app-x-zh
项目概览
DCloud
/
unidocs-uni-app-x-zh
通知
144
Star
2
Fork
33
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
9
列表
看板
标记
里程碑
合并请求
11
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
U
unidocs-uni-app-x-zh
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
9
Issue
9
列表
看板
标记
里程碑
合并请求
11
合并请求
11
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
提交
280c66e9
编写于
12月 19, 2023
作者:
D
DCloud_LXH
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
feat: api env
上级
7dbcae26
变更
5
展开全部
隐藏空白更改
内联
并排
Showing
5 changed file
with
923 addition
and
25 deletion
+923
-25
docs/.vuepress/utils/utsApiJson.json
docs/.vuepress/utils/utsApiJson.json
+881
-1
docs/api/_sidebar.md
docs/api/_sidebar.md
+1
-0
docs/api/download-file.md
docs/api/download-file.md
+1
-1
docs/api/env.md
docs/api/env.md
+15
-0
docs/api/file-system-spec.md
docs/api/file-system-spec.md
+25
-23
未找到文件。
docs/.vuepress/utils/utsApiJson.json
浏览文件 @
280c66e9
此差异已折叠。
点击以展开。
docs/api/_sidebar.md
浏览文件 @
280c66e9
...
@@ -3,6 +3,7 @@
...
@@ -3,6 +3,7 @@
*
[
getApp
](
get-app.md
)
*
[
getApp
](
get-app.md
)
*
[
getCurrentPages
](
get-current-pages.md
)
*
[
getCurrentPages
](
get-current-pages.md
)
*
基础
*
基础
*
[
uni.env
](
env.md
)
*
[
事件总线event-bus
](
event-bus.md
)
*
[
事件总线event-bus
](
event-bus.md
)
*
[
拦截器
](
interceptor.md
)
*
[
拦截器
](
interceptor.md
)
*
[
获取启动参数
](
get-launch-options-sync.md
)
*
[
获取启动参数
](
get-launch-options-sync.md
)
...
...
docs/api/download-file.md
浏览文件 @
280c66e9
...
@@ -13,7 +13,7 @@
...
@@ -13,7 +13,7 @@
+
如需主动删除下载文件,使用
[
uni.getFileSystemManager
](
get-file-system-manager.md
)
。
+
如需主动删除下载文件,使用
[
uni.getFileSystemManager
](
get-file-system-manager.md
)
。
+
默认下载路径为外置应用沙盒目录
`uni.env.CACHE_PATH/cache/uni-download`
。但在HBuilderX 3.99前有过几次变更,3.98的目录是
`uni.env.CACHE_PATH/cache/uniDownloads`
,而3.98之前则不在cache目录下。
+
默认下载路径为外置应用沙盒目录
`uni.env.CACHE_PATH/cache/uni-download`
。但在HBuilderX 3.99前有过几次变更,3.98的目录是
`uni.env.CACHE_PATH/cache/uniDownloads`
,而3.98之前则不在cache目录下。
*
filePath暂未支持
uni.env
*
filePath暂未支持
[
uni.env
](
./env.md
)
<!-- UTSAPIJSON.downloadFile.returnValue -->
<!-- UTSAPIJSON.downloadFile.returnValue -->
...
...
docs/api/env.md
0 → 100644
浏览文件 @
280c66e9
## env
<!-- UTSAPIJSON.env.description -->
<!-- UTSAPIJSON.env.param -->
<!-- UTSAPIJSON.env.returnValue -->
<!-- UTSAPIJSON.env.compatibility -->
<!-- UTSAPIJSON.env.tutorial -->
<!-- UTSAPIJSON.general_type.name -->
<!-- UTSAPIJSON.general_type.param -->
\ No newline at end of file
docs/api/file-system-spec.md
浏览文件 @
280c66e9
# 文件系统
# 文件系统
> [uni.env 参见](./env.md)
本文介绍uni-app x的文件系统,列出文件系统包括的内容以及框架已经使用了哪些目录和文件。
本文介绍uni-app x的文件系统,列出文件系统包括的内容以及框架已经使用了哪些目录和文件。
注意:
`DCloud-`
、
`DCloud_`
、
`uni-`
、
`uni_`
开头的目录和文件是保留目录。开发者自用的文件目录需避免使用这些前缀。
注意:
`DCloud-`
、
`DCloud_`
、
`uni-`
、
`uni_`
开头的目录和文件是保留目录。开发者自用的文件目录需避免使用这些前缀。
开发者可以通过API
[
uni.getFileSystemManager
](
get-file-system-manager.md
)
获取到文件系统管理器,进一步对文件目录进行增删改查。
开发者可以通过API
[
uni.getFileSystemManager
](
get-file-system-manager.md
)
获取到文件系统管理器,进一步对文件目录进行增删改查。
```
uts
```
uts
const fs = uni.getFileSystemManager()
const fs = uni.getFileSystemManager()
```
```
...
@@ -22,7 +24,7 @@ const fs = uni.getFileSystemManager()
...
@@ -22,7 +24,7 @@ const fs = uni.getFileSystemManager()
-
uni-media :拍照、相册选择
-
uni-media :拍照、相册选择
-
uni-snapshot :App dom截图
-
uni-snapshot :App dom截图
-
uni-crash :App崩溃日志
-
uni-crash :App崩溃日志
*
用户文件目录(
`uni.env.USER_DATA_PATH`
):提供给开发者操作的本地文件目录(files)
*
用户文件目录(
`uni.env.USER_DATA_PATH`
):提供给开发者操作的本地文件目录(files)
+
应用内置沙盒目录(
`uni.env.ANDROID_INTERNAL_SANDBOX_PATH`
):存放框架的网络缓存(如网络图片、视频、web-view的缓存)、storage。
+
应用内置沙盒目录(
`uni.env.ANDROID_INTERNAL_SANDBOX_PATH`
):存放框架的网络缓存(如网络图片、视频、web-view的缓存)、storage。
+
沙盒外目录
+
沙盒外目录
...
@@ -68,31 +70,31 @@ fileManager.copyFile({
...
@@ -68,31 +70,31 @@ fileManager.copyFile({
**真机运行注意**
**真机运行注意**
App端真机运行期间会做特殊处理,将代码包文件同步到
`应用沙盒目录`
下的特定目录:
App端真机运行期间会做特殊处理,将代码包文件同步到
`应用沙盒目录`
下的特定目录:
-
Android平台
-
Android平台
保存在应用专属存储空间的外置存储空间根目录下的apps目录,通常为“/sdcard/Android/data/%应用包名%/apps/%应用AppID%/www/”
保存在应用专属存储空间的外置存储空间根目录下的apps目录,通常为“/sdcard/Android/data/%应用包名%/apps/%应用AppID%/www/”
-
iOS平台
-
iOS平台
保存在应用沙盒目录下的Documents/uni-app-x目录,通常为“/%应用沙盒目录%/Documents/uni-app-x/apps/%应用AppID%/www/”
保存在应用沙盒目录下的Documents/uni-app-x目录,通常为“/%应用沙盒目录%/Documents/uni-app-x/apps/%应用AppID%/www/”
## 本地磁盘文件@disk
## 本地磁盘文件@disk
本地磁盘文件分沙盒内和沙盒外。
本地磁盘文件分沙盒内和沙盒外。
沙盒内是指应用安装到设备(通常指手机)后,系统会提供一块独立的文件存储区域。以应用维度隔离,即在同一台设备,不同应用间的本地磁盘文件不能直接相互访问。
沙盒内是指应用安装到设备(通常指手机)后,系统会提供一块独立的文件存储区域。以应用维度隔离,即在同一台设备,不同应用间的本地磁盘文件不能直接相互访问。
而沙盒目录,又分内置和外置。外置可以在Android手机自带的系统文件管理器里看到,并且用户可以改动。内置的保护级别更高,无法在系统文件管理器中看到。
而沙盒目录,又分内置和外置。外置可以在Android手机自带的系统文件管理器里看到,并且用户可以改动。内置的保护级别更高,无法在系统文件管理器中看到。
本地磁盘文件路径格式为:
本地磁盘文件路径格式为:
```
```
{{协议名}}://文件路径
{{协议名}}://文件路径
```
```
> App端,协议名为"unifile",不应该直接拼写协议名路径访问本地磁盘文件,推荐使用uni.env中的目录常量获取本地磁盘文件目录的路径。
> App端,协议名为"unifile",不应该直接拼写协议名路径访问本地磁盘文件,推荐使用uni.env中的目录常量获取本地磁盘文件目录的路径。
**通过uni.env的目录常量访问本地磁盘文件**
**通过uni.env的目录常量访问本地磁盘文件**
uni-app x提供了一批uni.env常量,来指定不同的可访问目录。
uni-app x提供了一批uni.env常量,来指定不同的可访问目录。
以下示例为在
`用户文件目录`
下写入hello.txt文件:
以下示例为在
`用户文件目录`
下写入hello.txt文件:
```
ts
```
ts
const
fs
=
uni
.
getFileSystemManager
();
const
fs
=
uni
.
getFileSystemManager
();
fs
.
writeFile
({
fs
.
writeFile
({
...
@@ -119,13 +121,13 @@ App端专有目录,为应用沙盒根目录,其下包含了`缓存文件目
...
@@ -119,13 +121,13 @@ App端专有目录,为应用沙盒根目录,其下包含了`缓存文件目
#### 缓存文件目录cache@cache
#### 缓存文件目录cache@cache
目录常量名称:
`uni.env.CACHE_PATH`
目录常量名称:
`uni.env.CACHE_PATH`
缓存文件目录,保存应用运行过程中产生的缓存文件。操作系统或小程序宿主会在存储空间不足时清除缓存文件,因此不要在此目录中保存应用的关键业务数据文件。
缓存文件目录,保存应用运行过程中产生的缓存文件。操作系统或小程序宿主会在存储空间不足时清除缓存文件,因此不要在此目录中保存应用的关键业务数据文件。
实际保存的目录在不同平台存在差异:
实际保存的目录在不同平台存在差异:
-
Android平台
-
Android平台
应用专属存储空间的外置存储空间根目录下的cache目录,通常为“/Android/data/%应用包名%/cache/”
应用专属存储空间的外置存储空间根目录下的cache目录,通常为“/Android/data/%应用包名%/cache/”
-
iOS平台
-
iOS平台
应用沙盒目录下的Library/Caches目录
应用沙盒目录下的Library/Caches目录
uni-app x的部分内置API会产生临时文件会放置在本cache目录,如:
uni-app x的部分内置API会产生临时文件会放置在本cache目录,如:
-
uni.downloadFile下载的文件
-
uni.downloadFile下载的文件
...
@@ -145,16 +147,16 @@ uni-app x的部分内置API会产生临时文件会放置在本cache目录,如
...
@@ -145,16 +147,16 @@ uni-app x的部分内置API会产生临时文件会放置在本cache目录,如
*
java //java、kotlin层崩溃日志
*
java //java、kotlin层崩溃日志
*
c //c、so库崩溃日志
*
c //c、so库崩溃日志
#### 用户文件目录files@files
#### 用户文件目录files@files
目录常量名称:
`uni.env.USER_DATA_PATH`
目录常量名称:
`uni.env.USER_DATA_PATH`
App端和小程序提供了用户文件目录,用于开发者在应用运行期读写文件,此目录不会被操作系统自动清除,由开发者自由管理。
App端和小程序提供了用户文件目录,用于开发者在应用运行期读写文件,此目录不会被操作系统自动清除,由开发者自由管理。
实际保存的目录在不同平台存在差异:
实际保存的目录在不同平台存在差异:
-
Android平台
-
Android平台
应用专属存储空间的外置存储空间根目录下的files目录,通常为“/sdcard/Android/data/%应用包名%/files/”
应用专属存储空间的外置存储空间根目录下的files目录,通常为“/sdcard/Android/data/%应用包名%/files/”
-
iOS平台
-
iOS平台
应用沙盒目录下的Document目录
应用沙盒目录下的Document目录
### 内置应用沙盒目录@internalsandbox
### 内置应用沙盒目录@internalsandbox
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录