koa框架的基本使用

最新推荐文章于 2024-07-29 11:00:00 发布
最新推荐文章于 2024-07-29 11:00:00 发布
阅读量3.2k 收藏 27
点赞数 6
分类专栏： nodejs
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xiasohuai/article/details/114483975
版权

1.Koa介绍

Koa 是基于 Node.js 平台的下一代 web 开发框架。

Koa是由 Express 原班人马打造的，致力于成为一个更小、更富有表现力、更健壮的 Web 框架。 使用 Koa 编写 web 应用，可以免除重复繁琐的回调函数嵌套， 并极大地提升错误处理的效率。Koa不在内核方法中绑定任何中间件， 它仅仅提供了一个轻量优雅的函数库，使得编写 Web 应用变得得心应手，开发思路和 Express 差不多，最大的特点就是可以避免异步嵌套

2.Koa的安装和基本使用

 

（1）koa的基本使用：

// 引入Koa
var koa = require('koa');
// 实例化Koa
var app = new koa();
 
app.use( async(ctx)=>{
    ctx.body = "hello,koa"
});
 
// 监听端口
app.listen(3000);

（2）koa路由的使用：

// 1.安装 npm install --save koa-router
 
var Koa = require('koa');
// 2.引入路由并实例化
var Router = require('koa-router');
var app = new Koa();
var router = new Router();
 
// 路由路径前缀设置
router.prefix('/api')

// 3.配置路由
router.get('/get', async (ctx) => { // 路径: /api/get
    // 返回数据给前端
    ctx.body = "返回响应数据";
});
 
// 4.启动路由(来自于官方文档);
// router.allowedMethods()可以配置也可以不配置。
// 如果之前的没有设置响应头，配置此选项以后可以自动设置响应头。
app.use(router.routes()).use(router.allowedMethods());
 
// 监听端口
app.listen(3000);

（3）Koa中间件

中间件是配合路由匹配完成做的一系列的操作，我们就可以把它叫做中间件。Koa中运用中间件可以实现以下一些功能：

(1).添加应用。主要通过app.use()这个函数添加或是启动一些应用，如常见的一些第三方中间件的使用。
(2)匹配路由。主要通过next()这个函数完成多级路由匹配。
(3)错误处理。如果当前访问的路由一直向下匹配没有匹配到，可以通过中间件给出错误响应。

var Koa = require('koa');
var Router = require('koa-router');
var app = new Koa();
var router = new Router();
// Koa 错误处理中间件
// 无论app.use放到路由前面还是后面
// 都是先执行app.use再去执行路由
app.use(async (ctx, next) => {
    console.log('这是一个中间件');       // 执行顺序1
    await next();
    if (ctx.status == 404) {           // 执行顺序3
        ctx.body = '这是一个404页面';
    } else {
        console.log(ctx.url);
    }
});
// 配置新闻页                            // 执行顺序2
router.get('/news', async (ctx, next) => {
    console.log('这是新闻路由');
    await next();
});
 
app.use(router.routes());
app.use(router.allowedMethods());
 
app.listen(3000);

（4）使用koa-body和@koa/cors

介绍：
koa-body  //处理request过来的请求里面的数据
@koa/cors  //处理一些跨域请求

安装：

npm install -S koa-body @koa/cors

使用：

（5）Koa中post传值的获取

var Koa = require('koa');
var Router = require('koa-router');
var cors = require('@koa/cors');
var koabody = require('koa-body');

var app = new Koa();
var router = new Router();

router.post('/post', async (ctx, next) => {
    let {body}=ctx.request;//获取前端给的值
    ctx.body={//把body里面前端给的内容再返回给前端
        ...body
    }
});

//app.use注意顺序
app.use(koaBody())//处理request过来的请求里面的数据
app.use(cors())//处理一些跨域请求

app.use(router.routes())
    .use(router.allowedMethods());
 
app.listen(3000);

（6）Koa中get传值及获取get传值

Koa中的get传值主要有以下两种方式：

(1).键值对拼接传参，接收参数主要通过ctx.qruery获取，需要注意的是在ctx与ctx.request里均可以获得一样的结果。

