本文轉載自https://segmentfault.com/a/1190000019155991
初始化專案
使用 koa-generator 腳手架工具
npm install koa-generator -g #全域安裝
koa2 demo #創建demo專案
cd demo && npm install #安裝依賴
默認生成專案結構如下
修改配置
用腳手架生成的專案，默認是服務器渲染，即回應的是html視圖，而我們要開發介面，回應的是json資料，所以要洗掉渲染視圖的代碼，增加回應json的配置，
首先洗掉views檔案夾，接下來就是修改 app.js
1. 洗掉視圖配置
以下是要洗掉的代碼
const views = require('koa-views')
app.use(views(__dirname + '/views', {
extension: 'pug'
}))
2. 修改路由的注冊方式，通過遍歷routes檔案夾讀取檔案
const fs = require('fs')
fs.readdirSync('./routes').forEach(route=> {
let api = require(`./routes/${route}`)
app.use(api.routes(), api.allowedMethods())
})
3. 添加jwt認證，同時過濾不需要認證的路由，如獲取token
const jwt = require('koa-jwt')
app.use(jwt({ secret: 'yourstr' }).unless({
path: [
/^\/$/, /\/token/, /\/wechat/,
{ url: /\/papers/, methods: ['GET'] }
]
}));
4. 全域錯誤捕獲并回應
// error
app.use(async (ctx, next) => {
try {
await next()
} catch(err) {
ctx.status = err.statusCode || err.status || 500;
ctx.body = err.message
ctx.app.emit('error', err, ctx);
}
})
5. 跨域處理
當介面發布到線上，前端通過ajax請求時，會報跨域的錯誤，koa2使用koa2-cors這個庫非常方便的實作了跨域配置，使用起來也很簡單
const cors = require('koa2-cors');
app.use(cors());
連接資料庫
我們使用mongodb資料庫，在koa2中使用mongoose這個庫來管理整個資料庫的操作，
1. 創建組態檔
根目錄下新建config檔案夾，新建mongo.js
// config/mongo.js
const mongoose = require('mongoose').set('debug', true);
const options = {
autoReconnect: true
}
// username 資料庫用戶名
// password 資料庫密碼
// localhost 資料庫ip
// dbname 資料庫名稱
const url = 'mongodb://username:password@localhost:27017/dbname'
module.exports = {
connect: ()=> {
mongoose.connect(url,options)
let db = mongoose.connection
db.on('error', console.error.bind(console, '連接錯誤:'));
db.once('open', ()=> {
console.log('mongodb connect suucess');
})
}
}
然后在app.js中引入
const mongoConf = require('./config/mongo');
mongoConf.connect();
連接資料庫完成！
2. Schema 和 Model
mongoose有兩個核心概念，Schema和Model，Schema是預先定義的資料庫模型骨架，定義集合存盤的資料結構；Model是依據Schema構造生成的模型，有資料庫操作的能力，
下面是案例，新建一個用戶集合：
根目錄下新建models檔案夾，新建users.js
const mongoose = require('mongoose');
mongoose.Promise = global.Promise;
const Schema = mongoose.Schema
const ObjectId = mongoose.Types.ObjectId
// Schema
const usersSchema = new Schema({
_id: { type: ObjectId }, // 默認生成，不加也可以
username: { type: String, required: [true,'username不能為空'] },
sex: { type: String, enum: ['man','woman'], required: [true,'sex不能為空'] },
age: { type: Number required: [true,'age不能為空'] },
avatar: { type: String, default: '' }
})
// Model
const users = mongoose.model('users',usersSchema);
module.exports = users;
這樣，一個用戶集合的model就建好了，接下來在路由中直接引入這個model，就可以進行資料庫操作了
注冊路由
按照app.js的配置，routes檔案夾下每一個檔案都要注冊成為一個路由
1. 基本結構
一個基本的, RESTful風格的用戶增查改刪介面路由檔案如下，包含了增查改刪的通用寫法
const router = require('koa-router')()
router.prefix('/users')
router.get('/', function (ctx, next) {
ctx.body = '獲取所有用戶'
})
router.get('/:id', function (ctx, next) {
let id = ctx.params.id
ctx.body = '獲取單個用戶'
})
router.post('/', function (ctx, next) {
let data = https://www.cnblogs.com/wangzisheng/archive/2022/04/20/ctx.request.body
ctx.body = '新增用戶'
})
router.put('/:id', function (ctx, next) {
let id = ctx.params.id
ctx.body = '修改用戶資訊'
})
router.delete('/:id', function (ctx, next) {
let id = ctx.params.id
ctx.body = '洗掉用戶'
})
module.exports = router
2. 請求引數驗證
任何一次請求介面傳來的引數，首先要在最前面做一次引數驗證，如果請求引數不合法，那么直接回傳錯誤資訊，無需繼續走下面的業務邏輯，
引數驗證，推薦使用 Joi 這個庫，它是 hapijs 內置的引數驗證模塊，也是使用Schema定義資料結構，
比如創建用戶介面，對用戶傳來的資料進行驗證
const Joi = require('joi')
router.post('/', function (ctx, next) {
let data = https://www.cnblogs.com/wangzisheng/archive/2022/04/20/ctx.request.body
let schema = Joi.object().keys({
username: Joi.string().required(),
sex: Joi.string().required(),
age: Joi.number().required()
})
let result = Joi.validate(data, schema);
if(result.error) {
return ctx.body = result.error.details
}
let reqdata = https://www.cnblogs.com/wangzisheng/archive/2022/04/20/result.value; #經過驗證后的資料
})
這樣就完成了一個簡單的驗證，具體驗證請看joi檔案
3. 資料庫操作
之前已經創建了users的model，現在我們可以直接在路由檔案中使用該模塊，進行資料庫操作
// 引入上一步創建的model
const Users = require('../models/users');
router.get('/', async (ctx, next)=> {
ctx.body = await Users.find()
})
router.get('/:_id', async (ctx, next)=> {
let _id = ctx.params._id
ctx.body = await Users.findOne({_id})
})
// 創建用戶
router.post('/', async (ctx, next)=> {
let data = https://www.cnblogs.com/wangzisheng/archive/2022/04/20/ctx.request.body
ctx.body = await Users.create(data)
})
router.put('/:_id', async (ctx, next)=> {
let _id = ctx.params._id
let data = https://www.cnblogs.com/wangzisheng/archive/2022/04/20/ctx.request.body
ctx.body = await Users.update({_id}, { $set: data }, {
runValidators: true
})
})
router.delete('/:_id', async (ctx, next)=> {
let _id = ctx.params._id
ctx.body = await Users.deleteOne({_id})
})
這是基本的增查改刪的操作，這里用到了koa2最大的亮點，就是async，await異步處理方案，只要await 后面回傳的是 promise，就可以直接使用，這比在 express 框架上使用 then 方法處理要優雅的多的多，
上一步講的請求引數驗證，是第一層驗證，其實在model操作中，資料進入資料庫時，也會進行一層驗證，就是mongoose的Schema定義的資料型別和欄位，如果不匹配，則會拒絕寫入并回傳錯誤，這就是mongoose的好處之一，可以防止寫入不規范的資料，
這里不做mongoose的詳解，附上檔案地址：mongoose
運行與部署
1. pm2
應用啟動檔案是 www/bin，所以我們可以通過 node www/bin 開啟動應用，默認是9000埠，
這樣啟動會有一個問題，就是在修改代碼之后，程式不會自動運行最新的代碼，需要手動斷開重新啟動，
pm2的誕生就是用來解決這個問題，他是一個nodejs應用程式管理器，通過pm2啟動nodejs應用，開啟監聽模式，它就可以自動監聽檔案變化重啟應用，
當然pm2的作用還有很多，首先啟動應用：
pm2 start --name koa2 bin/www --watch
結果如下：
然后可以洗掉或重啟：
pm2 list # 查看行程串列
pm2 restart koa2 # 重啟名稱為koa2的應用
pm2 delete koa2 # 洗掉名稱為koa2的行程
pm2 logs koa2 # 查看名稱為koa2的行程日志
2. nginx配置
koa2應用在linux服務端部署，首先需要pm2來啟動應用，但是koa2專案啟動一般不使用80埠，所以在線上部署時，還需要nginx做反向代理以及域名配置，
配置如下：
server {
listen 80;
server_name api.xxxxx.com;
location / {
proxy_pass http://127.0.0.1:9000;
#兼容scoket.io
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header Host $host;
}
}
這樣訪問 api.xxxxx.com 就能訪問koa2的應用了！
如果是https，需要修改下配置：
server {
listen 80;
server_name api.xxxxx.com;
rewrite ^(.*) https://$host$1 permanent;
}
server {
listen 443 ssl;
server_name api.ruidoc.com;
ssl on;
ssl_certificate 1_api.xxxxx.com_bundle.crt; #ssl證書
ssl_certificate_key 2_api.xxxxx.com.key;
location / {
proxy_pass http://127.0.0.1:9000;
#兼容scoket.io
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header Host $host;
}
}
此時你可以上傳你的應用了！
3. 快速上傳原始碼
一般上傳原始碼的時候，可能會用ftp服務之類的，如果是Mac用戶，那么可以配置一條快捷命令，直接上傳，方便省事
rsync -avz ./* root@1.23.45.67:/home/api
root 是服務器用戶名；
1.23.45.67 是服務器IP地址；
/home/api 是原始碼在服務器的存放路徑
然后輸入服務器密碼，就可以快速上傳了，而且只會上傳修改過的原始碼，非常快速，
還可以將命令配置到package.json檔案的scripts下，如
"scripts": {
"upload": "rsync -avz ./* [email protected]:/home/api"
}
此時你可以這樣上傳：
npm run upload
這樣配置上傳效率非常高，一起試試吧！
寫博客能賺錢嗎？如果不賺錢，那這個簽名又有什么意義！所以大家多多給我發紅包，多多祈禱，祈禱我成為萬元戶，然后普渡眾生！轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/459526.html
標籤：其他
上一篇：GPUImage – 像素色值亮度平均(漫畫效果) GPUImageAverageLuminanceThresholdFilter
下一篇：python中類的匯入類