进行单元测试时无法将值设置为 MutableLiveData - 抛出 java.lang.reflect.InvocationTargetException

Question

我有一个 User class 有一个生成器，这个 class 的构造函数是私有的。

public class User {

    private String name;

    private User() {
    }

    public static class UserBuilder {
        private User user;

        public UserBuilder() {
            user = new User();
        }

        public UserBuilder withName(String name) {
            user.name = name;
            return this;
        }

        public User build() {
            return user;
        }
    }
}

然后我想要一个 ViewModel class，我想要一个 MutableLiveData for User class 从我的 activity/fragment。

public class UserViewModel extends ViewModel {

    private User.UserBuilder userBuilder;
    private MutableLiveData<User> user;

    public UserViewModel() {
        userBuilder = new User.UserBuilder();
        user = new MutableLiveData<>(userBuilder.build());
    }

    public void setName(String name) {
        userBuilder.withName(name);
        user.setValue(userBuilder.build());
    }

    public MutableLiveData<User> getUser() {
        user.setValue(userBuilder.build());
        return user;
    }
}

在上面的实现中，我发现它在从我的单元测试中调用 setValue 函数时抛出 NullPointerException 后跟 InvocationTargetException 。

我搜索了原因，看起来 User class 需要一个 public 构造函数才能与 MutableLiveData 一起使用。然而，事实并非如此，我尝试制作一个 public 构造函数，但它仍然失败。

我正在尝试编写一些单元测试，但在 logcat 中出现以下错误。请注意，我正在使用以下内容来解决我认为的 mainThread 错误。

@Rule
public InstantTaskExecutorRule instantTaskExecutorRule = new InstantTaskExecutorRule();

这是我在单元测试中尝试做的事情。

@RunWith(MockitoJUnitRunner.class)
public class UserViewModelTest {

    private UserViewModel userViewModel;

    @Mock
    private Observer<User> userObserver;

    @Rule
    public InstantTaskExecutorRule instantTaskExecutorRule = new InstantTaskExecutorRule();

    @Before
    public void setup() {
        initMocks(this);
        userViewModel = new userViewModel();
        userViewModel.getUser().observeForever(userObserver);
    }
}

异常出现在下一行。

user.setValue(userBuilder.build());

这里是 logcat.

java.lang.NullPointerException
    at androidx.arch.core.executor.DefaultTaskExecutor.isMainThread(DefaultTaskExecutor.java:77)
    at androidx.arch.core.executor.ArchTaskExecutor.isMainThread(ArchTaskExecutor.java:116)
    at androidx.lifecycle.LiveData.assertMainThread(LiveData.java:460)
    at androidx.lifecycle.LiveData.setValue(LiveData.java:304)
    at androidx.lifecycle.MutableLiveData.setValue(MutableLiveData.java:50)
    at com.example.viewmodel.UserViewModel.getUser(UserViewModel.java:79)
    at com.example.viewmodels.UserViewModelTest.setup(UserViewModelTest.java:66)
    at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
    at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
    at java.lang.reflect.Method.invoke(Method.java:498)
    at org.junit.runners.model.FrameworkMethod.runReflectiveCall(FrameworkMethod.java:50)
    at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12)
    at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:47)
    at org.junit.internal.runners.statements.RunBefores.evaluate(RunBefores.java:24)
    at org.mockito.internal.runners.DefaultInternalRunner.evaluate(DefaultInternalRunner.java:44)
    at org.junit.rules.TestWatcher.evaluate(TestWatcher.java:55)
    at org.junit.rules.RunRules.evaluate(RunRules.java:20)
    at org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:325)
    at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:78)
    at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:57)
    at org.junit.runners.ParentRunner.run(ParentRunner.java:290)
    at org.junit.runners.ParentRunner.schedule(ParentRunner.java:71)
    at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288)
    at org.junit.runners.ParentRunner.access[=16=]0(ParentRunner.java:58)
    at org.junit.runners.ParentRunner.evaluate(ParentRunner.java:268)
    at org.junit.runners.ParentRunner.run(ParentRunner.java:363)
    at org.mockito.internal.runners.DefaultInternalRunner.run(DefaultInternalRunner.java:74)
    at org.mockito.internal.runners.DefaultInternalRunner.run(DefaultInternalRunner.java:80)
    at org.mockito.internal.runners.StrictRunner.run(StrictRunner.java:39)
    at org.mockito.junit.MockitoJUnitRunner.run(MockitoJUnitRunner.java:163)
    at org.junit.runners.Suite.runChild(Suite.java:128)
    at org.junit.runners.Suite.runChild(Suite.java:27)
    at org.junit.runners.ParentRunner.run(ParentRunner.java:290)
    at org.junit.runners.ParentRunner.schedule(ParentRunner.java:71)
    at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288)
    at org.junit.runners.ParentRunner.access[=16=]0(ParentRunner.java:58)
    at org.junit.runners.ParentRunner.evaluate(ParentRunner.java:268)
    at org.junit.runners.ParentRunner.run(ParentRunner.java:363)
    at org.junit.runner.JUnitCore.run(JUnitCore.java:137)
    at com.intellij.junit4.JUnit4IdeaTestRunner.startRunnerWithArgs(JUnit4IdeaTestRunner.java:68)
    at com.intellij.rt.execution.junit.IdeaTestRunner$Repeater.startRunnerWithArgs(IdeaTestRunner.java:47)
    at com.intellij.rt.execution.junit.JUnitStarter.prepareStreamsAndStart(JUnitStarter.java:242)
    at com.intellij.rt.execution.junit.JUnitStarter.main(JUnitStarter.java:70)

