每天學點node系列-fs文件系統

来源:https://www.cnblogs.com/jingh/archive/2019/07/09/11161170.html
-Advertisement-
Play Games

好的代碼像粥一樣,都是用時間熬出來的。 概述 文件 I/O 是由簡單封裝的標準 POSIX 函數提供的。 通過 require('fs') 使用該模塊。 所有文件系統操作都具有同步和非同步的形式。 非同步的形式總是將完成回調作為其最後一個參數。 傳給完成回調的參數取決於具體方法，但第一個參數始終預留用於 ...


好的代碼像粥一樣,都是用時間熬出來的。

概述

文件 I/O 是由簡單封裝的標準 POSIX 函數提供的。 通過 require('fs') 使用該模塊。

所有文件系統操作都具有同步和非同步的形式。

非同步的形式總是將完成回調作為其最後一個參數。 傳給完成回調的參數取決於具體方法，但第一個參數始終預留用於異常。 如果操作成功完成，則第一個參數將為 null 或 undefined。

// 非同步示例
const fs = require('fs');

fs.unlink('/tmp/hello', (err) => {
  if (err) throw err;
  console.log('已成功刪除 /tmp/hello');
});

使用同步的操作發生的異常會立即拋出，可以使用 try/catch 處理，也可以允許冒泡。

//同步示例
const fs = require('fs');

try {
  fs.unlinkSync('/tmp/hello');
  console.log('已成功刪除 /tmp/hello');
} catch (err) {
  // 處理錯誤
}

在進程中，建議使用非同步版本。 同步的版本將阻塞整個進程，直到它們完成（停止所有連接）。但是非同步操作不保證執行順序所以，所以在使用時請註意使用對象執行順序。

文件系統標誌

flags可以是：

'a' - 打開文件用於追加。如果文件不存在，則創建該文件。
'ax' - 與 'a' 相似，但如果路徑已存在則失敗。
'a+' - 打開文件用於讀取和追加。如果文件不存在，則創建該文件。
'ax+' - 與 'a+' 相似，但如果路徑已存在則失敗。
'as' - 以同步模式打開文件用於追加。如果文件不存在，則創建該文件。
'as+' - 以同步模式打開文件用於讀取和追加。如果文件不存在，則創建該文件。
'r' - 打開文件用於讀取。如果文件不存在，則出現異常。
'r+' - 打開文件用於讀取和寫入。如果文件不存在，則出現異常。
'rs+' - 以同步模式打開文件用於讀取和寫入。指示操作系統繞過本地的文件系統緩存。
'w' - 打開文件用於寫入。如果文件不存在則創建文件，如果文件已存在則截斷文件。
'wx' - 與 'w' 相似，但如果路徑已存在則失敗。
'w+' - 打開文件用於讀取和寫入。如果文件不存在則創建文件，如果文件已存在則截斷文件。
'wx+' - 與 'w+' 相似，但如果路徑已存在則失敗。

底層介面

打開文件

非同步打開

// fs.open
path <string> | <Buffer> | <URL>
flags <string> | <number> 參閱支持的文件系統標誌。
mode <integer> 預設值: 0o666（可讀寫）。
callback <Function>
  - err <Error>
  - fd <integer>
var fs = require('fs')
fs.open('1.txt','r',function(err,fs){
    console.log(err)
    console.log(fs)
})

執行結果：

$ node 1.js
null
3

註意： 使用'rs+'模式不會使fs.open()進入同步阻塞調用。如果那是你想要的，則應該使用fs.openSync()

同步打開

// fs.openSync
path <string> | <Buffer> | <URL>
flags <string> | <number> 參閱支持的文件系統標誌。
mode <integer> 預設值: 0o666。
返回: <number>
返回表示文件描述符的整數。
var fs = require('fs');
var result = fs.openSync('1.txt','r');
console.log(result);

執行結果：

$ node 1.js
3

讀取文件

