android - Android Room - 简单的选择查询 - 无法访问主线程上的数据库

Question

我正在尝试使用Room Persistence Library的示例。我创建了一个实体：

@Entity
public class Agent {
    @PrimaryKey
    public String guid;
    public String name;
    public String email;
    public String password;
    public String phone;
    public String licence;
}

创建了一个 DAO 类：

@Dao
public interface AgentDao {
    @Query("SELECT COUNT(*) FROM Agent where email = :email OR phone = :phone OR licence = :licence")
    int agentsCount(String email, String phone, String licence);

    @Insert
    void insertAgent(Agent agent);
}

创建数据库类：

@Database(entities = {Agent.class}, version = 1)
public abstract class AppDatabase extends RoomDatabase {
    public abstract AgentDao agentDao();
}

在 Kotlin 中使用以下子类公开数据库：

class MyApp : Application() {

    companion object DatabaseSetup {
        var database: AppDatabase? = null
    }

    override fun onCreate() {
        super.onCreate()
        MyApp.database =  Room.databaseBuilder(this, AppDatabase::class.java, "MyDatabase").build()
    }
}

在我的活动中实现了以下功能：

void signUpAction(View view) {
        String email = editTextEmail.getText().toString();
        String phone = editTextPhone.getText().toString();
        String license = editTextLicence.getText().toString();

        AgentDao agentDao = MyApp.DatabaseSetup.getDatabase().agentDao();
        //1: Check if agent already exists
        int agentsCount = agentDao.agentsCount(email, phone, license);
        if (agentsCount > 0) {
            //2: If it already exists then prompt user
            Toast.makeText(this, "Agent already exists!", Toast.LENGTH_LONG).show();
        }
        else {
            Toast.makeText(this, "Agent does not exist! Hurray :)", Toast.LENGTH_LONG).show();
            onBackPressed();
        }
    }

不幸的是，在执行上述方法时，它会因以下堆栈跟踪而崩溃：

    FATAL EXCEPTION: main
 Process: com.example.me.MyApp, PID: 31592
java.lang.IllegalStateException: Could not execute method for android:onClick
    at android.support.v7.app.AppCompatViewInflater$DeclaredOnClickListener.onClick(AppCompatViewInflater.java:293)
    at android.view.View.performClick(View.java:5612)
    at android.view.View$PerformClick.run(View.java:22288)
    at android.os.Handler.handleCallback(Handler.java:751)
    at android.os.Handler.dispatchMessage(Handler.java:95)
    at android.os.Looper.loop(Looper.java:154)
    at android.app.ActivityThread.main(ActivityThread.java:6123)
    at java.lang.reflect.Method.invoke(Native Method)
    at com.android.internal.os.ZygoteInit$MethodAndArgsCaller.run(ZygoteInit.java:867)
    at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:757)
 Caused by: java.lang.reflect.InvocationTargetException
    at java.lang.reflect.Method.invoke(Native Method)
    at android.support.v7.app.AppCompatViewInflater$DeclaredOnClickListener.onClick(AppCompatViewInflater.java:288)
    at android.view.View.performClick(View.java:5612) 
    at android.view.View$PerformClick.run(View.java:22288) 
    at android.os.Handler.handleCallback(Handler.java:751) 
    at android.os.Handler.dispatchMessage(Handler.java:95) 
    at android.os.Looper.loop(Looper.java:154) 
    at android.app.ActivityThread.main(ActivityThread.java:6123) 
    at java.lang.reflect.Method.invoke(Native Method) 
    at com.android.internal.os.ZygoteInit$MethodAndArgsCaller.run(ZygoteInit.java:867) 
    at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:757) 
 Caused by: java.lang.IllegalStateException: Cannot access database on the main thread since it may potentially lock the UI for a long periods of time.
    at android.arch.persistence.room.RoomDatabase.assertNotMainThread(RoomDatabase.java:137)
    at android.arch.persistence.room.RoomDatabase.query(RoomDatabase.java:165)
    at com.example.me.MyApp.RoomDb.Dao.AgentDao_Impl.agentsCount(AgentDao_Impl.java:94)
    at com.example.me.MyApp.View.SignUpActivity.signUpAction(SignUpActivity.java:58)
    at java.lang.reflect.Method.invoke(Native Method) 
    at android.support.v7.app.AppCompatViewInflater$DeclaredOnClickListener.onClick(AppCompatViewInflater.java:288) 
    at android.view.View.performClick(View.java:5612) 
    at android.view.View$PerformClick.run(View.java:22288) 
    at android.os.Handler.handleCallback(Handler.java:751) 
    at android.os.Handler.dispatchMessage(Handler.java:95) 
    at android.os.Looper.loop(Looper.java:154) 
    at android.app.ActivityThread.main(ActivityThread.java:6123) 
    at java.lang.reflect.Method.invoke(Native Method) 
    at com.android.internal.os.ZygoteInit$MethodAndArgsCaller.run(ZygoteInit.java:867) 
    at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:757)