提前致谢！

Answer 1

我终于明白是什么导致了异常。看起来当 Observer 设置为 ViewModel 时需要一些时间来初始化，与此同时，如果我们尝试 setValue 到 LiveData，它会抛出NullPointerException 因为 ViewModel 还没有初始化。这是测试环境设置的问题，正如@CommonsWare 在本问题前面的评论中所建议的那样。我真的很感激，因为它让我找到了一种摆脱异常的方法。

我决定用 Kotlin 编写单元测试，因为使用 lateinit 变量更容易。我找到了一个很好的tutorial here。我在这里发布了测试 ViewModel 的相关代码。

首先创建一个名为 MockUtils.kt 的助手 class。

import org.mockito.Mockito

/**
 * Helper function to mock classes with types (generics)
 */
inline fun <reified T> mock(): T = Mockito.mock(T::class.java)

最后，测试 class 应该如下所示。

class UserViewModelTest {

    @get:Rule
    val rule = InstantTaskExecutorRule()

    private lateinit var viewModel: UserViewModel

    private val observer: Observer<User> = mock()

    @Before
    fun before() {
        viewModel = UserViewModel()
        viewModel.user.observeForever(observer)
    }

    @Test
    fun testUserViewModel() {
        val expectedUser = viewModel.user.value
        viewModel.setName("John")

        val captor = ArgumentCaptor.forClass(User::class.java)
        captor.run {
            verify(observer, times(2)).onChanged(capture())
            assertNotNull(expectedUser)
            assertEquals("John", value.name)
        }
    }
}

在摆脱异常的方式中，我不得不修复另一个问题。如果我在这里提到这一点，我认为它会对其他开发人员有所帮助。

我错误地使用了 InstantTaskExecutorRule 和 LiveData 的不同版本。你可以查看tweet from Jeroen Mols here。我有同样的问题。 LiveData 是从 androidx 包导入的，而 InstantTaskExecutorRule 是使用 android 包导入的 - 必须按如下方式修复。

implementation "androidx.lifecycle:lifecycle-viewmodel:2.1.0"
implementation "androidx.lifecycle:lifecycle-livedata:2.1.0"
implementation "androidx.lifecycle:lifecycle-extensions:2.1.0"
testImplementation "androidx.arch.core:core-testing:2.1.0"

我根据这个问题用简单的 classes 创建了一个 Github repository，这样任何人都可以使用自己的开发环境检查和运行单元测试。编码愉快！

进行单元测试时无法将值设置为 MutableLiveData - 抛出 java.lang.reflect.InvocationTargetException

Cannot setValue to a MutableLiveData while doing Unit Test - throwing java.lang.reflect.InvocationTargetException

java

android

unit-testing

android-livedata

android-viewmodel