fd <integer> 從 fd 指定的文件中讀取數據。
buffer <Buffer> | <TypedArray> | <DataView> 數據將寫入的緩衝區。
offset <integer> buffer 中開始寫入的偏移量
length <integer> 是一個整數，指定要讀取的位元組數
position <integer> 參數指定從文件中開始讀取的位置。 如果 position 為 null，則從當前文件位置讀取數據，並更新文件位置。 如果 position 是整數，則文件位置將保持不變。
callback <Function>
- err <Error>
- bytesRead <integer>
- buffer <Buffer>
var fs = require('fs');
fs.open('1.txt','r',function(err,fd){
    if(err){
        console.log('文件打開失敗');
    }else{
        var bf = Buffer.alloc(5);
        fs.read(fd,bf,0,3,null,function(err,len,buffer){
            console.log(err);
            console.log(len);
            console.log(buffer);
        })
    }
});

執行結果：

$ node 1.js
null
3
<Buffer 68 65 6c 00 00>

同步讀取

fd <integer>
buffer <Buffer> | <TypedArray> | <DataView>
offset <integer>
length <integer>
position <integer>
返回: <number>
返回 bytesRead 的數量。
var fs = require('fs');
var fd = fs.openSync('1.txt','r');
var bf = Buffer.alloc(5);
var result = fs.readSync(fd,bf,0,3,null);
console.log(result);

執行結果：

$ node 1.js
3

寫入文件

fd <Integer>  文件標識
buffer <String> | <Buffer> 要將buffer中的數據寫入到文件中
offset <Integer> buffer對象中要寫入的數據的起始位置
length <Integer> length是一個整數，指定要寫入的位元組數
position <Integer> 指定從文件開始寫入數據的位置的偏移量。 如果 typeof position !== 'number'，則數據從當前位置寫入
callback <Function> 回調有三個參數(err, written, buffer)，其中written指定從buffer寫入了多少位元組

執行結果

$ node 1.js
null
3
<Buffer 74 65 73 74>

[註意]多次對同一文件使用fs.write且不等待回調，是不安全的。對於這種情況，強烈推薦使用 fs.createWriteStream　　當我們要對打開的文件進行寫操作的時候，打開文件的模式應該是讀寫模式

同步寫入

fd <integer>
buffer <Buffer> | <TypedArray> | <DataView>
offset <integer>
length <integer>
position <integer>
返回: <number> 寫入的位元組數。
var fs = require('fs');
var fd = fs.openSync('1.txt','r+');
var bf = Buffer.alloc(5);
var result = fs.writeSync(fd,bf,0,3,null);
console.log(result);

執行結果：

$ node 1.js
3

關閉文件

fd - 通過 fs.open() 方法返回的文件描述符。
callback - 回調函數，沒有參數。
var fs = require('fs');
fs.open('1.txt','r+',function(err,fd){
    if(err){
        console.log('文件打開失敗');
    }else{
        fs.close(fd, function(err){
            if (err){
                console.log(err);
            } 
            console.log("文件關閉成功");
        });
    }
});
$ node 1.js
文件關閉成功

同步關閉

var fs = require('fs');
var fd = fs.openSync('1.txt','r+');
fs.closeSync(fd);

文件操作

文件讀取

同步讀取

// fs.readFileSync
path <string> | <Buffer> | <URL>
options <string> | <Object>
    encoding <string> 預設值: 'utf8'。
    withFileTypes <boolean> 預設值: false。

返回: <string[]> | <Buffer[]> | <fs.Dirent[]>
var fs = require('fs');
var data;

try{
    data = fs.readFileSync('./1.txt', 'utf8');
    console.log('文件內容: ' + data);
}catch(err){
    console.error('讀取文件出錯: ' + err.message);
}

執行結果為：

$ node 1.js
文件內容: hello rock

非同步讀取

// fs.readFile
path <string> | <Buffer> | <URL>
options <string> | <Object>
    - encoding <string> 預設值: 'utf8'。
    - withFileTypes <boolean> 預設值: false。
