• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# FileUri开发指导(C/C++)
2<!--Kit: Core File Kit-->
3<!--Subsystem: FileManagement-->
4<!--Owner: @lvzhenjie-->
5<!--Designer: @wang_zhangjun; @chenxi0605-->
6<!--Tester: @liuhonggang123-->
7<!--Adviser: @foryourself-->
8
9## 场景介绍
10
11FileUri提供了关于文件uri的基本操作，将uri转换成对应的沙箱路径path、将应用沙箱路径path转换成对应应用自己的uri、获取uri所在目录路径的uri等接口能力，方便应用对文件分享业务中uri的访问。
12
13## 基本概念
14
15**结果集**：满足使用场景的路径或uri。
16
17## 约束限制
18
19- uri转path时，uri来源建议使用系统能力获取，例如：picker、剪切板、拖拽、及系统提供的path转uri接口等系统能力返回的uri；如果转换应用或用户拼接的uri，则转换后的path可能无法访问。
20
21- 为保证数据的准确性，在转换或判断过程中应保持单对象处理。
22
23## 接口说明
24
25接口的详细说明，请参考[API参考](../reference/apis-core-file-kit/capi-oh-file-uri-h.md)。
26
27| 接口名称 | 描述 |
28| -------- |-------|
29| FileManagement_ErrCode OH_FileUri_GetUriFromPath(const char *path, unsigned int length, char **result)| 通过传入的路径path生成应用自己的uri；将path转uri时，路径中的中文及非数字字母的特殊字符会被编码为对应的ASCII码，并拼接在uri中。|
30| FileManagement_ErrCode OH_FileUri_GetPathFromUri(const char *uri, unsigned int length, char **result) | 将uri转换成对应的沙箱路径path。 <br>1、uri转path过程中会将uri中存在的ASCII码进行解码后拼接在原处，非系统接口生成的uri中可能存在ASCII码解析范围之外的字符，导致字符串无法正常拼接；<br>2、转换处理遵循系统约定的字符串替换规则（规则可能随系统演进而变化），转换过程中不进行路径校验操作，无法保证转换结果的可访问性。 |
31| FileManagement_ErrCode OH_FileUri_GetFullDirectoryUri(const char *uri, unsigned int length, char **result) | 获取所在路径uri。<br>uri指向文件则返回所在路径的uri，uri指向目录则不处理直接返回原串；<br>uri指向的文件不存在或属性获取失败则返回空串。|
32| bool OH_FileUri_IsValidUri(const char *uri, unsigned int length) | 判断传入的uri的格式是否正确。仅校验uri是否满足系统定义的格式规范，不校验uri的有效性。|
33| FileManagement_ErrCode OH_FileUri_GetFileName(const char *uri, unsigned int length, char **result) | 通过传入的uri获取到对应的文件名称。（如果文件名中存在ASCII码将会被解码处理后拼接在原处）。|
34
35## 开发步骤
36
37**在CMake脚本中链接动态库**
38
39CMakeLists.txt中添加以下lib。
40
41```txt
42target_link_libraries(sample PUBLIC libohfileuri.so)
43```
44
45**添加头文件**
46
47```c++
48#include <filemanagement/file_uri/oh_file_uri.h>
49```
50
511. 调用OH_FileUri_GetUriFromPath接口，在接口中malloc的内存需要在使用完后释放，因此需要free对应的内存。示例代码如下所示：
52
53    ```c
54    #include <cstring>
55
56    void OH_FileUri_GetUriFromPathExample() {
57        char *path = "/data/storage/el2/base/files/test.txt";
58        unsigned int length = strlen(path);
59        char *uriResult = NULL;
60        FileManagement_ErrCode ret = OH_FileUri_GetUriFromPath(path, length ,&uriResult);
61        if (ret == 0 && uriResult !=NULL) {
62            printf("pathUri=%s", uriResult); // 应用a获取到的URI为：file://com.example.demo/data/storage/el2/base/files/test.txt
63        }
64        if (uriResult != NULL) {
65            free(uriResult);
66        }
67    }
68    ```
69
702. 调用OH_FileUri_GetPathFromUri通过URi转成对应的path，在接口中malloc的内存需要在使用完后释放，因此需要free对应的内存。示例代码如下所示：
71
72    ```c
73    #include <cstring>
74
75    void OH_FileUri_GetPathFromUriExample() {
76        char *uri = "file://com.example.demo/data/storage/el2/base/files/test.txt";
77        unsigned int length = strlen(uri);
78        char *pathResult = NULL;
79        FileManagement_ErrCode ret = OH_FileUri_GetPathFromUri(uri, length, &pathResult);
80        if (ret == 0 && pathResult != NULL) {
81            printf("pathResult=%s", pathResult); // PathResult值为：/data/storage/el2/base/files/test.txt
82        }
83        if (pathResult != NULL) {
84            free(pathResult);
85        }
86    }
87    ```
88
893. 调用OH_FileUri_GetFullDirectoryUri获取uri所在路径的uri，在接口中malloc的内存需要在使用完后释放，因此需要free对应的内存。示例代码如下所示：
90
91    ```c
92    #include <cstring>
93
94    void OH_FileUri_GetFullDirectoryUriExample() {
95        char *uri = "file://com.example.demo/data/storage/el2/base/files/test.txt";
96        unsigned int length = strlen(uri);
97        char *uriResult = NULL;
98        FileManagement_ErrCode ret = OH_FileUri_GetFullDirectoryUri(uri, length, &uriResult);
99        if (ret == 0 && uriResult != NULL) {
100            printf("pathUri=%s",uriResult);//URI所在路径的URI：file://com.example.demo/data/storage/el2/base/files/
101        }
102        if (uriResult != NULL) {
103            free(uriResult);
104        }
105    }
106    ```
107
1084. 可以调用OH_FileUri_IsValidUri接口进行uri格式验证。 示例代码如下所示：
109
110   ```c
111    #include <cstring>
112
113    void OH_FileUri_IsValidUriExample() {
114        char *uri = "file://com.example.demo/data/storage/el2/base/files/test.txt";
115        unsigned int length = strlen(uri);
116        bool flags = OH_FileUri_IsValidUri(uri, length);
117        printf("The URI is valid? flags=%d", flags);
118    }
119   ```
120
1215. 调用OH_FileUri_GetFileName获取uri中的文件名称，在接口中malloc的内存需要在使用完后释放，因此需要free对应的内存。示例代码如下所示：
122
123    ```c
124    #include <cstring>
125
126    void OH_FileUri_GetFileNameExample() {
127        char *uri = "file://com.example.demo/data/storage/el2/base/files/test.txt";
128        unsigned int length = strlen(uri);
129        char *uriResult = NULL;
130        FileManagement_ErrCode ret = OH_FileUri_GetFileName(uri, length, &uriResult);
131        if (ret == 0 && uriResult != NULL) {
132            printf("pathUri=%s",uriResult);//获取到URI中的文件名：test.txt
133        }
134        if (uriResult != NULL) {
135            free(uriResult);
136        }
137    }
138    ```
139