NodeJs

Node.js 是一个免费、开源、跨平台的 JavaScript 运行时环境,基于 Chrome V8 引擎,让开发者可以创建服务器、Web 应用、命令行工具和脚本。

其核心思想是**用 JavaScript 统一前后端开发语言**,从而让前端开发者也能轻松编写服务端程序。

传统服务端开发需要掌握不同语言(如 Java、PHP),而 Node.js 让开发者仅用 JavaScript 即可完成前后端开发,降低了学习与协作成本。
Node.js · 技术笔记

1. 概述

1.1 Node.js 简介

Node.js is a free, open-source, cross-platform JavaScript runtime environment that lets developers create servers, web apps, command line tools and scripts.

Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行环境。

Node.js 的官网地址:https://nodejs.org/zh-cn/

1.2 下载与安装

下载 | Node.js 中文网 (nodejs.cn)

1.3 fs 文件系统模块

1.3.1 什么是 fs 文件系统模块

fs 模块是 Node.js 官方提供的、用来操作文件的模块。它提供了一系列的方法和属性,用来满足用户对文件的操作需求。

例如:

  • fs.readFile() 方法,用来读取指定文件中的内容
  • fs.writeFile() 方法,用来向指定的文件中写入内容

如果要在 JavaScript 代码中,使用 fs 模块来操作文件,则需要使用如下的方式先导入它:

const fs = require('fs')

1.3.2 读取与写入文件

1. 读取指定文件中的内容

fs.readFile() 的语法格式

使用 fs.readFile() 方法,可以读取指定文件中的内容,语法格式如下:

fs.readFile(path[, options], callback)

  • 参数1:必选参数,字符串,表示文件的路径
  • 参数2:可选参数,表示以什么编码格式来读取文件
  • 参数3:必选参数,文件读取完成后,通过回调函数拿到读取的结果

2. 向指定的文件中写入内容

fs.writeFile() 的语法格式

使用 fs.writeFile() 方法,可以向指定的文件中写入内容,语法格式如下:

fs.writeFile(file, data[, options], callback)

  • 参数1:必选参数,需要指定一个文件路径的字符串,表示文件的存放路径
  • 参数2:必选参数,表示要写入的内容
  • 参数3:可选参数,表示以什么格式写入文件内容,默认值是 utf8
const fs=require('fs');

/* fs.readFile("1.txt","utf-8",function(err,dataStr)
{
    console.log(dataStr);
}) */

/* fs.writeFile("1.txt","ik","utf-8",function(err){
    console.log(err);
}) */

fs.readFile("1.txt","utf-8",function(err,dataStr)
{
    const arrNew=[];
    const arr = dataStr.split(' ');

    arr.forEach(item=>{
        arrNew.push(item.replace('=',':'));
    })
    const garr=arrNew.join('\r\n');
    console.log(arr);
    console.log(arrNew);
    console.log(garr);
    fs.writeFile('2.txt',garr,'utf-8',function(err){
        console.log(err);
    })
})

2. 路径操作(path 模块)

2.1 路径拼接 path.join

路径的拼接使用 join 方法。

const path = require("path");

const pathStr = path.join('/a','/b/c','../../','./d','e');

console.log(pathStr);

__dirname 表示当前文件所在的目录路径名。

2.2 获取路径中的文件名 path.basename

path1="1.txt";
const str = path.basename(path1,".txt");
console.log(str);

2.3 获取文件的后缀名 path.extname

const fpath= "1.txt";
const ftxt = path.extname(fpath);
console.log(ftxt);

2.4 综合小脚本

下面是一段从 HTML 文件中分离出 style、script 并重新组织的小脚本:

const fs =require("fs");
const path = require("path");

const regStyle = /<style>[\s\S]*<\/style>/
const regScript = /<script>[\s\S]*<\/script>/

fs.readFile("./index.html",'utf-8',function(err,dataStr){
    if (err) return console.log("读取失败"+err.message);
    resolveCSS(dataStr);
    resolveScript(dataStr);
    resolveHTML(dataStr);
})

function resolveCSS(htmlstr){
    const str1 = regStyle.exec(htmlstr);
    const nstr = str1[0].replace('<style>','').replace('</style>','');
    fs.writeFile(path.join(__dirname,'/clcok.css'),nstr,function(err,dataStr){
        if (err) return console.log("写入失败");
        console.log("写入成功");
    })
}