callback <Function>
    - err <Error>
    - files <string[]> | <Buffer[]> | <fs.Dirent[]>
var fs = require('fs');

fs.readFile('./1.txt', 'utf8', function(err, data){
    if(err){
        return console.error('讀取文件出錯: ' + err.message);
    }
    console.log('文件內容: ' + data);
});

執行結果也為：

$ node 1.js
文件內容: hello rock

通過文件流讀取

適合讀取大文件

path <string> | <Buffer> | <URL>
options <string> | <Object>
   - flags <string> 參閱支持的文件系統標誌。預設值: 'r'。
   - encoding <string> 預設值: null。
   - fd <integer> 預設值: null。
   - mode <integer> 預設值: 0o666。
   - autoClose <boolean> 預設值: true。
   - start <integer>
   - end <integer> 預設值: Infinity。
   - highWaterMark <integer> 預設值: 64 * 1024。
返回: <fs.ReadStream> 參閱[可讀流]。
var fs = require('fs');
var readStream = fs.createReadStream('./1.txt', 'utf8');

readStream
    .on('data', function(chunk) {
        console.log('讀取數據: ' + chunk);
    })
    .on('error', function(err){
        console.log('出錯: ' + err.message);
    })
    .on('end', function(){  // 沒有數據了
        console.log('沒有數據了');
    })
    .on('close', function(){  // 已經關閉，不會再有事件拋出
        console.log('已經關閉');
    });

執行結果：

$ node 1.js
讀取數據: hello rock
沒有數據了
已經關閉

文件寫入

非同步寫入

// fs.writeFile
file <string> | <Buffer> | <URL> | <integer> 文件名或文件描述符。
data <string> | <Buffer> | <TypedArray> | <DataView>
options <Object> | <string>
  - encoding <string> | <null> 預設值: 'utf8'。
  - mode <integer> 預設值: 0o666。
  - flag <string> 參閱支持的文件系統標誌。預設值: 'w'。
callback <Function>
  - err <Error></Error>
var fs = require('fs');
fs.writeFile('./1.txt', 'hello rock', 'utf8', function(err){
    if(err) throw err;
    console.log('文件寫入成功');
});

執行結果：

$ node 1.js
文件寫入成功

同步寫入

// fs.writeFileSync
file <string> | <Buffer> | <URL> | <integer> 文件名或文件描述符。
data <string> | <Buffer> | <TypedArray> | <DataView>
options <Object> | <string>
  - encoding <string> | <null> 預設值: 'utf8'。
  - mode <integer> 預設值: 0o666。
  - flag <string> 參閱支持的文件系統標誌。預設值: 'w'。
  
返回 undefined。
var fs = require('fs');
try{
    fs.writeFileSync('./1.txt', 'hello rock', 'utf8');
    console.log('文件寫入成功');
}catch(err){
    throw err;
}

執行結果：

$ node 1.js
文件寫入成功

通過文件流寫入

path <string> | <Buffer> | <URL>
options <string> | <Object>
   - flags <string> 參閱支持的文件系統標誌。預設值: 'w'。
   - encoding <string> 預設值: 'utf8'。
   - fd <integer> 預設值: null。
   - mode <integer> 預設值: 0o666。
   - autoClose <boolean> 預設值: true。
   - start <integer>
返回: <fs.WriteStream> 參閱可寫流。
var fs = require('fs');
var writeStream = fs.createWriteStream('./1.txt', 'utf8');
writeStream
    .on('close', function(){ // 已經關閉，不會再有事件拋出
        console.log('已經關閉');
    });
writeStream.write('hello');
writeStream.write('rock');
writeStream.end('');

執行結果：

$ node 1.js
已經關閉

追加文件

