nodejs的web開發框架了解一下

項目地址

歡迎點贊，Fishbone

Fishbone是什麼

輕量級可擴展的敏捷開發Node.js框架,支持ES6/7全新特性,支持Koa、Express中間件,基於koa2。

特性

基於koa2

Fishbone基於著名的Node.js框架koa2進行了封裝。擴展了Koa的功能，可以迅速的進行Web開發。

爲敏捷開發和微服務而生

Fishbone是在Wii團隊1年的Node.js項目開發積累中醞釀誕生的，以提高團隊開發效率、助力敏捷開發爲目的。框架通過公司多個互聯網產品上線、迭代的考驗。

支持靈活的自定義路由

Fishbone採用的模式(module/controller/dao）路由規則之外，還支持用戶定製路由。 在項目中遵循路徑即url配置便可靈活的支持Restful等各類自定義路由。

中間件

支持JWT鑑權、解決跨域、報錯捕捉和請求中的文件解析等中間件。而且開發者能夠自由的定義/編寫中間件。

---

如何使用

建立項目結構

.
├-- server
|   ├-- Controllers     控制器
|   |    ├-- user.js     用戶模塊接口文件
|   |    └-- login.js     登錄模塊接口文件
|   ├-- Dao     數據庫操做層
|   |    ├-- userDao.js         用戶模塊數據庫操做文件
|   |    └-- loginDao.js     登錄模塊數據庫操做文件
|   ├-- Model     表模型
|   |    ├-- mongo     mongodb表模型
|   |    |    └-- user_info.js     模型文件
|   |    ├-- mysql     mysql表模型
|   |    └    └-- user.js     模型文件
|   ├-- Util     工具
|   |    └-- public.js     通用方法
|   └-- Base.js     註冊文件
├-- config.js     數據庫配置、端口配置
├-- start.js     啓動文件
├-- package.json     npm依賴目錄
└-- yarn.lock     yarn依賴目錄

文件說明

入口文件

start.js

const base = require('./server/Base');
const config = require('./config');
const {App} = require('fishbone_c');
const app = new App({config, base});

class start{

    static async run(){

        //鏈接數據庫
        await app.createDb();

        // 啓動服務
        await app.strat();
    }
};

start.run();

此文件爲啓動文件。主要進行了建立數據庫鏈接，註冊控制器和生成表模型。

服務配置文件

config.js

module.exports = {
    db:{
        mysql:{
            dbname: '數據庫名稱',
            username:'帳號',
            password: '密碼',
            tablePrefix:"前綴",
            options:{
                host: "服務器IP",
                port: '端口',
                dialect: '數據庫類型',
                logging: 日誌輸出開關
            }
        },
        mongo:{
            url: "mongodb://帳號:密碼@服務器IP:端口/數據庫名稱",
            tablePrefix:"前綴",
        }
    },
    port: 服務端口,
    secret: 'JWT鑑權密鑰',
    noAuth: [
        /\/user\/login/, 
        不須要鑑權的接口
    ],
}

配置mysql和mongodb的鏈接參數、端口號、JWT鑑權密鑰和不須要鑑權的接口。

安裝項目依賴

npm:

npm install fishbone_c

yarn:

yarn add fishbone_c

啓動服務

在根目錄打開命令窗口，執行命令行

node start.js