android - 如何在运行时动态查询房间数据库？

Question

问题

是否可以在运行时构造查询？

用例

@Query("SELECT * FROM playlist " +
        "WHERE playlist_title LIKE '% :playlistTitle %' " +
        "GROUP BY playlist_title " +
        "ORDER BY playlist_title " +
        "LIMIT :limit")
 List<IPlaylist> searchPlaylists(String playlistTitle, int limit);

该limit部分是可选的。也就是说，它应该能够有或无限制地执行相同的查询。

更复杂的用例

在前一种情况下，可以进行两个有限制部分和没有限制部分的静态查询，并且每次都可以使用适当的一个。但有时我们可能不得不处理更复杂的情况，例如构建过滤器。

在这种情况下，与前面的示例不同，将有多个可选部分。对于一个图书表，我们可能需要根据图书所属的类别、作者姓名、价格范围、出版日期等进行过滤。几乎不可能将这些部分的所有组合都进行静态查询。

score 63 · Accepted Answer

Room 支持@RawQuery注释以在运行时构造查询。

第 1 步：制作 DAO 方法

@RawQuery使用注释而不是 normal标记 DAO 方法@Query。

@Dao
interface BooksDao{
    @RawQuery
    List<Book> getBooks(SupportSQLiteQuery query);
}

第 2 步：构造查询

Room 使用准备好的语句进行安全性和编译时验证。因此，在构造查询时，我们需要分别存储查询字符串和绑定参数。

在此示例中，我将变量queryString用于查询字符串和args绑定参数。

^{（请注意，我使用文本编辑器编写代码。因此可能存在拼写错误或简单的语法错误。如果您发现任何内容，请在评论中告诉我或编辑帖子。）}

// Query string
String queryString = new String();

// List of bind parameters
List<Object> args = new ArrayList();

boolean containsCondition = false;

// Beginning of query string
queryString += "SELECT * FROM BOOKS";

// Optional parts are added to query string and to args upon here

if(!authorName.isEmpty()){
    queryString += " WHERE";
    queryString += " author_name LIKE ?%";
    args.add(authorName);
    containsCondition = true;
}

if(fromDate!=null){
    
    if (containsCondition) {
        queryString += " AND";
    } else {
        queryString += " WHERE";
        containsCondition = true;
    }

    queryString += " publication_date AFTER ?";
    args.add(fromDate.getTime());
}

if(toDate!=null){
    
    if (containsCondition) {
        queryString += " AND";
    } else {
        queryString += " WHERE";
        containsCondition = true;
    }

    queryString += " publication_date BEFORE ?";
    args.add(toDate.getTime());
}

// End of query string
queryString += ";";

第 3 步：执行查询

SimpleSQLiteQuery query = new SimpleSQLiteQuery(queryString, args.toArray());
List<Book> result = booksDao.getBooks(query);

笔记

与正常一样Query， RawQuery支持返回原始游标、实体、POJO 和带有嵌入字段的 POJO
RawQuery支持关系

score 26 · Accepted Answer

根据我的经验（简短），使用 Room 是不可能的，并不是因为 Room 限制，而是正如 @CommonsWare 隐含评论的那样，是对 SQLite 的限制。你需要两个查询，因此在你的 DAO 中有两个方法。

我会做类似的事情：

@Query("SELECT * FROM playlist " +
    "WHERE playlist_title LIKE '% :playlistTitle %' " +
    "GROUP BY playlist_title " +
    "ORDER BY playlist_title " +
    "LIMIT :limit")
List<IPlaylist> searchPlaylists(String playlistTitle, int limit);

@Query("SELECT * FROM playlist " +
    "WHERE playlist_title LIKE '% :playlistTitle %' " +
    "GROUP BY playlist_title " +
    "ORDER BY playlist_title ")
List<IPlaylist> searchPlaylists(String playlistTitle);

然后在其他地方进行绕过：

if (limit.isPresent()) {
   return playlistDao.searchPlaylists(title, limit.get());
} else {
   return playlistDao.searchPlaylists(title);
}

这是我目前能想到的最佳选择。

score 17 · Accepted Answer

我没有编写多个查询，而是将负值传递给限制子句。因为如果查询发生变化，我必须更新这两个更容易出错的查询。

官方文档 ->如果 LIMIT 表达式的计算结果为负值，则返回的行数没有上限。你可以在这里找到它https://sqlite.org/lang_select.html并阅读限制条款部分。

所以我会做这样的事情，

@Query("SELECT * FROM playlist " +
    "WHERE playlist_title LIKE '% :playlistTitle %' " +
    "GROUP BY playlist_title " +
    "ORDER BY playlist_title " +
    "LIMIT :limit")
List<IPlaylist> searchPlaylists(String playlistTitle, int limit);

并在您不想应用过滤器时传递否定。

