头几天想写个小爬虫顺序,预备后端就用koa2。因而翻遍github与各大网站,都没找到一个好用的、轻一点的koa2脚手架,也找不到一个清楚些的搭建引见。github上的脚手架要么是1.x版的koa,要么一堆庞杂的依靠。
固然可以照样有写的比较好的吧,只是我没找到。不管怎样吧,我只能亲身上了,就当是进修了。
如今把搭建历程引见下,看能不能轻易下入门的同砚。
第一步:初始项目,引入 Koa2
官方的引见,是很简朴的。
$ npm install koa
const Koa = require('koa')
const app = new Koa()
// response
app.use(ctx => {
ctx.body = 'Hello Koa'
})
app.listen(3000)
好,那我们就先从这最先。建立一个文件夹,定名koa2。(记得先装好node v7.6.0 以上版本)
cd koa2
npm init // 一起回车,依据提醒输入信息。
npm install koa --save
然后在文件下根目次下建立顺序进口文件:index.js,并把官网引见那段代码贴进去。以后在命令行中实行
node index.js
翻开浏览器,接见 http://localhost:3000/
,可以看到页面输出了 hello world
。
很好,第一步已踏出去了。相信到这里大部份小白都没题目,以后就最先懵逼了。就这个玩意,我该怎样写接口?怎样衔接数据库?
第二步:搭建路由与Controller
Koa实质上是挪用一系列的中间件,来处置惩罚对应的要求,并决议是不是通报到下一个中间件去处置惩罚。我们来写一个最简朴的中间件尝尝。
// 适才index.js 中的这段代码,我们改写一下。
app.use(ctx => {
ctx.body = 'Hello Koa'
})
// 改成以下
app.use(ctx => {
ctx.body = `您的网址途径为:${ctx.request.url}`
})
这段代码中,app.use
的 function
就是最简朴的一个中间件,接受了要求,读出要求途径,并返回到客户端。从新实行下node index.js
,翻开浏览器,输入http://localhost:3000/hhhhh
,页面输出了您的网址途径为:hhhhh
。
所以,接口的实质,就是推断差别的要求链接,干差别的事变,返回响应的效果。那末我们得须要一个路由中间件来处置惩罚分发要求。开源的时期,固然是拿来主义了。github搜下koa-router,胜利找到。依据它的引见,我们先在项目根目次实行
npm install koa-router --save
然后把index.js
文件再革新下。变成以下:
const Koa = require('koa')
const Router = require('koa-router')
const app = new Koa()
const router = new Router()
// 先诠释了,背面再诠释
// const bodyParser = require('koa-bodyparser')
// app.use(bodyParser())
router.get('/', ctx => {
ctx.body = `这是主页`
})
router.get('/user', ctx => {
ctx.body = `这是user页`
})
router.get('/post', ctx => {
ctx.body = ctx.request.body
})
router.get('/async', async ctx => {
const sleep = async (ms) => {
return new Promise(resolve => {
setTimeout(() => {
resolve(true)
}, ms)
})
}
await sleep(1000)
ctx.body = `这是异步处置惩罚页`
})
app
.use(router.routes())
.use(router.allowedMethods())
app.listen(3000)
从新实行 node index.js
。我们可以看到接见 /
, /user
,/async
,都能获得响应的效果了。
除了谁人post的要领,压根得不到本身post的数据。
由于koa是很地道的,你提交的数据,它并不会帮你处置惩罚。所以这里我们又必需援用一个中间件来处置惩罚提交的数据–bodyparser。把上面那两行诠释代码解注,就可以处置惩罚要求数据了。记得要先
npm install koa-bodyparser --save
别的关于async/await
不明白的同砚,可以先去看下阮先生的引见,点击传送门。
不过我们不能把一切的接口都写在这一个文件呀,所以我们得革新下。理一下思绪,路由的设置文件应当零丁一份,接口的要领应当按营业模块分红一个个controller。说干就干!
先看革新后的目次构造,不想截图,人人迁就看看:
-koa2
-node_modules
-controller
user.js
-index.js
-router.js
-package.json
再来看文件变成怎样了。
// index.js
const Koa = require('koa')
const app = new Koa()
const router = require('./router')
const bodyParser = require('koa-bodyparser')
app.use(bodyParser())
app
.use(router.routes())
.use(router.allowedMethods())
app.listen(3000)
// router.js
const Router = require('koa-router')
const router = new Router()
const user = require('./controller/user')
router.post('/user/login', user.login)
router.get('/user/profile', user.profile)
module.exports = router
// controller/user.js
const sleep = async (ms) => {
return new Promise(resolve => {
setTimeout(() => {
resolve(true)
}, ms)
})
}
module.exports = {
login (ctx) {
ctx.body = {
username: ctx.request.body.username
}
},
async profile (ctx) {
await sleep(1000)
ctx.body = {
username: '相学长',
sex: 'man',
age: '999'
}
}
}
再从新实行 node index.js
。接见响应路由,应当能获得对应的效果了。
其他工程化设置
好,到此为止,我们的server已大抵完成了,然则我们发明一个很烦的题目就是,每次修正代码都得从新node index.js
,这也太烦了。我愿望的是,每次更新代码都能从新实行,而且帮我实行ESlint。其他前端项目webpack那一套,不是webpack设置工程师的话,本身挪过来又改不来。
这里我引见个简朴的计划,nodemon + gulp
。详细呢就不一步步来了,这类东西,不必太相识,能run起来满足本身需求就好。假如不须要eslint的话,只需装置nodemon就好。
package.json scripts部份 修正为:
"scripts": {
"nodemon": "nodemon index.js"
}
然后命令行实行:
npm install nodemon --save-dev
npm run nodemon
假如有eslint的需求的话,就轻微贫苦些了,eslint的init我就不贴教程了,我贴上我的gulp设置文件:
// gulpfile.js
const gulp = require('gulp')
const lint = require('gulp-eslint')
const nodemon = require('gulp-nodemon')
function lintFiles (files) {
return gulp.src(files)
.pipe(lint())
.pipe(lint.format())
// .pipe(lint.failAfterError())
}
gulp.task('eslint', () => lintFiles(['**/*.js', '!node_modules/**']))
gulp.task('eslint_nodemon', ['eslint'], () => {
return nodemon({
script: './app/server.js', // 项目进口文件
tasks (changedFiles) {
lintFiles(changedFiles)
return []
},
ignore: ['build/**', 'dist/**', '.git', 'node_modules/**']
})
})
gulp.task('default', ['eslint_nodemon'])
// package.json scripts
"scripts": {
"start": "pm2 start index.js --watch", // 这里用pm2 作为线上run,有兴致的同砚可以本身去看看
"dev": "gulp",
"lint": "eslint .",
"fix": "eslint --fix ."
},
写在末了
到这里,我想应当能让一部份同砚上手了。
但这只是开端的搭建了下koa。真的想投入使用,依据营业需求,可以还须要装置数据库驱动等中间件。关于庞杂营业场景的server,还须要越发合理的设想controller,service,在这里就不多论述了。
假如这篇文章,可以协助到一些同砚,下次有空再写写这方面相干的。
ps: 文章引见的一切代码都传了一份到github,有须要的同砚请自行去看。