搭建koa2项目

一、创建项目

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

npm init -y


安装 koa //当前版本 2.4.1

npm install koa -S


然后创建一个 app.js

// app.js

const Koa = require('koa');

const app = newKoa();

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 = newKoa();


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 模版为例

}))


最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,491评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,856评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,745评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,196评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,073评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,112评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,531评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,215评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,485评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,578评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,356评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,215评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,583评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,898评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,497评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,697评论 2 335

推荐阅读更多精彩内容

  • [TOC] Koa2 Koa2是现在最流行的基于Node.js平台的web开发框架,它很小,但扩展性很强使用 ko...
    duangdong阅读 1,791评论 0 5
  • 使用Koa搭建 基础项目 一、创建项目 手动创建一个项目目录,然后快速生成一个 package.json 文件np...
    随风飞2019阅读 1,352评论 0 6
  • 本文由郝晨光整理总结并编写,未经允许禁止转载。 前言 学习koa,我之前学习过express,但是在使用expre...
    郝晨光阅读 1,219评论 0 12
  • 一、基本用法 1.1 架设 HTTP 服务 // demos/01.jsconst Koa = require('...
    majun00阅读 1,335评论 0 5
  • 框架是一种概念,是对常见功能的封装,是整个或部分系统的可重用设计,表现为一组抽象构件及构件实例间交互的方法,通过制...
    Sun晨淏阅读 558评论 0 1