var Koa = require('koa');
var router = require('koa-router')();
var app = new Koa();
// http://localhost:3000/details?id=1&name=jiangyx
router.get('/details',async(ctx)=>{
    // 从ctx中读取Get传值
    console.log(ctx.url);// /details?id=1&name=jiangyx
    console.log(ctx.query); // { id: '1', name: 'jiangyx' } // 获取的是对象，用的最多的方式
    console.log(ctx.querystring) // id=1&name=jiangyx // 获取的是字符串
 
    // 从ctx里的request里获取Get传值
    console.log(ctx.request.url); // /details?id=1&name=jiangyx
    console.log(ctx.request.query); // { id: '1', name: 'jiangyx' }
    console.log(ctx.request.querystring); // id=1&name=jiangyx
});
 
app.use(router.routes());
app.use(router.allowedMethods());
app.listen(3000);

(2).动态路由传参，接收参数主要通过ctx.params获取。

var Koa = require('koa');
var router = require('koa-router')();
var app = new Koa();
 
// http://localhost:3000/details/1/jiangyx
router.get('/details/:id/:name', async (ctx) => {
    // 获取动态路由的传值
    console.log(ctx.params); // { id: '1' ,name:'jiangyx'}
});
 
app.use(router.routes());
app.use(router.allowedMethods());
app.listen(3000);

（7）koa-json的使用

介绍：按照json格式数据的传输

安装：

npm install -S koa-json

使用：

。。。。。
var json = require('koa-json');
。。。。。

app.use(json({ pretty: false, param: 'pretty' }));
。。。。



//案例：

http://localhost:3000/details?id=1&name=jiangyx
返回结果：{"foo":"bar"}

路径加pretty
http://localhost:3000/details?id=1&name=jiangyx&pretty
返回结果：
{
  "foo": "bar"
}

（8）合并路由(路由压缩)：koa-combine-routers

// 安装：npm install koa-combine-routers

// app.js
const Koa = require('koa')
const router = require('./routes')
 
const app = new Koa()
 
app.use(router())


// routers.js
const Router = require('koa-router')
const combineRouters = require('koa-combine-routers')
 
const dogRouter = new Router()
const catRouter = new Router()
 
dogRouter.get('/dogs', async ctx => {
  ctx.body = 'ok'
})
 
catRouter.get('/cats', async ctx => {
  ctx.body = 'ok'
})
 
const router = combineRouters(
  dogRouter,
  catRouter
)
 
module.exports = router

（9）加入安全头：koa-helmet

安装：npm install koa-helmet -S

使用：
const Koa = require("koa");
const helmet = require("koa-helmet");
const app = new Koa();
 
app.use(helmet());
 
app.use((ctx) => {
  ctx.body = "Hello World"
});
 
app.listen(4000);

（10）静态资源：koa-static

安装：npm install -S koa-static

使用：
const serve = require('koa-static');
const Koa = require('koa');
const app = new Koa();
 
// $ GET /package.json
app.use(serve('.'));
 
// $ GET /hello.txt
app.use(serve('test/fixtures'));
 
// or use absolute paths
app.use(serve(__dirname + '/test/fixtures'));
 
app.listen(3000);
 
console.log('listening on port 3000');

（11）使用koa-compose集成中间件

import koa from 'koa'
import path from 'path'
import helmet from 'koa-helmet'
import statics from 'koa-static'
import router from './routes/routes'//合并路由后的routers.js
import koaBody from 'koa-body'
import jsonutil from 'koa-json'
import cors from '@koa/cors'
import compose from 'koa-compose'

const app = new koa()

// app.use...
// app.use(helmet()) 
// app.use(statics(path.join(__dirname, '../public')))
// app.use(router())
const middleware = compose([
    koaBody(),
    statics(path.join(__dirname,'../public')),
    cors(),
    jsonutil({pretty: false, param:'pretty'}),
    helmet()
])

app.use(middleware)
app.use(router())

app.listen(3000);

（12）koa-compress压缩数据

import koa from 'koa'
import path from 'path'
import helmet from 'koa-helmet'
import statics from 'koa-static'
import router from './routes/routes'//合并路由后的routers.js
import koaBody from 'koa-body'
import jsonutil from 'koa-json'
import cors from '@koa/cors'
import compose from 'koa-compose'
import compress from 'koa-compress'


const app = new koa()

const isDevMode=process.env.NODE_ENV==='production'?false:true

