类依赖项的不透明性和透明性

在 TDD 的实践中，总是要考虑类的依赖项的透明性（Transparent）和不透明性（Opaque），进而采用合理的方式提高代码的可测试性。

不透明依赖

我们先看段前置条件代码，以供后文使用。

  public interface IUserProvider
  {
    IList<User> GetUserCollection();
  }

  public class UserProvider : IUserProvider
  {
    public IList<User> GetUserCollection()
    {
      return new List<User>() 
      { 
        new User()
        {
          Name = "hello",
          LastActivity = DateTime.Now.AddDays(-1),
        },
      };
    }
  }

  public class User
  {
    public string Name { get; set; }
    public DateTime LastActivity { get; set; }
  }

现在，我们需要一个负责管理 User 的类 UserManager，其实现了接口 IUserManager。

  public interface IUserManager
  {
    int NumberOfUsersActiveInLast10Days(string userName);
  }

  public class UserManager : IUserManager
  {
    public int NumberOfUsersActiveInLast10Days(string userName)
    {
      IUserProvider userProvider = ServiceLocator.Current.GetInstance<IUserProvider>();
      IList<User> userCollection = userProvider.GetUserCollection();
      int result = 0;
      foreach (User user in userCollection)
      {
        if (user.Name.StartsWith(userName)
            && user.LastActivity > DateTime.Now.AddDays(-10))
          result++;
      }
      return result;
    }
  }

通过 UserManager 内定义的 函数 NumberOfUsersActiveInLast10Days 我们可以得到过去 10 天内活跃的用户数量。

  class Program
  {
    static void Main(string[] args)
    {
      IUnityContainer container = new UnityContainer();
      ServiceLocator.SetLocatorProvider(() => new UnityServiceLocator(container));

      container.RegisterType<IUserProvider, UserProvider>(new ContainerControlledLifetimeManager());
      container.RegisterType<IUserManager, UserManager>(new ContainerControlledLifetimeManager());

      UserManager userManager = new UserManager();
      int activeUserCount = userManager.NumberOfUsersActiveInLast10Days("hello");
      Console.WriteLine(activeUserCount);

      Console.ReadKey();
    }
  }

在函数 NumberOfUsersActiveInLast10Days 中，我们从 ServiceLocator 中获取了一个 IUserProvider 的实现，然后通过其获取所有 User。再根据给定条件过滤用户，返回过去 10 天内的活跃用户数量。

在 UserManager 的使用中，我们并不知道其依赖于 ServiceLocator 和 UserProvider 等类。

这种将 IoC 调用直接嵌入到代码实现中的隐式使用方式称之为不透明依赖注入。

测试不透明依赖

现在我们来为 NumberOfUsersActiveInLast10Days 编写单元测试代码。

第一个用例为验证在数据库中不存在用户名以给定字符串开头的用户。

如果我不知道 NumberOfUsersActiveInLast10Days 的内部实现，采用黑盒测试的方式，我会写出如下代码。

    [TestMethod]
    public void GetActiveUsers_TestCaseOfZeroUsers_WouldReturnEmptyCollection()
    {
      // arrange
      // no clear idea what to mock here

      // act
      var userManager = new UserManager();
      int numberOfUsers = userManager.NumberOfUsersActiveInLast10Days("x");

      // assert
      Assert.IsTrue(numberOfUsers == 0);
    }

则运行测试用例后，得到的结果是：

"未将对象引用设置到对象的实例。"

此时，我们知道了 NumberOfUsersActiveInLast10Days 函数还要依赖 ServiceLocator 和 UserProvider 类。

现在，我们来改进测试代码。

    [TestMethod]
    public void GetActiveUsers_TestCaseOfZeroUsers_WouldReturnEmptyCollection()
    {
      // arrange
      IUnityContainer container = new UnityContainer();
      ServiceLocator.SetLocatorProvider(() => new UnityServiceLocator(container));

      IUserProvider userProvider = Substitute.For<IUserProvider>();
      userProvider.GetUserCollection().Returns<IList<User>>(new List<User>());
      container.RegisterInstance<IUserProvider>(userProvider, new ContainerControlledLifetimeManager());

      // act
      var userManager = new UserManager();
      int numberOfUsers = userManager.NumberOfUsersActiveInLast10Days("x");

      // assert
      Assert.IsTrue(numberOfUsers == 0);
    }

则现在我们可以通过此测试了。

透明依赖

可以看到，在代码中使用不透明依赖将导致为代码编写单元测试变得困难和不可预测。

现在我来将依赖项重构为透明依赖，通过构造函数将依赖注入。

  public class UserManager : IUserManager
  {
    private readonly IUserProvider _userProvider;

    public UserManager(IUserProvider userProvider)
    {
      _userProvider = userProvider;
    }

    public int NumberOfUsersActiveInLast10Days(string userName)
    {
      IList<User> userCollection = _userProvider.GetUserCollection();
      int result = 0;
      foreach (User user in userCollection)
      {
        if (user.Name.StartsWith(userName)
            && user.LastActivity > DateTime.Now.AddDays(-10))
          result++;
      }
      return result;
    }
  }

代码的使用也需稍作修改。

      UserManager userManager = new UserManager(container.Resolve<IUserProvider>());
      int activeUserCount = userManager.NumberOfUsersActiveInLast10Days("hello");
      Console.WriteLine(activeUserCount);

这种可以明确的通过构造函数显式的注入的依赖项称之为透明依赖。

测试透明依赖

改进测试代码，直接去掉了对 ServiceLocator 的依赖。

    [TestMethod]
    public void GetActiveUsers_TestCaseOfZeroUsers_WouldReturnEmptyCollection()
    {
      // arrange
      IUserProvider userProvider = Substitute.For<IUserProvider>();
      userProvider.GetUserCollection().Returns<IList<User>>(new List<User>());

      // act
      var userManager = new UserManager(userProvider);
      int numberOfUsers = userManager.NumberOfUsersActiveInLast10Days("x");

      // assert
      Assert.IsTrue(numberOfUsers == 0);
    }

这一次运行顺利的通过。

结论

通过使用透明依赖方式，可以极大的简化测试编写过程，并且可以引导更简洁的设计。同时，配合 IoC 容器的合理使用将极大的发挥依赖注入的能力。

参考资料

• Design for testability – Transparent and opaque dependencies
• Design for testability – Microsoft Unity
• Designing for testability – an valid architecture choice
• Separation of concern
• Are Opaque Depencies Bad?
• Black-box testing