return playlistDao.searchPlaylists(title, limit.isPresent() ? limit.get() : -1)

它在我的情况下工作。

更新 [2018 年 12 月 21 日]

如果您使用的是 kotlin，请使用默认值。

@JvmOverloads
@Query("SELECT * FROM playlist " +
        "WHERE playlist_title LIKE '% :playlistTitle %' " +
        "GROUP BY playlist_title " +
        "ORDER BY playlist_title " +
        "LIMIT :limit")
fun searchPlaylists(playlistTitle: String, limit: Int = -1): List<IPlaylist>

@JvmOverloads使其与Java兼容。它为 Java 生成两个单独的方法。

score 7 · Accepted Answer

Room 中没有类似于可选参数的东西，但有一个 @RawQuery 注释，您可以在其中将查询作为字符串传递，以便您可以在运行时构建 SQL 查询。我认为这对你有用。

以下是官方文档中的示例：

@Dao
 interface RawDao {
     @RawQuery
     User getUser(String query);
 }

以下是如何使用它：

User user = rawDao.getUser("SELECT * FROM User WHERE id = 3 LIMIT 1");

重要提示： RawQuery 方法必须返回非 void 类型

重要提示：这在 Room 1.1.0-alpha3 中可用

score 7 · Accepted Answer

使用 SupportSQLiteQuery。

https://developer.android.com/reference/android/arch/persistence/db/SupportSQLiteQuery

最新版本 1.1.1 现在使用 SupportSQLiteQuery。

带有类型绑定的查询。最好使用此 API 而不是 rawQuery(String, String[])，因为它允许绑定类型安全参数。

@Dao
     interface RawDao {
         @RawQuery(observedEntities = User.class)
         LiveData<List<User>> getUsers(SupportSQLiteQuery query);
     }

用法：

     LiveData<List<User>> liveUsers = rawDao.getUsers( new 
SimpleSQLiteQuery("SELECT * FROM User ORDER BY name DESC"));

将您的 gradle 更新到 1.1.1

implementation 'android.arch.persistence.room:runtime:1.1.1'
implementation 'android.arch.lifecycle:extensions:1.1.1'
annotationProcessor "android.arch.persistence.room:compiler:1.1.1"

注意：如果您升级到 1.1.1，并且使用 String 而不是 SupportSQLiteQuery，

你会得到错误：

RawQuery 不再允许传递字符串。请使用 android.arch.persistence.db.SupportSQLiteQuery。

如上所述使用 SupportSQLiteQuery 将解决问题。

注意：确保您传入 SupportSQLiteQuery 查询参数，否则您将收到此错误：

RawQuery 方法应该有 1 个且只有 1 个类型为 String 或 SupportSQLiteQuery 的参数

score 4 · Accepted Answer

让它更简单。我将向您展示使用两个变量的 where 子句的示例。像这样做：

  @Query("SELECT * FROM Student WHERE stdName1= :myname AND stdId1=:myid")
List<Student> fetchAllData(String myname,int myid);

stdName1 和 stdId1 是列名

score 0 · Accepted Answer

对于 Kotlin-Room-ViewModel

@Query("SELECT * FROM schedule_info_table where schedule_month = :monthValue ORDER BY schedule_date_time ASC")
fun getThisMonthSchedules(monthValue: Int): Flow<List<SchedulesInformation>>

score 0 · Accepted Answer

  @Query("select * from task where state = :states and sentdate between :fromdate and :todate")
  List<Task> getFilterAll(String states, String fromdate, String todate);

这里我们需要使用列名状态。每当需要实现自定义查询时，只需将值通过参数从活动或片段传递到我们将在查询中应用的接口。就像上面代码中的例子（:fromdate, :todate）

结肠是必须的。您将在查询中使用哪个参数，我们将在以:符号开头之前提到。

score 0 · Accepted Answer

@Anderson K & @Juanky Soriano，我同意 @CommonsWare，

@query()Room Library 有一些限制，那么我们也可以使用Support SQLite Database对 Room Database 编写完全动态的查询

String mQuery = "SELECT * FROM foobar WHERE columnName1 IN ('value_1','value_2') and columnName2 In('value_3','value_4')";

AppDatabase appDatabase = Room.databaseBuilder(getApplicationContext(),
        AppDatabase.class, "database-name").build();

Cursor mCursor = AppDatabase.getAppDatabase(context).getOpenHelper().getReadableDatabase().query(myQuery);

现在您可以将游标行数据转换为您的 POJO 类。

score -2 · Accepted Answer

-2

根据文档不推荐使用原始查询

于 2021-01-11T13:15:52.790 回答

android - 如何在运行时动态查询房间数据库？

问题

用例

更复杂的用例

10 回答 10

第 1 步：制作 DAO 方法

第 2 步：构造查询

第 3 步：执行查询

笔记

Related

Reference