koa2從入門到部署全過程(轉載)

来源:https://www.cnblogs.com/wangzisheng/archive/2022/04/20/16170716.html
-Advertisement-
Play Games

本文轉載自https://segmentfault.com/a/1190000019155991 初始化項目 使用 koa-generator 腳手架工具 npm install koa-generator -g #全局安裝 koa2 demo #創建demo項目 cd demo && npm in ...


本文轉載自https://segmentfault.com/a/1190000019155991

初始化項目

使用 koa-generator 腳手架工具

npm install koa-generator -g #全局安裝
koa2 demo #創建demo項目
cd demo && npm install #安裝依賴

預設生成項目結構如下

clipboard.png

修改配置

用腳手架生成的項目，預設是伺服器渲染，即響應的是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 = 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 = 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 = 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 = ctx.request.body
    ctx.body = await Users.create(data)
})

router.put('/:_id', async (ctx, next)=> {
    let _id = ctx.params._id
    let data = 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

結果如下：

clipboard.png

然後可以刪除或重啟：

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

這樣配置上傳效率非常高，一起試試吧！

寫博客能賺錢嗎？如果不賺錢，那這個簽名又有什麼意義！所以大家多多給我發紅包，多多祈禱，祈禱我成為萬元戶，然後普渡眾生！
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 【大話雲原生】負載均衡篇-小飯館客流量變大了
    一、前言 這是《大話雲原生》系列的第二篇，第一篇《煮餃子與docker、kubernetes之間的關係》推出之後受到大家的歡迎，很多朋友聯繫到我給我加油打氣，感謝！我會繼續寫下去！ 書接上回介紹了《煮餃子與docker、kubernetes之間的關係》之後，小娜同學（我老婆）問：為什麼不把服務統一開 ...
  • Python 中刪除列表元素的三種方法
    列表基本上是 Python 中最常用的數據結構之一了，並且刪除操作也是經常使用的。 那到底有哪些方法可以刪除列表中的元素呢？這篇文章就來總結一下。 一共有三種方法，分別是 remove，pop 和 del，下麵來詳細說明。 remove L.remove(value) → None -- remov ...
  • C++基礎-類與對象（1）
    C++類與對象(1) 類的設計：可以把屬性和行為放在不同的許可權下 struct和class區別在於某人的訪問許可權不同 struct:預設共有 class:預設私有 對象的初始化和清理 如果我們不寫，系統會自己給我沒寫 構造函數的語法 類名(){} 沒有返回值，也不寫void 函數名和類型相同 可以有 ...
  • python輸入和輸出
    使用場景 當我們返回給前端所需的對象數據時，大多數情況可以直接使用 StructMap 映射實現自動轉換，但碰到對象中的某些欄位需要從 Integer 類型轉換成對應枚舉的時候，在 StructMap 中就需要單獨對這些欄位添加轉換註解，實現較為麻煩，故整合出了一個通用轉換工具類。 ConverUt ...
  • Python 你不知道的全自動解密解碼神器
    前言 Ciphey 是一個使用自然語言處理和人工智慧的全自動解密/解碼/破解工具。 簡單地來講，你只需要輸入加密文本，它就能給你返回解密文本。就是這麼牛逼。 有了Ciphey，你根本不需要知道你的密文是哪種類型的加密，你只知道它是加密的，那麼Ciphey就能在3秒甚至更短的時間內給 你解密，返回你想 ...
  • IOS – OpenGL ES 設置圖像 lookup 濾鏡 GPUImageLookupFilter
    目錄 一.簡介 二.效果演示 三.源碼下載 四.猜你喜歡 零基礎 OpenGL (ES) 學習路線推薦 : OpenGL (ES) 學習目錄 >> OpenGL ES 基礎 零基礎 OpenGL (ES) 學習路線推薦 : OpenGL (ES) 學習目錄 >> OpenGL ES 轉場 零基礎 O ...
  • 將python腳本打包為exe可執行文件
    在完成一個軟體或者程式的實現之後，最後的一步就是發佈，發佈的目的是為了讓更多的人來使用這個項目，而大部分的人是沒有相應的編程環境的，因此我們必須考慮將代碼編譯成各個平臺的可執行文件，再發佈給用戶去使用。本文主要介紹通過pyinstaller在linux和windows上分別打包python腳本為可執... ...
  • python中類的導入類
    在上篇“python中的類的創建、使用和繼承”中，創建了Person()和Student()兩個類，最後才是程式執行主體，如下： class Person(): #創建一個person類，父類必須包含在當前文件中，且位於子類前面。 def __init__(self, name, age,homet ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類