node学习一 （node模块化，fs常见文件操作）

node中的模块: commonJs

模块是Node.js 应用程序的基本组成部分，文件和模块是一一对应的。换言之，一个 Node.js 文件就是一个模块，这个文件可能是JavaScript 代码、JSON 或者编译过的C/C++ 扩展。

• 一个文件就是一个模块
  采用module.exports 暴露方法和属性
  通过require外部可以导入

每个模块内部，module变量代表当前模块。这个变量是一个对象，它的exports属性（即module.exports）是对外的接口。加载某个模块，其实是加载该模块的module.exports属性。

var x = 5;
var addX = function (value) {
  return value + x;
};
module.exports.x = x;
module.exports.addX = addX;

上面代码通过module.exports输出变量x和函数addX。
require方法用于加载模块。

var example = require('./example.js');  
//相当于 example = module.exports
console.log(example.x); // 5
console.log(example.addX(1)); // 6

node中的模块和es6中的模块有一定的区别，本文不做比较，这里我们后面再做了解。因为现在nodejs 不支持es6语法，所有在webpack 的配置文件里面还要通过require来导入。

包的入口文件index.js

在组成一个包的所有子模块中，需要有一个入口模块，入口模块的导出对象被作为包的导出对象。例如有以下目录结构。

- /home/user/lib/
    - cat/
        head.js
        body.js
        main.js

使用require('/home/user/lib/cat/main')能达到目的，但是入口模块名称出现在路径里看上去不是个好主意。

当模块的文件名是index.js，加载模块时可以使用模块所在目录的路径代替模块文件路径，因此以下两条语句等价。

var cat = require('/home/user/lib/cat');
var cat = require('/home/user/lib/cat/index');

这样处理后，就只需要把包目录路径传递给require函数，感觉上整个目录被当作单个模块使用，更有整体感。

package.json

如果想自定义入口模块的文件名和存放位置，就需要在包目录下包含一个package.json文件，并在其中指定入口模块的路径。上例中的cat模块可以重构如下。

- /home/user/lib/
    - cat/
        + doc/
        - lib/
            head.js
            body.js
            main.js
        + tests/
        package.json

其中package.json内容如下。
{
"name": "cat",
"main": "./lib/main.js"
}

如此一来，就同样可以使用require('/home/user/lib/cat')的方式加载模块。NodeJS会根据包目录下的package.json找到入口模块所在位置。 这样他就不会默认去找cat文件夹下的index文件了，而是通过package.json来找入口文件。

内置FS模块

Node.js 提供一组类似 UNIX（POSIX）标准的文件操作API。 Node 导入文件系统模块(fs)语法如下所示：

const fs = require("fs")

异步和同步

Node.js 文件系统（fs 模块）模块中的方法均有异步和同步版本，例如读取文件内容的函数有异步的 fs.readFile() 和同步的 fs.readFileSync()。

异步的方法函数最后一个参数为回调函数，回调函数的第一个参数包含了错误信息(error)。

建议大家使用异步方法，比起同步，异步方法性能更高，速度更快，而且没有阻塞。

fs常用方法

这里介绍练习的方法都是异步的方法，同步方法使用这里不做介绍

• fs.stat
  检测传入的路径是文件还是目录

fs.stat('./html',function(err,data){
    if(err){
        console.log(err);
        return;
    }
    console.log(`是文件吗：${data.isFile()}`);
    console.log(`是目录吗: ${data.isDirectory()}`);
})
fs.stat('./html/app.html',function(err,data){
    if(err){
        console.log(err);
        return;
    }
    console.log(`是文件吗：${data.isFile()}`);
    console.log(`是目录吗：${data.isDirectory()}`);
})

• fs.mkdir
  创建目录
  path 将创建的目录路径
  mode 目录权限（读写权限），默认777
  callback 回调，传递异常参数err
  如果目录不存在 就创建， 如果存在 就报错 改路径已经存在

fs.mkdir(`./css`,function(err,data){
    if(err){
        console.log(err);
        return;
    }
    console.log('创建成功');
})

• fs.writeFile
  创建写入文件
  如果文件不存在就创建 如果文件存在 就替换

fs.writeFile('./html/app.html','你好 nodeJs', (err) => {
    if(err){
        console.log(err);
        return;
    }
    console.log('创建写入文件成功');
})

• fs.appendFile
  如果文件不存在就创建然后写入 如果存在就在内容后面追加

fs.appendFile('./css/base.css','body{color:red}',(err)=>{
    if(err){
        console.log(err);
        return;
    }
    console.log('appendFile 成功')
})

fs.appendFile('./css/base.css','h2{font-size:12px}',(err)=>{
    if(err){
        console.log(err);
        return;
    }
    console.log('appendFild 成功');
})

• fs.readDir
  查看目录
  会列出该路径下的文件和文件夹（只包含儿子，不包含孙子）

 fs.readdir('./html',(err,data)=> {
    if(err){
        console.log(err);
        return;
    }
    console.log(data);
 })

• fs.rename
  功能：
  1、 重命名文件 2、移动文件（相当于重命名路径）

fs.rename('./html/app.html','./html/index.html',(err) => {
    if(err){
        console.log(err);
        return;
    }
    console.log('重命名成功');
})
fs.rename('./css/base.css','./html/index.css',err =>{
    if(err){
        console.log(err);
        return;
    }
    console.log('移动成功');
})

• fs.rmdir
  删除目录 但是只能删除空的目录

fs.rmdir('./html/html2/',err => {
    if(err){
        console.log(err);
        return;
    }
    console.log('删除目录成功');
})

• fs.unlink
  删除文件

fs.unlink('./html/html2/index.html',err => {
    if(err){
        console.log(err);
        return;
    }
    console.log('删除文件成功');
})

文件流

阅读流

// 创建一个只读的流
const createRead = fs.createReadStream('./data/input.txt');

let count = 0;
let str = '';

// 当有数据可读时触发
createRead.on('data',(data)=>{
    str=str+data;
    count++;
})

// 当没有更多的数据可读时触发
createRead.on('end',()=> {
    console.log(str);
    console.log(count)
})
// 发生错误事触发
createRead.on('err',(err)=>{
    console.log(err.stack);
})

写入的流

// 写入的流
const fs = require('fs');

const data = '测试测试测试测试测试测试测试测试测试测试测试测试测试测试';

let str='';

// 创建一个写入的流 并写入到 ./data/data.txt文件中
const writeStream = fs.createWriteStream('./data/data.txt');

for(var i=0;i<500;i++){
    str = str + `${data}${i}\r\n`;
}

// 写入data数据 并设置格式
writeStream.write(str,'UTF8');

writeStream.end();//如果不写 end   不会触发finish事件

writeStream.on('finish',()=>{
    console.log('写入完成');
})

writeStream.on('err',(err)=>{
    console.log(err.stack);
})

参考文章：

• 七天学会NodeJS
• Node.js 教程
• node.js模块中exports和module.exports的区别