Loopback4 Starter 项目启动与配置教程

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

Loopback4 Starter 项目的目录结构如下：

loopback4-starter/
├── .vscode/              # Visual Studio Code 的配置文件
├── dist/                 # 构建后的输出目录
├── docs/                 # 项目文档
├── node_modules/         # 项目依赖的Node.js模块
├── package.json          # 项目信息和依赖关系
├── tsconfig.json         # TypeScript 配置文件
├── tslint.json           # TypeScript linter 配置文件
├── .env                  # 环境变量配置文件
├── src/                  # 源代码目录
│   ├── controllers/      # 控制器目录
│   ├── models/           # 模型目录
│   ├── repositories/     # 数据仓库目录
│   ├── routes/           # 路由目录
│   ├── services/         # 服务目录
│   ├── boot/             # 启动脚本目录
│   ├── config/           # 配置文件目录
│   ├── interfaces/       # 接口定义目录
│   ├── middlewares/      # 中间件目录
│   └── utils/            # 工具类目录
└── .gitignore            # Git 忽略文件列表

每个目录的说明如下：

• .vscode/: 包含 Visual Studio Code 项目的配置文件。
• dist/: 构建后的应用程序代码存放目录。
• docs/: 存放项目文档的目录。
• node_modules/: 项目依赖的Node.js模块。
• package.json: 定义项目依赖关系、脚本和元数据。
• tsconfig.json: TypeScript 编译器的配置文件。
• tslint.json: TypeScript 代码风格和错误检查的配置文件。
• .env: 环境变量配置文件，用于配置不同的环境变量。
• src/: 源代码目录，包含项目的所有源代码。
• .gitignore: 指定Git应该忽略的文件和目录。

2. 项目的启动文件介绍

Loopback4 Starter 项目的启动文件是 src/index.ts。以下是该文件的基本内容：

import { ApplicationConfig } from '@loopback/core';
import { RestApplication } from '@loopback/rest';
import { MyApplication } from './application';

async function main(options?: ApplicationConfig) {
  const app = new MyApplication(options);
  await app.boot();
  await app.start();
}

main().catch(err => {
  console.error('无法启动应用', err);
  process.exit(1);
});

这段代码创建了一个 LoopBack 应用实例，并调用了 boot 和 start 方法来启动应用。

3. 项目的配置文件介绍

Loopback4 Starter 项目的配置文件位于 src/config/ 目录中。以下是几个主要的配置文件及其作用：

• config.json: 包含应用程序的基本配置，如端口、数据库连接信息等。
• keys.ts: 存放用于数据加密和解密的密钥。
• rate-limiter.ts: 配置请求频率限制的设置。

例如，config.json 文件可能如下所示：

{
  "rest": {
    "port": 3000,
    "host": "localhost",
    " basePath": "/api",
    "bodyParser": {
      "json": {
        "limit": "100kb"
      },
      "urlencoded": {
        "extended": true
      }
    }
  },
  "sqlite": {
    "name": "db",
    "filename": "database.sqlite",
    "mode": "ow",
    "cache": {
      "evictionProbability": 0.1,
      "maxOpen": 10,
      "maxConnection": 10,
      "checkInterval": 5000
    }
  }
}

这个配置文件定义了 REST 服务器运行的端口和主机名，以及 body parser 的设置。此外，还配置了 SQLite 数据库的参数。