file - 文件名或文件描述符。
data - 要寫入文件的數據，可以是 String(字元串) 或 Buffer(流) 對象。
options - 該參數是一個對象，包含 {encoding, mode, flag}。預設編碼為 utf8, 模式為 0666 ， flag 為 'w'
callback - 回調函數，回調函數只包含錯誤信息參數(err)，在寫入失敗時返回。
var fs = require('fs');
var filename = '1.txt';
fs.appendFile(filename,' world',function(err){
    console.log(err);
})

執行結果

$ node 1.js
null

同步追加

var fs = require('fs');
var filename = '1.txt';
fs.appendFileSync(filename,' lalala');

刪除文件

path - 文件路徑。
callback - 回調函數，沒有參數。
var fs = require('fs');
var filename = '1.txt';
fs.unlink(filename, function(err) {
   if (err) {
       return console.log('刪除失敗');
   }
   console.log("刪除成功");
});

執行結果：

$ node 1.js
刪除成功

同步刪除

var fs = require('fs');
var filename = '1.txt';
fs.unlink(filename);

重命名

oldPath <String> | <Buffer>
newPath <String> | <Buffer>
callback <Function> 回調只有一個可能的異常參數
var fs = require('fs');
var filename = 'a.txt';
fs.rename(filename,'2.new.txt',function(err){
    console.log(err);
})
$ node 1.js
null

同步重命名

var fs = require('fs');
var filename = '2.new.txt';
var result = fs.renameSync(filename,'a.txt');

文件信息

path <string> | <Buffer> | <URL>
options <Object>
bigint <boolean> 返回的 fs.Stats 對象中的數值是否應為 bigint 型。預設值: false。
callback <Function>
   - err <Error>
   - stats <fs.Stats>
var fs = require('fs');
var filename = 'a.txt';
fs.stat(filename,function(err,stats){
    console.log(err);
    console.log(stats);
});

執行結果

$ node 1.js
null
Stats {
  dev: 163689085,
  mode: 33206,
  nlink: 1,
  uid: 0,
  gid: 0,
  rdev: 0,
  blksize: undefined,
  ino: 9007199254854088,
  size: 0,
  blocks: undefined,
  atimeMs: 1562684836201.136,
  mtimeMs: 1562684836201.136,
  ctimeMs: 1562684998231.913,
  birthtimeMs: 1562684836201.136,
  atime: 2019-07-09T15:07:16.201Z,
  mtime: 2019-07-09T15:07:16.201Z,
  ctime: 2019-07-09T15:09:58.232Z,
  birthtime: 2019-07-09T15:07:16.201Z }

stats類中的方法有

stats.isFile()  如果是文件返回 true，否則返回 false。
stats.isDirectory() 如果是目錄返回 true，否則返回 false。
stats.isBlockDevice()   如果是塊設備返回 true，否則返回 false。
stats.isCharacterDevice()   如果是字元設備返回 true，否則返回 false。
stats.isSymbolicLink()  如果是軟鏈接返回 true，否則返回 false。
stats.isFIFO()  如果是FIFO，返回true，否則返回false。FIFO是UNIX中的一種特殊類型的命令管道。
stats.isSocket()    如果是 Socket 返回 true，否則返回 false。
var fs = require('fs');
var filename = 'a.txt';
fs.stat(filename,function(err,stats){
    console.log(stats.isFile());//true
});

監聽

filename <String> | <Buffer>
options <String> | <Object> 參數可選，如果options是一個字元串，則它指定了encoding。否則options應該以一個對象傳入
    persistent <Boolean> 指明如果文件正在被監視，進程是否應該繼續運行。預設為true
    recursive <Boolean> 指明是否全部子目錄應該被監視，或只是當前目錄。 適用於當一個目錄被指定時，且只在支持的平臺。預設為false
    encoding <String> 指定用於傳給監聽器的文件名的字元編碼。預設為'utf8'
