Node.js使用Koa搭建基础项目

更新时间：2018年01月08日 08:58:20 作者：WiseWrong

时下前端工程师有很多人比较关注NodeJs以及express 框架或者Koa 框架之类的新技术。难得我最近闲时较多，利用一下旧历新年尚未正式到来的这片闲暇，也来涉足其中，一窥其中奥妙。

一、创建项目

手动创建一个项目目录，然后快速生成一个 package.json 文件

npm init -y

安装 koa //当前版本 2.4.1

npm install koa -S

然后创建一个 app.js

// app.js

const Koa = require('koa');
const app = new Koa();

app.use(async ctx => {
 ctx.body = 'Wise Wrong';
});

app.listen(3000);

最后在 package.json 中添加启动指令

一个最基础的 koa 应用就这样完成了

可以执行 npm start 并在浏览器访问 http://localhost:3000/ 查看效果

如果觉得手动创建项目太过繁琐，可以使用脚手架 koa-generato 来生成项目

npm install koa-generator -g

koa2 project_name

然后在项目下 npm install 安装依赖，npm start 启动项目

如果是刚接触 koa，建议先看完这篇博客，再使用脚手架工具，这样能更好的理解各个依赖包的作用

二、配置路由

上面 app.js 中有一个 ctx，这是一个 Koa 提供的 Context 对象，封装了 request 和 response

每一次 HTTP Request 都会创建一个 Context 对象

我们可以通过 Context.request.path 来获取用户请求的路径，然后通过 Context.response.body 给用户发送内容

Koa 默认的返回类型是 text/plain，如果要返回一个 html 文件（或者一个模块文件），就需要修改 Context.response.type

另外，Context.response 可以简写，比如 Context.response.type 简写为 Context.type，Context.response.body 简写为 Context.type

在项目下创建一个存放 html 文件的目录 views，并在该目录下创建一个 index.html，然后修改 app.js

// app.js// 原生路由

const Koa = require('koa');
const fs = require('fs');
const app = new Koa();

app.use(async (ctx, next) => {
 if (ctx.request.path === '/index') {
 ctx.type = 'text/html';
 ctx.body = fs.createReadStream('./views/index.html');
 } else {
 await next();
 }
});

app.listen(3000);

然后在浏览器中访问 http://localhost:3000/index 就能看到 index.html 页面，而访问别的地址则是 not found

这样处理 url 显得特别笨拙，所以我们需要引入路由中间件 koa-router

npm install koa-router -S

需要注意的是，在导入 koa-router 的时候，需要在末尾加一个括号：

const router = require('koa-router')();

相当于：

const koaRouter = require('koa-router');
const router = koaRouter();

创建一个 routes 目录，用来存放路由文件，并在目录下创建 index.js

// routes/index.js

const fs = require('fs');
const router = require('koa-router')()

router.get('/index', async (ctx, next) => {
 ctx.type = 'text/html';
 ctx.body = fs.createReadStream('./views/index.html');
});

module.exports = router

这里还可以使用 prefix 方法，为文件中的所有接口添加一个 baseUrl

// router.prefix('/about')

修改 app.js

// app.js

const Koa = require('koa');
const app = new Koa();

const index = require('./routes/index')
app.use(index.routes(), index.allowedMethods())

app.listen(3000);

上面的 allowedMethods 用于校验请求的方法，如果用 post 请求访问 get 接口，就会直接返回失败

另外，还可以在 url 中添加变量，然后通过 Context.params.name 访问

router.get('/about/:name', async (ctx, next) => {
 ctx.body = `I am ${ctx.params.name}!`;
});

三、静态资源

在上面的 index.html 中，如果需要引入 css 等静态资源，就需要用到 koa-static

npm install koa-static -S

创建一个目录 public 用来存放静态资源

然后在 app.js 中添加以下代码

const static = require('koa-static');
// 将 public 目录设置为静态资源目录
const main = static(__dirname + '/public');
app.use(main);

事实上，这三行代码还可以优化

