通用nodejs开发架构

一、整体架构

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
    主要是包含 router api 接口中涉及到的业务逻辑;
    包含多个业务文件;
  • 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打印的message
  • git 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 过滤;

边遇到边补充 ......

评论

暂无评论