function resolveScript(htmlstr1){
    const str2 = regScript.exec(htmlstr1);
    const nstr2 = str2[0].replace('<script>','').replace('</script>','');
    fs.writeFile(path.join(__dirname,'/clcoks.js'),nstr2,function(err,dataStr){
        if (err) return console.log("写入失败");
        console.log("写入成功");
    })
}

function resolveHTML(htmlstr){
    const html = htmlstr.replace(regStyle,'<link rel="stylesheet" href="./clcok.css">').replace(regScript,'<script src="./clcoks.js"></script>');
    fs.writeFile('index.html',html,function(err,dataStr){
        if (err) return console.log("写入失败");
        console.log("写入成功");
    })
}

注意:后写入的内容会覆盖之前写入的内容。

3. http 模块

3.1 创建基础服务器

1. 导入 http 模块

const http = require('http')

const http = require('http')

const serve = http.createServer()

serve.on('request',(req,res)=>{
    console.log("web serve start");
})

serve.listen(1910,()=>{
    console.log("port:"+1910);
})

3.2 获取请求信息

serve.on('request',function(req,res){
    const url = req.url;
    const method  = req.method;
    console.log(url+"   "+method);
})

req.url 获取网址;req.method 获取请求方式。

3.3 解决中文乱码

通过设置响应头解决中文乱码:

res.setHeader('Content-Type','text/html; charset=utf-8');

const http = require('http');

const serve =http.createServer();

serve.on('request',function(req,res){
    const url = req.url;
    const method  = req.method;
    console.log(url+"   "+method);
    const str = "启动";
    res.setHeader('Content-Type','text/html; charset=utf-8');
    res.end(str);

})

serve.listen(1910,function(){
    console.log("启动");
})

3.4 根据 URL 响应不同内容

const http = require('http');

const serve = http.createServer();

serve.on('request',function(req,res){
    const url = req.url;

    let content = '404 Not Found';

    if (url === '/' || url === '/index.html'){
        content = '<h1>首页</h1>'
    }else if (url === '/other.html'){
        content = '<h2>其他</h2>'
    }

    res.setHeader('Content-Type','text/html; charset=utf-8');

    res.end(content);
})

serve.listen(1910,function(){
    console.log("启动服务");
})

3.5 静态资源服务小案例

const fs = require("fs");
const http = require("http");
const path = require("path");

const serve = http.createServer();

serve.on('request',(req,res)=>{
    const url = req.url;
    const str1 = path.join(__dirname,url);
    console.log(str1);
    fs.readFile(str1,'utf-8',function(err,dataStr){
        if (err) return res.end("404 Not found");
        res.end(dataStr);
    })
})

serve.listen(1910,function(){
    console.log("启动");
})

4. 模块化

4.1 模块的规范性

模块化规范就是对代码进行模块化的拆分与组合时,需要遵守的那些规则。例如:

  • 使用什么样的语法格式来引用模块
  • 在模块中使用什么样的语法格式向外暴露成员

模块化规范的好处:大家都遵守同样的模块化规范写代码,降低了沟通的成本,极大方便了各个模块之间的相互调用,利人利己。

4.2 Node.js 中的模块分类

Node.js 中的模块主要分为三类:

模块类型 说明 示例
内置模块 Node.js 官方内置 fs、path、http
自定义模块 用户自己创建的 .js 文件 用户创建的模块文件
第三方模块 由第三方开发并发布的模块 通过 npm 安装的包

加载模块使用 require():

require()

4.3 模块作用域

在自定义模块中的变量、方法等成员,只能在当前模块内被访问,这种模块级别的限制就叫做模块作用域。

好处

  • 防止全局变量被污染

向外共享模块作用域中的成员

module 对象:存储和当前模块有关的信息

module.exports 对象:可以将模块的成员共享出去,供外界使用。在外界用 require() 导入自定义模块得到 module.exports 对象。

默认情况下 module.exports 等于空对象。

module.exports.uname = "zs";

module.exports.say = function(){
    console.log("Hi");
}

以 module.exports 指向的对象为准。

module.exports.uname = "zs";

module.exports.say = function(){
    console.log("Hi");
}

module.exports = {
    nuname : 'ls',
    nsay(){
        console.log("HHi")
    }
}

exports 对象:

module.exports 对象与 exports 对象指向同一个对象。

exports.uname='ls';

exports.age=19;

建议不要在同一个文件同时使用 module.exports、exports。