listener <Function> 回調函數有兩個參數 (eventType, filename)。 eventType可以是'rename'或'change'，filename是觸發事件的文件的名稱
fs.watch('txt', (eventType, filename) => {
  console.log(`事件類型是: ${eventType}`);
  if (filename) {
    console.log(`提供的文件名: ${filename}`);
  } else {
    console.log('未提供文件名');
  }
});
var fs = require('fs');
var filename = '1.txt';
fs.watch(filename,function(eventType, _filename){
    console.log(eventType);//change
    if(_filename){
        console.log(_filename + '發生了改變');//'1.txt發生了改變'
    }else{
        console.log('...');
    }
    
})

[註意]當一個文件出現或消失在一個目錄里時，'rename'也會被觸發


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • iOS----------iPhone導出手機所有簡訊
    第一步：手機連接到itunes 選擇本電腦備份 備份的時候不要加密 然後立即備份 第二步：前往文件夾，找到itunes的備份路徑~/Library/Application Support/MobileSync/Backup 在這目錄下搜索 3d0d開頭的文件，這就是 iPhone 簡訊的資料庫文件。 ...
  • 使用CocoaPods創建自己的私有庫-iOS組件化第一步
    目前iOS組件化常用的解決方案是Pod+路由+持續集成，通常架構設計完成後第一步就是將原來工程里的模塊按照架構圖分解為一個個獨立的pod工程(組件)，今天我們就來看看如何創建一個Pod私有庫。 新建：pod lib create 假設我們需要創建的庫名為TestLib，下麵我們使用Pod官方提供的創 ...
  • jQuery基礎學習
    jQuery是一個快速、簡潔的JavaScript框架，是繼Prototype之後又一個優秀的JavaScript代碼庫（或JavaScript框架）。jQuery設計的宗旨是“Write Less, Do More”，即倡導寫更少的代碼，做更多的事情。它封裝JavaScript常用的功能代碼，提供... ...
  • HTML連載21-序選擇器上
    解釋CSS3 中新增的選擇器中最具有代表性的就是序選擇器，大致可以分為兩類： （1）同級別的第幾個（2）同類型的第幾個 先寫一個公共代碼 1.選中同級別中的第一個 註意點：不區分類型，只管取第一個，不管第一個是什麼標簽 解釋：在同級別中只選取第一個為h1標簽和div下的p標簽，然後在這些裡面只選p標 ...
  • JavaScript面試核心考點(精華)
    Javascript是前端面試的重點，本文重點梳理下 Javascript 中的常考基礎知識點，然後就一些容易出現的題目進行解析。限於文章的篇幅，無法將知識點講解的面面俱到，本文只羅列了一些重難點。 ...
  • Vue.js 源碼分析(二十二) 指令篇 v-model指令詳解
    Vue.js提供了v-model指令用於雙向數據綁定，比如在輸入框上使用時，輸入的內容會事實映射到綁定的數據上，綁定的數據又可以顯示在頁面里，數據顯示的過程是自動完成的。 v-model本質上不過是語法糖。它負責監聽用戶的輸入事件以更新數據，並對一些極端場景進行一些特殊處理。例如: 渲染如下: 當我 ...
  • 在Electron中最快速預載入腳本
    背景 在Electron打開新視窗的時候，提前載入一段JavaScript腳本，以此內置一些屬性或介面給被打開的頁面。之所以要以註入方式，而不是頁面自己引用，原因是不想麻煩頁面自行引用，不想修改舊有的業務邏輯。 方法一 一開始是想在打開BrowserWindow後，執行executeJavaScri ...
  • js原型，原型鏈
    先鋪墊下原型規則： 1.所有的引用類型（數組，對象，函數）都具有對象特性，可自由擴展屬性（出了null外） 2.所有的引用類型（數組，對象，函數）都有一個__proto__屬性（隱式原型），屬性值是一個對象 3.所有的函數都有一個prototype屬性（顯示原型），屬性值是一個對象 4.所有的引用類 ...
