@chanson/node-server

Node.js MVC Framework

Usage no npm install needed!

<script type="module">
  import chansonNodeServer from 'https://cdn.skypack.dev/@chanson/node-server';
</script>

README

Node.js 后端 MVC 框架

简介

  • 本项目的地址：https://gitee.com/sh-chanson/node-server.git
  • 基于 Adonis.js 框架，其官方文档地址：https://adonisjs.com/docs/4.1/folder-structure
  • 实际项目一般采用前后端分离开发，View 交给前端处理， 本框架的结构：Router->Controllers->Services->Models
  • models 层使用 query builder，基于 knex，容易上手
  • 本框架可以作为纯后端，提供 api 给前端调用。也可以作为全栈框架直接渲染 html 输出到前端

须具备知识

  • node.js（最好用过类似 express、koa、egg.js 等框架）
  • 熟悉 MVC 知识
  • 熟悉 es6 语法
  • 熟悉 sql 语法

准备工作

  • 安装 node.js（v12 以上版本）https://nodejs.org/en/
安装常用全局包

（windows 下无需 sudo 这 4 个字母）

  • 源管理器 sudo npm i -g nrm
  • 切换国内源 sudo nrm use taobao
  • adonis 必须的全局包 sudo npm i -g @adonisjs/cli
  • 其他全局包 sudo npm i -g live-server

项目安装

git clone 项目后，在根目录下：
  1. 安装项目的依赖
sudo npm i
  1. 首次运行项目时
npm run new
  1. 记得把.env 文件复制到项目根目录下
  • 找管理员要.env 配置文件
  1. 启动项目（开发环境）
npm run dev

项目结构说明

  • /start/routes.js：此文件用来处理路由，并绑定相应的 Controller
  • /app/Controllers/Http/PC/xxx.js：所有 Controller 文件都放在这里
  • /app/Services/xxx.js：所有 Services 文件都放在这里，且都继承于 BaseService 基类
  • /app/Models/Table/xxx.js：所有的表文件都放在这里，文件名应跟数据库上真实表文件名相同，且都继承于 BaseTable 基类
  • /config/xxx.js：可以对不同模块分别进行配置（一般按默认配置即可）
  • /.env：项目根目录下应该有此文件，用来设置全局配置信息。（重要）
  • /app/Lib/Util.js：常用工具库，包含对数组、对象、字符串、时间等处理的函数
  • /app/Lib/Request.js：基于 axios.js 的 HTTP 库，用于 get、post 方式访问 url
  • /resources/views/html/ : 存放 html 静态文件模板

代码规范

  • 默认 IDE 为 vscode，使用 settings sync 插件同步设置
  • 使用 eslint、prettier 规范代码格式
  • api 接口的 method：全部使用 post，只有下载之类的接口使用 get。比如： Route.get('download/:type/:file', 'PC/DownloadController.download') Route.post('entity/edit', 'PC/EntityController.edit') Route.post('entity/get-table', 'PC/EntityController.getTable') Route.post('entity/get-table-common', 'PC/EntityController.getTableCommon')
  • 类的名称用大驼峰：比如 UserController
  • 函数名称用小驼峰：比如 getUserInfo()
  • url 用连字符：比如 get-user-info
  • 变量、json 里的 key 用下划线：比如 let user_info = { user_name: 'xxx' }

页面-接口约定

  • 常见的页面分为列表页（比如文章列表、用户列表）和详情页（比如文章编辑页、用户信息编辑页）
  • 列表页一般都有 2 个接口，一个是公共接口，比如 get-table-common（返回页面上的一些公共信息），一个是 get-table（返回表格数据）
  • 详情页一般都有 2 个接口，一个是公共接口 get-edit-common（返回页面上的一些公共信息），一个是提交接口，比如 edit、create 等

常用操作

  • 熟悉 Util.js 里的函数，有需求时优先使用里面的函数，而不是另外写一个

  • 获取前端 get 和 post 方法传递过来的参数

    ctx.request.all()

  • session 的操作

    ctx.session.get('user')
ctx.session.put('user', {name:'xxx'})

  • redis 的操作

    await Redis.get(key)//返回字符串
await Redis.set(key, JSON.stringify(data))//对象要先转成字符串
await Redis.expire(key, 40000)//有效期

  • 每个函数正常结束时调用。用途：规范函数的返回值，使得返回值具有相同的数据结构

    Util.end({})

  • 每个函数内部抛出异常时，在 catch 里调用本函数，使得返回值具有相同的数据结构

    Util.error({})

  • Controller 里的函数正常结束时调用。规范要返回给前端的数据结构

    Util.end2front({})

  • Controller 里的函数内部抛出异常时，在 catch 里调用本函数，规范要返回给前端的数据结构

    Util.error2front({})

  • 对返回前端的 id(数字型) 进行加解密，用于某些不希望前端直接看到内容的场景，比如 user_id

    Util.encode(int)
Util.decode(str)

  • 打印信息到控制台

    log.debug('调试时建议用这个')
log.info('普通信息')
log.error('错误信息')

常用快捷操作

（根目录/.vscode/nodejs.code-snippets）请熟悉这个文件里的。自定义了一些代码片段，比如输入 func，vscode 就会智能提示 funcController... 按下 tab 键，就会把 controller 下的函数结构补全

  • func： funcController（创建一个 Controller 里的函数）、funcService（创建一个 Service 里的函数）、funcTable（创建一个 Table 里的函数）
  • require： requireService（引用一个 Service 文件）、requireTable
  • trans： 补全事务语法
  • template： templateTable（补全 table 类的模板）

常见问题

  • 运行失败？
  • 根目录下是否有.env 文件，没有找管理员要
  • 端口被占用