4.4 CommonJS 规范

  1. 每个模块的 module 代表当前模块
  2. module 变量是一个对象,module.exports 是一个接口
  3. require() 用来加载模块

5. npm 包管理

5.1 格式化时间

function dateformat(dastr){
    function zero(str){
        if (str<10) return '0'+str
    }
    const dt = new Date(dastr);

    const m = dt.getFullYear();

    const n = zero(dt.getMonth());

    const d = zero(dt.getDay());

    return `${m}-${n}-${d}`;
}

module.exports.dateformat=dateformat;
const req = require("./time")

const dt = new Date();

const s = req.dateformat(dt);

console.log(s)

5.2 安装与卸载包

npm install 包名

简写

npm i 包名
const moment = require("moment");

const dt = moment().format('YYYY-MM-DD');

console.log(dt);

安装指定版本的包:npm i moment@版本

5.3 语义化版本规范

以 2.24.0 为例:

位置 含义
第1位 大版本
第2位 功能版本
第3位 Bug 修复版本

5.4 包管理配置文件

快速创建 package.json 文件

npm init -y

要在 .gitignore 文件中添加 node_modules,避免将其提交到仓库。

5.5 dependencies 与 devDependencies

dependencies 用来记录使用 npm 下载了哪些包(项目运行所依赖)。

  • npm i:根据 package.json 直接安装所有依赖包
  • npm uninstall 包名:卸载包

某些包只在开发阶段使用,加入 devDependencies 节点;某些包在开发和上线后都需要使用,加入 dependencies 节点。

npm install webpack -D

5.6 镜像源与 nrm

查看当前镜像源:

npm config get registry

设置镜像源:

npm config set registry=https://registry.npm.taobao.org/

nrm 可以方便地切换镜像源:

npx nrm ls

npx nrm use taobao

5.7 包的分类

分类 说明 安装位置 / 命令
项目包 被安装到 node_modules 目录 开发依赖包 → devDependencies;核心依赖包 → dependencies
全局包 使用 npm install 加上 -g 参数 C:\Users\用户名\AppData\Roaming\npm\node_modules;卸载:npm uninstall 包名 -g

i5ting_toc 可以把 .md 转成 html:

npm install -g i5ting_toc

i5ting_toc -f .md -o

5.8 包的规范

一个规范的包需要满足:

  1. 单独目录存在
  2. 有 package.json 文件
  3. 有 name、version、main 三个属性(包名、版本号、包的入口)

5.9 自定义包

新建文件夹作为根目录,至少包含:

  1. package.json
  2. index.js
  3. README.md
function htmlEscape(htmlstr){
    return htmlstr.replace(/<|>|"|&/g,match=>{
        switch (match){
            case '<':
                return '&lt;';
            case '>':
                return '&gt;'
            case '"':
                return '&quot;'
            case '&':
                return '&amp;'
        }
    })
}

function htmlUnEscape(htmlstr){
    return htmlstr.replace(/&lt;|&gt;|&quot;|&amp;/g,match=>{
        switch (match){
            case '&lt;':
                return '<';
            case '&gt;':
                return '>'
            case '&quot;':
                return '"'
            case '&amp;':
                return '&'
        }
    })
}

module.exports={
    htmlEscape,
    htmlUnEscape
}

模块拆分示例:

const html = require("./src/html")
const unhtml = require("./src/unhtml")

module.exports={
    ...html,
    ...unhtml
}

5.10 发布 npm 包

  1. 注册 npm 账号
  2. 登录:npm login
  3. 发布:npm publish
  4. 删除包:npm unpublish 包名 --force

只能删除 72 小时以内发布的包;删除的包,在 24 小时内不允许发布没有意义的包。

5.11 模块的加载机制

  • 模块加载一次后会被缓存
  • 内置模块加载优先级最高
  • 在加载内置模块时,需要以 ./ 或 ../ 开头
  • 默认加载 main 入口;如果没找到,会找 index.js,否则报错

6. Express 框架

6.1 基本使用与 req.query

获取 url 中携带的参数:req.query

6.2 获取动态参数

const express = require("express");

const app = express();

app.all("/serve/:id",function(req,res){
    console.log(req.params);
    const str = JSON.stringify(req.params)
    res.end(str)
})

app.listen(4400,()=>{
    console.log("启动服务");
})

6.3 托管静态资源

express.static() 可以创建一个静态资源服务器,通过如下代码就可以将 public 目录下的图片、CSS 文件、JavaScript 文件对外开放访问了:

