node.js-1模块化、Express、及同源和跨域

node.js-1模块化、Express、及同源和跨域

01.什么是 Node.js

  1. Node.js 是一个独立的 JavaScript 运行环境,能独立执行 JS 代码,因为这个特点,它可以用来编写服务器后端的应用程序

  2. Node.js 作用除了编写后端应用程序,也可以对前端代码进行压缩,转译,整合等等,提高前端开发和运行效率

  3. Node.js 基于Chrome V8 引擎封装,独立执行 JS 代码,但是语法和浏览器环境的 V8 有所不同,没有 document 和 window 但是都支持 ECMAScript 标准的代码语法

  4. 想要得到 Node.js 需要把这个软件安装到电脑,在素材里有安装程序(window 和 mac 环境的)参考 PPT 默认下一步安装即可

  5. Node.js 没有图形化界面,需要使用 cmd 终端命令行(利用一些命令来操控电脑执行某些程序软件)输入,node -v 检查是否安装成功

    1
    node -v
  6. 需求:新建 index.js 文件,编写打印代码和 for 循环打印 3 个 6

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    /**
    * 目标:编写 js 代码,用 node 命令执行
    * 终端作用:敲击命令,调用对应程序执行
    * 终端打开:目标文件->右键->在集成终端中打开
    * 命令:node xxx.js (注意路径)
    */
    console.log('Hello, World')
    for (let i = 0; i < 3; i++) {
    console.log(6)
    }
  7. Node.js 执行目标 JS 文件,需要使用 node xxx.js 命令来执行(我们可以借助 VSCode 集成终端使用,好处:可以快速切换到目标 JS 文件所在终端目录,利用相对路径找到要执行的目标 JS 文件

    image-20240514135609104

02.fs模块-读写文件

  1. 模块:类似插件,封装了方法和属性供我们使用

  2. fs 模块:封装了与本机文件系统进行交互的,方法和属性

  3. fs 模块使用语法如下:

    • 加载 fs 模块,得到 fs 对象

      1
      const fs = require('fs')
    • 写入文件内容语法:

      1
      2
      3
      fs.writeFile('文件路径', '写入内容', err => {
      // 写入后的回调函数
      })
    • 读取文件内容的语法:

      1
      2
      3
      4
      fs.readFile('文件路径', (err, data) => {
      // 读取后的回调函数
      // data 是文件内容的 Buffer 数据流
      })
  4. 需求:向 test.txt 文件写入内容并读取打印

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    /**
    * 目标:使用 fs 模块,读写文件内容
    * 语法:
    * 1. 引入 fs 模块
    * 2. 调用 writeFile 写入内容
    * 3. 调用 readFile 读取内容
    */
    // 1. 引入 fs 模块
    const fs = require('fs')
    // 2. 调用 writeFile 写入内容
    // 注意:建议写入字符串内容,会覆盖目标文件所有内容
    fs.writeFile('./text.txt', '欢迎使用 fs 模块读写文件内容', err => {
    if (err) console.log(err)
    else console.log('写入成功')
    })
    // 3. 调用 readFile 读取内容
    fs.readFile('./text.txt', (err, data) => {
    if (err) console.log(err)
    else console.log(data.toString()) // 把 Buffer 数据流转成字符串类型
    })

    03.path模块-路径处理

    1. 为什么在 Node.js 待执行的 JS 代码中要用绝对路径:

      Node.js 执行 JS 代码时,代码中的路径都是以终端所在文件夹出发查找相对路径,而不是以我们认为的从代码本身出发,会遇到问题,所以在 Node.js 要执行的代码中,访问其他文件,建议使用绝对路径

    2. 新建 03 文件夹编写待执行的 JS 代码,访问外层相对路径下的文件,然后在最外层终端路径来执行目标文件,造成问题

      image-20230330113929178

      image-20230330113942679

    3. 问题原因:就是从代码文件夹出发,使用../text.txt解析路径,找不到目标文件,报错了!

    4. 解决方案:使用模块内置变量 __dirname配合 path.join() 来得到绝对路径使用

      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      const fs = require('fs')
      console.log(__dirname) // D:\备课代码\2_node_3天\Node_代码\Day01_Node.js入门\代码\03

      // 1. 加载 path 模块
      const path = require('path')
      // 2. 使用 path.join() 来拼接路径
      const pathStr = path.join(__dirname, '..', 'text.txt')
      console.log(pathStr)

      fs.readFile(pathStr, (err, data) => {
      if (err) console.log(err)
      else console.log(data.toString())
      })
    5. 再次执行查看问题就被修复了!以后在 Node.js 要执行的 JS 代码中访问其他文件的路径,都建议使用绝度路径

03.http模块-创建Web服务

  1. 需求:引入 http 模块,使用相关语法,创建 Web 服务程序,响应返回给请求方一句提示 ‘hello,world’

  2. 步骤:

    1. 引入 http 模块,创建 Web 服务对象
    2. 监听 request 请求事件,对本次请求,做一些响应处理
    3. 启动 Web 服务监听对应端口号
    4. 运行本服务在终端进程中,用浏览器发起请求
  3. 注意:本机的域名叫做 localhost

  4. 代码如下:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    /**
    * 目标:使用 http 模块,创建 Web 服务
    * Web服务:一个程序,用于提供网上信息浏览服务
    * 步骤:
    * 1. 引入 http 模块,创建 Web 服务对象
    * 2. 监听 request 事件,对本次请求,做一些响应处理
    * 3. 启动 Web 服务监听对应端口号
    * 4. 运行本服务在终端,用浏览器访问 http://localhost:3000/ 发起请求(localhost 是本机域名)
    * 注意:终端里启动了服务,如果想要终止按 ctrl c 停止即可
    */
    // 1. 引入 http 模块,创建 Web 服务对象
    const http = require('http')
    const server = http.createServer()
    // 2. 监听 request 事件,对本次请求,做一些响应处理
    server.on('request', (req, res) => {
    res.end('hello, world') // 一次请求只能对应一次响应
    })
    // 3. 启动 Web 服务监听对应端口号
    server.listen(3000, () => {
    console.log('Web 服务启动了')
    })

04.Web服务-支持中文字符

  1. 需求:让 Web 服务返回中文字符,浏览器能正确加载解析

  2. 步骤:给 Web 服务程序添加响应头,设置内容类型和正确的编码格式,重启 Web 服务测试访问即可

    1
    res.setHeader('Content-Type', 'text/html;charset=utf-8')
  3. 编码:编码是信息从一种形式或格式转换为另一种形式的过程,指的把文字在计算机里的二进制数据,用什么形式展示出来

  4. utf-8编码:是一种关系映射表,也叫 utf-8 编码表,可以把中文,英文等等很多字符准确的展示出来

05.模块化简介

  1. 在 Node.js 中每个文件都被当做是一个独立的模块,模块内定义的变量和函数都是独立作用域的,因为 Node.js 在执行模块代码时,将使用如下所示的函数封装器对其进行封装

    image-20230331150152299

  2. 而且项目是由多个模块组成的,每个模块之间都是独立的,而且提高模块代码复用性,按需加载,独立作用域

  3. 但是因为模块内的属性和函数都是私有的,如果对外使用,需要使用标准语法导出和导入才可以,而这个标准叫 CommonJS 标准,接下来我们在一个需求中,体验下模块化导出和导入语法的使用

  4. 需求:定义 utils.js 模块,封装基地址和求数组总和的函数,导入到 index.js 使用查看效果

    image-20230331150506876

  5. 导出语法:

    1
    2
    3
    module.exports = {
    对外属性名: 模块内私有变量
    }
  6. 导入语法:

    1
    2
    3
    const 变量名 = require('模块名或路径')
    // Node.js 环境内置模块直接写模块名(例如:fs,path,http)
    // 自定义模块:写模块文件路径(例如:./utils.js)

    变量名的值接收的就是目标模块导出的对象

  7. 代码实现

    • utils.js:导出

      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      /**
      * 目标:基于 CommonJS 标准语法,封装属性和方法并导出
      */
      const baseURL = 'http://www.baidu.net'
      const getArraySum = arr => arr.reduce((sum, item) => sum += item, 0)

      // 导出
      module.exports = {
      url: baseURL,
      arraySum: getArraySum
      }
    • index.js:导入使用

      1
      2
      3
      4
      5
      6
      7
      8
      /**
      * 目标:基于 CommonJS 标准语法,导入工具属性和方法使用
      */
      // 导入
      const obj = require('./utils.js')
      console.log(obj)
      const result = obj.arraySum([5, 1, 2, 3])
      console.log(result)

06.ECMAScript标准-默认导出和导入

  1. CommonJS 规范是 Node.js 环境中默认的,后来官方推出 ECMAScript 标准语法

  2. 需求:封装并导出基地址和求数组元素和的函数,导入到 index.js 使用查看效果

  3. 导出语法:

    1
    2
    3
    export default {
    对外属性名: 模块内私有变量
    }
  4. 导入语法:

    1
    import 变量名 from '模块名或路径'

    变量名的值接收的就是目标模块导出的对象

  5. 注意:Node.js 默认只支持 CommonJS 标准语法,如果想要在当前项目环境下使用 ECMAScript 标准语法,请新建 package.json 文件设置 type: ‘module’ 来进行设置

    1
    { "type": "module" }
  6. 代码实现:

    • utils.js:导出

      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      /**
      * 目标:基于 ECMAScript 标准语法,封装属性和方法并"默认"导出
      */
      const baseURL = 'http://hmajax.itheima.net'
      const getArraySum = arr => arr.reduce((sum, item) => sum += item, 0)

      // 默认导出
      export default {
      url: baseURL,
      arraySum: getArraySum
      }
    • index.js:导入

      1
      2
      3
      4
      5
      6
      7
      8
      /**
      * 目标:基于 ECMAScript 标准语法,"默认"导入,工具属性和方法使用
      */
      // 默认导入
      import obj from './utils.js'
      console.log(obj)
      const result = obj.arraySum([10, 20, 30])
      console.log(result)

07.ECMAScript标准-命名导出和导入

  1. ECMAScript 标准的语法有很多,常用的就是默认和命名导出和导入,这节课我们来学习下命名导出和导入的使用

  2. 需求:封装并导出基地址和数组求和函数,导入到 index.js 使用查看效果

  3. 命名导出语法:

    1
    export 修饰定义语句
  4. 命名导入语法:

    1
    import { 同名变量 } from '模块名或路径'

    注意:同名变量指的是模块内导出的变量名

  5. 代码示例:

    • utils.js 导出

      1
      2
      3
      4
      5
      6
      /**
      * 目标:基于 ECMAScript 标准语法,封装属性和方法并"命名"导出
      */
      export const baseURL = 'http://hmajax.itheima.net'
      export const getArraySum = arr => arr.reduce((sum, item) => sum += item, 0)

    • index.js 导入

      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      /**
      * 目标:基于 ECMAScript 标准语法,"命名"导入,工具属性和方法使用
      */
      // 命名导入
      import {baseURL, getArraySum} from './utils.js'
      console.log(obj)
      console.log(baseURL)
      console.log(getArraySum)
      const result = getArraySum([10, 21, 33])
      console.log(result)
  6. 与默认导出如何选择:

    • 按需加载,使用命名导出和导入
    • 全部加载,使用默认导出和导入

08.包的概念

  1. 包:将模块,代码,其他资料整合成一个文件夹,这个文件夹就叫包

  2. 包分类:

    • 项目包:主要用于编写项目和业务逻辑
    • 软件包:封装工具和方法进行使用
  3. 包要求:根目录中,必须有 package.json 文件(记录包的清单信息)

    image-20230331154702306

    image-20230331154639881

  4. 包使用:在引入一个包文件夹到代码中,默认引入的是包文件节下的 index.js 模块文件里导出的对象,如果没有 index.js 文件,则会引入 package.json 里 main 属性指定的文件模块导出的对象

  5. 需求:封装数组求和函数的模块,封装判断用户名和密码长度函数的模块,形成一个软件包,并导入到 index.js 中使用查看效果

  6. 代码示例:

    • utils/lib 相关代码在素材里准备好了,只需要自己在 utils/index.js 统一出口进行导出

      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      /**
      * 本文件是,utils 工具包的唯一出口
      * 作用:把所有工具模块方法集中起来,统一向外暴露
      */
      const { getArraySum } = require('./lib/arr.js')
      const { checkUser, checkPwd } = require('./lib/str.js')

      // 统一导出所有函数
      module.exports = {
      getArraySum,
      checkUser,
      checkPwd
      }

    • index.js 导入软件包文件夹使用(注意:这次导入的是包文件夹,不是模块文件)

      1
      2
      3
      4
      5
      6
      7
      /**
      * 目标:导入 utils 软件包,使用里面封装的工具函数
      */
      const obj = require('./utils')
      console.log(obj)
      const result = obj.getArraySum([10, 20, 30])
      console.log(result)

09.npm软件包管理器

  1. npm 简介链接: 软件包管理器,用于下载和管理 Node.js 环境中的软件包

  2. npm 使用步骤:

    1. 初始化清单文件: npm init -y (得到 package.json 文件,有则跳过此命令)

      注意 -y 就是所有选项用默认值,所在文件夹不要有中文/特殊符号,建议英文和数字组成,因为 npm 包名限制建议用英文和数字或者下划线中划线

    2. 下载软件包:npm i 软件包名称 下载的包会存放在当前项目下的 node_modules 中,并记录在 package.json 中

    3. 使用软件包

  3. 需求:使用 npm 下载 dayjs 软件包到本地项目文件夹中,引入到 index.js 中格式化日期打印,运行观察效果

  4. 具体使用流程图:

    image-20230331155537983

10.npm安装所有依赖

  1. 我们拿到了一个别人编写的项目,但是没有 node_modules,项目能否正确运行?

    不能,因为缺少了项目需要的依赖软件包,比如要使用 dayjs 和 lodash 但是你项目里没有这个对应的源码,项目会报错的

    image-20230331162320775

  2. 为何没有给我 node_modules?

    因为每个人在自己的本机使用 npm 下载,要比磁盘间传递要快(npm 有缓存在本机)

  3. 如何得到需要的所有依赖软件包呢?

    直接在项目目录下,运行终端命令:npm i 即可安装 package.json 里记录的所有包和对应版本到本项目中的 node_modules

    image-20230331162341684

11.npm全局软件包及nodemon命令

  1. 软件包区别:

    • 本地软件包:当前项目内使用,封装属性和方法,存在于 node_modules
    • 全局软件包:本机所有项目使用,封装命令和工具,存在于系统设置的位置
  2. nodemon 作用:替代 node 命令,检测代码更改,自动重启程序

  3. 使用:

    1. 安装:npm i nodemon -g (-g 代表安装到全局环境中)
    2. 运行:nodemon 待执行的目标 js 文件

12.Node.js概念和常用命令总结

  1. Node.js 模块化:把每个文件当做一个模块,独立作用域,按需加载,使用特定标准语法导出和导入使用

    CommonJS 标准:一般应用在 Node.js 项目环境中

    ECMAScript 标准:一般应用在前端工程化项目中

    image-20230331170210113

    image-20230331170220045

  2. Node.js 包:把模块文件,代码文件,其他资料聚合成一个文件夹就是包

    项目包:编写项目需求和业务逻辑的文件夹

    软件包:封装工具和方法进行使用的文件夹(一般使用 npm 管理)

    • 本地软件包:作用在当前项目,封装的属性/方法,供项目调用编写业务需求
    • 全局软件包:作用在所有项目,一般封装的命令/工具,支撑项目运行

    image-20230331170539931

  3. Node.js 常用命令:

    image-20230331171411780

13.Express快速搭建 Web 服务

  1. Express定义链接: 基于 Node.js 平台,快速,开放,极简的 Web 开发框架

    image-20230331172242865
  2. 概念:使用 express 本地软件包,快速搭建 Web 服务(基于 http 模块)

  3. 功能:开发 Web 服务,提供数据接口,提供网页资源供浏览器使用

  4. 需求:基于 express 编写 Web 服务,对 get 请求方法和 / 路径监听,有人请求返回一段提示字符串

  5. 使用:

    1. 下载 express 本地软件包到项目中

    2. 导入 express 创建 Web 服务对象

    3. 监听请求方法和请求路径,返回一段提示字符串

    4. 对其他请求方法和请求路径,默认返回 404 提示

    5. 监听端口号,启动 Web 服务,在浏览器请求测试

  6. 代码如下:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    /**
    * 目标:基于 express 本地软件包,开发 Web 服务,返回资源给请求方
    */
    // 1. 下载 express 软件包
    // 2. 导入并创建 Web 服务对象
    const express = require('express')
    const server = express()

    // 3. 监听请求的方法和请求的资源路径
    server.get('/', (req, res) => {
    res.send('你好,欢迎使用 Express')
    })

    // 4. 监听任意请求的方法和请求的资源路径
    server.all('*', (req, res) => {
    res.status(404)
    res.send('你要访问的资源路径不存在')
    })

    // 5. 监听端口号,启动 Web 服务
    server.listen(3000, () => {
    console.log('Web 服务已启动')
    })

14.浏览器的同源策略

  1. 同源策略:它限制一个源的文档或者加载的 JS 脚本,与另外一个源的资源进行交互,帮助我们阻隔恶意文档,减少被攻击的媒介

  2. 例如:被钓鱼网站收集信息,用 AJAX 发起恶意请求,传递转账信息到银行服务器(跨站伪造请求攻击)

    image-20230331175951962
  3. 源指的是:协议,域名,端口号的组成

    image-20230331180024848

  4. 同源:网页加载时所在源,和 AJAX 请求时的源(协议,域名,端口号)全部相同即为同源,所以刚刚的例子并不是同源访问,他们的域名是不同的

  5. 作用:浏览器的同源策略,保护浏览器中网站的安全,限制 AJAX 只能向同源 URL 发起请求

15.跨域问题

  1. 跨域:从一个源的文档/脚本,加载另一个源的资源产生了跨域

  2. 例如:网页文档打开时所在源和 AJAX 访问的源(协议,域名,端口)有一个不同,就发生了跨域访问

    image-20230331181356100
  3. 网页出现跨域访问时,会在浏览器控制里报错如下:

    Access to XMLHttpRequest 意思为:XHR 链接出了问题,从一个源(http://localhost:5500 跨域访问 http://localhost:3000)

    image-20230331181439053

14.跨域问题-解决方案1-CORS

  1. 目标:前后端分离的项目,前端和后端不在一个源,还要保证数据通信

  2. 解决:采用 CORS (跨域资源共享),一种基于 HTTP 头的机制,该机制通过允许服务器标示除了它自己以外的其他源(域、协议或端口),来访问加载服务器上的资源

    image-20230331183024877
  3. 思路:

    • 服务器端:设置 Access-Control-Allow-Origin 响应头字段,允许除了它自己以外的源来访问自己的资源
    • 前端:正常发起 AJAX 请求,无需额外操作
  4. 步骤:

    1. 下载 cors 本地软件包
    2. 导入 cors 函数
    3. 使用 server.use() 给 Web 服务添加插件功能
    4. 把 cors 函数调用传入给 Web 服务,启动测试
  5. 设置响应头代码

    1
    2
    3
    4
    // 2. 导入 cors 函数
    const cors = require('cors')
    // 3. 使用 server.use() 给 Web 服务添加插件功能
    server.use(cors())

15.跨域问题-解决方案2-同源访问

  1. 做法:让后端 Web 服务即可以提供数据接口,也可以返回网页资源

  2. 好处:安全,后端的接口不允许非同源来访问

  3. 代码:express 设置暴露 public 文件夹作为静态资源目录,供浏览器直接访问,可以访问里面的 html 网页

    1
    2
    // 暴露指定的文件夹,让前端可以直接拼接路径和资源名字来访问
    server.use(express.static(path.join(__dirname, 'public')))

node.js-1模块化、Express、及同源和跨域

https://bubuweiying.site/nodejs1模块化Express及同源和跨域/

作者

步步为营

发布于

2024-05-14

更新于

2025-03-15

许可协议