AdonisJS Lucid ORM 教程

AdonisJS Lucid ORM 教程

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

项目介绍

AdonisJS Lucid 是 AdonisJS 框架中的一款高性能、直观且灵活的对象关系映射（ORM）工具，它允许开发者以面向对象的方式操作数据库。Lucid 紧密集成到 AdonisJS 生态中，提供了一套丰富的 API 来处理数据库查询、事务、模型关联等，使数据库交互变得更加简单和高效。支持多种数据库系统，包括 MySQL、PostgreSQL 和 SQLite。

项目快速启动

在开始之前，确保已安装 Node.js。接下来，我们将创建一个简单的 AdonisJS 项目，并设置 Lucid。

安装 AdonisJS

通过 NPM 全局安装 AdonisCLI：

npm install --global @adonisjs/cli

然后创建新项目：

adonis new my-app --with-orm lucid
cd my-app

这将创建一个新的 AdonisJS 应用程序并自动配置 Lucid ORM。

创建模型

现在，让我们创建一个代表用户的模型。运行以下命令：

adonis make:model User

编辑 app/Models/User.js 文件，添加一些字段：

const { Model } = use('Model')

class User extends Model {
}

module.exports = User

连接数据库

在 .env 文件中设置数据库连接信息。例如，对于 MySQL:

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=mydatabase
DB_USERNAME=root
DB_PASSWORD=my-secret-pw

并在 config/database.js 中正确配置您的数据库连接。

快速插入数据

在终端中，你可以使用 Adonis 的 CLI 来执行数据库操作，比如插入一条用户记录：

adonis db:seed --file seed/UserSeeder.js

创建 start/seeds/UserSeeder.js：

const Users = use('App/Models/User')

exports.run = async () => {
  await Users.create({
    name: 'John Doe',
    email: 'john@example.com',
  })
}

记得在运行种子文件前，先运行迁移以创建表：

adonis migration:run

应用案例和最佳实践

查询示例

const User = use('App/Models/User')

// 获取所有用户
const users = await User.all()

// 查找特定用户
const user = await User.find(1)

// 执行复杂查询
const activeUsers = await User.query()
                        .where('status', 'active')
                        .orderBy('created_at', 'desc')
                        .fetch()

事务管理

const trx = await DB.beginTransaction()

try {
  await User.query(trx).insert({ name: 'Jane Doe' })
  // 更多数据库操作...
  await trx.commit() // 提交事务
} catch (error) {
  await trx.rollback() // 回滚事务
}

典型生态项目

AdonisJS 的生态系统广泛，包括但不限于中间件、认证库、RESTful API构建工具等。Lucid ORM作为核心部分，可以直接与AdonisJS框架中的其他组件结合，如：

• AdonisJS Route Middleware：用于基于角色或权限控制访问。
• Lucid Relations：如 BelongsTo, HasMany, ManyToMany，简化了模型间的关系管理。
• AdonisJS Validation：与Lucid模型紧密集成，确保数据输入的有效性。

通过这些生态项目和最佳实践的结合，AdonisJS Lucid ORM不仅提供了强大的数据库操作能力，还促进了高可维护性和高效开发流程。

请注意，上述代码示例和步骤基于AdonisJS的稳定版本撰写，具体细节可能随框架更新而变化。建议查阅最新的官方文档以获取最新信息。

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