NodeJS学习笔记之FS文件模块


Posted in NodeJs onJanuary 13, 2015

一,开篇分析

文件系统模块是一个简单包装的标准 POSIX 文件 I/O 操作方法集。可以通过调用 require("fs") 来获取该模块。文件系统模块中的所有方法均有异步和同步版本。

(1),文件系统模块中的异步方法需要一个完成时的回调函数作为最后一个传入形参。

(2),回调函数的构成由调用的异步方法所决定,通常情况下回调函数的第一个形参为返回的错误信息。

(3),如果异步操作执行正确并返回,该错误形参则为null或者undefined。如果使用的是同步版本的操作方法,一旦出现错误,会以通常的抛出错误的形式返回错误。

(4),可以用try和catch等语句来拦截错误并使程序继续进行。

我们先看一个简单的例子,读取文件("bb.txt"):

(1),建立文件"bb.txt“,如下内容(”大家好,我是大雄君!(*^__^*) 嘻嘻……“)。

(2),读取文件操作如下代码:

 var fs = require("fs") ;

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

     if(error) throw error ;

     console.log(data) ;

 }) ;

运行结果:

NodeJS学习笔记之FS文件模块

这里要注意的是:读取文件一定要设置编码,否则默认是 ”buffer“ 形式出现。

再看没设置的运行效果,区别还是很明显的。如下:

NodeJS学习笔记之FS文件模块

再来一个写操作,如下:

 var fs = require("fs") ;

 var txt = "大家要好好学习NodeJS啊!!!" ;

 //写入文件

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

     if (err) throw err ;

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

 }) ;

运行结果:

NodeJS学习笔记之FS文件模块

在列举一些常用的实例:

// 删除文件

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”

 <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),修改之前的程序如下:

 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 ...") ;

以下是运行结果:

NodeJS学习笔记之FS文件模块

现在我们需要思考一下,如果我们要发送的不是一个单纯的文本文件而是超媒体文件比如说 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”

 var http = require('http');

 var url = require('url');

 function start(route, handler) {

     function onRequest (request, response) {

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

         // 路由到相应的业务逻辑

         route (pathname, handler, response, request);

     }

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

     console.log('server is starting');

 }

 exports.start = start;

(2),建立“route.js”

 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”

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”

 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);

四,总结一下

(1),理解 "Fs与Stream之间的联系" 。
(2),熟练使用 "FS" 相关的api。
(3),注意细节的把控,比如: 文件操作api同步方式与异步方式之间的处理细节。
(4),最后强调:理解文件上传例子中的代码组织方式,不断重构,不断总结。

NodeJs 相关文章推荐
使用nodejs下载风景壁纸
Feb 05 NodeJs
详解nodejs异步I/O和事件循环
Jun 07 NodeJs
nodejs接入阿里大鱼短信验证码的方法
Jul 10 NodeJs
nodejs简单访问及操作mysql数据库的方法示例
Mar 15 NodeJs
nodejs连接mysql数据库及基本知识点详解
Mar 20 NodeJs
nodejs更改项目端口号的方法
May 13 NodeJs
NodeJs 模仿SIP话机注册的方法
Jun 21 NodeJs
nodejs实现UDP组播示例方法
Nov 04 NodeJs
nodejs开发一个最简单的web服务器实例讲解
Jan 02 NodeJs
详解nodejs内置模块
May 06 NodeJs
分享五个Node.js开发的优秀实践 
Apr 07 NodeJs
浅谈Node的内存泄露问题
May 06 NodeJs
NodeJS学习笔记之Http模块
Jan 13 #NodeJs
Nodejs学习笔记之Stream模块
Jan 13 #NodeJs
Nodejs学习笔记之NET模块
Jan 13 #NodeJs
Nodejs学习笔记之Global Objects全局对象
Jan 13 #NodeJs
Nodejs为什么选择javascript为载体语言
Jan 13 #NodeJs
NodeJS中Buffer模块详解
Jan 07 #NodeJs
Nodejs中读取中文文件编码问题、发送邮件和定时任务实例
Jan 01 #NodeJs
You might like
3.从实例开始
2006/10/09 PHP
文件系统基本操作类
2006/11/23 PHP
PHP setcookie设置Cookie用法(及设置无效的问题)
2011/07/13 PHP
jQuery获取地址栏参数插件(模仿C#)
2010/10/26 Javascript
Javascript Request获取请求参数如何实现
2012/11/28 Javascript
JS注册/移除事件处理程序(ExtJS应用程序设计实战)
2013/05/07 Javascript
js中unicode转码方法详解
2015/10/09 Javascript
javascript设计模式之Adapter模式【适配器模式】实现方法示例
2017/01/13 Javascript
微信小程序之电影影评小程序制作代码
2017/08/03 Javascript
利用yarn代替npm管理前端项目模块依赖的方法详解
2017/09/04 Javascript
Bootstrap Tooltip显示换行和左对齐的解决方案
2017/10/11 Javascript
r.js来合并压缩css文件的示例
2018/04/26 Javascript
Node.js模块全局安装路径配置方法
2018/05/17 Javascript
详解vue-router 初始化时做了什么
2018/06/11 Javascript
js回调函数仿360开机
2019/12/26 Javascript
[02:11]2014DOTA2 TI专访VG战队Fenrir:队伍气氛良好
2014/07/11 DOTA
[04:42]2015国际邀请赛CDEC战队晋级之路
2015/08/13 DOTA
[00:20]DOTA2荣耀之路7:-ah fu-抢盾
2018/05/31 DOTA
[54:27]TNC vs Serenity 2018国际邀请赛小组赛BO2 第一场 8.18
2018/08/19 DOTA
Python的string模块中的Template类字符串模板用法
2016/06/27 Python
浅谈pyhton学习中出现的各种问题(新手必看)
2017/05/17 Python
django初始化数据库的实例
2018/05/27 Python
Python同步遍历多个列表的示例
2019/02/19 Python
Eclipse配置python默认头过程图解
2020/04/26 Python
将python字符串转化成长表达式的函数eval实例
2020/05/11 Python
一些Solaris面试题
2013/03/22 面试题
介绍一下Java中标识符的命名规则
2014/02/03 面试题
保护环境倡议书范文
2014/05/13 职场文书
教育项目合作协议书格式
2014/10/17 职场文书
文明单位申报材料
2014/12/23 职场文书
工作会议简报
2015/07/20 职场文书
社区低保工作总结2015
2015/07/23 职场文书
2016年小学端午节活动总结
2016/04/01 职场文书
中学生打架《检讨书》范文
2019/08/12 职场文书
Nginx反向代理学习实例教程
2021/10/24 Servers
python分分钟绘制精美地图海报
2022/02/15 Python