Android 进行单元测试难在哪？Part 3

Question

在 Android 应用中进行单元测试很困难，有时候甚至是不可能的。在 之前的两篇博文 中，我已经向大家解释了在 Android 中进行单元测试如此困难的原因。而 上一篇博文 我们通过分析得到的结论是：正是 Google 官方所提倡的应用架构方式使得在 Android 中进行单元测试变成一场灾难。因为在官方提倡的架构方式中，Google 似乎希望我们将业务逻辑都放在应用的组件类中（例如：Activity，Fragment，Service，等等……）。而这种开发方式也是我们一直以来使用的开发模板。

在这篇博文中，我列举出几种架构 Android 应用的方法，使用这些方法进行开发能让单元测试变得轻松些。但正如我在 序 中所说，我最推崇的办法始终是 Square 在他们的应用中抛弃 Fragment 所用的通用方法。因为这个方法是由 Square 中的 Android 开发工程师想出来的，所以我会在接下来的博文中将这个办法叫作“Square 大法”。

Square 大法的核心思想是：把应用组件类中的业务逻辑全部移除（例如：Activity，Fragment，Service，等等……），并且把业务逻辑转移到业务对象，而这些业务对象都是被依赖注入的纯 Java 对象，以及与 Android 无关的接口在此的 Android 特定实现。如果我们在开发应用的时候使用 Square 大法，那进行单元测试就简单多了。在这篇博文中，我会解释 Square 大法是如何帮助我们重构 UI 无关的应用组件（例如我们在之前的博文中讨论的 SessionCalendarService），并让对它进行单元测试变得容易许多。

用 Square 大法重构 UI 无关的应用组件

用 Square 大法重构类似于 Service，ContentProvider，BroadcastReceiver 这样的 UI 无关的应用组件相对来说比较容易。我再说一次我们要做的事情吧：把在这些类中的业务逻辑移除，并把它们放到业务对象中。

由于“业务逻辑”是很容易有歧义的词语，我来解释下我使用“业务逻辑”这个词时，它所代表的含义吧。当我提到“业务逻辑”，它的含义和维基百科上的解释是一致的：程序中根据现实世界中的规则用于决定数据将如何被创建，展示，储存和修改的那部分代码。那么现在我们就可以就“业务逻辑”这个词的含义达成共识了，那就来看看 Square 大法到底是啥吧。

我们先来看看怎么用 Square 大法实现我在之前的博文中介绍的 SessionCalendarService 吧，具体代码如下：

/**
 * Background {@link android.app.Service} that adds or removes session Calendar events through
 * the {@link CalendarContract} API available in Android 4.0 or above.
 */
public class SessionCalendarService extends IntentService {
  private static final String TAG = makeLogTag(SessionCalendarService.class);

  //...

  public SessionCalendarService() {
    super(TAG);
  }

  @Override
  protected void onHandleIntent(Intent intent) {
    final String action = intent.getAction();
    Log.d(TAG, "Received intent: " + action);

    final ContentResolver resolver = getContentResolver();

    boolean isAddEvent = false;

    if (ACTION_ADD_SESSION_CALENDAR.equals(action)) {
      isAddEvent = true;

    } else if (ACTION_REMOVE_SESSION_CALENDAR.equals(action)) {
      isAddEvent = false;

    } else if (ACTION_UPDATE_ALL_SESSIONS_CALENDAR.equals(action) &&
        PrefUtils.shouldSyncCalendar(this)) {
      try {
        getContentResolver().applyBatch(CalendarContract.AUTHORITY,
            processAllSessionsCalendar(resolver, getCalendarId(intent)));
        sendBroadcast(new Intent(
            SessionCalendarService.ACTION_UPDATE_ALL_SESSIONS_CALENDAR_COMPLETED));
      } catch (RemoteException e) {
        LOGE(TAG, "Error adding all sessions to Google Calendar", e);
      } catch (OperationApplicationException e) {
        LOGE(TAG, "Error adding all sessions to Google Calendar", e);
      }

    } else if (ACTION_CLEAR_ALL_SESSIONS_CALENDAR.equals(action)) {
      try {
        getContentResolver().applyBatch(CalendarContract.AUTHORITY,
            processClearAllSessions(resolver, getCalendarId(intent)));
      } catch (RemoteException e) {
        LOGE(TAG, "Error clearing all sessions from Google Calendar", e);
      } catch (OperationApplicationException e) {
        LOGE(TAG, "Error clearing all sessions from Google Calendar", e);
      }

    } else {
      return;
    }

    final Uri uri = intent.getData();
    final Bundle extras = intent.getExtras();
    if (uri == null || extras == null || !PrefUtils.shouldSyncCalendar(this)) {
      return;
    }

    try {
      resolver.applyBatch(CalendarContract.AUTHORITY,
          processSessionCalendar(resolver, getCalendarId(intent), isAddEvent, uri,
              extras.getLong(EXTRA_SESSION_START),
              extras.getLong(EXTRA_SESSION_END),
              extras.getString(EXTRA_SESSION_TITLE),
              extras.getString(EXTRA_SESSION_ROOM)));
    } catch (RemoteException e) {
      LOGE(TAG, "Error adding session to Google Calendar", e);
    } catch (OperationApplicationException e) {
      LOGE(TAG, "Error adding session to Google Calendar", e);
    }
  }