似乎该问题与在主线程上执行 db 操作有关。但是，上面链接中提供的示例测试代码不在单独的线程上运行：

@Test
    public void writeUserAndReadInList() throws Exception {
        User user = TestUtil.createUser(3);
        user.setName("george");
        mUserDao.insert(user);
        List<User> byName = mUserDao.findUsersByName("george");
        assertThat(byName.get(0), equalTo(user));
    }

我在这里有什么遗漏吗？我怎样才能让它在没有崩溃的情况下执行？请建议。

score 201 · Accepted Answer

不推荐，但您可以访问主线程上的数据库allowMainThreadQueries()

MyApp.database =  Room.databaseBuilder(this, AppDatabase::class.java, "MyDatabase").allowMainThreadQueries().build()

score 73 · Accepted Answer

Kotlin 协程（清晰简洁）

AsyncTask 真的很笨重。协程是一种更简洁的替代方案（只需添加几个关键字，您的同步代码就会变得异步）。

// Step 1: add `suspend` to your fun
suspend fun roomFun(...): Int
suspend fun notRoomFun(...) = withContext(Dispatchers.IO) { ... }

// Step 2: launch from coroutine scope
private fun myFun() {
    lifecycleScope.launch { // coroutine on Main
        val queryResult = roomFun(...) // coroutine on IO
        doStuff() // ...back on Main
    }
}

依赖项（为 arch 组件添加协程范围）：

// lifecycleScope:
implementation 'androidx.lifecycle:lifecycle-runtime-ktx:2.2.0-alpha04'

// viewModelScope:
implementation 'androidx.lifecycle:lifecycle-viewmodel-ktx:2.2.0-alpha04'

-- 更新：
2019 年 5 月 8 日： Room 2.1现在支持suspend
2019 年 9 月 13 日：更新为使用架构组件范围

score 71 · Accepted Answer

就像 Dale 说的那样，锁定 UI 的主线程上的数据库访问是错误的。

--编辑2--

由于很多人可能会遇到这个答案......现在最好的选择，一般来说，是 Kotlin Coroutines。Room 现在直接支持它（目前处于测试阶段）。 https://kotlinlang.org/docs/reference/coroutines-overview.html https://developer.android.com/jetpack/androidx/releases/room#2.1.0-beta01

--编辑1--

对于想知道的人...您还有其他选择。我建议查看新的 ViewModel 和 LiveData 组件。LiveData 与 Room 配合得很好。 https://developer.android.com/topic/libraries/architecture/livedata.html

另一个选择是 RxJava/RxAndroid。比 LiveData 更强大但更复杂。 https://github.com/ReactiveX/RxJava

--原答案--

在扩展 AsyncTask 的 Activity 中创建一个静态嵌套类（以防止内存泄漏）。