app.use(express.static('public'))

app.use('/file',express.static('public'))

对应的访问地址示例:

注意:Express 在指定的静态目录中查找文件,并对外提供资源的访问路径,因此存放静态文件的目录名不会出现在 URL 中。

有多个静态资源目录就多次调用这个函数。

6.4 路由模块

const express = require("express");

const router = express.Router();

router.get("/serve/:id",function(req,res){
    console.log(req.params);
    const str = JSON.stringify(req.params);
    res.end(str);
})

router.post("/serve",function(req,res){
    console.log("POST");
    res.end("123");
})

module.exports = router;
const express = require("express");

const app = express();

const router = require('./model1')

app.use(router);

app.listen(4400,()=>{
    console.log("启动服务");
})

7. 中间件

7.1 简介

中间件的本质是一个 function 处理函数。

必须包含 next 函数,路由处理函数只包含 req 和 res。next() 把流转关系交给下一个中间件和路由。

const mv = function(req,res,next){
    console.log("中间件函数");
    next();
}
//将mv注册为全局生效的中间件
app.use(mv);

7.2 简写形式

app.use(function(req,res,next){
    console.log("中间件");
    next();
})

7.3 在中间件挂载属性

app.use(function(req,res,next){
    console.log("中间件");
    const time =new Date()
    req.stime = time;
    next();
})

app.all('/',(req,res)=>{
    console.log(req.stime);
    res.end(req.stime)
})

7.4 定义多个全局中间件

多次调用 use 方法即可。

const express = require("express");

const app = express();

app.use(function(req,res,next){
    console.log("1");
    next();
})

app.use(function(req,res,next){
    console.log("2");
    next();
})

app.all('/',(req,res)=>{
    res.end("1")
})

app.listen(4400,()=>{
    console.log("启动服务");
})

7.5 局部生效的中间件

不适用 app.use() 声明,只在指定路由上生效。

const express = require("express");

const app = express();

const mv = function(req,res,next){
    console.log("局部中间件");
    next();
}

app.all('/',mv,(req,res)=>{
    res.send("HOME");
})

app.listen(4400,()=>{
    console.log("启动服务");
})

定义多个中间件:

const mv1 = function(req,res,next){
    console.log("局部中间件1");
    next();
}

const mv2 = function(req,res,next){
    console.log("局部中间件2");
    next();
}

app.all('/serve',mv1,mv2,(req,res)=>{
    res.send("HOME1");

})
app.all('/serve',[mv1,mv2],(req,res)=>{
    res.send("HOME1");
})

mv1,mv2 等价于 [mv1,mv2]。

7.6 注意事项

  • 一定要在路由之前定义中间件
  • 客户端发过来的请求,可以连续调用多个中间件进行处理
  • 执行完中间件代码后要调用 next() 函数
  • next() 函数后面不要再写代码
  • 连续调用多个中间件时,多个中间件共享 req 和 res 对象

7.7 中间件的分类

5 大类:

  • 应用级别的中间件:绑定到了 app.use、app.get、app.post,即绑定到了 app 实例上的中间件
  • 路由级别的中间件:绑定到 express.Router

错误级别的中间件,用来捕获整个项目发生的异常错误,从而防止项目异常崩溃。其函数签名为 (err,req,res,next)。

express 内置的中间件:

  • express.static:托管静态资源
  • express.json:解析 JSON 格式的请求实体数据
  • express.urlencoded:解析 URL-encoded 格式的请求实体数据
const express = require("express");

const app = express();

app.use(function(req,res,next){
    console.log("1");
    next();
})

/* 配置解析json格式的数据 */
app.use(express.json)
app.use(express.urlencoded({extented:false}))
app.post('/serve',(req,res)=>{
    /* req.body获取请求体的数据 */
    console.log(req.body);
    res.end(req.body)
})

app.listen(4400,()=>{
    console.log("启动服务");
})

第三方中间件:require() 引入后,使用 app.use() 注册。

8. 自定义中间件

8.1 解析请求体数据

const express = require("express");
const app = express();

const qs = require("querystring");
/* 数据量较大无法一次传输完 */
const mymod = function(req,res,next){
    /* 监听data事件 */
    let str=''
    req.on('data',(Chunk)=>{
        str += Chunk;
    })
    /* 当数据接受完毕会触发end事件 */
    req.on('end',()=> {
        const body = qs.parse(str);
        req.body=body;
        next();
    })
}