  //...
}

如你所见，SessionCalendarService 调用了将要在后面定义的 helper 方法。一旦我们将这些 helper 方法和类的字段声明也考虑进来，Service 类的代码就有 400 多行。要 hold 住这么庞大的类内发生的业务逻辑可不是什么简单的活，而且就像我们在上一篇博文中看到的那样，要在 SessionCalendarService 中进行单元测试简直是天方夜谭。

那现在来看看用 Square 大法实现它代码会是怎样的。我再强调一次：Square 大法需要我们将 Android 类内的业务逻辑迁移到一个业务对象中。在这里，SessionCalendarService 所对应的业务对象则是 SessionCalendarUpdater，具体代码如下：

public class SessionCalendarUpdater {

  //...

  private SessionCalendarDatabase mSessionCalendarDatabase;
  private SessionCalendarUserPreferences mSessionCalendarUserPreferences;

  public SessionCalendarUpdater(SessionCalendarDatabase sessionCalendarDatabase,
                  SessionCalendarUserPreferences sessionCalendarUserPreferences) {

    mSessionCalendarDatabase = sessionCalendarDatabase;
    mSessionCalendarUserPreferences = sessionCalendarUserPreferences;
  }

  public void updateCalendar(CalendarUpdateRequest calendarUpdateRequest) {

    boolean isAddEvent = false;

    String action = calendarUpdateRequest.getAction();

    long calendarId = calendarUpdateRequest.getCalendarId();

    if (ACTION_ADD_SESSION_CALENDAR.equals(action)) {
      isAddEvent = true;

    } else if (ACTION_REMOVE_SESSION_CALENDAR.equals(action)) {
      isAddEvent = false;

    } else if (ACTION_UPDATE_ALL_SESSIONS_CALENDAR.equals(action)
        && mSessionCalendarUserPreferences.shouldSyncCalendar()) {

      try {

        mSessionCalendarDatabase.updateAllSessions(calendarId);

      } catch (RemoteException | OperationApplicationException e) {

        LOGE(TAG, "Error adding all sessions to Google Calendar", e);
      }

    } else if (ACTION_CLEAR_ALL_SESSIONS_CALENDAR.equals(action)) {

      try {

        mSessionCalendarDatabase.clearAllSessions(calendarId);

      } catch (RemoteException | OperationApplicationException e) {

        LOGE(TAG, "Error clearing all sessions from Google Calendar", e);
      }

    } else {
      return;
    }


    if (!shouldUpdateCalendarSession(calendarUpdateRequest, mSessionCalendarUserPreferences)) {
      return;
    }

    try {

      CalendarSession calendarSessionToUpdate = calendarUpdateRequest.getCalendarSessionToUpdate();

      if (isAddEvent) {

        mSessionCalendarDatabase.addCalendarSession(calendarId, calendarSessionToUpdate);
      } else {

        mSessionCalendarDatabase.removeCalendarSession(calendarId, calendarSessionToUpdate);
      }

    } catch (RemoteException | OperationApplicationException e) {
      LOGE(TAG, "Error adding session to Google Calendar", e);
    }
  }

  private boolean shouldUpdateCalendarSession(CalendarUpdateRequest calendarUpdateRequest, 
                        SessionCalendarUserPreferences sessionCalendarUserPreferences) {

    return calendarUpdateRequest.getCalendarSessionToUpdate() == null || !sessionCalendarUserPreferences.shouldSyncCalendar();
  }
}