private static class AgentAsyncTask extends AsyncTask<Void, Void, Integer> {

    //Prevent leak
    private WeakReference<Activity> weakActivity;
    private String email;
    private String phone;
    private String license;

    public AgentAsyncTask(Activity activity, String email, String phone, String license) {
        weakActivity = new WeakReference<>(activity);
        this.email = email;
        this.phone = phone;
        this.license = license;
    }

    @Override
    protected Integer doInBackground(Void... params) {
        AgentDao agentDao = MyApp.DatabaseSetup.getDatabase().agentDao();
        return agentDao.agentsCount(email, phone, license);
    }

    @Override
    protected void onPostExecute(Integer agentsCount) {
        Activity activity = weakActivity.get();
        if(activity == null) {
            return;
        }

        if (agentsCount > 0) {
            //2: If it already exists then prompt user
            Toast.makeText(activity, "Agent already exists!", Toast.LENGTH_LONG).show();
        } else {
            Toast.makeText(activity, "Agent does not exist! Hurray :)", Toast.LENGTH_LONG).show();
            activity.onBackPressed();
        }
    }
}

或者您可以在自己的文件上创建最终类。

然后在signUpAction(View view)方法中执行：

new AgentAsyncTask(this, email, phone, license).execute();

在某些情况下，您可能还希望在 Activity 中保留对 AgentAsyncTask 的引用，以便在 Activity 被销毁时取消它。但是您必须自己中断任何交易。

另外，您对 Google 测试示例的问题......他们在该网页中声明：

测试数据库实现的推荐方法是编写在 Android 设备上运行的 JUnit 测试。因为这些测试不需要创建活动，所以它们应该比你的 UI 测试更快地执行。

没有活动，没有用户界面。

score 51 · Accepted Answer

对于所有RxJava或RxAndroid或RxKotlin爱好者