module.exports = mymod;

8.2 使用示例

const express = require("express");
const mymod = require("./moudule");

const app = express();
app.use(mymod);

app.post('/',function(req,res){
    console.log(req.body);
    res.end("end");
})

app.listen(4400,()=>{
    console.log("启动服务");
})

9. 接口跨域问题

9.1 cors 中间件

  1. npm i cors
  2. const cors = require("cors")
  3. app.use(cors)

CORS:

  • 由一系列 HTTP 响应头组成
  • 在服务端进行配置,不需要做额外配置
  • 在浏览器中有兼容性
const express = require("express");
const cors = require("cors");
const app = express();

app.use(cors());

app.all('/',(req,res)=>{
    res.send("a");
})

app.listen(4400,()=>{
    console.log("启动");
})

10. 前后端的身份认证(JWT)

npm i jsonwebtoken
npm i express-jwt

10.1 导入 JWT 相关的包

const express = require('express');

const app = express();

const jwt = require("jsonwebtoken");
const expressjwt = require("express-jwt");

app.listen(4400,()=>{
    console.log("qd");
})

10.2 secret 密钥

const secretKey = "^-^hi";

10.3 生成 JWT 字符串

使用 jsonwebtoken 的 sign() 方法。

app.all('/',(req,res)=>{
    const tokenstr=jwt.sign({username:'zs'},secret,{expiresIn:'30s'});
    res.send({
        status:200,
        message:"dl",
        token:tokenstr
    })
})

10.4 解析还原成 JSON 对象

使用 express-jwt。

app.use(expressjwt({secret:secret})).unless({path:[/^\/api\//]})
//secret->密钥
//unless不需要解析的路径
const jwt = require("jsonwebtoken");
const { expressjwt:expressJWT } = require("express-jwt");
const secret = "^-^hi";
app.use(expressJWT({secret:secret, algorithms:['HS256']}));

10.5 捕获错误信息

定义一个全局的错误级别中间件:

app.use((err,req,res,next)=>{
    //if (err.name=)
})

11. Node.js 项目实战

11.1 创建项目与基础配置

npm init -y

安装 express 并启动服务器:

const express = require("express");

const app = express();

app.listen(4400,()=>{
    console.log("启动服务器");
})

配置 cors 跨域:

const cors = require("cors");

app.use(cors);

配置表单解析的中间件:

//解析x-www格式
app.use(express.urlencoded({extended:false}));

安装 mysql,创建数据库和数据库表:

npm i mysql

创建 db 文件夹和 index.js:

const mysql =require("mysql");

const db = mysql.createPool({
    host:'127.0.0.1',
    user:'root',
    password:'12345678',
    database:'test'
})

module.exports=db;

11.2 注册用户功能实现

const { request } = require("express");

/* 导入数据库操作模块 */
const db = require("../dp/index.js")

exports.reguser=(req,res)=>{
    const mes = req.body;
    if (!mes.username || !mes.password){
        res.end("error");
    }
    const sqlstr = "select * from ev_users where username=?"
    db.query(sqlstr,mes.username,(err,results)=>{
        if (err){
            return res.send({
                status:200,
                Message:err.message
            })
        }
        if (results.length > 0){
            return res.send({
                status:200,
                Message:"用户名被占用"
            })
        }else{
            res.send("reg ok");
        }
    })
    //res.send("reg ok");
}

exports.loguser=(req,res)=>{
    res.send("log ok");
}

11.3 密码加密与 Token 生成

对密码进行加密,使用 bcryptjs:

npm i bcryptjs@2.4.3

const bcrypt=require("bcryptjs");
mes.password = bcrypt.hashSync(mes.password,10);

生成 jwt 的 Token 字符串:

npm i jsonwebtoken

const user = {...results[0],password:'',user_pic:''};
const tokenstr = jwt.sign(user,config.jwtSecretKey,{expiresIn: config.experiments})
res.send({
    status:200,
    message:"登录成功",
    token:'Bearer '+tokenstr
});

11.4 解析 Token 的中间件

npm i express-jwt@5.3.3

app.use(expressJWT({secret:config.jwtSecretKey}).unless({path:/^\/login/}));

一句话总结:Node.js 基于 Chrome V8 引擎,用 JavaScript 统一前后端开发,并借助内置模块、npm 生态与 Express 框架快速构建服务端应用与接口。