Nodejs-Koa基于分层理念的框架搭建（附完整TS源码）

原创 已于 2023-12-01 10:46:50 修改 · 1.6k 阅读 · 22 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#typescript #node.js #javascript #vue

于 2023-11-30 22:10:20 首次发布

因为工作原因接触了Nodejs，前后端代码风格的一致性对于前端出生的小伙伴是十分友好的，TypeScript也提供了比JavaScript更加强大的特性，而且环境搭建也比较简单。具体的都不在此处介绍了，本人也是尝试着搭建一个后台管理系统，采用的是KOA框架。但是始终还是觉得太前端化了，在使用的时候需要关心一些参数传递的机制和其他一些细枝末节的额外工作，使用起来并没有Java/.net等老牌的框架来的“爽” 。网上也搜索了一下相关资料，NPM库中也有一些组件可以实现一些命名控件传参、Controller层的注解等特性，所以我就使用这些依赖和组件来实现一个与Java差不多的后台开发框架，一起分享给大家吧！

目录

一、开发环境

二、目标特性

二、依赖选用

三、目录结构

四、洋葱模型

五、Controller 层

5.1 新增 Controller

5.2 注册 Controller

六、Service层

6.1 新增业务接口

6.1 实现业务接口

七、Data/Dao层

八、Models层

九、KOA中间件

9.1 添加中间件

9.2 日志中间件介绍

9.3 异常处理中间件介绍

9.4 session 中间件

9.5 事务处理中间件

十、源码

一、开发环境

Node 版本为 v20.0.0，其他版本的Node并没有进行实际的测试，编辑器是VSCode 。

具体如何安装就不再介绍了，未接触过的小伙伴请先学习基础知识哦！

后端使用 Typescript（TS）

前端使用 Typescript（TS） + Vue3 + Vite

前端是别人的开源项目拉过来直接改的，本文不进行介绍了。

最后会附上前端和后端完整的代码，有需要的小伙伴直接拿走吧。

二、目标特性

后台框架就先支持如下特性：

1. 支持分层开发

并分为DTO层、Entity层、Controller层、Service层、Data层。

2. 使用命名空间参数传递

通过命名空间来对临时变量进行传递，例如来解决Session传递繁琐的问题。

因为在KOA的框架中，类似Session必须借助ctx通过洋葱模型的顺序进行层层传递。

3. 使用路由注解

如果在原生的KOA框架的路由组件，每新增一个Controller都要修改一下对应的路由文件。

为了解决这种繁琐方式和增加代码可读性，这里我们直接使用注解的方式来实现路由。

4. 使用ORM

一般的项目中使用ORM是非常必要的，因此这边也使用ORM来对数据进行操作。

二、依赖选用

组件            介绍
JWT 用户身份认证
Sequelize 一款人气还不错的ORM
Log4js 日志记录
routing-controllers 路由注解组件
class-transformer 类型转换，主要用于DTO和Entity的转换
cls-hooked 命名控件传递信息
Koa 热门的开发框架

除了上面一些依赖组件的外，还会用到一些其他的基础依赖，例如Typescript的解释器等等。

三、目录结构

后端项目中目录结构如下所示

目录/文件 描述
src 后台代码
    - config 存放所有的配置文件，如数据库配置，日志配置等
    - controller 存放所有的controller层文件
    - dao 存放所有的data层的文件
    - dto 存放所有的DTO类的文件
    - error 存放错误代码定义文件，来统一后台错误信息
    - middlewares 存放koa的中间层代码
    - models 存放Entity实体类文件
    - sequlize 存放ORM初始化文件
最低0.47元/天 解锁文章

