Huajs-node NPM

介绍

huajs-node 是一个基于 ES6，使用 TypeScript 编写的 nodejs 服务端框架

内核为 fastify.js，数据库连接为 knex.js

安装教程

创建项目文件夹
参考源码中的test文件夹，创建config、controller、domain、service、model文件夹，以及index.ts
npm install huajs-node --save
npm run tsc // 将ts文件编译为js文件
npm run start // 启动框架

框架解释

任何在controller内存在的后缀为Action的函数都会对外暴露
domain为逻辑层，目录结构与controller层完全一致，在controller中，能且只能执行对应的domain层方法
controller中只做简单的数据校验，复杂逻辑交给domain层来处理
在domain层中，可以执行任意目录的service层和model层方法
service是服务层，一般用来存放公共方法
model为模型层，能且只能执行数据库方法

框架目录

├── README.md                            // readme
├── package.js                           // 版本管理
├── tsconfig.js                          // TypeScript 控制
├── src                                  // 代码目录
│   ├── lib                              // 框架源代码
│   │   ├── config                       // 配置目录
│   │   │   ├── adapter.ts               // 配置
│   │   │   └── config.ts                // 配置信息
│   │   ├── core                         // 代码目录
│   │   │   ├── layer                    // 层
│   │   │   │   ├── base.ts              // 层级 基础继承
│   │   │   │   ├── controller.ts        // 控制层实现
│   │   │   │   ├── domain.ts            // 逻辑层实现 ( domain 领域驱动开发 )
│   │   │   │   ├── model.ts             // 模型层实现
│   │   │   │   └── service.ts           // 服务层实现
│   │   │   └── methods                  // 方法
│   │   │   │   ├── hook.ts              // 钩子
│   │   │   │   └── router.ts            // 配置路由信息
│   │   ├── extend                       // 框架继承目录
│   │   │   ├── helper.ts                // 继承基础方法
│   │   │   ├── hua-cache.ts             // 继承缓存
│   │   │   ├── hua-mysql.ts             // 继承数据库
│   │   │   └── hua-rabbitmq.ts          // 继承延时队列
│   │   ├── application.ts               // 框架继承入口
│   │   └── hua.ts                       // 框架启动入口
│   └── test                             // 单元测试代码

如上，由框架约定的目录： 1. dist文件夹为ts编译成的js文件，框架在此目录内执行 2. src文件夹为ts文件，编写功能的目录，如要修改请在此文件夹内修改 3. src/lib 是框架代码目录，不建议直接修改 4. src/test 是单元测试目录，可在此文件夹内测试框架各项功能 5. src/test/config 配置文件目录 (可选) 6. src/test/index 入口文件，必须使用 new Application().start() 来启动框架