鸿蒙语言基础类库：【@system.file (文件存储)】

文件存储

   说明：
  

• 从API Version 6开始，该接口不再维护，推荐利用新接口[@ohos.fileio]。
  
• 本模块首批接口从API version 3开始支持。后续版本的新增接口，接纳上角标单独标记接口的起始版本。
  

  导入模块

1. import file from '@system.file';

复制代码

file.move

move(Object): void
将指定文件移动到其他指定位置。
系统能力： SystemCapability.FileManagement.File.FileIO
参数：
参数名类型必填说明srcUristring是要移动的文件的uri。字符串最大长度为128，且不能包罗“"*+,:;<=>?[]dstUristring是文件要移动到的位置的uri。字符串最大长度为128，且不能包罗“"*+,:;<=>?[]successFunction否接口调用乐成的回调函数，返回文件要移动到的位置的uri。failFunction否接口调用失败的回调函数。completeFunction否接口调用竣事的回调函数。 fail返回错误代码：
错误码说明202出现参数错误。300出现I/O错误。301文件或目录不存在。 示例：

1. export default {   
2.   move() {        
3.     file.move({            
4.       srcUri: 'internal://app/myfiles1',            
5.       dstUri: 'internal://app/myfiles2',            
6.       success: function(uri) {               
7.         console.log('call success callback success');            
8.       },            
9.       fail: function(data, code) {               
10.         console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
11.       },        
12.     });   
13.   }
14. }

复制代码

file.copy

copy(Object): void
将指定文件拷贝并存储到指定位置。
系统能力： SystemCapability.FileManagement.File.FileIO
参数：
参数名类型必填说明srcUristring是要拷贝的文件的uri。dstUristring是文件要拷贝到的位置的uri。 不支持用应用资源路径或tmp类型的uri。successFunction否接口调用乐成的回调函数，返回文件要拷贝到的位置的uri。failFunction否接口调用失败的回调函数。completeFunction否接口调用竣事的回调函数。 fail返回错误代码：
错误码说明202出现参数错误。300出现I/O错误。301文件或目录不存在。 示例：

1. export default {   
2.   copy() {        
3.     file.copy({            
4.       srcUri: 'internal://app/file.txt',            
5.       dstUri: 'internal://app/file_copy.txt',            
6.       success: function(uri) {               
7.         console.log('call success callback success');            
8.       },            
9.       fail: function(data, code) {               
10.         console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
11.       },
12.     });   
13.   }
14. }

复制代码

file.list

list(Object): void
获取指定路径下全部文件的列表。
系统能力： SystemCapability.FileManagement.File.FileIO
参数：
参数名类型必填说明uristring是目录uri。字符串最大长度为128，且不能包罗“"*+,:;<=>?[]successFunction否接口调用乐成的回调函数。failFunction否接口调用失败的回调函数。completeFunction否接口调用竣事的回调函数。 success返回值：
参数名类型说明fileListArray获取的文件列表，此中每个文件的信息的格式为： { uri:‘file1’, lastModifiedTime:1589965924479, length:10240, type: ‘file’ } 表1 FileInfo
参数名类型说明uristring文件的 uri。lastModifiedTimenumber文件上一次保存时的时间戳，显示从1970/01/01 00:00:00 GMT到当前时间的毫秒数。lengthnumber文件的大小，单位为字节。typestring文件的类型，可选值为： - dir：目录； - file：文件。 fail返回错误代码：
错误码说明202出现参数错误。300出现I/O错误。301文件或目录不存在。 示例：

1. export default {   
2.   list() {        
3.     file.list({            
4.       uri: 'internal://app/pic',            
5.       success: function(data) {               
6.         console.log(JSON.stringify(data.fileList));            
7.       },            
8.       fail: function(data, code) {               
9.         console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
10.       },        
11.     });   
12.   }
13. }

复制代码

file.get

