Koa2项目实战1(项目搭建)

news2024/10/6 7:20:14

前言

在正式开始之前,需要先知道用到的东西:

  • koa:Koa 是一个基于 Node.js 的 Web 应用框架,非常适合开发API服务,可以与前端框架(如 Vue.js、React.js)结合使用,实现前后端分离的开发模式。
  • koa-router:是一个用于在 Koa 框架中实现路由功能的模块。
  • koa-body:是一个用于 Koa 框架的中间件,它主要用于处理 HTTP 请求中的请求体。

文档:

Koa中文文档
koa-router NPM
koa-router API
koa-body NPM

Koa 是一个基于 Node.js 的 Web 应用框架,由 Express 原班人马打造。
Koa 并没有捆绑任何中间件,而是提供了一套优雅的方法,帮助开发者快速地编写服务端应用程序。

项目初始化

创建一个文件夹:ko2-mongodb

打开文件夹,初始化项目,生成一个package.json 文件:

npm init -y

这个命令会自动创建一个 package.json 文件,该文件是 Node.js 项目的配置文件,包含了项目的名称、版本、依赖项、脚本等重要信息。
通过 -y(或 --yes)参数,命令会自动使用默认值填充 package.json,无需手动回答一系列问题。

如果需要在本地git仓库对项目版本做管理,可以初始化git:

git init

在项目根目录下新建一个.gitignore文件,让项目的某些文件不要提交到git仓库:

node_modules

项目搭建

安装Koa框架:

npm install koa

安装成功,在package.json中会显示依赖信息:
在这里插入图片描述

创建src/main.js,编写代码:

// 导入koa, koa是一个类
const Koa = require('koa')

// 创建koa实例对象:app
const app = new Koa()

// 使用 app.use() 方法添加中间件,且只能写一个中间件
// 注意:app.use 只能接收函数作为参数
app.use((ctx, next) => {
  // 中间件逻辑
  ctx.body = 'hello Koa!'
});

// 指定端口号并启动服务器
const port = 3000 // 表示服务器将监听的端口号
app.listen(port, () => {
  console.log('server is running on http://localhost:3000')
})
  • app.use():用于向应用添加中间件

    • 语法: app.use(middleware)
      • middleware 是一个函数,它接收两个参数 ctx(上下文对象)和 next(一个函数,用于调用下一个中间件)。
      • ctx 包含了请求和响应的信息,可以通过它访问请求对象 ctx.request 和响应对象 ctx.response。例如,在中间件中修改 ctx.body 来设置响应内容,或者通过 ctx.params 获取路由参数等。
      • next 函数用于调用下一个中间件。当在一个中间件中调用 next() 时,Koa 会暂停当前中间件的执行,将请求传递给下一个中间件。当后续的中间件都执行完毕后,Koa 会回溯回来继续执行当前中间件中 next() 之后的代码。
    • 如果 app.use 接收到的 middleware 不是函数,执行运行命令后,在终端会报错:
      在这里插入图片描述
  • app.listen():用于启动服务器并在指定的端口上监听传入的连接。

    • 调用这个方法后,服务器开始在指定的端口上监听传入的 HTTP 请求。当有请求到达时,Koa 会根据注册的中间件依次处理请求,并生成响应返回给客户端。
    • 语法:app.listen(port, [hostname], [backlog], [callback])
      • port:必选参数,服务器要监听的端口号。
      • hostname:可选参数,服务器要监听的主机名。默认是 '0.0.0.0',表示监听所有的网络接口。
      • backlog:可选参数,指定连接队列的最大长度。默认是 511
      • callback:可选参数,服务器启动后要执行的回调函数。如果提供了回调函数,它会在服务器成功启动后被调用。这个回调函数通常用于输出一些启动成功的信息或者执行其他初始化操作。

在终端执行指令,启动服务:

node src/main.js

在这个例子中,main.js 文件中使用了 Koa 框架创建了一个服务器,设置一个简单的中间件,并设置了服务器监听的端口为 3000,执行node src/main.js指令后,服务器就会在本地的 3000 端口上运行,当有请求到达时,会返回 'hello Koa!' 作为响应内容。

命令行终端输出:
在这里插入图片描述

按住CTRL+单击,可以打开链接http://localhost:3000
在这里插入图片描述

node src/main.js用于使用 Node.js 运行位于 src目录下的 main.js文件。
这条指令的作用通常是启动一个基于 Node.js 的应用程序。如果 main.js 文件中包含了服务器的设置、路由定义、中间件的使用等代码,执行这个指令后,就会启动相应的服务,可能是一个 Web 服务器、API 服务或者其他类型的后端服务。

注意
修改main.js后,必须停掉服务,重新执行node src/main.js,刷新页面,页面才会更新!

所以在实际项目中,是不会使用node命令来直接启动的。

现在,项目的目录结构如下图所示:
在这里插入图片描述

配置项目自动重启

安装nodemon

npm i nodemon -D

安装完毕后,配置package.json:

"scripts": {
  "dev": "nodemon ./src/main.js",
},

