HarmonyOS API：@ohos.fileio (文件管理)

版本：v3.1 Beta

@ohos.fileio (文件管理)

fileio.fdopenStream⁷⁺

fdopenStream(fd: number, mode: string): Promise<Stream>

基于文件描述符打开文件流，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
fileio.fdopenStream(fd, "r+").then(function(stream){
    console.info("openStream succeed");
}).catch(function(err){
    console.info("openStream failed with error:"+ err);
});

fileio.fdopenStream⁷⁺

fdopenStream(fd: number, mode: string, callback: AsyncCallback<Stream>): void

基于文件描述符打开文件流，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
fileio.fdopenStream(fd, "r+", function (err, stream) {
    // do something
});

fileio.fdopenStreamSync⁷⁺

fdopenStreamSync(fd: number, mode: string): Stream

以同步方法基于文件描述符打开文件流。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
let ss = fileio.fdopenStreamSync(fd, "r+");

fileio.fchown⁷⁺

fchown(fd: number, uid: number, gid: number): Promise<void>

基于文件描述符改变文件所有者，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
let stat = fileio.statSync(filePath);
fileio.fchown(fd, stat.uid, stat.gid).then(function() {
    console.info("chown succeed");
}).catch(function(err){
    console.info("chown failed with error:"+ err);
});

fileio.fchown⁷⁺

fchown(fd: number, uid: number, gid: number, callback: AsyncCallback<void>): void

基于文件描述符改变文件所有者，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
let stat = fileio.statSync(filePath);
fileio.fchown(fd, stat.uid, stat.gid, function (err){
    // do something
});

fileio.fchownSync⁷⁺

fchownSync(fd: number, uid: number, gid: number): void

以同步方法基于文件描述符改变文件所有者。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
let stat = fileio.statSync(filePath);
fileio.fchownSync(fd, stat.uid, stat.gid);

fileio.lchown⁷⁺

lchown(path: string, uid: number, gid: number): Promise<void>

基于文件路径改变文件所有者，更改符号链接本身的所有者，而不是符号链接所指向的实际文件，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let stat = fileio.statSync(filePath);
fileio.lchown(filePath, stat.uid, stat.gid).then(function() {
    console.info("chown succeed");
}).catch(function(err){
    console.info("chown failed with error:"+ err);
});

fileio.lchown⁷⁺

lchown(path: string, uid: number, gid: number, callback: AsyncCallback<void>): void

基于文件路径改变文件所有者，更改符号链接本身的所有者，而不是更改符号链接所指向的实际文件，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let stat = fileio.statSync(filePath);
fileio.lchown(filePath, stat.uid, stat.gid, function (err){
    // do something
});

fileio.lchownSync⁷⁺

lchownSync(path: string, uid: number, gid: number): void

以同步方法基于文件路径改变文件所有者，更改符号链接本身的所有者，而不是更改符号链接所指向的实际文件。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let stat = fileio.statSync(filePath);
fileio.lchownSync(filePath, stat.uid, stat.gid);

fileio.createWatcher⁷⁺

createWatcher(filename: string, events: number, callback: AsyncCallback<number>): Watcher

监听文件或者目录的变化，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir +"/test.txt";
fileio.createWatcher(filePath, 1, function(number){
   console.info("Monitoring times: "+number);
});

Readout

仅用于read方法，获取文件的读取结果。

系统能力：以下各项对应的系统能力均为SystemCapability.FileManagement.File.FileIO。

Stat

文件具体信息，在调用Stat的方法前，需要先通过​​stat()​​方法（同步或异步）来构建一个Stat实例。

系统能力：以下各项对应的系统能力均为SystemCapability.FileManagement.File.FileIO。

属性

isBlockDevice

isBlockDevice(): boolean

用于判断文件是否是块特殊文件。一个块特殊文件只能以块为粒度进行访问，且访问的时候带缓存。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

示例：

let filePath = pathDir + "/test.txt";
let isBLockDevice = fileio.statSync(filePath).isBlockDevice();

isCharacterDevice

isCharacterDevice(): boolean

用于判断文件是否是字符特殊文件。一个字符特殊设备可进行随机访问，且访问的时候不带缓存。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

示例：

let filePath = pathDir + "/test.txt";
let isCharacterDevice = fileio.statSync(filePath).isCharacterDevice();

isDirectory

isDirectory(): boolean

用于判断文件是否是目录。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

示例：

let dirPath = pathDir + "/test";
let isDirectory = fileio.statSync(dirPath).isDirectory(); 

isFIFO

isFIFO(): boolean

用于判断文件是否是命名管道（有时也称为FIFO）。命名管道通常用于进程间通信。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

示例：

let filePath = pathDir + "/test.txt";
let isFIFO = fileio.statSync(filePath).isFIFO(); 

