跳到主要内容

TypeScript ORM框架

在现代后端开发中，数据库操作是不可或缺的一部分。为了简化数据库操作，开发者通常会使用ORM（对象关系映射）框架。本文将介绍如何在TypeScript中使用ORM框架，帮助你更高效地与数据库交互。

什么是ORM？​

ORM（Object-Relational Mapping）是一种编程技术，它将数据库中的表映射为编程语言中的对象。通过ORM，开发者可以使用面向对象的方式来操作数据库，而不需要直接编写SQL语句。这不仅提高了开发效率，还减少了出错的可能性。

为什么选择TypeScript ORM框架？​

TypeScript是一种强类型的JavaScript超集，它提供了更好的类型检查和代码提示。结合ORM框架，TypeScript可以帮助你在开发过程中更早地发现潜在的错误，并提高代码的可维护性。

常见的TypeScript ORM框架​

在TypeScript生态系统中，有多个流行的ORM框架可供选择，包括：

  • TypeORM：一个功能强大且灵活的ORM框架，支持多种数据库。
  • Prisma：一个现代化的ORM框架，提供了类型安全的数据库访问。
  • Sequelize：一个成熟的ORM框架，支持多种数据库，并且有丰富的插件生态系统。

本文将重点介绍TypeORM和Prisma这两个框架。

TypeORM入门​

安装TypeORM​

首先，你需要安装TypeORM及其依赖项。你可以使用npm或yarn来安装：

npm install typeorm reflect-metadata

配置TypeORM​

接下来，你需要创建一个ormconfig.json文件来配置数据库连接：

{
  "type": "mysql",
  "host": "localhost",
  "port": 3306,
  "username": "root",
  "password": "password",
  "database": "test",
  "synchronize": true,
  "logging": false,
  "entities": ["src/entity/**/*.ts"],
  "migrations": ["src/migration/**/*.ts"],
  "subscribers": ["src/subscriber/**/*.ts"]
}

创建实体​

在TypeORM中，实体（Entity）是映射到数据库表的类。以下是一个简单的用户实体示例：

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

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

  @Column()
  firstName: string;

  @Column()
  lastName: string;

  @Column()
  age: number;
}

使用TypeORM进行数据库操作​

一旦你定义了实体，就可以使用TypeORM进行数据库操作了。以下是一个简单的示例，展示如何插入和查询数据：

import "reflect-metadata";
import { createConnection } from "typeorm";
import { User } from "./entity/User";

createConnection().then(async connection => {
  const user = new User();
  user.firstName = "John";
  user.lastName = "Doe";
  user.age = 25;

  await connection.manager.save(user);
  console.log("Saved a new user with id: " + user.id);

  const users = await connection.manager.find(User);
  console.log("Loaded users: ", users);
}).catch(error => console.log(error));

Prisma入门​

安装Prisma​

首先，你需要安装Prisma CLI：

npm install @prisma/cli --save-dev

初始化Prisma项目​

接下来，使用Prisma CLI初始化一个新的Prisma项目：

npx prisma init

这将生成一个prisma/schema.prisma文件，用于定义数据模型。

定义数据模型​

在schema.prisma文件中，你可以定义你的数据模型。以下是一个简单的用户模型示例：

model User {
  id        Int      @id @default(autoincrement())
  firstName String
  lastName  String
  age       Int
}

使用Prisma进行数据库操作​

一旦你定义了数据模型，就可以使用Prisma进行数据库操作了。以下是一个简单的示例，展示如何插入和查询数据：

import { PrismaClient } from '@prisma/client';

const prisma = new PrismaClient();

async function main() {
  const user = await prisma.user.create({
    data: {
      firstName: "John",
      lastName: "Doe",
      age: 25,
    },
  });
  console.log("Created user: ", user);

  const users = await prisma.user.findMany();
  console.log("All users: ", users);
}

main()
  .catch(e => {
    throw e;
  })
  .finally(async () => {
    await prisma.$disconnect();
  });

实际案例：构建一个简单的用户管理系统​

假设你需要构建一个简单的用户管理系统，允许用户注册、登录和查看用户列表。以下是如何使用TypeORM和Prisma实现这一功能的示例。

使用TypeORM实现​

import "reflect-metadata";
import { createConnection } from "typeorm";
import { User } from "./entity/User";
import express from "express";

const app = express();
app.use(express.json());

createConnection().then(async connection => {
  app.post("/register", async (req, res) => {
    const user = new User();
    user.firstName = req.body.firstName;
    user.lastName = req.body.lastName;
    user.age = req.body.age;

    await connection.manager.save(user);
    res.send("User registered successfully");
  });

  app.get("/users", async (req, res) => {
    const users = await connection.manager.find(User);
    res.json(users);
  });

  app.listen(3000, () => {
    console.log("Server is running on port 3000");
  });
}).catch(error => console.log(error));

使用Prisma实现​

import { PrismaClient } from '@prisma/client';
import express from 'express';

const prisma = new PrismaClient();
const app = express();
app.use(express.json());

app.post('/register', async (req, res) => {
  const user = await prisma.user.create({
    data: {
      firstName: req.body.firstName,
      lastName: req.body.lastName,
      age: req.body.age,
    },
  });
  res.send("User registered successfully");
});

app.get('/users', async (req, res) => {
  const users = await prisma.user.findMany();
  res.json(users);
});

app.listen(3000, () => {
  console.log("Server is running on port 3000");
});

总结​

通过本文，你已经了解了如何在TypeScript中使用ORM框架来简化数据库操作。无论是TypeORM还是Prisma，它们都提供了强大的功能，帮助你更高效地开发后端应用。

提示

如果你对ORM框架还不熟悉，建议从TypeORM开始，因为它有更丰富的文档和社区支持。一旦你熟悉了基本概念，可以尝试使用Prisma，它提供了更现代化的开发体验。

附加资源与练习​

希望本文对你有所帮助，祝你在TypeScript后端开发的学习之旅中取得成功！