const middleware = compose([
    koaBody(),
    statics(path.join(__dirname,'../public')),
    cors(),
    jsonutil({pretty: false, param:'pretty'}),
    helmet()
])

if(!isDevMode){
    app.use(compress())
}

app.use(middleware)
app.use(router())

app.listen(3000);

（13）nodemon

nodemon是一种工具，可以自动检测到目录中的文件更改时通过重新启动应用程序来调试基于node.js的应用程序。

// 安装
npm install -g nodemon
//或
npm install --save-dev nodemon


// 使用
nodemon   ./main.js // 启动node服务
nodemon ./main.js localhost 6677 // 在本地6677端口启动node服务
"start": "nodemon src/main.ts",//在package.json中使用

nodemon是利用common.js语法执行的进行监视的，我们如何支持es6的语法进行监视执行呢？

"start": "nodemon --exec babel-node src/main.ts",

（14）Koa操作MySQL数据库

// 1.npm install --save mysql
 
// 2.引入模块
const mysql = require('mysql');
 
// 3.连接数据库
const connection = mysql.createConnection({
    host: '127.0.0.1',         // 数据库地址
    user: 'root',              // 用户名 
    password: '123456' ,       // 密码   
    database: 'my_data'        // 数据库名称   
})
 
// 4.执行sql语句操作数据库
connection.query('SELECT * FROM user',
     (error, results, fields) => {
        if (error) {
            console.log(error)
        };
        // 操作数据
 
        // 结束会话
        connection.release();
    }
);

注意，数据库会话操作执行完后，需要关闭掉，以免占用连接资源。

当有多个会话需要操作数据库时，为了避免每次会话都要重新连接，所以这时候就需要连接池管理会话。

// 1.npm install --save mysql
 
// 2.引入模块
const mysql = require('mysql');
 
// 3.创建数据池
const pool = mysql.createPool({
    host: '127.0.0.1',         // 数据库地址
    user: 'root',              // 用户名 
    password: '123456',        // 密码   
    database: 'my_data'        // 数据库名称 
})
 
// 4.在数据池中进行会话操作
pool.getConnection(function (err, connection) {
    // 5.执行sql语句操作数据库
    connection.query('SELECT * FROM user', 
        (error, results, fields) => {
        
            // 执行操作
 
            // 释放连接
            connection.release();
            // 如果有错误就抛出
            if (error) {
                throw error;
            }
        }
    )
})

（15）断点调试

nodejs在Chrome 中断点调试：https://blog.csdn.net/xiasohuai/article/details/90551504

nodejs在vscode 中断点调试：https://blog.csdn.net/xiasohuai/article/details/90551380

webpack打包过程如何调试（浏览器）：https://blog.csdn.net/xiasohuai/article/details/107889879

 

 

 

 

 

 

 

