koa大型web項(xiàng)目中使用路由裝飾器的方法示例
一、關(guān)于重復(fù)造輪子解釋下
在npmjs上搜索關(guān)于koa路由裝飾器的已經(jīng)有那么幾個(gè)包了,但是我從幾個(gè)包中發(fā)現(xiàn)作者的思維僅僅限制于前端開(kāi)發(fā)的思想,項(xiàng)目分層不明確,我們開(kāi)發(fā)kow-web項(xiàng)目可以根據(jù)java-web中項(xiàng)目分層的思想來(lái)寫(xiě)項(xiàng)目,項(xiàng)目結(jié)構(gòu)清晰明了,本人封裝這個(gè)包也是參考了java-web開(kāi)發(fā)過(guò)程中把項(xiàng)目分為四層架構(gòu)。
1、controllers:路由的控制
2、servers:常用于一些業(yè)務(wù)邏輯的判斷
3、dao:操作數(shù)據(jù)庫(kù)的
4、models:關(guān)于建表的數(shù)據(jù)模型
二、關(guān)于koa2-router-decors包的使用步驟
1、構(gòu)建一個(gè)項(xiàng)目,并創(chuàng)建分層目錄
2、安裝
npm install koa2-router-decors // or yarn add koa2-router-decors
3、在中間件中使用我們安裝的包
import { resolve } from 'path';
import Route from 'koa2-router-decors';
// 可以寫(xiě)到config中統(tǒng)一配置
const API_VERSION = '/api/v1';
/**
* @Description: 反轉(zhuǎn)路徑的方法
* @param {String}
* @return:
*/
const dir = path => resolve(__dirname, path);
/**
* @Description: 路由中間件讀取controllers中的裝飾器配置
* @param {type}
* @return:
*/
export default (app) => {
// 這個(gè)地方是要讀取的文件夾目錄
const apiPath = dir('../controllers/*');
// 實(shí)例化類(lèi)并調(diào)用方法
const route = new Route(app, apiPath, API_VERSION);
route.init();
};
4、使用中間件
5、在controllers的文件夾中使用裝飾器
@controller('/user')
export class UserController extends BaseController {
constructor() {
super();
}
/**
*
* @api {post} /api/v1/user/create/ 添加用戶(hù)
* @apiDescription 創(chuàng)建用戶(hù)的接口
* @apiName createUser
* @apiGroup users
* @apiVersion 0.1.0
* @apiParam {string} username="張三" 用戶(hù)名
* @apiParam {string} mobile 手機(jī)號(hào)碼
* @apiParam {string} email 郵箱
* @apiParam {string} password 密碼
*/
@post('/create')
@required({ body: ['username', 'mobile', 'password'] })
async createUser(ctx) {
const result = await UserServer.createUser(ctx.request.body);
ctx.success(result);
}
....
}
6、具體代碼可以參考example中寫(xiě)的
三、關(guān)于example代碼跑起來(lái)的說(shuō)明
1、使用的是mysql
2、mysql建表sql
CREATE TABLE `user` ( `id` int(11) NOT NULL AUTO_INCREMENT, `username` varchar(30) NOT NULL, `mobile` varchar(11) DEFAULT NULL, `email` varchar(20) DEFAULT NULL, `password` varchar(255) NOT NULL, `created_at` datetime DEFAULT CURRENT_TIMESTAMP, `updated_at` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, PRIMARY KEY (`id`) ) ENGINE=InnoDB AUTO_INCREMENT=12 DEFAULT CHARSET=utf8
3、在example的根目錄下創(chuàng)建一個(gè).env的文件
DB_HOST=數(shù)據(jù)庫(kù)地址 DB_USERNAME=數(shù)據(jù)庫(kù)連接名 DB_PASSWORD=數(shù)據(jù)庫(kù)連接密碼 DB_DATABASE=數(shù)據(jù)庫(kù)名
四、源碼地址,歡迎小伙伴提出問(wèn)題，方便點(diǎn)贊一個(gè)
以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
這篇文章主要介紹了在 Node.js 中使用原生 ES 模塊方法解析，還有部分內(nèi)容的鏈接，下面我們就來(lái)一起看看吧，需要的朋友可以參考下。2017-09-09
這篇文章主要介紹了使用npm發(fā)布Node.JS程序包教程,本文講解了配置package.json、注冊(cè)npm帳號(hào)、發(fā)布程序包等內(nèi)容,需要的朋友可以參考下2015-03-03
文章從nodejs環(huán)境安裝、文件結(jié)構(gòu)、路由做了詳細(xì)介紹，然后結(jié)合mongodb制作注冊(cè)功能也做了細(xì)致的講述，是篇非常不錯(cuò)的文章，這里推薦給大家2014-11-11
Node.js如何快速導(dǎo)出多表頭的excel文件實(shí)現(xiàn)方法
這篇文章主要為大家介紹了Node.js如何快速導(dǎo)出多表頭的excel文件實(shí)現(xiàn)方法詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2023-06-06
node文件資源管理器的解壓縮從零實(shí)現(xiàn)
這篇文章主要為大家介紹了node文件資源管理器的解壓縮從零實(shí)現(xiàn)示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-12-12
簡(jiǎn)單的說(shuō)Node.js就是運(yùn)行在服務(wù)端的JavaScript。Node.js是一個(gè)基于Chrome JavaScript運(yùn)行時(shí)建立的一個(gè)平臺(tái)。Node.js是一個(gè)事件驅(qū)動(dòng)I/O服務(wù)端JavaScript環(huán)境，基于Google的V8引擎，V8引擎執(zhí)行Javascript的速度非?？欤阅芊浅：?/div> 2021-06-06
這篇文章主要給大家介紹了在Node.js中用D3.js的方法，文中分別介紹了如何安裝模塊和一小段簡(jiǎn)單的示例代碼，有需要的朋友可以參考借鑒，下面來(lái)一起看看吧。2017-01-01
這篇文章主要介紹了修改NPM全局模式的默認(rèn)安裝路徑的方法，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-12-12
Nestjs自定義注解實(shí)現(xiàn)接口權(quán)限控制詳解
這篇文章主要為大家介紹了Nestjs自定義注解實(shí)現(xiàn)接口權(quán)限控制詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-12-12
node鏈接mongodb數(shù)據(jù)庫(kù)的方法詳解【阿里云服務(wù)器環(huán)境ubuntu】
這篇文章主要介紹了node鏈接mongodb數(shù)據(jù)庫(kù)的方法,結(jié)合實(shí)例形式分析了nodejs基于阿里云服務(wù)器環(huán)境ubuntu下實(shí)現(xiàn)連接MongoDB數(shù)據(jù)庫(kù)的相關(guān)操作技巧,需要的朋友可以參考下2019-03-03最新評(píng)論