200万优质内容无限畅学
nodejs -- koa框架
King Saj
05-04 979
Koa 是一个基于 Node.js 的 Web 框架，它提供了一组简洁而优雅的 API，使得编写 Web 应用程序变得更加容易和快捷。首先，需要安装 Node.js 运行环境。可以从 Node.js 官网下载适合自己操作系统的安装包，并按照提示进行安装。这将创建一个名为my-koa-app的新目录，并在其中初始化一个新的 Node.js 项目。-y参数将启用默认设置，跳过对项目的交互式询问。这将在 Node.js 项目中安装 Koa 模块，并将其添加到项目的依赖列表中。在my-koa-app。
nodejs-koa-blog：基于Node.js Koa2实战开发的一套完整的博客项目网站
02-03
基于Node.js Koa2实战开发的一套完整的博客项目网站，使用Koa2二次开发套件适合多端的RESTful API，同时配套完整的后台管理系统，并前端展示既有基于ejs服务端渲染，也有基于Vue.js前瞻分离的2套前端网站。...
Koa框架
zep
08-11 5795
一、认识Koa 前面我们已经学习了express，另外一个非常流行的Node Web服务器框架就是Koa。 Koa官方的介绍： koa：next generation web framework for node.js； koa：node.js的下一代web框架； 事实上，koa是express同一个团队开发的一个新的Web框架： 目前团队的核心开发者TJ的主要精力也在维护Koa，express已经交给团队维护了； Koa旨在为Web应用程序和API提供更小、更丰富和更强大的能力； 相对于expres
Node.js中的洋葱模型
最新发布
Bruce__taotao的博客
05-13 1535
洋葱模型是一种中间件执行机制，通过层层包裹的中间件结构，实现请求从外到内穿透、响应从内向外返回的顺序执行。该模型的核心概念包括类比洋葱的层次结构和中间件通过next()函数传递控制权。实现原理涉及中间件的进入和返回阶段，以及Koa通过koa-compose库严格遵循洋葱模型，而Express基于回调函数可能导致异步中间件执行顺序混乱。框架对比显示Koa更适合精细控制异步流程，而Express在同步场景下更具优势。实际应用场景包括日志记录、统一错误处理和权限验证。总的来说，洋葱模型通过中间件现了请求-响应流程
Koa: 打造高效、灵活的Node.js后端 (介绍与环境部署)
极限突破者的博客
03-08 6685
Koa是一个新生代Node.js Web框架，由Express原团队成员开发，它的设计目标是成为一个更小、更富有表现力、更健壮的Web框架。中间件机制：Koa的中间件机制更加简洁、灵活，可以更好地控制请求和响应的流程。异步流程控制：Koa使用async/await来处理异步操作，使得代码更加简洁、易读。轻量级：Koa本身很小，只提供了最基本的功能，其他功能都可以通过中间件来扩展。高度可定制：Koa没有强制性的中间件，开发者可以自由选择和定制中间件来满足自己的需求。
Koa 框架介绍
04-22 569
Node.js 是一个异步的世界，官方 API 支持的都是 callback 形式的异步编程模型，这 会带来许多问题，例如：callback 嵌套问题 ，异步函数中可能同步调用 callback 返回 数据，带来不一致性。为了解决以上问题 Koa 出现了。 Koa-- 基于 Node.js 平台的下一代 web 开发框架 koa 是由 Express 原班人马打造的，致力于成为...
Node.js 核心知识点 - Koa 框架
qq_61723274的博客
07-05 3430
/ 导入数据库连接对象// 路由处理函数// 查询的 sql 语句// 执行查询的 sql 语句// 执行错误if(err) {})})// 返回响应信息// 导入路由// 导入路由处理函数// 创建路由对象。
NodeJS-Koa-MongoDB-样板API：带有Koa和MongoDB的NodeJS样板
02-03
NodeJS-Koa-MongoDB-样板API Node.js，Koa，MongoDB的入门项目 NodeJS Koa MongoDB Boilerplate API结构 ├── apidocs ├── app │ ├── controllers │ ├── helpers │ ├── middlewares │ ├─── ...
Nodejs-Koa2-island:Node.js Koa2开发微信小程序服务端
05-07
项目介绍 Node.js Koa2 实战开发微信小程序...以Koa框架为基础，进行Koa二次开发，封装属于自己的中间件 kou-router的路由自动加载 利用jsonwebtoken实现token用户登录以及鉴权处理 应用Sequelize类创建实例后，创建或
nodejs-workflow：Node.js + Koa.js工作流
02-03
Node.js + Koa.js工作流程 依存关系： Node.js >= v8; 启动并运行 安装依赖项： yarn （或npm i ）; 运行yarn start （或npm run start ）以在http://localhost:3001/api 为生产构建运行yarn build （或npm run ...
Nodejs-Koa框架
weixin_47342624的博客
10-29 4100
请求地址：http://localhost:8000/login?nodejs中除了express框架， 另外一个非常流行的Node Web服务器框架就是Koa。koa官方并没有给我们提供路由的库，我们可以选择第三方 库：koa-router。请求地址：http://localhost:8000/login。真实开发中我们如何将路径和method分离呢？
node.js框架之KOA框架
weixin_46240162的博客
05-12 687
node.js框架之KOA koa框架是express框架之后使用的比较多的框架，虽然说现在已经有了更新的egg框架，但是koa框架还是要好好的学习一下。 koa框架和express框架相比较下他的好处是在于它去除了大量的回调函数的使用，封装了async 和 await处理异步函数的方式，async await是es7出的新语法，也是处理promise的最佳解决方案了。 Koa的基本结构 路由 在KOA中，将路由模块给分离了出去，这样的好处是在模块化开发的时候可以不用重复的引入KOA模块，只需要引入单独
nodejs之web服务器框架koa
chengcheng9876的博客
11-30 1421
Koa使用（Koa的安装，Koa的应用程序，Koa的属性，Koa错误处理，Koa的上下文Context） koa-router路由（koa-router的使用，koa-router的参数解析，koa上传文件，嵌套路由）
TKoa - 使用 TypeScript 重构的 Node.js Koa开发框架
weixin_34209406的博客
04-17 295
Node Koa 框架
lio-zero 的博客
04-04 210
Koa 被定位为下一代 Web 框架，由 Express 原班人马打造。Koa 非常轻巧且模块化，可以在不使用回调的情况下编写代码。 Koa 应用程序是一系列中间件功能，可按顺序运行以处理传入的请求并提供响应。每个中间件功能都可以访问上下文对象，该上下文对象包装了原生 Node 请求和响应对象，并提供了改进的 API 来处理它们。 创建一个基于 Koa 的应用程序 安装 koa： $ npm i ...
node之koa框架
lzccheng
01-24 335
koa: 入门教程：http://www.ruanyifeng.com/blog/2017/08/koa.html koa const Koa = require('koa'); const app = new Koa(); const main = ctx => { ctx.response.body = 'Hello World'; }; app.use(main); app...
koa框架
weixin_44954172的博客
07-20 243
node require
nodejs-koa框架linux后端项目
12-10
Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行时环境，而 Koa 是一个由 Express 原班人马打造的轻量级、灵活的 Node.js Web 框架。Koa 提供了一组丰富的功能，使得开发者可以快速构建高效、安全的 Web 应用和 API。 在 Linux 后端项目中，使用 Koa 框架可以带来以下优势： 1. **中间件机制**：Koa 的中间件机制非常强大，允许开发者通过级联的方式处理 HTTP 请求。这种设计使得代码更加模块化和可维护。 2. **轻量级**：Koa 本身非常轻量，不会强制开发者使用任何特定的中间件，这使得开发者可以自由选择适合项目的中间件。 3. **异步编程**：Koa 基于 async/await 语法，使得异步代码更加简洁和易读。 4. **高性能**：由于其轻量级设计和高效的异步处理，Koa 在处理高并发请求时表现出色。 以下是一个简单的 Koa 应用示例： ```javascript const Koa = require('koa'); const app = new Koa(); // 中间件1：记录请求时间 app.use(async (ctx, next) => { const start = Date.now(); await next(); const ms = Date.now() - start; ctx.set('X-Response-Time', `${ms}ms`); }); // 中间件2：响应内容 app.use(async ctx => { ctx.body = 'Hello, Koa!'; }); app.listen(3000, () => { console.log('Server running on http://localhost:3000'); }); ``` 在这个示例中，我们创建了一个简单的 Koa 应用，并添加了两个中间件。第一个中间件记录请求处理时间，第二个中间件返回响应内容。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值