AdonisJS Lucid 框架教程

AdonisJS Lucid 框架教程

lucidAdonisJS SQL ORM. Supports PostgreSQL, MySQL, MSSQL, Redshift, SQLite and many more项目地址:https://gitcode.com/gh_mirrors/luc/lucid

AdonisJS Lucid 是一个基于 Node.js 的 ORM（对象关系映射），专为 AdonisJS 框架设计，提供了优雅且强大的数据库操作能力。本教程将带您了解其核心结构、启动机制以及配置细节，帮助您快速上手。

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

AdonisJS 应用通常遵循一定的目录约定，虽然 Lucid 本身不直接定义一个独立的目录结构，但它的使用紧密围绕在 AdonisJS 应用框架中。以下是一般 AdonisJS 应用中，与 Lucid 相关的典型目录结构部分：

• app/Model
  这是存放所有模型（Models）的地方。每个模型代表数据库中的一个表，用于定义数据结构和数据操作逻辑。

• database/migrations
  存放数据库迁移文件，通过这些脚本可以创建、更改或删除数据库表结构。

• config/database.ts
  包含数据库连接设置，这里配置你的数据库凭证和其他连接选项，Lucid 使用这些配置来建立与数据库的通信。

• start/app.ts (或相关启动配置)
  虽然不直接管理Lucid，但应用程序的基础配置可能会影响到Lucid的行为，如服务提供者注册等。

2. 项目的启动文件介绍

在 AdonisJS 中，主要的启动流程不是通过单一的“启动文件”控制，而是通过一系列的服务提供者（Service Providers）和配置加载完成的。关键的启动逻辑发生在以下几个地方：

• start/kernel.ts
  这个文件处理HTTP请求的中间件栈，尽管它不直接影响Lucid的启动，但可以通过中间件实现数据访问的前置条件。

• config/app.ts
  定义了应用的启动模式（如生产或开发模式）、错误处理方式等，间接影响Lucid的行为配置。

对于Lucid来说，其初始化是在AdonisJS启动过程中自动进行的，具体由Database服务提供者处理，在启动时自动连接到配置的数据库并准备模型的使用环境。

3. 项目的配置文件介绍

数据库配置 (config/database.ts)

这是与Lucid直接相关的核心配置文件。示例配置包括但不限于：

export default {
  connections: {
    mysql: {
      client: 'mysql',
      host: env('DB_HOST', 'localhost'),
      port: env.int('DB_PORT', 3306),
      username: env('DB_USER', 'root'),
      password: env('DB_PASSWORD', ''),
      database: env('DB_NAME', 'adonis_app'),
      // ...其他配置项
    },
  },
 默认Connection: env('DEFAULT_CONNECTION', 'mysql'),
}

在这个文件中，你可以添加多个数据库连接，并指定应用应该使用的默认连接。每种数据库类型（如MySQL, PostgreSQL等）都有其特定的配置参数。

通过理解上述三个核心方面，您可以更好地掌握如何在AdonisJS项目中高效地使用Lucid进行数据库管理和操作。记得查看AdonisJS的官方文档以获取更详细的信息和最佳实践。

lucidAdonisJS SQL ORM. Supports PostgreSQL, MySQL, MSSQL, Redshift, SQLite and many more项目地址:https://gitcode.com/gh_mirrors/luc/lucid