NodeJS學(xué)習(xí)筆記之FS文件模塊

更新時(shí)間：2015年01月13日 11:13:50 投稿：hebedich

在看nodejs介紹的過(guò)程中，nodejs對(duì)自己的異步I/O是重點(diǎn)突出的說(shuō)明的。在fs模塊中，nodejs提供了異步和同步兩種讀寫(xiě)方式

一，開(kāi)篇分析

文件系統(tǒng)模塊是一個(gè)簡(jiǎn)單包裝的標(biāo)準(zhǔn) POSIX 文件 I/O 操作方法集?？梢酝ㄟ^(guò)調(diào)用 require("fs") 來(lái)獲取該模塊。文件系統(tǒng)模塊中的所有方法均有異步和同步版本。

（1），文件系統(tǒng)模塊中的異步方法需要一個(gè)完成時(shí)的回調(diào)函數(shù)作為最后一個(gè)傳入形參。

（2），回調(diào)函數(shù)的構(gòu)成由調(diào)用的異步方法所決定，通常情況下回調(diào)函數(shù)的第一個(gè)形參為返回的錯(cuò)誤信息。

（3），如果異步操作執(zhí)行正確并返回，該錯(cuò)誤形參則為null或者undefined。如果使用的是同步版本的操作方法，一旦出現(xiàn)錯(cuò)誤，會(huì)以通常的拋出錯(cuò)誤的形式返回錯(cuò)誤。

（4），可以用try和catch等語(yǔ)句來(lái)攔截錯(cuò)誤并使程序繼續(xù)進(jìn)行。

我們先看一個(gè)簡(jiǎn)單的例子，讀取文件（"bb.txt"）:

（1），建立文件"bb.txt“，如下內(nèi)容（”大家好，我是大雄君！(*^__^*) 嘻嘻……“）。

（2），讀取文件操作如下代碼：

復(fù)制代碼代碼如下:

 var fs = require("fs") ;

 fs.readFile("bb.txt","utf8",function (error,data){

     if(error) throw error ;

     console.log(data) ;

 }) ;

運(yùn)行結(jié)果：

這里要注意的是：讀取文件一定要設(shè)置編碼，否則默認(rèn)是 ”buffer“ 形式出現(xiàn)。

再看沒(méi)設(shè)置的運(yùn)行效果，區(qū)別還是很明顯的。如下：

再來(lái)一個(gè)寫(xiě)操作，如下：

復(fù)制代碼代碼如下:

 var fs = require("fs") ;

 var txt = "大家要好好學(xué)習(xí)NodeJS?。。?！" ;

 //寫(xiě)入文件

 fs.writeFile("bb.txt",txt,function (err) {

     if (err) throw err ;

     console.log("File Saved !"); //文件被保存

 }) ;

運(yùn)行結(jié)果：

在列舉一些常用的實(shí)例：

復(fù)制代碼代碼如下:

// 刪除文件

fs.unlink('bb.txt', function(){

console.log('success') ;

}) ;

// 修改文件名稱(chēng)

fs.rename('bb.txt','bigbear.txt',function(err){

console.log('rename success') ;

});

// 查看文件狀態(tài)

fs.stat('bb.txt', function(err, stat){

 console.log(stat);

});

// 判斷文件是否存在

fs.exists('bb.txt', function( exists ){

   console.log( exists ) ;

}) ;

二，F(xiàn)s與Stream之間的聯(lián)系

"Stream" 具有異步的特性。我么可以將一個(gè)文件或一段內(nèi)容分為未知個(gè)制定大小的 "chunk" 去讀取，每讀取到一個(gè) "chunk" 我們就將他輸出。直到文件讀完。這就像 "http1.1" 種支持的 "Transfer-Encoding: chunked" 那樣。 ("chunk"可以以任何的形式存在，NodeJS默認(rèn)是以 "Buffer" 的形式存在，這樣更高效)。NodeJS中的"Stream"具備Unix系統(tǒng)上的一個(gè)超級(jí)特性就是 ("pipe" ------ 管道)。

還記得 “Http模塊那篇” 第一個(gè)NodeJS程序， "Hello,大熊！" 嗎？我們基于那個(gè)小程序做一下修改，如下代碼：

（1），建立“bb.html”

復(fù)制代碼代碼如下:

 <html>

     <head>

         <style type="text/css">

             div {

                 　　margin-top: 50px;

                　　 width: 100%; 

                   　margin: 0px;

                 　　height:120px;

                 　　line-height:120px;

                    color:#fff;

                    font-size:22px;

                    background:#ff9900;

                 　 text-align: center;

             }

         </style>

     </head>

     <body>

         <div>Hello,大熊！</div>

     </body>

 </html>

（2），修改之前的程序如下：

復(fù)制代碼代碼如下:

 var http = require('http') ;

 var fs = require("fs") ;

 var server = http.createServer(function(req,res){

     fs.readFile("bb.html","utf-8", function(err, data){

       if(err) {

           res.writeHead(500, {'Context-Type': 'text/plain'});

           res.end('specify file not exists! or server error!');

       }

       else{

         res.writeHead(200, {'Context-Type': 'text/html'});

         res.write(data);

         res.end();

       }

   })

 }) ;

 server.listen(8888) ;

 console.log("http server running on port 8888 ...") ;