isFile

isFile(): boolean

用于判断文件是否是普通文件。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

示例：

let filePath = pathDir + "/test.txt";
let isFile = fileio.statSync(filePath).isFile();

isSocket

isSocket(): boolean

用于判断文件是否是套接字。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

示例：

let filePath = pathDir + "/test.txt";
let isSocket = fileio.statSync(filePath).isSocket(); 

isSymbolicLink

isSymbolicLink(): boolean

用于判断文件是否是符号链接。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

示例：

let filePath = pathDir + "/test";
let isSymbolicLink = fileio.statSync(filePath).isSymbolicLink(); 

Watcher⁷⁺

Watcher是文件变化监听的实例，调用Watcher.stop()方法（同步或异步）来停止文件监听。

stop⁷⁺

stop(): Promise<void>

关闭watcher监听，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

示例：

let filePath = path + "/test.txt";
let watcher = fileio.createWatcher(filePath, 1, function(number){
    console.info("Monitoring times: "+number);
});
watcher.stop().then(function(){
     console.info("close watcher succeed");
});

stop⁷⁺

stop(callback: AsyncCallback<void>): void

关闭watcher监听，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = path +"/test.txt";
let watcher = fileio.createWatcher(filePath, 1, function(number){
    console.info("Monitoring times: "+number);
});
watcher.stop(function(){
    console.info("close watcher succeed");
})

Stream

文件流，在调用Stream的方法前，需要先通过createStream()方法（同步或异步）来构建一个Stream实例。

close⁷⁺

close(): Promise<void>

关闭文件流，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

示例：

let filePath = pathDir + "/test.txt";
let ss= fileio.createStreamSync(filePath, "r+");
ss.close().then(function(){
    console.info("close fileStream succeed");
}).catch(function(err){
    console.info("close fileStream  failed with error:"+ err);
});

close⁷⁺

close(callback: AsyncCallback<void>): void

异步关闭文件流，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let ss= fileio.createStreamSync(filePath, "r+");
ss.close(function (err) {
    // do something
});

closeSync

closeSync(): void

同步关闭文件流。

系统能力：SystemCapability.FileManagement.File.FileIO

示例：

let filePath = pathDir + "/test.txt";
let ss= fileio.createStreamSync(filePath, "r+");
ss.closeSync();

flush⁷⁺

flush(): Promise<void>

刷新文件流，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

示例：

let filePath = pathDir + "/test.txt";
let ss= fileio.createStreamSync(filePath, "r+");
ss.flush().then(function (){
    console.info("flush succeed");
}).catch(function(err){
    console.info("flush failed with error:"+ err);
});

flush⁷⁺

flush(callback: AsyncCallback<void>): void

异步刷新文件流，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let ss= fileio.createStreamSync(filePath, "r+");
ss.flush(function (err) {
    // do something
});

flushSync⁷⁺

flushSync(): void

同步刷新文件流。

系统能力：SystemCapability.FileManagement.File.FileIO

示例：

let filePath = pathDir + "/test.txt";
let ss= fileio.createStreamSync(filePath, "r+");
ss.flushSync();

write⁷⁺

write(buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; position?: number; encoding?: string; }): Promise<number>

将数据写入流文件，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let ss= fileio.createStreamSync(filePath, "r+");
ss.write("hello, world",{offset: 1,length: 5,position: 5,encoding :'utf-8'}).then(function (number){
    console.info("write succeed and size is:"+ number);
}).catch(function(err){
    console.info("write failed with error:"+ err);
});

write⁷⁺

write(buffer: ArrayBuffer|string, options: { offset?: number; length?: number; position?: number; encoding?: string; }, callback: AsyncCallback<number>): void

将数据写入流文件，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let ss= fileio.createStreamSync(filePath, "r+");
ss.write("hello, world", {offset: 1, length: 5, position: 5, encoding :'utf-8'}, function (err, bytesWritten) {
    if (bytesWritten) {
       // do something
       console.info("write succeed and size is:"+ bytesWritten);
    }
});

writeSync⁷⁺

writeSync(buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; position?: number; encoding?: string; }): number

以同步方法将数据写入流文件。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let ss= fileio.createStreamSync(filePath,"r+");
let num = ss.writeSync("hello, world", {offset: 1, length: 5, position: 5, encoding :'utf-8'});

read⁷⁺

read(buffer: ArrayBuffer, options?: { position?: number; offset?: number; length?: number; }): Promise<ReadOut>

从流文件读取数据，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let ss = fileio.createStreamSync(filePath, "r+");
ss.read(new ArrayBuffer(4096), {offset: 1, length: 5, position: 5}).then(function (readOut){
    console.info("read data succeed");
    console.log(String.fromCharCode.apply(null, new Uint8Array(readOut.buffer)));
}).catch(function(err){
    console.info("read data failed with error:"+ err);
});