一周排行
    -Advertisement-
    Play Games
  • C# + WPF 音頻播放器 界面優雅，體驗良好
    前言 本文介紹一款使用 C# 與 WPF 開發的音頻播放器，其界面簡潔大方，操作體驗流暢。該播放器支持多種音頻格式（如 MP4、WMA、OGG、FLAC 等），並具備標記、實時歌詞顯示等功能。 另外，還支持換膚及多語言（中英文）切換。核心音頻處理採用 FFmpeg 組件，獲得了廣泛認可，目前 Git ...
  • OAuth2.0授權-gitee授權碼模式
    OAuth2.0授權驗證-gitee授權碼模式 本文主要介紹如何筆者自己是如何使用gitee提供的OAuth2.0協議完成授權驗證並登錄到自己的系統，完整模式如圖 1、創建應用 打開gitee個人中心->第三方應用->創建應用 創建應用後在我的應用界面，查看已創建應用的Client ID和Clien ...
  • FastReport.OpenSource .Net下開源免費報表列印組件
    解決了這個問題：《winForm下，fastReport.net 從.net framework 升級到.net5遇到的錯誤“Operation is not supported on this platform.”》 本文內容轉載自：https://www.fcnsoft.com/Home/Sho ...
  • 如何在 ASP.NET Core Web API 方法執行前後 “偷偷“ 作一些 “壞“ 事？初識 ActionFilterAttribute
    國內文章 WPF 從裸 Win 32 的 WM_Pointer 消息獲取觸摸點繪製筆跡 https://www.cnblogs.com/lindexi/p/18390983 本文將告訴大家如何在 WPF 裡面，接收裸 Win 32 的 WM_Pointer 消息，從消息裡面獲取觸摸點信息，使用觸摸點 ...
  • 在 ASP.NET Core Web API 中使用異常篩選器捕獲和統一處理異常
    前言 給大家推薦一個專為新零售快消行業打造了一套高效的進銷存管理系統。 系統不僅具備強大的庫存管理功能，還集成了高性能的輕量級 POS 解決方案，確保頁面載入速度極快，提供良好的用戶體驗。 項目介紹 Dorisoy.POS 是一款基於 .NET 7 和 Angular 4 開發的新零售快消進銷存管理 ...
  • AbpHelper CLI積累與實戰分享
    ABP CLI常用的代碼分享 一、確保環境配置正確 安裝.NET CLI： ABP CLI是基於.NET Core或.NET 5/6/7等更高版本構建的，因此首先需要在你的開發環境中安裝.NET CLI。這可以通過訪問Microsoft官網下載並安裝相應版本的.NET SDK來實現。 安裝ABP ...
  • 記一次HttpClient使用問題分析
    問題 問題是這樣的：第三方的webapi，需要先調用登陸介面獲取Cookie，訪問其它介面時攜帶Cookie信息。 但使用HttpClient類調用登陸介面，返回的Headers中沒有找到Cookie信息。 分析 首先，使用Postman測試該登陸介面，正常返回Cookie信息，說明是HttpCli ...
  • .NET周刊【9月第3期 2024-09-15】
    國內文章 關於.NET在中國為什麼工資低的分析 https://www.cnblogs.com/thinkingmore/p/18406244 .NET在中國開發者的薪資偏低，主要因市場需求、技術棧選擇和企業文化等因素所致。歷史上，.NET曾因微軟的閉源策略發展受限，儘管後來推出了跨平臺的.NET ...
  • 我的網站集成ElasticSearch初體驗
    在WPF開發應用中，動畫不僅可以引起用戶的註意與興趣，而且還使軟體更加便於使用。前面幾篇文章講解了畫筆（Brush），形狀（Shape），幾何圖形（Geometry），變換（Transform）等相關內容，今天繼續講解動畫相關內容和知識點，僅供學習分享使用，如有不足之處，還請指正。 ...
  • 第23篇 委托的概述
    什麼是委托？ 委托可以說是把一個方法代入另一個方法執行，相當於指向函數的指針；事件就相當於保存委托的數組； 1.實例化委托的方式： 方式1：通過new創建實例： public delegate void ShowDelegate(); 或者 public delegate string ShowDe ...
所有分類