接下来,就可以执行npm run dev启动服务:
在这里插入图片描述
执行命令npm run dev,本质上是使用 nodemon 来监控文件变化并自动重启服务器。

  • [nodemon] 3.1.7,表示正在使用的 nodemon 版本是 3.1.7
  • [nodemon] to restart at any time, enter 'rs',表示可以在任何时候输入 rs 来手动重启 nodemon
  • nodemon 正在监控的路径和文件扩展名:[nodemon] watching path(s): *.*[nodemon] watching extensions: js,mjs,cjs,json,表示 nodemon 正在监控所有路径下的 .js.mjs.cjs.json 文件。
  • nodemon 启动服务器的命令:[nodemon] starting 'node./src/main.js',表示 nodemon 正在启动 node 进程来执行 ./src/main.js 文件。

服务器成功启动并输出了 server is running on http://localhost:3000,表示服务器正在监听本地的 3000 端口。

读取配置文件

dotenv:一个用于读取 Node 环境变量的工具库。
dotenv 是一个 npm 包,用于加载 .env 文件中定义的环境变量赋值给到 process.env 中。
process.env 是 Node.js 程序在运行时能访问到的一个全部变量,存储环境变量信息。

dotenv 中文网
dotenv

安装dotenv

npm install dotenv -D

在项目的根目录下创建一个 .env 文件:

APP_PORT=8080

创建config/config.env.js文件:

// 引入dotenv,注意:dotenv 是一个对象
const dotenv = require('dotenv')
dotenv.config()

// 将当前进程的环境变量对象 process.env 导出
// process: 当前执行的node的进程
// env: 环境变量
module.exports = process.env

const dotenv = require('dotenv'):这行代码引入了 dotenv 模块。dotenv 是一个用于在 Node.js 应用中加载环境变量的模块。
dotenv.config():调用 dotenv.config() 方法来加载环境变量配置文件。

  • 通常,这个方法会查找项目根目录下的 .env 文件,并将其中定义的环境变量加载到前进程的 process.env 对象中。
  • 环境变量可以在应用中通过 process.env.VARIABLE_NAME 的方式来访问。

module.exports = process.env:这里将当前进程的环境变量对象 process.env 导出。这样,其他模块在引入这个模块时,就可以直接访问当前进程的环境变量。

改写main.js

// 导入koa, koa是一个类
const Koa = require('koa')

const { APP_PORT } = require('./config/config.env')

// 创建koa实例对象:app
const app = new Koa()

// 使用 app.use() 方法添加中间件,且只能写一个中间件
app.use((ctx, next) => {
  console.log(`Request received: ${ctx.request.method} ${ctx.request.url}`);
  // 中间件逻辑
  ctx.body = 'hello Koa!'
});

// 指定端口号并启动服务器
app.listen(APP_PORT, () => {
  console.log(`server is running on http://localhost:${APP_PORT}`)
})

执行npm run dev启动服务:
在这里插入图片描述
按住CTRL+单击,打开链接http://localhost:8080
在这里插入图片描述

项目的目录结构如下图所示:
在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2191390.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

第八篇:磁盘管理(1)

目录 6.1分区 6.1.1基本分区 6.1.1.1磁盘的相关知识 6.1.1.1.1基础知识 6.1.1.1.2命名 1.对于串口硬盘:/dev/sda、/dev/sdb、/dev/sdc......往后都是一个字母一个字母的累加 2.对于并口硬盘:/dev/hda其余相同 6.1.1.1.3磁盘的分区方式 方式1&am…

c++_ 多态

目录 一.多态 1.1多态(polymorphism)的概念 1.2实现多态还有两个必须重要条件: 1.3 重载 和 虚函数的重写/覆盖 和 隐藏 的比对 1.4 协变(了解) 1.5 析构函数的重写 1.6 override 和final关键字 二.纯虚函数和抽象类 三. 多态的原理 3.1虚函数表指针 3.…

黑马JavaWeb开发跟学(十一)SpringBootWeb案例

黑马JavaWeb开发跟学十一.SpringBootWeb案例 SpringBootWeb案例1. 新增员工1.1 需求1.2 接口文档1.3 思路分析1.4 功能开发1.5 功能测试1.6 前后端联调 2. 文件上传2.1 简介2.2 本地存储2.3 阿里云OSS2.3.1 准备2.3.2 入门2.3.3 集成 3. 修改员工3.1 查询回显3.1.1 接口文档3.1…

性能测试笔记2-总

安装路径:先装jdk,后装JMeter 安装JDK: 下载JDK – 安装JDK – 配置环境变量 – 验证 安装Jmeter: 下载Jmeter – 安装Jmeter – 配置环境变量 – 启动验证 注意点: 下载JDK时,注意电脑操作系统是32位/64位 下载…

力扣 简单 110.平衡二叉树

文章目录 题目介绍解法 题目介绍 解法 平衡二叉树:任意节点的左子树和右子树的高度之差的绝对值不超过 1 //利用递归方法自顶向下判断以每个节点为根节点的左右子树的最大深度是否大于1 class Solution {public boolean isBalanced(TreeNode root) {if(root null){return tr…

Uniapp API

