扩展TypeORM Repository类报错：派生类构造函数参数数量不符

问题场景 #

在Express.js中使用TypeORM，尝试创建继承自Repository的自定义BookRepository，代码如下：

import { Repository } from 'typeorm';
import { AppDataSource } from '..';
import { provideSingleton } from '../common/utils/ProvideSingleton';
import { Book } from './Book';

@provideSingleton(BookRepository)
export class BookRepository extends Repository<Book> {
    constructor() {
        super(Book, AppDataSource.manager, AppDataSource.createQueryRunner());
    }
}

调用路由触发控制器→服务→仓库流程时，出现错误：

Error: The number of constructor arguments in the derived class BookRepository must be >= than the number of constructor arguments of its base class.

已知TypeORM的Repository类构造函数定义为：

constructor(target: EntityTarget<Entity>, manager: EntityManager, queryRunner?: QueryRunner);

其中第三个参数为可选参数，但仍触发该错误。

问题原因 #

TypeScript处理类继承时，会检查构造函数的参数总数（包括可选参数）。基类Repository的构造函数包含3个参数（2个必填+1个可选），而自定义的BookRepository构造函数无参数，参数数量0小于3，因此触发TypeScript的参数数量校验错误。

另外，直接在构造函数中硬编码AppDataSource会提高代码耦合度，不利于后续测试和维护。

解决方法 #

方法一：匹配基类构造函数参数签名 #

让自定义Repository的构造函数接收与基类一致的参数，即使不需要手动传入，也保留签名并传递给父类：

import { Repository, EntityTarget, EntityManager, QueryRunner } from 'typeorm';
import { provideSingleton } from '../common/utils/ProvideSingleton';
import { Book } from './Book';

@provideSingleton(BookRepository)
export class BookRepository extends Repository<Book> {
    constructor(
        target: EntityTarget<Book>,
        manager: EntityManager,
        queryRunner?: QueryRunner
    ) {
        super(target, manager, queryRunner);
    }
}

之后可通过TypeORM的getRepository方法获取实例，或让provideSingleton装饰器处理参数注入。

方法二：使用TypeORM官方自定义仓库注册方式（推荐） #

TypeORM原生支持自定义仓库注册，无需手动实现构造函数，更符合框架规范：

1. 在Book实体类上指定自定义仓库：

import { Entity, PrimaryGeneratedColumn, Column } from 'typeorm';
import { BookRepository } from './BookRepository';

@Entity({ repository: () => BookRepository })
export class Book {
    @PrimaryGeneratedColumn()
    id: number;

    @Column()
    title: string;

    // 其他字段定义...
}

2. 简化自定义仓库实现，无需手动编写构造函数：

import { Repository } from 'typeorm';
import { provideSingleton } from '../common/utils/ProvideSingleton';
import { Book } from './Book';

@provideSingleton(BookRepository)
export class BookRepository extends Repository<Book> {
    // 添加自定义业务方法，示例：
    async findBooksByTitleKeyword(keyword: string) {
        return this.createQueryBuilder('book')
            .where('book.title LIKE :keyword', { keyword: `%${keyword}%` })
            .getMany();
    }
}

3. 通过数据源获取仓库实例：

const bookRepository = AppDataSource.getRepository(Book) as BookRepository;

这种方式由TypeORM自动处理仓库实例化与参数注入，既避免了构造函数参数问题，又符合TypeORM设计模式。

方法三：重载构造函数兼容无参调用 #

如果必须保留无参构造函数，可通过构造函数重载实现兼容：

import { Repository } from 'typeorm';
import { AppDataSource } from '..';
import { provideSingleton } from '../common/utils/ProvideSingleton';
import { Book } from './Book';

@provideSingleton(BookRepository)
export class BookRepository extends Repository<Book> {
    constructor();
    constructor(target: typeof Book, manager: typeof AppDataSource.manager, queryRunner?: typeof AppDataSource.createQueryRunner);
    constructor(target?: typeof Book, manager?: typeof AppDataSource.manager, queryRunner?: typeof AppDataSource.createQueryRunner) {
        super(target || Book, manager || AppDataSource.manager, queryRunner || AppDataSource.createQueryRunner());
    }
}

但该方式仍存在硬编码数据源的问题，不推荐用于大型项目。

内容的提问来源于stack exchange，提问作者Gardelin