Sean's Note: 6月 2016

2016年6月24日 星期五

Touch Event 的機制

Android 在處理 touch event 的傳遞可以分 ViewGroup 跟 View 來看,
兩者皆都透過 dispatchTouchEvent() 來傳遞事件,而 ViewGroup 會先交由 onInterceptTouchEvent() 來做處理(line 1960),預設是 return false 不做處理(可以透過繼承來改寫),找到第一個可視的 child 後,再呼叫 dispatchTransformedTouchEvent() (line 2049)。

 // ViewGroup.java Click here for full source.
1928  @Override
1929  public boolean dispatchTouchEvent(MotionEvent ev) {
1930      if ( != null) {
1931          .onTouchEvent(ev, 1);
1932      }
1934      // If the event targets the accessibility focused view and this is it, start
1935      // normal event dispatch. Maybe a descendant is what will handle the click.
1936      if (ev.isTargetAccessibilityFocus() && isAccessibilityFocusedViewOrHost()) {
1937          ev.setTargetAccessibilityFocus(false);
1938      }
1940      boolean handled = false;
1941      if (onFilterTouchEventForSecurity(ev)) {
1942          final int action = ev.getAction();
1943          final int actionMasked = action & .;
1945          // Handle an initial down.
1946          if (actionMasked == .) {
1947              // Throw away all previous state when starting a new touch gesture.
1948              // The framework may have dropped the up or cancel event for the previous gesture
1949              // due to an app switch, ANR, or some other state change.
1950              cancelAndClearTouchTargets(ev);
1951              resetTouchState();
1952          }
1954          // Check for interception.
1955          final boolean intercepted;
1956          if (actionMasked == .
1957                  ||  != null) {
1958              final boolean disallowIntercept = ( & ) != 0;
1959              if (!disallowIntercept) {
1960                  intercepted = onInterceptTouchEvent(ev);
1961                  ev.setAction(action); // restore action in case it was changed
1962              } else {
1963                  intercepted = false;
1964              }
1965          } else {
1966              // There are no touch targets and this action is not an initial down
1967              // so this view group continues to intercept touches.
1968              intercepted = true;
1969          }
1971          // If intercepted, start normal event dispatch. Also if there is already
1972          // a view that is handling the gesture, do normal event dispatch.
1973          if (intercepted ||  != null) {
1974              ev.setTargetAccessibilityFocus(false);
1975          }
1977          // Check for cancelation.
1978          final boolean canceled = resetCancelNextUpFlag(this)
1979                  || actionMasked == .;
1981          // Update list of touch targets for pointer down, if needed.
1982          final boolean split = ( & ) != 0;
1983          TouchTarget newTouchTarget = null;
1984          boolean alreadyDispatchedToNewTouchTarget = false;
1985          if (!canceled && !intercepted) {
1987              // If the event is targeting accessiiblity focus we give it to the
1988              // view that has accessibility focus and if it does not handle it
1989              // we clear the flag and dispatch the event to all children as usual.
1990              // We are looking up the accessibility focused host to avoid keeping
1991              // state since these events are very rare.
1992              View childWithAccessibilityFocus = ev.isTargetAccessibilityFocus()
1993                      ? findChildWithAccessibilityFocus() : null;
1995              if (actionMasked == .
1996                      || (split && actionMasked == .)
1997                      || actionMasked == .) {
1998                  final int actionIndex = ev.getActionIndex(); // always 0 for down
1999                  final int idBitsToAssign = split ? 1 << ev.getPointerId(actionIndex)
2000                          : .;
2002                  // Clean up earlier touch targets for this pointer id in case they
2003                  // have become out of sync.
2004                  removePointersFromTouchTargets(idBitsToAssign);
2006                  final int childrenCount = ;
2007                  if (newTouchTarget == null && childrenCount != 0) {
2008                      final float x = ev.getX(actionIndex);
2009                      final float y = ev.getY(actionIndex);
2010                      // Find a child that can receive the event.
2011                      // Scan children from front to back.
2012                      final ArrayList<View> preorderedList = buildOrderedChildList();
2013                      final boolean customOrder = preorderedList == null
2014                              && isChildrenDrawingOrderEnabled();
2015                      final View[] children = ;

如果沒有自定義 children 的 draw 順序的話,default 就是越晚加入 ViewGroup 的 child 也晚畫,所以從最上層的 child 來開始接收事件,最上層不收就在往下一層丟,直到 child 處理事件就跳開迴圈(line 2049)。

2016                      for (int i = childrenCount - 1; i >= 0; i--) {
2017                          final int childIndex = customOrder
2018                                  ? getChildDrawingOrder(childrenCount, i) : i;
2019                          final View child = (preorderedList == null)
2020                                  ? children[childIndex] : preorderedList.get(childIndex);
2022                          // If there is a view that has accessibility focus we want it
2023                          // to get the event first and if not handled we will perform a
2024                          // normal dispatch. We may do a double iteration but this is
2025                          // safer given the timeframe.
2026                          if (childWithAccessibilityFocus != null) {
2027                              if (childWithAccessibilityFocus != child) {
2028                                  continue;
2029                              }
2030                              childWithAccessibilityFocus = null;
2031                              i = childrenCount - 1;
2032                          }
2034                          if (!canViewReceivePointerEvents(child)
2035                                  || !isTransformedTouchPointInView(x, y, child, null)) {
2036                              ev.setTargetAccessibilityFocus(false);
2037                              continue;
2038                          }
2040                          newTouchTarget = getTouchTarget(child);
2041                          if (newTouchTarget != null) {
2042                              // Child is already receiving touch within its bounds.
2043                              // Give it the new pointer in addition to the ones it is handling.
2044                              newTouchTarget.pointerIdBits |= idBitsToAssign;
2045                              break;
2046                          }
2048                          resetCancelNextUpFlag(child);
2049                          if (dispatchTransformedTouchEvent(ev, false, child, idBitsToAssign)) {
2050                              // Child wants to receive touch within its bounds.
2051                               = ev.getDownTime();
2052                              if (preorderedList != null) {
2053                                  // childIndex points into presorted list, find original index
2054                                  for (int j = 0; j < childrenCount; j++) {
2055                                      if (children[childIndex] == [j]) {
2056                                           = j;
2057                                          break;
2058                                      }
2059                                  }
2060                              } else {
2061                                   = childIndex;
2062                              }
2063                               = ev.getX();
2064                               = ev.getY();
2065                              newTouchTarget = addTouchTarget(child, idBitsToAssign);
2066                              alreadyDispatchedToNewTouchTarget = true;
2067                              break;
2068                          }
2070                          // The accessibility focus didn't handle the event, so clear
2071                          // the flag and do a normal dispatch to all children.
2072                          ev.setTargetAccessibilityFocus(false);
2073                      }
2074                      if (preorderedList != null) preorderedList.clear();
2075                  }
2077                  if (newTouchTarget == null &&  != null) {
2078                      // Did not find a child to receive the event.
2079                      // Assign the pointer to the least recently added target.
2080                      newTouchTarget = ;
2081                      while (newTouchTarget.next != null) {
2082                          newTouchTarget = newTouchTarget.next;
2083                      }
2084                      newTouchTarget.pointerIdBits |= idBitsToAssign;
2085                  }
2086              }
2087          }
2089         ...

可以看到 dispatchTransformedTouchEvent() 裡又會去呼叫 child 的 dispatchTouchEvent() (line 2405)。

 // ViewGroup.java Click here for full source.
2363  private boolean dispatchTransformedTouchEvent(MotionEvent event, boolean cancel,
2364          View child, int desiredPointerIdBits) {
2365      final boolean handled;
2367      // Canceling motions is a special case.  We don't need to perform any transformations
2368      // or filtering.  The important part is the action, not the contents.
2369      final int oldAction = event.getAction();
2370      if (cancel || oldAction == .) {
2371          event.setAction(.);
2372          if (child == null) {
2373              handled = super.dispatchTouchEvent(event);
2374          } else {
2375              handled = child.dispatchTouchEvent(event);
2376          }
2377          event.setAction(oldAction);
2378          return handled;
2379      }
2381      // Calculate the number of pointers to deliver.
2382      final int oldPointerIdBits = event.getPointerIdBits();
2383      final int newPointerIdBits = oldPointerIdBits & desiredPointerIdBits;
2385      // If for some reason we ended up in an inconsistent state where it looks like we
2386      // might produce a motion event with no pointers in it, then drop the event.
2387      if (newPointerIdBits == 0) {
2388          return false;
2389      }
2391      // If the number of pointers is the same and we don't need to perform any fancy
2392      // irreversible transformations, then we can reuse the motion event for this
2393      // dispatch as long as we are careful to revert any changes we make.
2394      // Otherwise we need to make a copy.
2395      final MotionEvent transformedEvent;
2396      if (newPointerIdBits == oldPointerIdBits) {
2397          if (child == null || child.hasIdentityMatrix()) {
2398              if (child == null) {
2399                  handled = super.dispatchTouchEvent(event);
2400              } else {
2401                  final float offsetX =  - child.mLeft;
2402                  final float offsetY =  - child.mTop;
2403                  event.offsetLocation(offsetX, offsetY);
2405                  handled = child.dispatchTouchEvent(event);
2407                  event.offsetLocation(-offsetX, -offsetY);
2408              }
2409              return handled;
2410          }
2411          transformedEvent = MotionEvent.obtain(event);
2412      } else {
2413          transformedEvent = event.split(newPointerIdBits);
2414      }
2416      // Perform any necessary transformations and dispatch.
2417      if (child == null) {
2418          handled = super.dispatchTouchEvent(transformedEvent);
2419      } else {
2420          final float offsetX =  - child.mLeft;
2421          final float offsetY =  - child.mTop;
2422          transformedEvent.offsetLocation(offsetX, offsetY);
2423          if (! child.hasIdentityMatrix()) {
2424              transformedEvent.transform(child.getInverseMatrix());
2425          }
2427          handled = child.dispatchTouchEvent(transformedEvent);
2428      }
2430      // Done.
2431      transformedEvent.recycle();
2432      return handled;
2433  }

接著跳轉到 View 的 dispatchTouchEvent() 來看,可以發現View 會先處理 user 定義的 onTouch() 事件(line 8467),如果 user 不處理(返回 false),系統才會呼叫 onTouchEvent() (line 8471) 來進一步觸發常用的 onClick()或 onLongClick() callback

// View.java  Click here for full source.
8439  public boolean dispatchTouchEvent(MotionEvent event) {
8440      // If the event should be handled by accessibility focus first.
8441      if (event.isTargetAccessibilityFocus()) {
8442          // We don't have focus or no virtual descendant has it, do not handle the event.
8443          if (!isAccessibilityFocusedViewOrHost()) {
8444              return false;
8445          }
8446          // We have focus and got the event, then use normal event dispatch.
8447          event.setTargetAccessibilityFocus(false);
8448      }
8450      boolean result = false;
8452      if ( != null) {
8453          .onTouchEvent(event, 0);
8454      }
8456      final int actionMasked = event.getActionMasked();
8457      if (actionMasked == .) {
8458          // Defensive cleanup for new gesture
8459          stopNestedScroll();
8460      }
8462      if (onFilterTouchEventForSecurity(event)) {
8463          //noinspection SimplifiableIfStatement
8464          ListenerInfo li = ;
8465          if (li != null && li.mOnTouchListener != null
8466                  && ( & ) == 
8467                  && li.mOnTouchListener.onTouch(this, event)) {
8468              result = true;
8469          }
8471          if (!result && onTouchEvent(event)) {
8472              result = true;
8473          }
8474      }
8476      if (!result &&  != null) {
8477          .onUnhandledEvent(event, 0);
8478      }
8480      // Clean up after nested scrolls if this is the end of a gesture;
8481      // also cancel it if we tried an ACTION_DOWN but we didn't want the rest
8482      // of the gesture.
8483      if (actionMasked == . ||
8484              actionMasked == . ||
8485              (actionMasked == . && !result)) {
8486          stopNestedScroll();
8487      }
8489      return result;
8490  }

2016年6月22日 星期三

Unit Tests for Beginners

Unit Tests 和 UI Tests 不同,Unit Tests 著重於測試程式中的一小部分的邏輯,例如 Class 或是 Class 中的 methods。而 Unit Tests 又可分為:

  • Local tests
    本地端的測試,程式碼只會運行在 JVM 上,所以執行效率最佳。多用於測試與 Android framework 沒有相依性的程式碼,或是其相依能被 mock objects 所取代。(Robolectric 也可以解決這個問題,見 Ref 3)

  • Instrumented tests
    跑在實體機器或模擬器上的測試。這些測試需要取得裝置上的一些資訊,如 Context 物件,或有其他不容易被 mock objects 所取代的相依類別。

建立 Local Unit Test Class

在 Android 中,建立單元測試需要用到 JUnit 這個已在 Java 世界中被廣泛被使用的 Unit Testing Framework,目前最新的版本是 JUnit 4,JUnit 4 不像前一版 JUnit 3 需要讓 test classes繼承 junit.framework.TestCase,更不限制 method 的命名要以 "test" 為前綴字。

測試的程式碼需要放在路徑 src/test/java 之下。

範例如下:
import org.junit.Test;
import java.util.regex.Pattern;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;

public class EmailValidatorTest {

    @Test
    public void emailValidator_CorrectEmailSimple_ReturnsTrue() {
        assertThat(EmailValidator.isValidEmail("name@email.com"), is(true));
    }
    ...
}

在 gradle.build 裡宣告:

dependencies {
    // Required -- JUnit 4 framework
    testCompile 'junit:junit:4.12'
    // Optional -- Mockito framework
    testCompile 'org.mockito:mockito-core:1.+'
}


建立 Instrumented Test Class

需要用到 JUnit 4 test runner,而且測試的程式碼需要放在路徑 src/androidTest/java 之下。
此外 AndroidJUnitRunner 已經用來取代舊的 InstrumentationTestRunner 和 MultiDexTestRunner(自己繼承 AndroidJUnitRunner 來實作 AndroidJUnitMultiDexRunner )。若需要 Context 的話,可以透過 InstrumentationRegistry.getContext() 來取得物件(不用再繼承 InstrumentationTestCase 了)。

範例如下:
import android.os.Parcel;
import android.support.test.runner.AndroidJUnit4;
import android.util.Pair;
import org.junit.Test;
import org.junit.runner.RunWith;
import java.util.List;
import static org.hamcrest.Matchers.is;
import static org.junit.Assert.assertThat;

@RunWith(AndroidJUnit4.class)
@SmallTest
public class LogHistoryAndroidUnitTest {

    public static final String TEST_STRING = "This is a string";
    public static final long TEST_LONG = 12345678L;
    private LogHistory mLogHistory;

    @Before
    public void createLogHistory() {
        mLogHistory = new LogHistory();
    }

    @Test
    public void logHistory_ParcelableWriteRead() {
        // Set up the Parcelable object to send and receive.
        mLogHistory.addEntry(TEST_STRING, TEST_LONG);

        // Write the data.
        Parcel parcel = Parcel.obtain();
        mLogHistory.writeToParcel(parcel, mLogHistory.describeContents());

        // After you're done with writing, you need to reset the parcel for reading.
        parcel.setDataPosition(0);

        // Read the data.
        LogHistory createdFromParcel = LogHistory.CREATOR.createFromParcel(parcel);
        List> createdFromParcelData = createdFromParcel.getData();

        // Verify that the received data is correct.
        assertThat(createdFromParcelData.size(), is(1));
        assertThat(createdFromParcelData.get(0).first, is(TEST_STRING));
        assertThat(createdFromParcelData.get(0).second, is(TEST_LONG));
    }
}

在 gradle.build 裡宣告: (Note: 這裡可能會遇到 support-annotations 版本衝突的問題)
dependencies {
    androidTestCompile 'com.android.support:support-annotations:23.0.1'
    androidTestCompile 'com.android.support.test:runner:0.4.1'
    androidTestCompile 'com.android.support.test:rules:0.4.1'
    // Optional -- Hamcrest library
    androidTestCompile 'org.hamcrest:hamcrest-library:1.3'
    // Optional -- UI testing with Espresso
    androidTestCompile 'com.android.support.test.espresso:espresso-core:2.2.1'
    // Optional -- UI testing with UI Automator
    androidTestCompile 'com.android.support.test.uiautomator:uiautomator-v18:2.1.1'
}

Ref: