本篇跟 Android UiAutomator 自动化测试相关,涉及到 waitForIdle 这个方法。从名字上来看,它的作用是等待空闲,通常用来等待界面上没有变化时使用。但它真的能监测到 idle 状态吗,今天就解读一下它的源码
这个方法是从 UiDevice 暴露出来供测试代码调用的,通过查看调用关系,最终实现是在 framework 层的 UiAutomation 中
// UiAutomation
void waitForIdle(long idleTimeoutMillis, long globalTimeoutMillis)
该方法包含 2 个参数,都是超时时间,具体看看代码逻辑推断它们的作用
final long startTimeMillis = SystemClock.uptimeMillis();
if (mLastEventTimeMillis <= 0) {
mLastEventTimeMillis = startTimeMillis;
}
while (true) {
final long currentTimeMillis = SystemClock.uptimeMillis();
final long elapsedGlobalTimeMillis = currentTimeMillis - startTimeMillis;
final long remainingGlobalTimeMillis =
globalTimeoutMillis - elapsedGlobalTimeMillis;
if (remainingGlobalTimeMillis <= 0) {
throw new TimeoutException("No idle state with idle timeout: "
+ idleTimeoutMillis + " within global timeout: "
+ globalTimeoutMillis);
}
final long elapsedIdleTimeMillis = currentTimeMillis - mLastEventTimeMillis;
final long remainingIdleTimeMillis = idleTimeoutMillis - elapsedIdleTimeMillis;
if (remainingIdleTimeMillis <= 0) {
return;
}
try {
mLock.wait(remainingIdleTimeMillis);
} catch (InterruptedException ie) {
/* ignore */
}
}
这段代码中关于时间的变量较多,一个个看
mLastEventTimeMillis 是一个成员变量,它在 onAccessibilityEvent 回调中得到赋值
// UiAutomation$ IAccessibilityServiceClientImpl# onAccessibilityEvent
mLastEventTimeMillis = event.getEventTime();
记录的是当前收到的 AccessibilityEvent 事件时间,如果事件时间无效(mLastEventTimeMillis <= 0),在 waitForIdle 方法中就会记录为当前代码被执行时的系统时间
回到 waitForIdle 方法体中,当 remainingGlobalTimeMillis <= 0 时会抛出一个异常,说的是没有 idle 状态,说明 remainingGlobalTimeMillis 是用来表示监测 idle 超时的变量,因此 globalTimeoutMillis 是设定的监测超时时长
当 remainingIdleTimeMillis <= 0 时,方法直接 return 了,说明监测到了 idle 状态,因此只要该变量不大于 0,说明当前就是界面空闲的
lapsedIdleTimeMillis 表示距离上一次收到 AccessibilityEvent 事件过去了多长时间,假如密集地收到该事件,则 currentTimeMillis - mLastEventTimeMillis 就可能始终是个负值,那么 remainingIdleTimeMillis > 0 就始终不是 idle 状态,后续就会触发到监测 idle 超时
而如果某个时候不再收到该事件了,那么 currentTimeMillis - mLastEventTimeMillis 足够大,并且超过 idleTimeoutMillis (注:这个值在 UiAutomator 中写定为 500ms)时,remainingIdleTimeMillis <= 0 就会发生
因此,wait for Idle 是否真的能够准确监测到 idle 的关键是 AccessibilityEvent 事件是如何产生的。这里主要看看该事件有哪些类型
- TYPE_VIEW_CLICKED
- TYPE_VIEW_LONG_CLICKED
- TYPE_VIEW_SELECTED
- TYPE_VIEW_FOCUSED
- TYPE_VIEW_TEXT_CHANGED
- TYPE_WINDOW_STATE_CHANGED
- TYPE_NOTIFICATION_STATE_CHANGED
- TYPE_VIEW_HOVER_ENTER
- TYPE_VIEW_HOVER_EXIT
- TYPE_TOUCH_EXPLORATION_GESTURE_START
- TYPE_TOUCH_EXPLORATION_GESTURE_END
- TYPE_WINDOW_CONTENT_CHANGED
- TYPE_VIEW_SCROLLED
- TYPE_VIEW_TEXT_SELECTION_CHANGED
- TYPE_ANNOUNCEMENT
- TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY
- TYPE_GESTURE_DETECTION_START
- TYPE_GESTURE_DETECTION_END
- TYPE_TOUCH_INTERACTION_START
- TYPE_TOUCH_INTERACTION_END
- TYPE_WINDOWS_CHANGED
- TYPE_VIEW_CONTEXT_CLICKED
捡几个熟悉的说,当 view 被点击,被选取,被滚动,或者文字内容发生变化等的情况下,就会发送 AccessibilityEvent 事件,也即此时不是 idle 状态。所以这个方法里体现的 idle,说的也正是界面的静止状态
总结一下,当在 UiAutomator 中使用 UiDevice# waitForIdle 时,表示在超时时间内会阻塞直到界面静止下来