以下是運(yùn)行結(jié)果：

現(xiàn)在我們需要思考一下，如果我們要發(fā)送的不是一個(gè)單純的文本文件而是超媒體文件比如說(shuō) Google 2014 IO 大會(huì) 的全程高清視頻文件。mp4 格式。長(zhǎng)度2個(gè)多小時(shí)1080p。

大概4個(gè)多GB。已知 "readFile" 的工作方式是將文件讀取到內(nèi)存。那么這么大一個(gè)文件顯然是不能這么做的。那該怎么辦呢？是之后就需要使用 stream 的來(lái)做。那么是這樣的。

代碼如下像這樣：

復(fù)制代碼代碼如下:

fs.createReadStream(__dirname + '/vedio.mp4').pipe(res) ;

總結(jié)一下：

這些代碼可以實(shí)現(xiàn)需要的功能，但是服務(wù)在發(fā)送文件數(shù)據(jù)之前需要緩存整個(gè)文件數(shù)據(jù)到內(nèi)存，如果"bb.html"文件很
大并且并發(fā)量很大的話，會(huì)浪費(fèi)很多內(nèi)存。因?yàn)橛脩粜枰鹊秸麄€(gè)文件緩存到內(nèi)存才能接受的文件數(shù)據(jù)，這樣導(dǎo)致
用戶體驗(yàn)相當(dāng)不好。不過(guò)還好 "(req, res)" 兩個(gè)參數(shù)都是Stream，這樣我們可以用fs.createReadStream()代替"fs.readFile()"。

三，實(shí)例

來(lái)一個(gè)文件上傳的小栗子：

（1），建立“server.js”

復(fù)制代碼代碼如下:

 var http = require('http');

 var url = require('url');

 function start(route, handler) {

     function onRequest (request, response) {

         var pathname = url.parse(request.url).pathname;

         // 路由到相應(yīng)的業(yè)務(wù)邏輯

         route (pathname, handler, response, request);

     }

     http.createServer(onRequest).listen(3000);

     console.log('server is starting');

 }

 exports.start = start;

（2），建立“route.js”

復(fù)制代碼代碼如下:

 function route (pathname, handler, response, request) {

     console.log('about to route a request for ' + pathname);

     if (typeof handler[pathname] === 'function') {

         return handler[pathname](response, request);

     } else {

         console.log('no request handler found for ' + pathname);

         response.writeHead(404, {'Content-Type': 'text/html'});

         response.write('404 Not Found!');

         response.end();

     }

 }

 exports.route = route;

（3），建立“requestHandler.js”

復(fù)制代碼代碼如下:

var querystring = require('querystring'),

    fs = require('fs'),

    formidable = require('formidable');

function start (response, request) {

    console.log('start module');

  var body = '<html>'+

      '<head>'+

      '<meta http-equiv="Content-Type" '+

      'content="text/html; charset=UTF-8" />'+

      '</head>'+

      '<body>'+

      '<form action="/upload" enctype="multipart/form-data" method="post">'+

      '<input type="file" name="upload" multiple="multiple">'+

      '<input type="submit" value="Submit text" />'+

      '</form>'+

      '</body>'+

      '</html>';

    response.writeHead(200, {'Content-Type': 'text/html'});

    response.write(body);

    response.end();

}

function upload (response, request) {

    console.log('upload module');

    var form = new formidable.IncomingForm();

    form.parse(request, function (error, fields, files) {

        fs.renameSync(files.upload.path, '/tmp/test.png');

        response.writeHead(200, {'Content-Type': 'text/html'});

        response.write('You\'ve sent: <br />');

        response.write('<img src="/show" />');

        response.end();

    });

}

function show (response, request) {

    console.log('show module');

    fs.readFile ('/tmp/test.png', 'binary', function (error, file) {

        if (error) {

            response.writeHead(200, {'Content-Type': 'text/html'});

            response.write(error);

            response.end();

        } else {

            response.writeHead(200, {'Content-Type': 'image/png'});

            response.write(file, 'binary');

            response.end();

        }

    });

}

exports.start = start;

exports.upload = upload;

exports.show= show;

（4），建立“index.js”

復(fù)制代碼代碼如下:

 var server = require('./server');

 var router = require('./router');

 var requestHandler = require('./requestHandler');

 var formidable = require('formidable'); // require路徑搜索算法？？

 var handler = {};

 handler['/'] = requestHandler.start;

 handler['/start'] = requestHandler.start;

 handler['/upload'] = requestHandler.upload;

 handler['/show'] = requestHandler.show;

 server.start(router.route, handler);

四，總結(jié)一下

（1），理解 "Fs與Stream之間的聯(lián)系" 。
（2），熟練使用 "FS" 相關(guān)的api。
（3），注意細(xì)節(jié)的把控，比如：文件操作api同步方式與異步方式之間的處理細(xì)節(jié)。
（4），最后強(qiáng)調(diào)：理解文件上傳例子中的代碼組織方式，不斷重構(gòu)，不斷總結(jié)。

您可能感興趣的文章: