How to do orderBy on custom field in typeorm?

在使用TypeORM进行数据操作时，对自定义字段执行orderBy是一个常见的需求，特别是在处理复杂查询或者需要根据非数据库列的计算结果进行排序的场景下。TypeORM本身提供了多种方式来进行排序，包括基于数据库中存在的字段。然而，对于自定义字段（即，不直接存在于数据库表中的字段），我们需要采取一些特别的策略。

例子说明

假设我们有一个Employee实体，其中包含firstName和lastName字段，我们需要根据全名（fullName）对员工进行排序，但数据库中并不存在fullName字段。

解决方案 1：在查询中创建自定义字段

在QueryBuilder中，我们可以使用addSelect方法来创建一个自定义的选择字段，然后基于该字段进行排序。例如：

typescript
import { getRepository } from "typeorm";

const employeeRepository = getRepository(Employee);

const employees = await employeeRepository
  .createQueryBuilder("employee")
  .select("employee.firstName")
  .addSelect("employee.lastName")
  .addSelect("CONCAT(employee.firstName, ' ', employee.lastName)", "fullName")
  .orderBy("fullName", "ASC")
  .getMany();

这里，我们通过CONCAT函数合成了一个新的列fullName，然后在orderBy中使用这个新生成的列来进行排序。

解决方案 2：在实体中定义虚拟字段

如果排序的逻辑比较复杂或者需要在多个地方使用，可以在实体类中定义一个虚拟字段，并利用TypeORM的@AfterLoad()装饰器计算该字段的值。然后在服务层进行排序，如下：

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

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

    @Column()
    firstName: string;

    @Column()
    lastName: string;

    fullName: string;  // 虚拟字段，不对应数据库

    @AfterLoad()
    setComputed() {
        this.fullName = `${this.firstName} ${this.lastName}`;
    }
}

// 在服务层使用JavaScript的sort函数进行排序
const employees = await employeeRepository.find();
employees.sort((a, b) => a.fullName.localeCompare(b.fullName));

在这个例子中，fullName字段是在实体加载后计算出来的，然后我们在应用层面进行了排序。

结论

对于自定义字段的排序，TypeORM提供了灵活的方法来处理这些情况。你可以选择在数据库查询层面处理，也可以在应用层处理，具体取决于你的具体需求和性能考虑。在处理大量数据或性能关键的应用时，尽可能在数据库层面解决排序问题是更优的选择。