TypeORM在Node.js中的高级应用

💓 博客主页：瑕疵的CSDN主页

📝 Gitee主页：瑕疵的gitee主页

⏩ 文章专栏：《热点资讯》

TypeORM 是一个非常强大的 ORM（对象关系映射）库，适用于 TypeScript 和 JavaScript 的 Node.js 应用程序。它支持多种数据库，如 MySQL、PostgreSQL、SQLite、Mssql 等，并提供了丰富的功能来简化数据库操作。本文将详细介绍 TypeORM 在 Node.js 中的高级应用，包括连接配置、实体定义、查询构建、事务处理、迁移管理等方面。

实体是 TypeORM 中的基本单元，表示数据库表中的记录。通过定义实体类，可以方便地进行数据库操作。

TypeORM 使用连接配置来建立与数据库的连接。连接配置可以是 JSON 对象或环境变量。

TypeORM 提供了强大的查询构建器，可以方便地构建复杂的 SQL 查询。

事务处理确保了一组数据库操作的原子性，即要么全部成功，要么全部失败。

迁移管理允许你通过代码来管理数据库结构的变化，确保数据库模式与应用程序保持同步。

import { createConnection } from 'typeorm';

createConnection({
  type: 'mysql',
  host: 'localhost',
  port: 3306,
  username: 'test',
  password: 'test',
  database: 'test',
  entities: [
    __dirname + '/entity/**/*.ts' // 指定实体文件路径
  ],
  synchronize: true, // 自动同步数据库结构
  logging: false, // 是否开启日志
}).then(connection => {
  console.log('Connected to database!');
}).catch(error => console.log(error));

import { createConnection } from 'typeorm';
import * as dotenv from 'dotenv';

dotenv.config();

createConnection({
  type: 'mysql',
  host: process.env.DB_HOST,
  port: parseInt(process.env.DB_PORT),
  username: process.env.DB_USERNAME,
  password: process.env.DB_PASSWORD,
  database: process.env.DB_DATABASE,
  entities: [
    __dirname + '/entity/**/*.ts'
  ],
  synchronize: true,
  logging: false,
}).then(connection => {
  console.log('Connected to database!');
}).catch(error => console.log(error));

import { Entity, Column, PrimaryGeneratedColumn } from 'typeorm';

@Entity()
export class User {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  name: string;

  @Column()
  email: string;
}

import { Entity, Column, PrimaryGeneratedColumn, ManyToOne, OneToMany } from 'typeorm';

@Entity()
export class Post {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  title: string;

  @ManyToOne(type => User, user => user.posts)
  author: User;
}

@Entity()
export class User {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  name: string;

  @Column()
  email: string;

  @OneToMany(type => Post, post => post.author)
  posts: Post[];
}

import { getRepository } from 'typeorm';
import { User } from './entity/User';

const userRepository = getRepository(User);

// 查找所有用户
const users = await userRepository.find();

// 查找特定用户
const user = await userRepository.findOne(1); // 通过 ID 查找
const userByEmail = await userRepository.findOne({ where: { email: 'example@example.com' } }); // 通过条件查找

import { getRepository } from 'typeorm';
import { User } from './entity/User';

const userRepository = getRepository(User);

const users = await userRepository.createQueryBuilder('user')
  .where('user.name = :name', { name: 'John Doe' })
  .andWhere('user.email LIKE :email', { email: '%example.com' })
  .orderBy('user.id', 'DESC')
  .skip(10)
  .take(10)
  .getMany();

import { getManager } from 'typeorm';

await getManager().transaction(async transactionalEntityManager => {
  const user = new User();
  user.name = 'John Doe';
  user.email = 'john.doe@example.com';
  await transactionalEntityManager.save(user);

  const post = new Post();
  post.title = 'First Post';
  post.author = user;
  await transactionalEntityManager.save(post);
});

import { getManager } from 'typeorm';

try {
  await getManager().transaction(async transactionalEntityManager => {
    const user = new User();
    user.name = 'John Doe';
    user.email = 'john.doe@example.com';
    await transactionalEntityManager.save(user);

    const post = new Post();
    post.title = 'First Post';
    post.author = user;
    await transactionalEntityManager.save(post);

    throw new Error('Something went wrong!');
  });
} catch (error) {
  console.error(error);
}

typeorm migration:create -n CreateUsersTable

import { MigrationInterface, QueryRunner } from 'typeorm';

export class CreateUsersTable1604123456789 implements MigrationInterface {
  public async up(queryRunner: QueryRunner): Promise<void> {
    await queryRunner.query(
      `CREATE TABLE users (
        id SERIAL PRIMARY KEY,
        name VARCHAR NOT NULL,
        email VARCHAR NOT NULL UNIQUE
      )`
    );
  }

  public async down(queryRunner: QueryRunner): Promise<void> {
    await queryRunner.query(`DROP TABLE users`);
  }
}

typeorm migration:run

typeorm migration:revert

通过环境变量来配置数据库连接信息，可以提高代码的可维护性和安全性。

通过定义通用的实体和方法，可以减少重复代码，提高开发效率。

对于涉及多个数据库操作的业务逻辑，使用事务处理可以确保数据的一致性。

通过迁移管理，可以方便地管理数据库结构的变化，确保数据库模式与应用程序保持同步。

开启日志记录可以帮助调试和优化数据库操作。

博客系统通常包含用户、文章和评论等模块。通过 TypeORM，可以方便地管理这些模块的数据关系和操作。

电商系统通常包含商品、订单和用户等模块。通过 TypeORM，可以方便地管理这些模块的数据关系和操作。

随着 TypeScript 和 Node.js 的发展，TypeORM 将继续改进和完善，提供更多强大的功能。

TypeORM 拥有活跃的社区支持，可以及时获得帮助和反馈。

随着技术的成熟和文档的完善，TypeORM 将在更多的项目中得到应用，成为主流的 ORM 解决方案。

TypeORM 是一个功能强大且易用的 ORM 库，适用于 TypeScript 和 JavaScript 的 Node.js 应用程序。通过本文的介绍和实际案例，希望读者能够更好地理解和应用 TypeORM，提升开发效率和代码质量。

• TypeORM. (2021). TypeORM Documentation.
• Roman Kuba. (2018). TypeORM: The Complete Developer's Guide.
• Basarat Ali Syed. (2017). Learning TypeScript.

以下是一个简单的 TypeORM 应用示例，展示了如何定义实体、连接数据库和执行查询。

import { Entity, Column, PrimaryGeneratedColumn } from 'typeorm';

@Entity()
export class User {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  name: string;

  @Column()
  email: string;
}

import { createConnection } from 'typeorm';

createConnection({
  type: 'mysql',
  host: 'localhost',
  port: 3306,
  username: 'test',
  password: 'test',
  database: 'test',
  entities: [
    __dirname + '/entity/**/*.ts'
  ],
  synchronize: true,
  logging: false,
}).then(connection => {
  console.log('Connected to database!');
}).catch(error => console.log(error));

import { getRepository } from 'typeorm';
import { User } from './entity/User';

const userRepository = getRepository(User);

// 查找所有用户
const users = await userRepository.find();
console.log(users);

// 查找特定用户
const user = await userRepository.findOne(1); // 通过 ID 查找
console.log(user);

const userByEmail = await userRepository.findOne({ where: { email: 'example@example.com' } }); // 通过条件查找
console.log(userByEmail);

这个示例展示了如何使用 TypeORM 定义实体、连接数据库和执行查询。