MikroORM项目实战：从零搭建Web服务与测试环境-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01114/article/details/148440995

MikroORM项目实战：从零搭建Web服务与测试环境

mikro-orm mikro-orm/mikro-orm: 是一个基于 PHP 的轻量级 ORM 库，它支持多种数据库，包括 MySQL、SQLite、PostgreSQL 等。适合用于 PHP 应用程序的数据库操作和对象关系映射，特别是对于需要轻量级、高性能的 ORM 库的场景。特点是轻量级、高性能、支持多种数据库。项目地址: https://gitcode.com/gh_mirrors/mi/mikro-orm

前言

本文将详细介绍如何使用MikroORM框架构建一个完整的Web服务项目，包括Fastify服务器集成、请求上下文管理、依赖注入容器设计以及测试环境搭建等核心内容。通过本文，你将掌握MikroORM在实际项目中的应用技巧。

项目初始化与Fastify集成

基础架构搭建

首先我们需要创建一个基础的Web服务架构。这里选择Fastify作为Web框架，它轻量高效，非常适合与MikroORM配合使用。

// app.ts
import { MikroORM, RequestContext } from '@mikro-orm/core';
import { fastify } from 'fastify';

export async function bootstrap(port = 3001) {
  const orm = await MikroORM.init();
  const app = fastify();

  // 注册请求上下文钩子
  app.addHook('onRequest', (request, reply, done) => {
    RequestContext.create(orm.em, done);
  });

  // 应用关闭时断开数据库连接
  app.addHook('onClose', async () => {
    await orm.close();
  });

  const url = await app.listen({ port });
  return { app, url };
}

请求上下文管理

MikroORM的RequestContext是一个关键组件，它利用Node.js的AsyncLocalStorage为每个请求创建独立的EntityManager实例。这种设计解决了多请求并发时的上下文隔离问题。

工作原理：

每个请求进入时创建新的EntityManager分支
所有数据库操作自动获取当前请求的上下文
请求结束时自动清理资源

依赖注入容器设计

数据库服务封装

为了提高代码的可维护性和可测试性，我们创建一个简单的DI容器：

// db.ts
import { EntityManager, EntityRepository, MikroORM } from '@mikro-orm/sqlite';

export interface Services {
  orm: MikroORM;
  em: EntityManager;
  article: EntityRepository<Article>;
  user: EntityRepository<User>;
  tag: EntityRepository<Tag>;
}

let cache: Services;

export async function initORM(options?: Options): Promise<Services> {
  if (cache) return cache;
  
  const orm = await MikroORM.init(options);
  return cache = {
    orm,
    em: orm.em,
    article: orm.em.getRepository(Article),
    user: orm.em.getRepository(User),
    tag: orm.em.getRepository(Tag),
  };
}

实体仓库(EntityRepository)详解

实体仓库是MikroORM提供的一个便捷抽象层：

封装了常见CRUD操作
自动关联实体类型，避免重复指定
可作为扩展点添加自定义查询方法
底层仍使用EntityManager，保持一致性

业务端点实现

文章列表接口

下面实现一个分页查询文章的接口：

app.get('/article', async request => {
  const { limit, offset } = request.query as { 
    limit?: number; 
    offset?: number 
  };
  
  const [items, total] = await db.article.findAndCount({}, {
    limit, 
    offset,
  });

  return { items, total };
});

使用findAndCount方法可以一次性获取分页数据和总数，比单独调用find和count更高效。

测试环境搭建

测试工具链配置

我们使用Vitest作为测试框架，需要特别注意TypeScript文件的处理：

// mikro-orm.config.ts
export default {
  // 解决Vitest中的TS文件导入问题
  dynamicImportProvider: id => import(id),
  // 其他配置...
};

测试应用初始化

创建专门的测试初始化工具：

// test/utils.ts
export async function initTestApp(port: number) {
  const { orm } = await initORM({
    ...config,
    debug: false,
    dbName: ':memory:', // 使用内存数据库
  });

  await orm.schema.createSchema();
  const { app } = await bootstrap(port);
  return app;
}

测试用例示例

// test/article.test.ts
let app: FastifyInstance;

beforeAll(async () => {
  app = await initTestApp(30001);
});

afterAll(async () => {
  await app.close();
});

test('文章列表接口', async () => {
  const res = await app.inject({
    method: 'get',
    url: '/article',
  });

  expect(res.statusCode).toBe(200);
  expect(res.json()).toMatchObject({
    items: [],
    total: 0,
  });
});

数据库种子数据

使用Seeder填充测试数据

MikroORM提供了专门的Seeder工具：

安装依赖：

npm install @mikro-orm/seeder

配置Seeder扩展：

import { SeedManager } from '@mikro-orm/seeder';

export default defineConfig({
  extensions: [SeedManager],
});

创建Seeder：

export class TestSeeder extends Seeder {
  async run(em: EntityManager): Promise<void> {
    // 创建测试数据
    em.create(Article, {
      title: '测试文章',
      // 其他字段...
    });
  }
}

单元测试优化技巧

无连接初始化

对于不需要实际数据库连接的测试，可以使用轻量级初始化：

const orm = await MikroORM.init({
  connect: false, // 不建立实际连接
});

// 或同步初始化
const orm = MikroORM.initSync({
  // 配置...
});

总结

本文详细介绍了MikroORM在实际项目中的应用，从基础架构搭建到测试环境配置，涵盖了以下关键点：

Fastify与MikroORM的集成方式
请求上下文管理的最佳实践
依赖注入容器的设计与实现
测试环境的搭建与优化技巧
数据库种子数据的管理

通过这些实践，你可以构建出结构清晰、易于测试的MikroORM应用。记住良好的项目结构和测试覆盖率是长期维护的关键。

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考