ThinkJS 开源项目教程

ThinkJS 开源项目教程

think-awesomeA curated list of awesome things related to ThinkJS 3.x项目地址:https://gitcode.com/gh_mirrors/th/think-awesome

1. 项目的目录结构及介绍

ThinkJS 项目的目录结构通常如下：

think-awesome/
├── src/
│   ├── controller/
│   ├── model/
│   ├── service/
│   ├── config/
│   ├── middleware/
│   ├── logic/
│   └── router.js
├── view/
├── public/
├── package.json
└── thinkjs.js

目录介绍

• src/：项目的源代码目录，包含主要的业务逻辑。
  • controller/：控制器文件，处理请求和响应。
  • model/：模型文件，处理数据逻辑。
  • service/：服务文件，处理复杂的业务逻辑。
  • config/：配置文件，包含项目的各种配置。
  • middleware/：中间件文件，处理请求的中间处理逻辑。
  • logic/：逻辑文件，处理业务逻辑的中间层。
  • router.js：路由配置文件，定义URL和控制器的映射关系。
• view/：视图文件，包含前端模板文件。
• public/：静态资源文件，如图片、CSS、JavaScript等。
• package.json：项目的依赖管理文件。
• thinkjs.js：项目的启动文件。

2. 项目的启动文件介绍

ThinkJS 项目的启动文件通常是 thinkjs.js，其主要作用是启动应用并加载必要的配置和中间件。

启动文件示例

const Application = require('thinkjs');
const path = require('path');

const instance = new Application({
  ROOT_PATH: __dirname,
  APP_PATH: path.join(__dirname, 'src'),
  proxy: true, // use proxy
  env: 'development'
});

instance.run();

启动文件介绍

• Application：ThinkJS 应用的实例。
• ROOT_PATH：项目的根目录。
• APP_PATH：应用的源代码目录。
• proxy：是否使用代理。
• env：运行环境，如 development、production 等。

3. 项目的配置文件介绍

ThinkJS 项目的配置文件通常位于 src/config/ 目录下，包含各种配置项，如数据库配置、中间件配置等。

配置文件示例

module.exports = {
  port: 8360, // 服务端口
  host: '', // 服务地址
  workers: 1, // 启动进程数
  createServer: undefined, // 自定义创建服务
  startServerTimeout: 3000, // 等待子进程启动时间
  reloadSignal: 'SIGUSR2', // 重启信号
  stickyCluster: false, // 是否启用 sticky 模式
  onUnhandledRejection: err => think.logger.error(err), // 未处理的 rejection
  onUncaughtException: err => think.logger.error(err), // 未捕获的异常
  processKillTimeout: 10 * 1000, // 退出进程前的等待时间
  exitSignal: 'SIGINT', // 退出信号
  cron: {
    enable: false, // 是否启用定时任务
    tasks: [] // 定时任务列表
  },
  errnoField: 'errno', // 错误号字段
  errmsgField: 'errmsg', // 错误信息字段
  defaultErrno: 1000, // 默认错误号
  validateDefaultErrno: 1001 // 验证默认错误号
};

配置文件介绍

• port：服务端口。
• host：服务地址。
• workers：启动进程数。
• createServer：自定义创建服务。
• startServerTimeout：等待子进程启动时间。
• reloadSignal：重启信号。
• stickyCluster：是否启用 sticky 模式。
• onUnhandledRejection：未处理的 rejection 处理函数。
• onUncaughtException：未捕获的异常处理函数。
• processKillTimeout：退出进程前的等待时间。
• exitSignal：退出信号。
• cron：定时任务配置。
• `errnoField

think-awesomeA curated list of awesome things related to ThinkJS 3.x项目地址:https://gitcode.com/gh_mirrors/th/think-awesome