Observable.just(db)
          .subscribeOn(Schedulers.io())
          .subscribe { db -> // database operation }

score 34 · Accepted Answer

您不能在主线程上运行它，而是使用处理程序、异步或工作线程。此处提供示例代码，并在此处阅读有关房间库的文章： Android 的房间库

/**
 *  Insert and get data using Database Async way
 */
AsyncTask.execute(new Runnable() {
    @Override
    public void run() {
        // Insert Data
        AppDatabase.getInstance(context).userDao().insert(new User(1,"James","Mathew"));

        // Get Data
        AppDatabase.getInstance(context).userDao().getAllUsers();
    }
});

如果您想在不是首选方式的主线程上运行它。

您可以使用此方法在主线程上实现Room.inMemoryDatabaseBuilder()

score 25 · Accepted Answer

25

使用 lambda 很容易使用 AsyncTask 运行

 AsyncTask.execute(() -> //run your query here );

于 2019-03-14T01:43:30.583 回答

score 16 · Accepted Answer

只需在单独的线程中执行数据库操作。像这样（科特林）：

Thread {
   //Do your database´s operations here
}.start()

score 13 · Accepted Answer

借助 Jetbrains Anko 库，您可以使用 doAsync{..} 方法自动执行数据库调用。这可以解决您在 mcastro 的答案中似乎遇到的冗长问题。

示例用法：

    doAsync { 
        Application.database.myDAO().insertUser(user) 
    }

我经常将它用于插入和更新，但是对于选择查询，我建议使用 RX 工作流程。

score 12 · Accepted Answer

只需您可以使用此代码来解决它：

Executors.newSingleThreadExecutor().execute(new Runnable() {
                    @Override
                    public void run() {
                        appDb.daoAccess().someJobes();//replace with your code
                    }
                });

或者在 lambda 中，您可以使用以下代码：

Executors.newSingleThreadExecutor().execute(() -> appDb.daoAccess().someJobes());

您可以appDb.daoAccess().someJobes()用自己的代码替换；

score 8 · Accepted Answer

您必须在后台执行请求。一种简单的方法是使用Executors：

Executors.newSingleThreadExecutor().execute { 
   yourDb.yourDao.yourRequest() //Replace this by your request
}

score 8 · Accepted Answer

由于不推荐使用 asyncTask，我们可以使用 executor 服务。或者，您也可以将 ViewModel 与LiveData一起使用，如其他答案中所述。

要使用 executor 服务，您可以使用如下所示的内容。

public class DbHelper {

    private final Executor executor = Executors.newSingleThreadExecutor();

    public void fetchData(DataFetchListener dataListener){
        executor.execute(() -> {
                Object object = retrieveAgent(agentId);
                new Handler(Looper.getMainLooper()).post(() -> {
                        dataListener.onFetchDataSuccess(object);
                });
        });
    }
}

使用 Main Looper，以便您可以从onFetchDataSuccess回调中访问 UI 元素。

score 5 · Accepted Answer

对于快速查询，您可以留出空间在 UI 线程上执行它。

AppDatabase db = Room.databaseBuilder(context.getApplicationContext(),
        AppDatabase.class, DATABASE_NAME).allowMainThreadQueries().build();

就我而言，我必须弄清楚列表中单击的用户是否存在于数据库中。如果没有，则创建用户并开始另一个活动

       @Override
        public void onClick(View view) {



            int position = getAdapterPosition();

            User user = new User();
            String name = getName(position);
            user.setName(name);

            AppDatabase appDatabase = DatabaseCreator.getInstance(mContext).getDatabase();
            UserDao userDao = appDatabase.getUserDao();
            ArrayList<User> users = new ArrayList<User>();
            users.add(user);
            List<Long> ids = userDao.insertAll(users);

            Long id = ids.get(0);
            if(id == -1)
            {
                user = userDao.getUser(name);
                user.setId(user.getId());
            }
            else
            {
                user.setId(id);
            }

            Intent intent = new Intent(mContext, ChatActivity.class);
            intent.putExtra(ChatActivity.EXTRAS_USER, Parcels.wrap(user));
            mContext.startActivity(intent);
        }
    }

score 5 · Accepted Answer

一个优雅的 RxJava/Kotlin 解决方案是使用Completable.fromCallable，它会给你一个 Observable ，它不返回值，但可以在不同的线程上观察和订阅。

public Completable insert(Event event) {
    return Completable.fromCallable(new Callable<Void>() {
        @Override
        public Void call() throws Exception {
            return database.eventDao().insert(event)
        }
    }
}

或者在 Kotlin 中：

fun insert(event: Event) : Completable = Completable.fromCallable {
    database.eventDao().insert(event)
}

您可以像往常一样观察和订阅：

dataManager.insert(event)
    .subscribeOn(scheduler)
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe(...)

score 5 · Accepted Answer

您可以允许在主线程上访问数据库，但仅用于调试目的，您不应在生产环境中执行此操作。

这就是原因。

注意：Room 不支持在主线程上访问数据库，除非您在构建器上调用了 allowMainThreadQueries()，因为它可能会长时间锁定 UI。异步查询（返回 LiveData 或 Flowable 实例的查询）不受此规则的约束，因为它们会在需要时在后台线程上异步运行查询。

score 3 · Accepted Answer

错误信息，

无法访问主线程上的数据库，因为它可能会长时间锁定 UI。

描述得非常准确和准确。问题是您应该如何避免在主线程上访问数据库。这是一个巨大的话题，但要开始，请阅读AsyncTask（单击此处）

- - -编辑 - - - - -

我看到您在运行单元测试时遇到问题。你有几个选择来解决这个问题：

直接在开发机器上而不是在 Android 设备（或模拟器）上运行测试。这适用于以数据库为中心并且并不真正关心它们是否在设备上运行的测试。
使用注解 @RunWith(AndroidJUnit4.class) 在 android 设备上运行测试，但不能在带有 UI 的 Activity 中运行。可以在本教程中找到有关此的更多详细信息

score 3 · Accepted Answer

更新：当我尝试在 DAO 中使用 @RawQuery 和 SupportSQLiteQuery 构建查询时，我也收到了此消息。

@Transaction
public LiveData<List<MyEntity>> getList(MySettings mySettings) {
    //return getMyList(); -->this is ok

    return getMyList(new SimpleSQLiteQuery("select * from mytable")); --> this is an error

解决方案：在 ViewModel 中构建查询并将其传递给 DAO。

public MyViewModel(Application application) {
...
        list = Transformations.switchMap(searchParams, params -> {

            StringBuilder sql;
            sql = new StringBuilder("select  ... ");

            return appDatabase.rawDao().getList(new SimpleSQLiteQuery(sql.toString()));

        });
    }

或者...

您不应该直接在主线程上访问数据库，例如：

 public void add(MyEntity item) {
     appDatabase.myDao().add(item); 
 }

您应该使用 AsyncTask 进行更新、添加和删除操作。

例子：

public class MyViewModel extends AndroidViewModel {

    private LiveData<List<MyEntity>> list;

    private AppDatabase appDatabase;

    public MyViewModel(Application application) {
        super(application);

        appDatabase = AppDatabase.getDatabase(this.getApplication());
        list = appDatabase.myDao().getItems();
    }

    public LiveData<List<MyEntity>> getItems() {
        return list;
    }

    public void delete(Obj item) {
        new deleteAsyncTask(appDatabase).execute(item);
    }

    private static class deleteAsyncTask extends AsyncTask<MyEntity, Void, Void> {

        private AppDatabase db;

        deleteAsyncTask(AppDatabase appDatabase) {
            db = appDatabase;
        }

        @Override
        protected Void doInBackground(final MyEntity... params) {
            db.myDao().delete((params[0]));
            return null;
        }
    }

    public void add(final MyEntity item) {
        new addAsyncTask(appDatabase).execute(item);
    }

    private static class addAsyncTask extends AsyncTask<MyEntity, Void, Void> {

        private AppDatabase db;

        addAsyncTask(AppDatabase appDatabase) {
            db = appDatabase;
        }

        @Override
        protected Void doInBackground(final MyEntity... params) {
            db.myDao().add((params[0]));
            return null;
        }

    }
}

如果使用 LiveData 进行选择操作，则不需要 AsyncTask。

score 3 · Accepted Answer

如果您对Async 任务更满意：

  new AsyncTask<Void, Void, Integer>() {
                @Override
                protected Integer doInBackground(Void... voids) {
                    return Room.databaseBuilder(getApplicationContext(),
                            AppDatabase.class, DATABASE_NAME)
                            .fallbackToDestructiveMigration()
                            .build()
                            .getRecordingDAO()
                            .getAll()
                            .size();
                }

                @Override
                protected void onPostExecute(Integer integer) {
                    super.onPostExecute(integer);
                    Toast.makeText(HomeActivity.this, "Found " + integer, Toast.LENGTH_LONG).show();
                }
            }.execute();

score 2 · Accepted Answer

您可以使用 Future 和 Callable。因此，您不需要编写长的异步任务，并且可以在不添加 allowMainThreadQueries() 的情况下执行查询。

我的道查询：-

@Query("SELECT * from user_data_table where SNO = 1")
UserData getDefaultData();

我的存储库方法：-

public UserData getDefaultData() throws ExecutionException, InterruptedException {

    Callable<UserData> callable = new Callable<UserData>() {
        @Override
        public UserData call() throws Exception {
            return userDao.getDefaultData();
        }
    };

    Future<UserData> future = Executors.newSingleThreadExecutor().submit(callable);

    return future.get();
}

score 1 · Accepted Answer

添加.allowMainThreadQueries()数据库文件

@Database(entities = [Country::class], version = 1)
abstract class CountryDatabase: RoomDatabase() {
    abstract fun getCountryDao(): CountryDao
    companion object {
        @Volatile
        private var instance: CountryDatabase? = null
        private val LOCK = Any()

        operator fun invoke(context: Context) = instance ?:
        synchronized(LOCK) {
            instance ?:
            createDatabase(context).also { instance = it }
        }
        private fun createDatabase(context: Context) =
            Room.databaseBuilder(
                context.applicationContext,
                CountryDatabase::class.java,
                "country_db"
            ).allowMainThreadQueries()
             .build()
    }
}

score 0 · Accepted Answer

在我看来，正确的做法是将查询委托给使用 RxJava 的 IO 线程。

我有一个解决我刚刚遇到的等效问题的示例。

((ProgressBar) view.findViewById(R.id.progressBar_home)).setVisibility(View.VISIBLE);//Always good to set some good feedback
        Completable.fromAction(() -> {
            //Creating view model requires DB access
            homeViewModel = new ViewModelProvider(this, factory).get(HomeViewModel.class);
        }).subscribeOn(Schedulers.io())//The DB access executes on a non-main-thread thread
        .observeOn(AndroidSchedulers.mainThread())//Upon completion of the DB-involved execution, the continuation runs on the main thread
        .subscribe(
                () ->
                {
                    mAdapter = new MyAdapter(homeViewModel.getExams());
                    recyclerView.setAdapter(mAdapter);
                    ((ProgressBar) view.findViewById(R.id.progressBar_home)).setVisibility(View.INVISIBLE);
                },
                error -> error.printStackTrace()
        );

如果我们想推广解决方案：

((ProgressBar) view.findViewById(R.id.progressBar_home)).setVisibility(View.VISIBLE);//Always good to set some good feedback
        Completable.fromAction(() -> {
            someTaskThatTakesTooMuchTime();
        }).subscribeOn(Schedulers.io())//The long task executes on a non-main-thread thread
        .observeOn(AndroidSchedulers.mainThread())//Upon completion of the DB-involved execution, the continuation runs on the main thread
        .subscribe(
                () ->
                {
                    taskIWantToDoOnTheMainThreadWhenTheLongTaskIsDone();
                },
                error -> error.printStackTrace()
        );

score 0 · Accepted Answer

0

Dispatchers.IO像这样在流的末尾添加：

flow { ... }.flowOn(Dispatchers.IO)

于 2021-11-16T23:28:51.483 回答

score 0 · Accepted Answer

Room Database 不允许您在主线程中执行数据库 IO 操作（后台操作），除非您allowMainThreadQueries()与数据库构建器一起使用。但这是一个不好的方法。

推荐方法：
这里我使用了我当前项目中的一些代码。

在存储库中的方法之前添加suspend关键字

class FavRepository @Inject constructor(private val dao: WallpaperDao) {
    suspend fun getWallpapers(): List<Wallpaper> =  dao.getWallpapers()
}

在您的viewmodel课堂上，您首先需要使用 Coroutine Dispature IO 执行数据库操作，以从房间数据库中获取数据。然后使用 Coroutine Dispature MAIN 更新您的值。

@HiltViewModel
class FavViewModel @Inject constructor(repo: FavRepository, @ApplicationContext context: Context) : ViewModel() {
    var favData = MutableLiveData<List<Wallpaper>>()
    init {
        viewModelScope.launch(Dispatchers.IO){
            val favTmpData: List<Wallpaper> = repo.getWallpapers()
            withContext(Dispatchers.Main){
                favData.value = favTmpData
            }
        }
    }
}

现在您通过从 Activity/Fragment 观察来使用您的视图模型的数据。

希望这对你有帮助:)。

android - Android Room - 简单的选择查询 - 无法访问主线程上的数据库

22 回答 22

Kotlin 协程（清晰简洁）

Related

Reference