姜无忧
关注
专栏目录
【Nodejs】Koa基本使用
DomCode
07-26 646
koa是由 Express 原班人马打造的，致力于成为一个更小、更富有表现力、更健壮的 Web 框架。使用 koa 编写 web 应用，通过组合不同的 generator，可以免除重复繁琐的回调函数嵌套，并极大地提升错误处理的效率。koa 不在内核方法中绑定任何中间件，它仅仅提供了一个轻量优雅的函数库，使得编写 Web 应用变得得心应手。
Koa框架的一些基本用法
weixin_40976555的博客
02-19 734
一、基本用法 创建 HTTP服务 server.js const Koa = require('koa'); const app = new Koa(); app.listen(3000, () => { console.log('Server Started...') }) 运行 node server.js 访问 http://localhost:3000/ 浏览器显示...
【Koa基本使用】
最新发布
热情、奔放、快乐编程！
07-29 308
koa 是由 Express 原班人马打造的，致力于成为一个更小、更富有表现力、更健壮的 Web 框架。使用 koa 编写 web 应用，通过组合不同的 generator，可以免除重复繁琐的回调函数嵌套，并极大地提升错误处理的效率。koa 不在内核方法中绑定任何中间件，它仅仅提供了一个轻量优雅的函数库，使得编写 Web 应用变得得心应手。
Koa的基本使用
L20150514的博客
10-03 217
1. 安装 2. 路由中间件 安装 cnpm i koa-router -D const koa = require('koa'); const Router = require('koa-router'); let server = new koa(); server.listen(8080); let router = new Router(); router.get('/a', async (ctx, next) => { ctx.body = 'aaa'; }); se
Koa框架教程,Koa框架开发指南,Koa框架中文使用手册,Koa框架中文文档
weixin_33716941的博客
08-09 281
我的博客：CODE大全：www.codedq.net；业余草：www.xttblog.com；爱分享：www.ndislwf.com或ifxvn.com。 Koa -- 基于 Node.js 平台的下一代 web 开发框架。 简介koa 是由 Express 原班人马打造的，致力于成为一个更小、更富有表现力、更健壮的 Web 框架。使用 koa 编写 ...
Koa的使用
nanxing的博客
10-01 793
Koa的使用Koa初体验Koa中间件：路由的使用params和query参数解析json数据解析x-www-form-urlencoded数据解析form-data数据解析Koa数据响应响应结果响应码静态资源服务器错误处理 Koa初体验 安装：npm install koa const Koa = require("koa"); const url = require("url"); const app = new Koa(); // 注册中间件 app.use((ctx, next) => {
koa 使用
gronkie的博客
12-19 728
1. koa 是什么 2. ctx 参数 3. next 参数 4. request 对象 5. response 对象 6. koa1，koa2 和 express 的区别
Koa框架教程
01-27
【Koa框架教程】 Koa 是一款针对Node.js平台的轻量级Web应用框架，以其优雅、简洁和高效而著称。它具有高度的可扩展性，所有的功能都是通过插件来实现，遵循Unix哲学，使得Koa的核心代码非常精简，只有1000多行。...
使用nodejs的koa框架连接MongoDB数据库.zip
11-05
至此，你已经学会了如何使用Node.js的Koa框架连接MongoDB数据库并进行基本的数据操作。这个基础可以进一步扩展到更复杂的Web应用，包括用户认证、数据验证、分页、聚合查询等功能。在实际项目中，还可以考虑使用ORM...
Koa框架基础快速入门
01-27
要使用Koa，首先需要确保你的系统上安装了Node.js，版本至少为7.6，因为Koa框架依赖于某些Node.js的新特性。你可以从官方站点下载并安装适合的版本。安装完成后，可以使用`node -v`命令检查Node.js版本。 ### **...
nodejs -- koa框架
King Saj
05-04 840
Koa 是一个基于 Node.js 的 Web 框架，它提供了一组简洁而优雅的 API，使得编写 Web 应用程序变得更加容易和快捷。首先，需要安装 Node.js 运行环境。可以从 Node.js 官网下载适合自己操作系统的安装包，并按照提示进行安装。这将创建一个名为my-koa-app的新目录，并在其中初始化一个新的 Node.js 项目。-y参数将启用默认设置，跳过对项目的交互式询问。这将在 Node.js 项目中安装 Koa 模块，并将其添加到项目的依赖列表中。在my-koa-app。
koa框架文件上传.zip
11-08
在这个"koa框架文件上传.zip"中，我们将会探讨如何使用Koa实现文件上传功能。 首先，`npm i` 是Node.js项目中安装依赖包的命令，这里指的依赖可能包括`koa`本身，以及处理文件上传所需的库，如`koa-bodyparser`...
koa的基本使用
hjhfreshman的博客
08-02 352
主要实现了以下几个知识点： 1.koa中的路由如何引入 2.处理get请求，及获取参数 3.处理post请求，及获取参数 4.使用中间件koa-bodyparser（获取请求参数），koa-static（解析静态文件）， 5.操作封装后的mongodb数据库，如何封装可以看我之前的文章：封装koa操作mongodb数据库方法 直接上代码，对应功能有注释 const koa = require("koa") const router = require("koa-router")() // 路由 const
koa2框架的使用与解析
weixin_34408717的博客
04-09 280
koa是什么？ koa是基于nodejs的一个http中间件框架。koa源码只有一千多行，所有的功能都可以通过插件实现，简单易懂，自由度高。 准备 node需要v7.6.0或者更高的版本(支持es6和async的语法)。 npm install koa 开始 先看看来自官方github的最小demo const Koa = require('koa'); const app = new Koa...
koa基本使用
qq_45768871的博客
02-09 1519
koa 基本使用 var Koa = require('koa'); var Router = require('koa-router'); var app = new Koa(); var router = new Router(); /* koa 中间件 */ app.use(async(ctx, next) => { console.log(new Date()) await next(); }) router.get('/', (ctx, next
koa（express升级版框架）的基本使用
weixin_46560512的博客
02-23 1462
koa是express的基础上的升级框架，本koa使用教程
koa框架的使用
没有途径，只有努力
07-21 1158
koa框架的使用在package.json中修改启动命令为nodemon。在app.js中把下面的代码添加到引入路由配置之前。在某个路由文件中导入dbpool.js即可，例如。进入项目根目录执行npminstall。在根目录创建utils/dbpool.js。通过crypto进行加密。...
Koa使用教程
sinat_38832964的博客
06-26 2025
一、KOA准备–搭建本地服务器 1、首先创建一个目录 koa-app ，用相关工具打开 使用 npm init --yes 命令生成package.json 文件 新建 app.js 2、安装 KOA npm install koa koa-router -s 3、在 app.js 中写入： //引入模块 const Koa = require('koa'); ...
koa框架
mantou_riji的博客
07-11 7866
Koa采用洋葱模型 通常都会说Koa是洋葱模型,这重点在于中间件的设计。但是按照上面的分析,会发现Express也是类似的，不同的是Express中间件机制使用了Callback 实现，这样如果出现异步则可能会使你在执行顺序上感到困惑，因此如果我们想做接口耗时统计、错误处理Koa的这种中间件模式处理起来更方便些。最后一点响应机制也很重要, Koa不是立即响应，是整个中间件处理完成在最外层进行了响应，而Express则是立即响应。Koa更轻量 koa不提供内置的中间件; koa不提供路由，而是把路由这个库分离
koa框架中如何使用注解
05-26
在 Koa 框架中使用注解需要借助于 TypeScript，因为注解本身就是 TypeScript 中的一种特性。具体步骤如下： 1. 安装依赖： ```bash npm install reflect-metadata npm install @koa/router npm install koa-bodyparser npm install typescript npm install ts-node ``` 2. 在 tsconfig.json 中启用 decorator 和 emitDecoratorMetadata： ```json { "compilerOptions": { "target": "es6", "module": "commonjs", "esModuleInterop": true, "experimentalDecorators": true, "emitDecoratorMetadata": true } } ``` 3. 创建一个 Koa 应用，并且使用 koa-router 和 koa-bodyparser： ```typescript import Koa from 'koa'; import Router from '@koa/router'; import bodyParser from 'koa-bodyparser'; const app = new Koa(); const router = new Router(); app.use(bodyParser()); app.use(router.routes()); ``` 4. 创建一个控制器类，使用 @Controller 装饰器标记该类，并使用 @Route 装饰器标记该类中的方法对应的路由： ```typescript import { Controller, Route } from './decorators'; @Controller('/api') class ApiController { @Route('get', '/hello') async sayHello(ctx: Koa.Context) { ctx.body = 'Hello, world!'; } } ``` 5. 创建一个装饰器文件 decorators.ts，包含 @Controller 和 @Route 装饰器： ```typescript import 'reflect-metadata'; import Router from '@koa/router'; const CONTROLLER_KEY = Symbol('controller'); const ROUTES_KEY = Symbol('routes'); export function Controller(path: string) { return function(target: any) { Reflect.defineMetadata(CONTROLLER_KEY, path, target); } } export function Route(method: string, path: string) { return function(target: any, key: string) { if (!Reflect.hasMetadata(ROUTES_KEY, target.constructor)) { Reflect.defineMetadata(ROUTES_KEY, [], target.constructor); } const routes = Reflect.getMetadata(ROUTES_KEY, target.constructor); routes.push({ method, path, key }); } } export function registerRoutes(router: Router) { const controllers = Reflect.getMetadata(CONTROLLER_KEY, Reflect) || []; controllers.forEach((controller: any) => { const routes = Reflect.getMetadata(ROUTES_KEY, controller) || []; routes.forEach((route: any) => { router[route.method](controller.path + route.path, controller[route.key]); }); }); } ``` 6. 在入口文件中注册路由： ```typescript import { registerRoutes } from './decorators'; registerRoutes(router); app.listen(3000); ``` 以上就是在 Koa 框架中使用注解的基本步骤。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值