TypeORM find选项中Raw SQL条件的高效应用

在typeorm中进行数据查询时，find或findandcount等方法提供了简洁的where选项来构建查询条件。然而，当面临需要组合复杂逻辑（如and、or以及is null检查）的场景时，直接使用嵌套对象和数组可能会导致where条件结构变得异常庞大和难以维护。尤其是在不希望引入querybuilder进行轻量级复杂查询的情况下，寻找一种更优雅的解决方案变得尤为重要。

理解TypeORM的Raw操作符

TypeORM的Raw操作符提供了一种在find选项中直接注入原始SQL片段的能力。这使得开发者能够在不完全放弃find选项的便利性，且不转向QueryBuilder的前提下，处理那些标准where选项难以表达的复杂条件。Raw操作符接收一个函数作为参数，该函数会接收当前列的别名，并返回一个包含原始SQL的字符串。同时，它还支持传入一个参数对象，以安全地绑定SQL中的参数，有效防止SQL注入。

其基本用法如下：

import { Raw } from "typeorm";

// 示例：查询 currentDate 晚于指定日期的记录
const loadedPosts = await dataSource.getRepository(Post).findBy({
    currentDate: Raw((alias) => `${alias} > :date`, { date: "2020-10-06" }),
});

上述代码将生成类似 SELECT * FROM "post" WHERE "currentDate" > '2020-10-06' 的SQL查询。这里的关键在于Raw函数中的alias参数，它代表了当前字段在SQL查询中的别名，确保了SQL片段的正确性。通过:date占位符和第二个参数 { date: "2020-10-06" }，TypeORM会安全地将值绑定到查询中。

解决复杂OR和IS NULL条件

考虑一个常见的场景：需要查询某个字段满足“小于某个值”或者“为NULL”的记录。如果直接在where选项中表达，可能需要多个OR条件分支，导致结构冗余。例如，在新闻发布系统中，我们可能需要查询availableFrom字段小于当前时间或者为NULL，同时availableTo字段大于当前时间或者为NULL的新闻。

AppMall应用商店

AI应用商店，提供即时交付、按需付费的人工智能应用服务

56

查看详情

通过Raw操作符，我们可以将这种复合逻辑封装在一个条件中，从而显著简化where条件：

import { Raw, LessThanOrEqual } from "typeorm";
import { NewsStatus } from "./enums"; // 假设存在 NewsStatus 枚举

// 获取当前日期时间
const now = new Date();

const newsItems = await this.newsRepository.findAndCount({
    select: {
        id: true,
        publishedAt: true,
        isDisplayed: true,
        priority: true,
        availableTo: true,
        availableFrom: true,
        useAvailablePeriod: true,
    },
    where: [
        {
            status: NewsStatus.PUBLISHED,
            newsCategories: { seoName: params.categorySeoName },
            useAvailablePeriod: true,
            // 使用 Raw 处理复杂的 availableFrom 条件：小于当前时间或为NULL
            availableFrom: Raw(
                (alias) => `(${alias} < :now OR ${alias} IS NULL)`,
                { now: now }
            ),
            // 使用 Raw 处理复杂的 availableTo 条件：大于当前时间或为NULL
            availableTo: Raw(
                (alias) => `(${alias} > :now OR ${alias} IS NULL)`,
                { now: now }
            ),
            publishedAt: LessThanOrEqual(now), // 其他标准条件
        },
        {
            status: NewsStatus.PUBLISHED,
            newsCategories: { seoName: params.categorySeoName },
            useAvailablePeriod: false,
            publishedAt: LessThanOrEqual(now),
        },
    ],
    order: { publishedAt: 'DESC', priority: 'DESC' },
});

在这个示例中，availableFrom 和 availableTo 字段的条件被有效地整合到 Raw 操作符中。availableFrom: Raw((alias) =>(${alias} < :now OR ${alias} IS NULL), { now: now }) 会生成类似 ("news"."availableFrom" < '2023-10-26T10:00:00.000Z' OR "news"."availableFrom" IS NULL) 的SQL片段，完美地解决了“小于当前时间或为NULL”的需求，避免了在where数组中创建多个冗余的OR条件分支。

注意事项与最佳实践

1. 参数化查询： 始终通过Raw的第二个参数（一个对象）来绑定SQL中的值（如:now）。这不仅提高了代码的可读性，更重要的是，它能有效防止SQL注入攻击，是数据库操作中的黄金法则。
2. 可读性与维护性： 尽管Raw非常强大，但过度使用可能会降低代码的抽象层次，使其更接近原始SQL，从而失去TypeORM ORM的优势。建议仅在标准where选项无法简洁表达时，或为了避免引入QueryBuilder而解决局部复杂条件时使用Raw。
3. 调试： 使用Raw时，如果遇到问题，可以通过TypeORM的日志功能（例如在ormconfig.ts中设置logging: ["query"]）来查看实际生成的SQL语句，这对于调试非常有用。
4. 性能考量： Raw操作符本身不会引入额外的性能开销，但其内部的原始SQL语句的性能将完全取决于您编写的SQL。请确保您的SQL片段是高效且优化的。
5. 替代方案：QueryBuilder： 对于更复杂、涉及多表连接、子查询、聚合函数或需要高度动态构建查询的场景，TypeORM的QueryBuilder仍然是更强大和灵活的选择。Raw操作符适用于在find选项框架内解决局部复杂条件，而无需完全切换到QueryBuilder。

总结

TypeORM的Raw操作符是处理find选项中复杂查询条件的强大工具，尤其适用于需要结合OR逻辑、IS NULL判断或自定义SQL函数等场景。通过合理利用Raw，开发者可以在保持代码简洁性的同时，有效应对复杂的数据库查询需求，避免了冗长的where数组或不必要的QueryBuilder引入。然而，务必注意参数化查询以保障安全性，并权衡其与代码可读性及维护性之间的关系，确保在享受便利的同时，不牺牲代码质量和安全性。

以上就是TypeORM find选项中Raw SQL条件的高效应用的详细内容，更多请关注php中文网其它相关文章！