koa2 入门(1)koa-generator 脚手架和 mongoose 使用
项目地址:https://github.com/caochangkui/demo/tree/koa2-learn
1 构建项目
1.1 安装koa-generator
$ npm install -g koa-generator
1.2 使用koa-generator生成koa2项目
$ koa2 -e project(项目名称) (-e 代表使用模板引擎ejs)
1.3 进入项目
$ cd project
$ npm install
1.4 启动项目,默认端口号是3000
$ DEBUG=koa2-learn:* npm start (该方法在修改文件时需要重新启动服务。不建议使用)
$ npm run dev (该方法可以直接刷新服务)
1.5 项目目录
其中:dbs为后来创建的操作mongo的文件目录;middleware为后来创建的自定义中间件目录
2. 中间件
koa是从第一个中间件开始执行,遇到 await next() 进入下一个中间件,一直执行到最后一个中间件,在逆序,执行上一个中间件,一直到第一个中间件执行结束才发出响应。
2.1 自定义中间件
创建文件夹middleware存放各种自定义中间件;
创建文件 koa-pv.js:
// 自定义中间件 koa-pv
function pv (ctx) {
global.console.log('当前路由', ctx.path) // 打印当前路由,node中全局不能用window,需要用global代替
}
module.exports = function () {
return async function(ctx, next) {
pv(ctx)
await next() // 每个中间件都必须有这一句,用以执行下一个中间件
}
}
然后,在app.js中引入中间件
const pv = require('./middleware/koa-pv')
app.use(pv())
3. mongoose的使用
3.1 判断是否安装了mongo:
$ which mongod
3.2 运行 MongoDB
$ sudo mongod
<!--
首先创建一个数据库存储目录 /data/db:
sudo mkdir -p /data/db
启动 mongodb,默认数据库目录即为 /data/db
参考:http://www.runoob.com/mongodb/mongodb-osx-install.html
如果已经有进程27017,需要先停止:
停止进程:
lsof -i :27017
kill -9 3243
-->
3.3 配置mongoose
在文件夹dbs中创建文件 config.js:
// 配置mongo 地址
module.exports = {
dbs: 'mongodb://127.0.0.1:27017/dbs'
}
3.4 创建数据表
在文件dbs 中创建文件夹models 用来存放不同的数据表。
创建文件person.js, 文件名person即为数据表名称。
person.js:
const mongoose = require('mongoose')
// 创建数据表模型,该文件的名字,即person,就是数据表的名字
// 下面给 person 表声明两个字段name和age
let personSchema = new mongoose.Schema({
name: String,
age: Number
})
// 通过建 model 给 person 赋予增删改查等读写的功能
module.exports = mongoose.model('Person', personSchema)
3.5 连接koa2和mongoose
// 一、引入mongoose
const mongoose = require('mongoose')
const dbConfig = require('./dbs/config')
// 二、 连接数据库的服务
mongoose.connect(dbConfig.dbs, {
useNewUrlParser: true
})
3.6 通过mongoose进行数据的增删改查
进入文件 routes/uses.js:
const router = require('koa-router')()
// 引入mongo模型
const Person = require('../dbs/models/person')
router.prefix('/users')
router.get('/', function (ctx, next) {
ctx.body = 'this is a users response!'
})
router.get('/bar', function (ctx, next) {
ctx.body = 'this is a users/bar response'
})
/**
* 一、 增加 内容 向person数据模型中
*
* 可以通过命令行执行:curl -d 'name=cck&age=27' http://localhost:3000/users/addPerson
* 若返回: {
"code": 0
}
证明添加数据成功。
注意: save()方法是model自带的写入数据的方法, 通过实例 person 写入
*/
router.post('/addPerson', async function (ctx) {
// 创建实例
const person = new Person({
name: ctx.request.body.name,
age: ctx.request.body.age
})
let code = 0 // 状态码
try {
await person.save()
code = 0
} catch(e) {
code = -1
}
// 返回状态(成功为0, 错误为-1)
ctx.body = {
code
}
})
/**
* 二、 读取 内容 从person数据模型中
* 命令行中输入:curl -d 'name=cck' http://localhost:3000/users/getPerson
* 返回:{
"code": 0,
"result": {
"_id": "5beb91bcd6e7060ffcca6a46",
"name": "cck",
"age": 27,
"__v": 0
},
"results": [
{
"_id": "5beb91bcd6e7060ffcca6a46",
"name": "cck",
"age": 27,
"__v": 0
}
]
}
*
* 注意: findOne()和find()方法是model自带的读取数据的方法, 注意:这里直接通过模型 Person 写入 !!!
* findOne() 只是找到一条符合条件的内容
* find() 可以找到整个符合条件的集合(数组)
*/
router.post('/getPerson', async function (ctx) {
const result = await Person.findOne({
name: ctx.request.body.name
})
const results = await Person.find({
name: ctx.request.body.name
})
// 这里没有考虑异常,直接返回了结果
ctx.body = {
code: 0,
result,
results
}
})
/**
* 三、 修改 内容 从person数据模型中
* 命令行中输入:curl -d 'name=wy&age=19' http://localhost:3000/users/updatePerson
* 返回:{
"code": 0,
}
*
* 注意: where()和update()方法是model自带的读取数据的方法, 注意:这里直接通过模型 Person 写入 !!!
* where() 找到符合条件的内容
* update() 修改该内容
*/
router.post('/updatePerson', async function (ctx) {
// 找到符合条件的name,并修改其age
const result = await Person.where({
name: ctx.request.body.name
}).update({
age: ctx.request.body.age
})
// 这里没有考虑异常,直接返回了结果
ctx.body = {
code: 0
}
})
/**
* 四、 删除 内容 从person数据模型中
*
* 注意: where()和update()方法是model自带的读取数据的方法, 注意:这里直接通过模型 Person 写入 !!!
* where() 找到符合条件的内容
* remove() 删除该内容
*/
router.post('/removePerson', async function (ctx) {
// 找到符合条件的name,并修改其age
const result = await Person.where({
name: ctx.request.body.name
}).remove()
// 这里没有考虑异常,直接返回了结果
ctx.body = {
code: 0
}
})
module.exports = router
参考
- koa文档: https://koa.bootcss.com/#
- koa参考资料:https://www.jianshu.com/p/6b816c609669
- mongoDB教程: http://www.runoob.com/mongodb/mongodb-tutorial.html
- mongosse中文文档: https://mongoose.shujuwajue.com/