read⁷⁺

read(buffer: ArrayBuffer, options: { position?: number; offset?: number; length?: number; }, callback: AsyncCallback<ReadOut>): void

从流文件读取数据，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let ss = fileio.createStreamSync(filePath, "r+");
ss.read(new ArrayBuffer(4096),{offset: 1, length: 5, position: 5},function (err, readOut) {
    if (readOut) {
        console.info("read data succeed");
        console.log(String.fromCharCode.apply(null, new Uint8Array(readOut.buffer)));
    }
});

readSync⁷⁺

readSync(buffer: ArrayBuffer, options?: { position?: number; offset?: number; length?: number; }): number

以同步方法从流文件读取数据。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let ss = fileio.createStreamSync(filePath, "r+");
let num = ss.readSync(new ArrayBuffer(4096), {offset: 1, length: 5, position: 5});

Dir

管理目录，在调用Dir的方法前，需要先通过opendir方法（同步或异步）来构建一个Dir实例。

read

read(): Promise<Dirent>

读取下一个目录项，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

示例：

dir.read().then(function (dirent){
    console.log("read succeed, the name of dirent is " + dirent.name);
}).catch(function(err){
    console.info("read failed with error:"+ err);
});

read

read(callback: AsyncCallback<Dirent>): void

读取下一个目录项，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

dir.read(function (err, dirent) {
    if (dirent) {
        // do something
        console.log("read succeed, the name of file is " + dirent.name);
    }
});

readSync

readSync(): Dirent

同步读取下一个目录项。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

示例：

let dirent = dir.readSync();

close⁷⁺

close(): Promise<void>

异步关闭目录，使用promise形式返回结果。目录被关闭后，Dir中持有的文件描述将被释放，后续将无法从Dir中读取目录项。

系统能力：SystemCapability.FileManagement.File.FileIO

示例：

dir.close().then(function(err){
    console.info("close dir successfully");
});

close⁷⁺

close(callback: AsyncCallback<void>): void

异步关闭目录，使用callback形式返回结果。目录被关闭后，Dir中持有的文件描述将被释放，后续将无法从Dir中读取目录项。

系统能力：SystemCapability.FileManagement.File.FileIO

示例：

dir.close(function(err){
    console.info("close dir successfully");
});

closeSync

closeSync(): void

用于关闭目录。目录被关闭后，Dir中持有的文件描述将被释放，后续将无法从Dir中读取目录项。

系统能力：SystemCapability.FileManagement.File.FileIO

示例：

dir.closeSync();

Dirent

在调用Dirent的方法前，需要先通过​​dir.read()​​方法（同步或异步）来构建一个Dirent实例。

系统能力：以下各项对应的系统能力均为SystemCapability.FileManagement.File.FileIO。

属性

isBlockDevice

isBlockDevice(): boolean

用于判断当前目录项是否是块特殊文件。一个块特殊文件只能以块为粒度进行访问，且访问的时候带缓存。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

示例：

let dir = fileio.opendirSync(pathDir);
let isBLockDevice = dir.readSync().isBlockDevice();

isCharacterDevice

isCharacterDevice(): boolean

用于判断当前目录项是否是字符特殊设备。一个字符特殊设备可进行随机访问，且访问的时候不带缓存。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

示例：

let dir = fileio.opendirSync(pathDir);
let isCharacterDevice = dir.readSync().isCharacterDevice(); 

isDirectory

isDirectory(): boolean

用于判断当前目录项是否是目录。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

示例：

let dir = fileio.opendirSync(pathDir);
let isDirectory = dir.readSync().isDirectory(); 

isFIFO

isFIFO(): boolean

用于判断当前目录项是否是命名管道（有时也称为FIFO）。命名管道通常用于进程间通信。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

示例：

let dir = fileio.opendirSync(pathDir);
let isFIFO = dir.readSync().isFIFO(); 

isFile

isFile(): boolean

用于判断当前目录项是否是普通文件。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

示例：

let dir = fileio.opendirSync(pathDir);
let isFile = dir.readSync().isFile(); 

isSocket

isSocket(): boolean

用于判断当前目录项是否是套接字。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

示例：

let dir = fileio.opendirSync(pathDir);
let isSocket = dir.readSync().isSocket(); 

isSymbolicLink

isSymbolicLink(): boolean

用于判断当前目录项是否是符号链接。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

示例：

let dir = fileio.opendirSync(pathDir);
let isSymbolicLink = dir.readSync().isSymbolicLink();

文章转载自：​​https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-fileio-0000001478181641-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001478181641__issymboliclink-1​​