app.use(require('koa-static')(__dirname + '/public'));

然后就能在 index.html 中引入对应的文件了

四、模板引擎

上面的路由是使用 fs 模块直接读取 html 文件

开发的时候更推荐使用 koa-views 中间件来渲染页面

npm install koa-views -S

在 app.js 中将 views 目录设定为模版目录

const views = require('koa-views')
app.use(views(__dirname + '/views'));

然后在路由文件中，就能使用 render 方法了

// routes/index.js

const router = require('koa-router')()

router.get('/index', async (ctx, next) => {
 await ctx.render('index');
});

module.exports = router

以上是直接渲染 html 文件的方法，如果要引入模板引擎，可以添加 extension 字段来设定模版类型

app.use(views(__dirname + '/views', {
 extension: 'pug' // 以 pug 模版为例
}))

五、结语

如果将 Express 看作 webstorm，那么 Koa 就是 sublime

当 Express 流行的时候，其冗杂的依赖项被很多开发者所诟病

所以 Express 团队将 Express 拆卸得只剩下最基本的骨架，让开发者自行组装，这就是 Koa

正如文中所说，从零开始太过繁琐，可以使用脚手架 koa-generato 来快速开发

不过我更推荐，在熟悉了 Koa 之后，搭一个适合自己项目的脚手架

不然为何不直接用 Express 呢

我想这也是 Koa 的官方文档中没有提到 generato 工具的原因吧

您可能感兴趣的文章:

Node.js
koa

nodejs将JSON字符串转化为JSON对象报错的解决
这篇文章主要介绍了nodejs将JSON字符串转化为JSON对象报错的解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-07-07
使用NODE.JS创建一个WEBSERVER(服务器)的步骤
在 node.js 中创建一个服务器非常简单，只需要使用 node.js 为我们提供的 http 模块及相关 API 即可创建一个麻雀虽小但五脏俱全的web 服务器，相比 Java/Python/Ruby 搭建web服务器的过程简单的很。本文简单的讲解下实现步骤
2021-06-06
Node.js对MongoDB数据库实现模糊查询的方法
模糊查询是数据库的基本操作之一，下面这篇文章主要给大家介绍了利用Node.js对MongoDB数据库实现模糊查询的方法教程，文中给出了详细的介绍和示例代码，对大家具有一定的参考价值，需要的朋友们下面来一起看看吧。
2017-05-05
解析NodeJs的调试方法
本文主要介绍了NodeJs调试的步骤，以及实例方法，具有一定的参考作用，需要的朋友可以看下
2016-12-12
Node.js中的缓冲与流模块详细介绍
这篇文章主要介绍了Node.js中的缓冲与流模块详细介绍,本文讲解了缓冲（buffer）模块、类：Buffer、写入缓冲区、复制缓冲区、流模块等内容,需要的朋友可以参考下
2015-02-02
详解Puppeteer前端自动化测试实践
这篇文章主要介绍了详解Puppeteer前端自动化测试实践，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2019-02-02
Express实现定时发送邮件的示例代码
在开发中我们有时候需要每隔一段时间发送一次电子邮件，或者在某个特定的时间进行发送邮件，无需手动去操作，基于这样的情况下我们需要用到了定时任务。本文就来用Express实现定时发送邮件吧
2023-04-04
node.js实现端口转发
这篇文章主要为大家详细介绍了node.js实现端口转发的关键代码，感兴趣的小伙伴们可以参考一下
2016-04-04
nodejs中转换URL字符串与查询字符串详解
这篇文章主要介绍了nodejs中转换URL字符串与查询字符串详解,需要的朋友可以参考下
2014-11-11
使用Nodejs 实现一个简单的 Redis客户端(推荐)
在nodejs中支持TCP连接的是net模块, 其中使用createConnection(config)或者直接new Socket(config)来初始化一个TCP连接，这篇文章主要介绍了用Nodejs 实现一个简单的 Redis客户端,需要的朋友可以参考下
2022-11-11