如何向Room的@Query注解传递Order By参数？

你的问题本质是Room不允许直接用参数替换SQL语法中的标识符（比如排序字段、方向）——Room的查询参数是用来替换SQL中的值（比如WHERE id = :id里的id），而不是语法元素。所以直接传:order :orderDirection会被Room当成无效的SQL语法，报错；而传整串time desc会被当作字符串字面量，变成ORDER BY 'time desc'，这其实是按固定字符串排序，自然看起来像被忽略了。

下面给你两种可行的解决方案：

方案一：使用@RawQuery（灵活但需注意安全） #

Room提供了@RawQuery注解，允许你传入动态构建的SQL语句。这种方式适合排序字段/方向较多、需要高度灵活的场景，但一定要做好输入校验，避免SQL注入。

步骤1：在Dao中定义RawQuery方法 #

import androidx.room.RawQuery
import androidx.sqlite.db.SupportSQLiteQuery
import androidx.paging.DataSource

@Dao
interface OrderDao {
    @RawQuery(observedEntities = [Order::class])
    fun getAllOrders(query: SupportSQLiteQuery): DataSource.Factory<Int, Order>
}

这里observedEntities用来指定要观察的实体类，确保Paging能正常感知数据变化。

步骤2：构建安全的动态查询 #

在Repository或者ViewModel中，先校验输入的合法性，再构建SQL语句：

import androidx.sqlite.db.SimpleSQLiteQuery

fun getSortedOrders(orderField: String, orderDirection: String): DataSource.Factory<Int, Order> {
    // 定义允许的排序字段和方向，防止非法输入导致SQL注入
    val validFields = listOf("time", "id", "total_price") // 替换成你实际的字段
    val validDirections = listOf("ASC", "DESC")
    
    // 校验并获取安全的字段和方向，默认用time DESC
    val safeField = if (validFields.contains(orderField)) orderField else "time"
    val safeDirection = if (validDirections.contains(orderDirection.uppercase())) orderDirection.uppercase() else "DESC"
    
    // 构建SQL语句
    val query = SimpleSQLiteQuery(
        "SELECT * FROM orders ORDER BY $safeField $safeDirection"
    )
    
    return orderDao.getAllOrders(query)
}

方案二：枚举限定排序选项（更安全） #

如果你的排序选项是固定的（比如只能按time、id排序，方向只能是ASC/DESC），推荐用枚举来限定输入，这样完全避免SQL注入风险，Room也能正常编译校验SQL。

步骤1：定义枚举类 #

enum class SortField(val columnName: String) {
    TIME("time"),
    ID("id"),
    TOTAL_PRICE("total_price")
}

enum class SortDirection(val direction: String) {
    ASC("ASC"),
    DESC("DESC")
}

步骤2：在Dao中编写带条件的Query #

@Dao
interface OrderDao {
    @Query("""
        SELECT * FROM orders 
        ORDER BY 
            CASE :sortField 
                WHEN ${SortField.TIME.columnName} THEN time
                WHEN ${SortField.ID.columnName} THEN id
                WHEN ${SortField.TOTAL_PRICE.columnName} THEN total_price
                ELSE time
            END 
            :sortDirection
    """)
    fun getAllOrders(
        sortField: String,
        sortDirection: String
    ): DataSource.Factory<Int, Order>
}

步骤3：调用时传入枚举值 #

// 示例：按time降序查询
orderDao.getAllOrders(
    SortField.TIME.columnName,
    SortDirection.DESC.direction
)

这种方式下，输入被严格限定在枚举范围内，Room编译时就能验证SQL的正确性，同时完全避免SQL注入。

为什么之前的方法无效？ #

再补充下原因：

• 直接传:order :orderDirection时，Room会把这两个参数当作字符串值，拼接后SQL变成ORDER BY 'time' 'desc'，这不符合SQL语法，所以编译器报错。
• 传整串time desc时，SQL变成ORDER BY 'time desc'，这是在按字符串常量'time desc'排序，所有行的这个值都一样，所以看起来排序没生效。

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