1.uni.showToast 显示消息提示框 unishowToast({ obj参数 }) 2.uni.showLoading 显示 loading 提示框, 需主动调用 uni.hideLoading 才能关闭提示框。 3.uni.showModal 显示模态弹窗,可以只有一个确定按钮,也可以同时有确定和取消按钮。类似于一个A…

windows上安装python环境

前言 最近电脑重装了系统,需要重新安装python环境 ,因此记录一下 1.下载 打开python官网下载,下载链接:https://www.python.org/downloads/windows/ 点击下载 ,我这里使用64位操作系统(大部分电脑),根据…

怎么查看网站是否被谷歌收录,查看网站是否被谷歌收录的简便方法

查看网站是否被谷歌收录,有多种简便方法可供选择。以下是一些常用的简便方法: 一、使用“site:”指令 打开谷歌搜索引擎: 在浏览器中打开Google.com,确保使用的是谷歌的官方搜索引擎。 输入查询指令: 在搜索框中输…

网关路由登录校验

网关过滤器 登录校验必须在请求转发到微服务之前做,否则就失去了意义。而网关的请求转发是Gateway内部代码实现的,要想在请求转发之前做登录校验,就必须了解Gateway内部工作的基本原理。 暂时无法在飞书文档外展示此内容 如图所示&#xff…

15分钟学 Python 第38天 :Python 爬虫入门(四)

Day38 : Python爬虫异常处理与反爬虫机制 章节1:异常处理的重要性 在爬虫开发过程中,网络请求和数据解析常常会遭遇各种异常。正确的异常处理可以提高程序的稳定性,避免崩溃,并帮助开发者快速定位问题。 章节2:常见…

requests案例——腾讯新闻数据的爬取

需求: 1.利用requests方法爬取该i.news.qq.com网站的数据(包括名字和对应链接) 2.实现翻页的爬取 3.将爬取下来的数据保存在excel文件中 4.利用jsonpath来解析获取的数据 5.使用openpyxl库处理 Excel 文件 注意: 1.如果报以…

一个不错的 SQL 编码风格的指南

前言 SQL语句的编写对于我们后端开发者而言是一个必备的技巧,在日常工作中,SQL语言编写的质量不仅仅会影响到团队的合作效率与项目的可维护性,还直接关系到数据库的性能优化与数据安全。今天大姚给大家分享一个不错的 SQL 编码风格的指南&am…

卡码网KamaCoder 117. 软件构建

题目来源:117. 软件构建 C题解(来源代码随想录):拓扑排序:给出一个 有向图,把这个有向图转成线性的排序。拓扑排序也是图论中判断有向无环图的常用方法。 拓扑排序的过程,其实就两步&#xff1…

Kubernetes资源详解

华子目录 1.Kubernetes中的资源1.1资源管理介绍1.2资源管理方式1.2.1命令式对象管理1.2.2kubectl常见command命令1.2.3资源类型1.2.4常用资源类型 基本命令示例运行和调试命令示例高级命令示例总结 其他命令示例create和apply区别案例显示命名空间查看命名空间中的pod如何对外暴…

数据库伸缩设计-分库分表如何做?读书笔记

一些企业内部系统,用户数量和业务规模有限,因此并不会产生巨大的数据量,这时数据库的存储和读写性能均不会成为瓶颈,没有扩容的需要,因此无须考虑伸缩性。对于一些互联网系统,前后端应用可以通过CDN 、缓存…

基于Zynq SDIO WiFi移植二(支持2.4/5G)

1 SDIO设备识别 经过编译,将移植好的uboot、kernel、rootFS、ramdisk等烧录到Flash中,上电启动,在log中,可看到sdio设备 [ 1.747059] mmc1: queuing unknown CIS tuple 0x01 (3 bytes) [ 1.761842] mmc1: queuing unknown…

vite学习教程06、vite.config.js配置

前言 博主介绍:✌目前全网粉丝3W,csdn博客专家、Java领域优质创作者,博客之星、阿里云平台优质作者、专注于Java后端技术领域。 涵盖技术内容:Java后端、大数据、算法、分布式微服务、中间件、前端、运维等。 博主所有博客文件…

Meta MovieGen AI:颠覆性的文本生成视频技术详解

近年来,生成式AI技术的发展迅猛,尤其是在文本生成图像、文本生成视频等领域。Meta公司近期推出的MovieGen AI,以其强大的文本生成视频能力震撼了整个AI行业。本文将详细解读Meta MovieGen AI的核心技术、功能特性及其在实际应用中的潜力。 一…

ssrf学习(ctfhub靶场)

ssrf练习 目录 ssrf类型 漏洞形成原理(来自网络) 靶场题目 第一题(url探测网站下文件) 第二关(使用伪协议) 关于http和file协议的理解 file协议 http协议 第三关(端口扫描&#xff09…

Linux自动化构建工具Make/Makefile

make是一个命令 makefile是一个文件 touch 创建并用vim打开makefile 写入依赖对象和依赖方法 mycode是目标文件 第二行数依赖方法 以tab键开头 make makefile原理 makefile中写的是依赖关系和依赖方法 clean英语清理文件 后不用加源文件。.PHONY定义clean是伪目标。 make只…