一,開篇分析
文件系統模塊是一個簡單包裝的標准 POSIX 文件 I/O 操作方法集。可以通過調用 require("fs")
來獲取該模塊。文件系統模塊中的所有方法均有異步和同步版本。
(1),文件系統模塊中的異步方法需要一個完成時的回調函數作為最后一個傳入形參。
(2),回調函數的構成由調用的異步方法所決定,通常情況下回調函數的第一個形參為返回的錯誤信息。
(3),如果異步操作執行正確並返回,該錯誤形參則為null
或者undefined
。如果使用的是同步版本的操作方法,一旦出現錯誤,會以通常的拋出錯誤的形式返回錯誤。
(4),可以用try
和catch
等語句來攔截錯誤並使程序繼續進行。
我們先看一個簡單的例子,讀取文件("bb.txt"):
(1),建立文件"bb.txt“,如下內容(”大家好,我是大雄君!(*^__^*) 嘻嘻……“)。
(2),讀取文件操作如下代碼:
1 var fs = require("fs") ; 2 fs.readFile("bb.txt","utf8",function (error,data){ 3 if(error) throw error ; 4 console.log(data) ; 5 }) ;
運行結果:
這里要注意的是:讀取文件一定要設置編碼,否則默認是 ”buffer“ 形式出現。
再看沒設置的運行效果,區別還是很明顯的。如下:
再來一個寫操作,如下:
1 var fs = require("fs") ; 2 var txt = "大家要好好學習NodeJS啊!!!" ; 3 //寫入文件 4 fs.writeFile("bb.txt",txt,function (err) { 5 if (err) throw err ; 6 console.log("File Saved !"); //文件被保存 7 }) ;
運行結果:
在列舉一些常用的實例:
// 刪除文件 fs.unlink('bb.txt', function(){ console.log('success') ; }) ; // 修改文件名稱 fs.rename('bb.txt','bigbear.txt',function(err){ console.log('rename success') ; }); // 查看文件狀態 fs.stat('bb.txt', function(err, stat){ console.log(stat); }); // 判斷文件是否存在 fs.exists('bb.txt', function( exists ){ console.log( exists ) ; }) ;
二,Fs與Stream之間的聯系
"Stream" 具有異步的特性
。我么可以將一個文件或一段內容分為未知個制定大小的 "chunk" 去讀取,每讀取到一個 "chunk" 我們就將他輸出。直到文件讀完。這就像 "http1.1" 種支持的 "Transfer-Encoding: chunked"
那樣。 ("chunk"可以以任何的形式存在,NodeJS默認是以 "Buffer" 的形式存在,這樣更高效
)。NodeJS中的"Stream"具備Unix系統上的一個超級特性就是 ("pipe" ------ 管道
)。
還記得 “Http模塊那篇” 第一個NodeJS程序, "Hello,大熊!" 嗎?我們基於那個小程序做一下修改,如下代碼:
(1),建立“bb.html”
1 <html> 2 <head> 3 <style type="text/css"> 4 div { 5 margin-top: 50px; 6 width: 100%; 7 margin: 0px; 8 height:120px; 9 line-height:120px; 10 color:#fff; 11 font-size:22px; 12 background:#ff9900; 13 text-align: center; 14 } 15 </style> 16 </head> 17 <body> 18 <div>Hello,大熊!</div> 19 </body> 20 </html>
(2),修改之前的程序如下:
1 var http = require('http') ; 2 var fs = require("fs") ; 3 var server = http.createServer(function(req,res){ 4 fs.readFile("bb.html","utf-8", function(err, data){ 5 if(err) { 6 res.writeHead(500, {'Context-Type': 'text/plain'}); 7 res.end('specify file not exists! or server error!'); 8 } 9 else{ 10 res.writeHead(200, {'Context-Type': 'text/html'}); 11 res.write(data); 12 res.end(); 13 } 14 }) 15 }) ; 16 server.listen(8888) ; 17 console.log("http server running on port 8888 ...") ;
以下是運行結果:
現在我們需要思考一下,如果我們要發送的不是一個單純的文本文件而是超媒體文件比如說 Google 2014 IO 大會
的全程高清視頻文件。mp4
格式。長度2個多小時1080p。
大概4個多GB。已知 "readFile"
的工作方式是將文件讀取到內存。那么這么大一個文件顯然是不能這么做的。那該怎么辦呢?是之后就需要使用 stream 的來做。那么是這樣的。
代碼如下像這樣:
fs.createReadStream(__dirname + '/vedio.mp4').pipe(res) ;
總結一下:
這些代碼可以實現需要的功能,但是服務在發送文件數據之前需要緩存整個文件數據到內存,如果"bb.html"文件很
大並且並發量很大的話,會浪費很多內存。因為用戶需要等到整個文件緩存到內存才能接受的文件數據,這樣導致
用戶體驗相當不好。不過還好 "(req, res)"
兩個參數都是Stream,這樣我們可以用fs.createReadStream()
代替"fs.readFile()"。
三,實例賞心
來一個文件上傳的小栗子:
(1),建立“server.js”
1 var http = require('http'); 2 var url = require('url'); 3 function start(route, handler) { 4 function onRequest (request, response) { 5 var pathname = url.parse(request.url).pathname; 6 // 路由到相應的業務邏輯 7 route (pathname, handler, response, request); 8 } 9 http.createServer(onRequest).listen(3000); 10 console.log('server is starting'); 11 } 12 exports.start = start;
(2),建立“route.js”
1 function route (pathname, handler, response, request) { 2 console.log('about to route a request for ' + pathname); 3 if (typeof handler[pathname] === 'function') { 4 return handler[pathname](response, request); 5 } else { 6 console.log('no request handler found for ' + pathname); 7 response.writeHead(404, {'Content-Type': 'text/html'}); 8 response.write('404 Not Found!'); 9 response.end(); 10 } 11 } 12 exports.route = route;
(3),建立“requestHandler.js”
1 var querystring = require('querystring'), 2 fs = require('fs'), 3 formidable = require('formidable'); 4 5 function start (response, request) { 6 console.log('start module'); 7 8 var body = '<html>'+ 9 '<head>'+ 10 '<meta http-equiv="Content-Type" '+ 11 'content="text/html; charset=UTF-8" />'+ 12 '</head>'+ 13 '<body>'+ 14 '<form action="/upload" enctype="multipart/form-data" method="post">'+ 15 '<input type="file" name="upload" multiple="multiple">'+ 16 '<input type="submit" value="Submit text" />'+ 17 '</form>'+ 18 '</body>'+ 19 '</html>'; 20 21 response.writeHead(200, {'Content-Type': 'text/html'}); 22 response.write(body); 23 response.end(); 24 } 25 26 function upload (response, request) { 27 console.log('upload module'); 28 var form = new formidable.IncomingForm(); 29 form.parse(request, function (error, fields, files) { 30 fs.renameSync(files.upload.path, '/tmp/test.png'); 31 response.writeHead(200, {'Content-Type': 'text/html'}); 32 response.write('You\'ve sent: <br />'); 33 response.write('<img src="/show" />'); 34 response.end(); 35 }); 36 } 37 38 function show (response, request) { 39 console.log('show module'); 40 fs.readFile ('/tmp/test.png', 'binary', function (error, file) { 41 if (error) { 42 response.writeHead(200, {'Content-Type': 'text/html'}); 43 response.write(error); 44 response.end(); 45 } else { 46 response.writeHead(200, {'Content-Type': 'image/png'}); 47 response.write(file, 'binary'); 48 response.end(); 49 50 } 51 }); 52 } 53 54 exports.start = start; 55 exports.upload = upload; 56 exports.show= show;
(4),建立“index.js”
1 var server = require('./server'); 2 var router = require('./router'); 3 var requestHandler = require('./requestHandler'); 4 var formidable = require('formidable'); // require路徑搜索算法?? 5 var handler = {}; 6 handler['/'] = requestHandler.start; 7 handler['/start'] = requestHandler.start; 8 handler['/upload'] = requestHandler.upload; 9 handler['/show'] = requestHandler.show; 10 server.start(router.route, handler);
四,總結一下
(1),理解 "Fs與Stream之間的聯系" 。
(2),熟練使用 "FS" 相關的api。
(3),注意細節的把控,比如: 文件操作api同步方式與異步方式之間的處理細節。
(4),最后強調:理解文件上傳例子中的代碼組織方式,不斷重構,不斷總結。
哈哈哈,本篇結束,未完待續,希望和大家多多交流夠溝通,共同進步。。。。。。呼呼呼……(*^__^*)