get(Object): void
获取指定本地文件的信息。
系统能力： SystemCapability.FileManagement.File.FileIO
参数：
参数名类型必填说明uristring是文件的uri。recursiveboolean否是否进行递归获取子目录文件列表，缺省为false。successFunction否接口调用乐成的回调函数。failFunction否接口调用失败的回调函数。completeFunction否接口调用竣事的回调函数。 success返回值：
参数名类型说明uristring文件的uri。lengthnumber文件字节长。lastModifiedTimenumber文件保存时的时间戳，从1970/01/01 00:00:00到当前时间的毫秒数。typestring文件类型，可选值为： - dir：目录； - file：文件。subFilesArray文件列表。 fail返回错误代码：
错误码说明202出现参数错误。300出现I/O错误。301文件或目录不存在。 示例：

1. export default {   
2.   get() {        
3.     file.get({            
4.       uri: 'internal://app/file',            
5.       success: function(data) {               
6.         console.log(data.uri);            
7.       },            
8.       fail: function(data, code) {               
9.         console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
10.       },
11.     });   
12.   }
13. }

复制代码

file.delete

delete(Object): void
删除本地文件。
系统能力： SystemCapability.FileManagement.File.FileIO
参数：
参数名类型必填说明uristring是删除文件的uri，不能是应用资源路径。successFunction否接口调用乐成的回调函数。failFunction否接口调用失败的回调函数。completeFunction否接口调用竣事的回调函数。 fail返回错误代码：
错误码说明202参数错误。300I/O错误。301文件或目录不存在。 示例：

1. export default {   
2.   delete() {        
3.     file.delete({            
4.       uri: 'internal://app/my_file',            
5.       success: function() {               
6.         console.log('call delete success.');            
7.       },            
8.       fail: function(data, code) {               
9.         console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
10.       },
11.     });   
12.   }
13. }

复制代码

file.writeText

writeText(Object): void
写文本内容到指定文件。仅支持文本文档读写。
系统能力： SystemCapability.FileManagement.File.FileIO
参数：
参数名类型必填说明uristring是本地文件uri，假如文件不存在会创建文件。textstring是写入的字符串。encodingstring否编码格式，默认为UTF-8。appendboolean否是否追加模式，默认为false。successFunction否接口调用乐成的回调函数。failFunction否接口调用失败的回调函数。completeFunction否接口调用竣事的回调函数。 fail返回错误代码：
错误码说明202参数错误。300I/O错误。 示例：

1. export default {   
2.   writeText() {        
3.     file.writeText({            
4.       uri: 'internal://app/test.txt',            
5.       text: 'Text that just for test.',            
6.       success: function() {               
7.         console.log('call writeText success.');            
8.       },            
9.       fail: function(data, code) {               
10.         console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
11.       },        
12.     });   
13.   }
14. }

复制代码

file.writeArrayBuffer

writeArrayBuffer(Object): void
写Buffer内容到指定文件。仅支持文本文档读写。
系统能力： SystemCapability.FileManagement.File.FileIO
参数：
参数名类型必填说明uristring是本地文件uri，假如文件不存在会创建文件。bufferUint8Array是写入的Buffer。positionnumber否文件开始写入数据的位置的偏移量，默认为0。appendboolean否是否追加模式，默认为false。当设置为true时，position参数无效。successFunction否接口调用乐成的回调函数。failFunction否接口调用失败的回调函数。completeFunction否接口调用竣事的回调函数。 fail返回错误代码：
错误码说明202出现参数错误。300出现I/O错误。 示例：

1. export default {   
2.   writeArrayBuffer() {      
3.     file.writeArrayBuffer({           
4.       uri: 'internal://app/test',           
5.       buffer: new Uint8Array(8), //buffer为Uint8Array类型           
6.       success: function() {               
7.         console.log('call writeArrayBuffer success.');            
8.       },           
9.       fail: function(data, code) {               
10.         console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
11.       },
12.     });   
13.   }
14. }

复制代码

file.readText

readText(Object): void
从指定文件中读取文本内容。仅支持文本文档读写。
系统能力： SystemCapability.FileManagement.File.FileIO
参数：
参数名类型必填说明uristring是本地文件uri。encodingstring否编码格式，缺省为UTF-8。positionnumber否读取的起始位置，默认值为文件的起始位置。lengthnumber否读取的长度，默认值为4096。successFunction否接口调用乐成的回调函数。failFunction否接口调用失败的回调函数。completeFunction否接口调用竣事的回调函数。 success返回值：
参数名类型说明textstring读取到的文本内容。 fail返回错误代码：
错误码说明202出现参数错误。300出现I/O错误。301文件或目录不存在。302要读取的文件内容超过4KB。 示例：