我想要强调其中的一些要点：首先，需要注意，我们完全不需要用到任何新的关键字，因为业务对象的依赖都被注入了，它根本不会使用新的关键字，而这正是让类可单元测试的关键。其次，你会注意到类没有确切地依赖于 Android SDK，因为业务对象的依赖都是 Android 无关接口的 Android 特定实现，因此它不需要依赖于 Android SDK。

那么这些依赖是怎么添加到　SessionCalendarUpdater　类中的呢？是通过　SessionCalendarService　类注入进去的：

/**
 * Background {@link android.app.Service} that adds or removes session Calendar events through
 * the {@link CalendarContract} API available in Android 4.0 or above.
 */
public class SessionCalendarService extends IntentService {
  private static final String TAG = makeLogTag(SessionCalendarService.class);

  public SessionCalendarService() {
    super(TAG);
  }

  @Override
  protected void onHandleIntent(Intent intent) {
    final String action = intent.getAction();
    Log.d(TAG, "Received intent: " + action);

    final ContentResolver resolver = getContentResolver();

    Broadcaster broadcaster = new AndroidBroadcaster(this);

    SessionCalendarDatabase sessionCalendarDatabase = new AndroidSessionCalendarDatabase(resolver,
                                               broadcaster);

    SharedPreferences defaultSharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);

    SessionCalendarUserPreferences sessionCalendarUserPreferences = new AndroidSessionCalendarUserPreferences(defaultSharedPreferences);

    SessionCalendarUpdater sessionCalendarUpdater
                  = new SessionCalendarUpdater(sessionCalendarDatabase,
                                 sessionCalendarUserPreferences);

    AccountNameRepository accountNameRepository = new AndroidAccountNameRepository(intent, this);

    String accountName = accountNameRepository.getAccountName();

    long calendarId = sessionCalendarDatabase.getCalendarId(accountName);
    CalendarSession calendarSessionToUpdate = CalendarSession.fromIntent(intent);

    CalendarUpdateRequest calendarUpdateRequest = new CalendarUpdateRequest(action, calendarId, calendarSessionToUpdate);

    sessionCalendarUpdater.updateCalendar(calendarUpdateRequest);
  }
}

值得注意的是，修改后的 SessionCalendarService 到处都是新的关键字，但这些关键字在类中并不会引起什么问题。如果我们花几秒时间略读一下要点就会明白这一点：SessionCalendarService 类中已经没有任何业务逻辑，因此 SessionCalendarService 类不再需要进行单元测试。只要我们确定在 SessionCalendarService 调用的是 SessionCalendarUpdater 类中的 updateCalendar() 方法，在 SessionCalendarService 唯一可能出现的就是编译时错误。我们完全不需要为此实现测试单元，因为这是编译器的工作，与我们无关。

由于我在前两篇博文中提到的相关原因，将我们的 Service 类拆分成这样会使对业务逻辑进行单元测试变得非常简单，例如我们对 SessionCalendarUpdater 类进行单元测试的代码可以写成下面的样子：

public class SessionCalendarUpdaterTests extends TestCase {

  public void testShouldClearAllSessions() throws RemoteException, OperationApplicationException {

    SessionCalendarDatabase sessionCalendarDatabase = mock(SessionCalendarDatabase.class);

    SessionCalendarUserPreferences sessionCalendarUserPreferences = mock(SessionCalendarUserPreferences.class);


    SessionCalendarUpdater sessionCalendarUpdater = new SessionCalendarUpdater(sessionCalendarDatabase,
                                           sessionCalendarUserPreferences);

    CalendarUpdateRequest calendarUpdateRequest = new CalendarUpdateRequest(SessionCalendarUpdater.ACTION_CLEAR_ALL_SESSIONS_CALENDAR,
                                        0,
                                        null);

    sessionCalendarUpdater.updateCalendar(calendarUpdateRequest);

    verify(sessionCalendarDatabase).clearAllSessions(0);
  }
}

结论

为了能够进行单元测试，我认为修改后的代码变得更易读和更易维护了。可以肯定的是，我们还有许多办法能让代码变得更好，但在让代码能够进行单元测试的过程中，我想让修改后的代码尽可能与修改前风格相似，所以我没有进行其他修改。在下一篇博文中，我将会教大家如何使用 Square 大法重构应用的 UI 组件（例如：Fragment 和 Activity）。