首页
/ ThinkJS 开源项目教程

ThinkJS 开源项目教程

2024-08-07 06:26:47作者:郦嵘贵Just

1. 项目目录结构及介绍

ThinkJS 的典型项目目录结构如下:

├── app                 # 应用代码目录
│   ├── controller      # 控制器目录
│   ├── model           # 模型目录
│   ├── service         # 服务层目录
│   └── view            # 视图目录
├── common              # 公共代码目录
│   ├── controller      # 全局控制器
│   ├── logic           # 逻辑层目录
│   ├── middleware      # 中间件目录
│   └── model           # 全局模型
├── config               # 配置文件目录
├── public                # 静态资源目录
├── node_modules          # 依赖包目录
├── src                  # 自定义扩展目录
└── test                  # 测试用例目录
  • app: 应用的核心代码,包括控制器、模型、服务和视图。
  • common: 存放全局性、跨模块使用的代码,如全局控制器和服务。
  • config: 存放各种环境下的配置文件。
  • public: 部署时可被直接访问到的静态资源。
  • node_modules: 项目依赖的第三方模块。
  • src: 用于存放自定义扩展模块的地方。
  • test: 项目测试相关的代码。

2. 项目的启动文件介绍

ThinkJS 的启动文件通常是 bin/www.js。此文件主要负责加载项目并设置服务器运行的参数。例如,它会初始化应用实例,加载配置文件,设置监听端口等。在启动项目时,通常执行以下命令:

npm start

这将运行 www.js 文件启动服务。你可以在 www.js 文件中找到类似下面的代码:

const { think } = require('thinkjs');
const app = think.app();
app.httpServer.listen(app.config.port, () => {
  console.log(`Server is running at http://${app.config.host}:${app.config.port}`);
});

这个示例展示了如何通过 ThinkJS 初始化应用,然后监听指定端口运行服务。

3. 项目的配置文件介绍

ThinkJS 使用 config 目录下的配置文件管理不同环境(development, testing, production)下的项目设置。默认情况下,主要有以下几个核心配置文件:

  • default.js: 默认配置,所有环境都会使用此配置。
  • development.js: 开发环境配置,当环境变量 NODE_ENV 设置为 'development' 时生效。
  • testing.js: 测试环境配置,用于自动化测试。
  • production.js: 生产环境配置,当 NODE_ENV 设置为 'production' 时生效。

配置文件中的键值对可以覆盖 default.js 中的同名配置,例如设置数据库连接、服务器端口、日志级别等。一个简单的配置项示例如下:

module.exports = {
  env: 'development',
  http: {
    port: 8360,
    host: 'localhost'
  },
  database: {
    type: 'mysql',
    adapter: {
      mysql: {
        host: 'localhost',
        user: 'root',
        password: 'your_password',
        database: 'test_db'
      }
    }
  },
  log: {
    level: 'info'
  }
};

请注意,实际项目中的配置可能会更加复杂,涵盖更多服务组件和特性。以上是一个简化的示例,以帮助理解配置文件的基本结构和作用。在实际开发中,你需要根据项目需求来定制这些配置。

登录后查看全文
热门项目推荐