1. export default {   
2.   readText() {        
3.     file.readText({            
4.       uri: 'internal://app/text.txt',            
5.       success: function(data) {               
6.         console.log('call readText success: ' + data.text);            
7.       },            
8.       fail: function(data, code) {               
9.         console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
10.       },        
11.     });   
12.   }
13. }

复制代码

file.readArrayBuffer

readArrayBuffer(Object): void
从指定文件中读取Buffer内容。仅支持文本文档读写。
系统能力： SystemCapability.FileManagement.File.FileIO
参数：
参数名类型必填说明uristring是本地文件uri。positionnumber否读取的起始位置，缺省为文件的起始位置。lengthnumber否需要读取的长度，缺省则读取到文件末端。successFunction否接口调用乐成的回调函数。failFunction否接口调用失败的回调函数。completeFunction否接口调用竣事的回调函数。 success返回值：
参数名类型说明bufferUint8Array读取到的文件内容。 fail返回错误代码：
错误码说明202出现参数错误。300出现I/O错误。301文件或目录不存在。 示例：

1. export default {   
2.   readArrayBuffer() {        
3.     file.readArrayBuffer({            
4.       uri: 'internal://app/test',            
5.       position: 10,            
6.       length: 200,            
7.       success: function(data) {               
8.         console.log('call readArrayBuffer success: ' + data.buffer);            
9.       },            
10.       fail: function(data, code) {               
11.         console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
12.       },
13.     });   
14.   }
15. }

复制代码

file.access

access(Object): void
判断指定文件或目录是否存在。
系统能力： SystemCapability.FileManagement.File.FileIO
参数：
参数名类型必填说明uristring是目录或文件uri。successFunction否接口调用乐成的回调函数。failFunction否接口调用失败的回调函数。completeFunction否接口调用竣事的回调函数。 fail返回错误代码：
错误码说明202出现参数错误。300出现I/O 错误。301文件或目录不存在。 示例：

1. export default {   
2.   access() {        
3.     file.access({            
4.       uri: 'internal://app/test',            
5.       success: function() {               
6.         console.log('call access success.');            
7.       },            
8.       fail: function(data, code) {               
9.         console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
10.       },        
11.     });   
12.   }
13. }

复制代码

file.mkdir

mkdir(Object): void
创建指定目录。
系统能力： SystemCapability.FileManagement.File.FileIO
参数：
参数名类型必填说明uristring是目录的uri路径。recursiveboolean否是否递归创建该目录的上级目录，缺省为false。successFunction否接口调用乐成的回调函数。failFunction否接口调用失败的回调函数。completeFunction否接口调用竣事的回调函数。 fail返回错误代码：
错误码说明202出现参数错误。300出现I/O 错误。 示例：

1. export default {   
2.   mkdir() {        
3.     file.mkdir({            
4.       uri: 'internal://app/test_directory',            
5.       success: function() {               
6.         console.log('call mkdir success.');            
7.       },            
8.       fail: function(data, code) {               
9.         console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
10.       },
11.     });   
12.   }
13. }

复制代码

file.rmdir

rmdir(Object): void
删除指定目录。
系统能力： SystemCapability.FileManagement.File.FileIO
参数：
参数名类型必填说明uristring是目录的uri路径。recursiveboolean否是否递归删除子文件和子目录，缺省为false。successFunction否接口调用乐成的回调函数。failFunction否接口调用失败的回调函数。completeFunction否接口调用竣事的回调函数。 fail返回错误代码：
错误码说明202出现参数错误。300出现I/O 错误。301文件或目录不存在。HarmonyOS与OpenHarmony鸿蒙文档籽料：末端扫直接拿

示例：

1. export default {   
2.   rmdir() {        
3.     file.rmdir({            
4.       uri: 'internal://app/test_directory',            
5.       success: function() {               
6.         console.log('call rmdir success.');            
7.       },            
8.       fail: function(data, code) {               
9.         console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
10.       },
11.     });   
12.   }
13. }

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。