通用nodejs开发架构
文章目录
一、整体架构

以nodejs项目为例(非前后端分离),分层结构设计,分层说的就是将要做的事抽象出来,分成相互联系的几部分,反应在项目中就是文件结构。
上图将项目分为view、router、controller、cache、service、db几部分,其中:(以下均为同名文件夹)
- view
view使用ejs模板,相当于ssr服务端渲染;
包含一个组件文件夹、多个业务界面;
注:
除了正常业务的界面,通常会有个error和404界面;
还会将公共组件放在view/layout下,供ejs引用; - router
router分为view、api、校验;view路由负责加载ejs,作为页面导航;api路由实际就是接口,作数据渲染;
校验即是参数校验,涉及到复用,将检验处理为一个中间件引入;
包含一个路由文件夹、一个接口文件夹; - controller
主要是包含routerapi接口中涉及到的业务逻辑;
包含多个业务文件; - service
从controller过来的需要调用数据,访问数据库的部分逻辑;
包含多个业务文件; - db
包括数据库的配置,表的数据模型等内容;
每次更新数据模型,都需要执行一次同步文件执行同步;
需要包含一个配置文件、一个执行同步的文件、一个表模型文件夹; - cache
一般采用redis作为缓存库,包括redis的配置、get/set定义和业务文件;
需要包含一个配置文件、多个业务文件;
二、技术选型
重点说连接数据库、缓存库部分:
- view、router
view这里采用ejs模板,如果是前后端分离,前端采用框架的话,这个view层就单独为前端vue/react项目了,同样的,router也不需要view层的路由了;ejs配合koa-view指定.ejs文件路径,可在页面路由中使用ctx.render渲染; - db
连接数据库,不同数据库有不同的orm可供操作:
关系型数据库mysql可以使用sequelize来连接数据库,还可以搭配sequelize-auto自动生成表模型model;
非关系型数据库mongodb可以使用mongoose来连接数据库; - 单元测试
使用jest断言
三、规范
这里规范包括团队协作、代码风格、编码习惯,业务等
git commit
主要type feat:增加新功能 fix:修复bug 特殊type docs:只改动了文档相关的内容 style:不影响代码含义的改动,例如去掉空格、改变缩进、增删分号 build:构造工具的或者外部依赖的改动,例如webpack,npm refactor:代码重构时使用 revert:执行git revert打印的messagegit brach
master:主分支,用于部署生产环境的分支,确保master分支稳定性,一般由develop以及hotfix分支合并,任何时间都不能直接修改代码 develop:开发分支,始终保持最新完成以及bug修复后的代码 feature:开发新功能时,以develop为基础创建feature分支 release:预上线分支,发布提测阶段,会release分支代码为基准提测 hotfix:修复分支,线上出现紧急问题时,需要及时修复,以master分支为基线,创建hotfix分支,修复完成后,需要合并到master分支和develop分支当有一组
feature开发完成,首先会合并到develop分支,进入提测时,会创建release分支。
如果测试过程中若存在bug需要修复,则直接由开发者在release分支修复并提交。
当测试完成之后,合并release分支到master和develop分支,此时master为最新代码,用作上线。- eslint
通过.eslintrc.json文件配置相关格式化要求 - 编码方面
将常量集中到config下,以引入的方式来获取,包括mysql配置,redis等数据库配置,服务器地址,加密秘钥等公共常量;
定义数据模型,将接口返回值的格式及内容定义到model中(非db中的model,与db同一级),保持输出统一,方便修改;
将常用的方法定义为工具类,放到utils下统一管理;
一般文件名首字母大写意为输出为类class; - 注释
使用jsdoc,每页文件注明描述description、作者author,方法注明作用、参数类型和描述、返回类型和描述;
四、细节
- 登录
登录可以采用session或jwt;session使用koa-generic-session来配置,可以配置存储位置store为redisStore,然后注册在app.js,就可在全局使用ctx.session来获取了;
密码加密可采用crypto,或者使用bcrypt; - 中间件
参数校验可作为一个中间件,引入ajv对传入参数进行校验,将验证代码抽离到middleware中,之后再引入到router;
对登录验证也需要加入到中间件中,如果没登录访问路由,跳转登录页,没登录访问接口,返回未登录的信息; - 单元测试
使用supertest模块可模拟请求,测试接口; - 安全
使用xss模块,在controller中对输入内容进行xss过滤;
边遇到边补充 ......
评论
登录后参与技术讨论,分享你的经验与见解。
登录 / 注册暂无评论