基于前后端分離使用框架 express 4.X 、數(shù)據(jù)庫(kù) Mysql 、 MVC模式 、 Swagger 、 RESTful規(guī)范、Webpack實(shí)現(xiàn)API接口的Node服務(wù)器

前言

Node單線程、異步非阻塞I/O模型、V8引擎等特性在現(xiàn)代互聯(lián)網(wǎng)性能優(yōu)越,且是基于JavaScript即能實(shí)現(xiàn)服務(wù)端;

Node越來(lái)越備受關(guān)注,所以基于前后端分離使用框架 express 4.X 、數(shù)據(jù)庫(kù) Mysql 、 MVC模式 、 Swagger 、 RESTful規(guī)范實(shí)現(xiàn)API接口

具體項(xiàng)目:https://github.com/devin-huang/RESTful_API,喜歡的可以給星支持

項(xiàng)目結(jié)構(gòu):
|- build                           webapck
|- config                          數(shù)據(jù)庫(kù)配置與連接
|- log                             日志配置與記錄
|- /src                            
  |- controller                    MVC中的C層
  |- model                         MVC中的M層
  |- routes                        路由文件
  |- uploadFiles                   上傳文件夾
  |- utils                         工具
    |- jwt                         jwt驗(yàn)證
    |- redis                       redis內(nèi)存數(shù)據(jù)庫(kù)
    |- postSetting.js              post請(qǐng)求的依賴
|- index.js                        主要運(yùn)行文件
|- swagger                         swagger配置
|- package.json                    項(xiàng)目依賴

MVC模式

基于前后端而設(shè)計(jì)開(kāi)發(fā)返回?cái)?shù)據(jù),所以View層直接用route替代。運(yùn)行主文件 index.js會(huì)依次執(zhí)行routes -> controller -> model 獲取數(shù)據(jù)

API調(diào)試

下載: chrome 網(wǎng)上應(yīng)用店搜索 Postman

使用:通過(guò)該插件調(diào)試 POST/PUT/DELETE/UPLOAD 請(qǐng)求

MySql

window安裝Mysql

  1. Mysql官方下載

  2. (Mysql使用教程)[http://www.runoob.com/mysql/mysql-install.html]

  3. 使用Intelli IDEA 設(shè)置可視化Mysql

Json Web Token(JWT)用戶驗(yàn)證

原理

主要使用密鑰+用戶信息(非密碼)來(lái)驗(yàn)證雙方 (該項(xiàng)目密碼:1.MD5加密 2.MD5_SUFFIX添加后綴)

參考文檔: http://www.itdecent.cn/p/180a870a308a

作用:通過(guò) URL, POST 參數(shù)或者在 HTTP header 通信雙方之間以 JSON 對(duì)象的形式安全傳遞信息的方法, 這種通信屬于明文通信請(qǐng)別把密碼也寫(xiě)入,一般用于Token驗(yàn)證

image

jsonwebtoken 創(chuàng)建jwt對(duì)象 (圖中步驟2)

express-jwt 驗(yàn)證jwt對(duì)象 (圖中步驟5)

log(日志)

主要使用 morgan 完成日志記錄,而 file-stream-rotator 則用于按照日期區(qū)分文件保存日志記錄

Swagger

express 里接入 swagger 需要兩個(gè)包 swagger-jsdocswagger-ui-express ,前者將 jsdoc 格式的注釋轉(zhuǎn)化為 swagger 類(lèi)型的 json,后者使用這個(gè) json 生產(chǎn)對(duì)應(yīng)的 swagger 頁(yè)面.接入成功之后我們給接口寫(xiě)的 jsdoc 注釋就會(huì)自動(dòng)生成為 swagger 文檔頁(yè)面使用/api-docs 查看效果

swagger/config.js 基本配置需要注意使用:swagger: '2.0'

swagger/swaggerDoc.js jsdoc全局配置

src/routes jsdoc單獨(dú)配置

目前沒(méi)有找到JAVA的接口函數(shù)自動(dòng)更新方式,有了解的小伙伴可以分享下
使用swagger需要token時(shí)webpack環(huán)境變量設(shè)置開(kāi)發(fā)環(huán)境無(wú)需驗(yàn)證token即可

redis (內(nèi)存數(shù)據(jù)庫(kù))

作用: 多次請(qǐng)求數(shù)據(jù)庫(kù)造成性能開(kāi)銷(xiāo),如果存儲(chǔ)到服務(wù)端 Session 消耗內(nèi)存且會(huì)被清空; 而 redis (內(nèi)存數(shù)據(jù)庫(kù))就是在不訪問(wèn)數(shù)據(jù)庫(kù)的基礎(chǔ)上獲取數(shù)據(jù)(可以設(shè)置過(guò)期時(shí)間)

Express 使用 redis

參考文檔: https://github.com/NodeRedis/node_redis

具體參考: src/utils/redis

windows 安裝 redis

redis官網(wǎng)僅是linux安裝教程,window須在github下載zip后綴文件 https://github.com/microsoftarchive/redis/tags

安裝

解壓并使用管理員身份啟動(dòng)CMD在解壓后的redis根目錄 redis-server.exe redis.windows.conf 安裝 Redis 并啟動(dòng)

啟動(dòng)

雖已啟動(dòng) redis,但是只要關(guān)閉CMD窗口即停止redis。所以要把redis設(shè)置成windows下的服務(wù),在初始啟動(dòng)后會(huì)一直運(yùn)行

redis-server --service-install redis.windows.conf

測(cè)試

我的電腦 》 管理 》 服務(wù)于應(yīng)用程序 》 服務(wù) 》 redis (如果禁用啟動(dòng)為手動(dòng))

工具

安裝 RedisDesktopManager 可視化工具

設(shè)置密碼 (默認(rèn)密碼為空)

  1. 根目錄啟動(dòng) redis-cli.exe

  2. 查看當(dāng)前密碼 config get requirepass

  3. 設(shè)置密碼

- redis.windows.conf 和 redis.windows-service.conf 兩個(gè)配置文件。
- 在配置文件中找到 # requirepass foobared 并在下方填入密碼

- for example:
# requirepass foobared
requirepass 123

- 重啟 Redis 生效

- CMD 到 Redis 的安裝路徑
- 輸入指令:redis-cli.exe -h 127.0.0.1 -p 6379 -a 123
-h: 是指地址 127.0.0.1 指的是本地,如果是遠(yuǎn)程的就寫(xiě)遠(yuǎn)程的地址
-p: 這邊是端口號(hào),具體看個(gè)人的配置 redis.windows.conf 里面的,默認(rèn)是 6379
-a: 密碼和 -p 一樣,沒(méi)設(shè)置就不用寫(xiě) -a
- 成功則彈出:requirepass 123

webapck

參考 Express + Webapck 、 package.json

node *.js 提示 Unexpected token import錯(cuò)誤: Node 8.* 基于commonJS規(guī)范無(wú)法識(shí)別ES6 import/export,利用webpack/babel將其轉(zhuǎn)化為commonJS規(guī)范,對(duì)打包生產(chǎn)項(xiàng)目使用 node *.js 啟動(dòng)

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

友情鏈接更多精彩內(nèi)容