NestJS/TypeORM如何实现按自定义字段搜索

看起来你已经搞定了基础CRUD的搭建，现在要加按username搜索的功能其实很简单，TypeORM提供了好几种实用的实现方式，我给你列几个常用方案：

方案1：直接用Repository的findOne/find方法 #

这是最快捷的方式，TypeORM的findOne不仅能传ID，还支持接收查询条件对象。如果你的username是唯一字段，用findOne返回单个用户；如果允许重复，就用find返回结果数组：

返回单个用户（假设username唯一） #

async findByUsername(username: string): Promise<User | null> {
  // ES6对象简写，等价于 { username: username }
  return this.usersRepository.findOne({ where: { username } });
}

返回多个用户（如果username可能重复） #

async findByUsername(username: string): Promise<User[]> {
  return this.usersRepository.find({ where: { username } });
}

方案2：用QueryBuilder实现灵活查询 #

如果之后需要扩展查询逻辑（比如加性别过滤、关联其他表），QueryBuilder会更灵活，可读性也更强：

async findByUsername(username: string): Promise<User | null> {
  return this.usersRepository
    .createQueryBuilder('user') // 给User实体起别名`user`
    .where('user.username = :username', { username }) // 参数化查询防止SQL注入
    .getOne(); // 返回单个结果，换成getMany()可返回数组
}

方案3：自定义Repository（适合复杂/复用的查询） #

如果你的项目里有很多针对User的自定义查询，推荐创建自定义Repository来统一管理逻辑：

TypeORM v0.2.x版本 #

先创建UserRepository类：

// src/user/user.repository.ts
import { EntityRepository, Repository } from 'typeorm';
import { User } from './user.entity';

@EntityRepository(User)
export class UserRepository extends Repository<User> {
  async findByUsername(username: string): Promise<User | null> {
    // 这里可以用上面任意一种方式实现
    return this.findOne({ where: { username } });
  }
}

然后在模块里注册这个Repository：

// src/user/user.module.ts
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { UserRepository } from './user.repository';
import { UserService } from './user.service';

@Module({
  imports: [TypeOrmModule.forFeature([UserRepository])],
  providers: [UserService],
  exports: [UserService],
})
export class UserModule {}

最后在Service里注入自定义Repository：

constructor(private readonly usersRepository: UserRepository) {}

TypeORM v0.3+版本（EntityRepository已弃用） #

TypeORM 0.3+推荐用extend方法扩展默认Repository：

// 在UserService或模块中初始化
import { DataSource } from 'typeorm';
import { User } from './user.entity';

constructor(private dataSource: DataSource) {
  this.usersRepository = dataSource.getRepository(User).extend({
    async findByUsername(username: string): Promise<User | null> {
      return this.findOne({ where: { username } });
    },
  });
}

private usersRepository: ReturnType<typeof dataSource.getRepository<User>.extend>;

额外建议 #

如果username应该是全局唯一的，建议在实体字段上加上unique: true约束，数据库层面会保证唯一性，查询返回单个结果也更合理：

@Column({ unique: true })
username: string;

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