让设计更具可测试性的重构方法

### 让设计更具可测试性的重构方法 #### 1. 核心概念介绍 在软件开发中，为了让代码更具可测试性，我们需要了解两个重要概念：重构和接缝。 重构是指在不改变代码功能的前提下对代码进行修改。例如，重命名方法、将一个长方法拆分成多个小方法等。 接缝则是代码中可以插入不同功能的位置。比如，添加构造函数参数、添加可设置的公共属性、将方法设为虚方法以便重写，或者将委托作为参数或属性外部化，使其可以从类外部进行设置。接缝的实现遵循开闭原则，即类的功能可以扩展，但源代码不能直接修改。 为了打破被测代码与文件系统之间的依赖关系，我们可以在代码中引入一个或多个接缝。这里有两种类型的依赖打破重构方式： - **类型A**：将具体对象抽象为接口或委托。 - **类型B**：重构代码以允许注入这些委托或接口的虚假实现。 以下是具体的重构方式列表： | 重构类型 | 具体方式 | | ---- | ---- | | 类型A | 提取接口以允许替换底层实现 | | 类型B | 将存根实现注入到被测类中 | | 类型B | 在构造函数级别注入虚假对象 | | 类型B | 通过属性的获取或设置注入虚假对象 | | 类型B | 在方法调用前注入虚假对象 | #### 2. 提取接口以替换底层实现 这种技术需要将涉及文件系统操作的代码提取到一个单独的类中。以下是示例代码： ```csharp public bool IsValidLogFileName(string fileName) { FileExtensionManager mgr = new FileExtensionManager(); return mgr.IsValid(fileName); } class FileExtensionManager { public bool IsValid(string fileName) { //read some file here } } ``` 接着，让被测类使用某种形式的`ExtensionManager`，而不是具体的`FileExtensionManager`类。在.NET中，可以通过使用基类或接口来实现。以下是使用新接口的示例： ```csharp public class FileExtensionManager : IExtensionManager { public bool IsValid(string fileName) { ... } } public interface IExtensionManager { bool IsValid (string fileName); } //the unit of work under test: public bool IsValidLogFileName(string fileName) { IExtensionManager mgr = new FileExtensionManager(); return mgr.IsValid(fileName); } ``` 现在，我们创建了一个带有`IsValid(string)`方法的接口，并让`FileExtensionManager`类实现该接口。这样，我们就可以用自己创建的“虚假”管理器替换“真实”的管理器。 以下是创建的简单存根代码： ```csharp public class AlwaysValidFakeExtensionManager:IExtensionManager { public bool IsValid(string fileName) { return true; } } ``` 这里使用`FakeExtensionManager`而不是`StubExtensionManager`或`MockExtensionManager`，是因为`fake`表示一个看起来像另一个对象但可以用作模拟或存根的对象。这个`AlwaysValidFakeExtensionManager`类总是返回`true`，方便读者理解其行为。 #### 3. 依赖注入：将虚假实现注入到被测单元中 有几种经过验证的方法可以在代码中创建基于接口的接缝，以下是一些常见的方式： - 在构造函数级别接收接口并将其保存到字段中供后续使用。 - 通过属性的获取或设置接收接口并将其保存到字段中供后续使用。 - 在被测方法调用前接收接口，可以通过以下方式实现： - 方法参数（参数注入） - 工厂类 - 本地工厂方法 - 上述技术的变体 #### 4. 在构造函数级别注入虚假对象（构造函数注入） 在这种情况下，需要添加一个新的构造函数（或为现有构造函数添加一个新参数），该构造函数将接受之前提取的接口类型（`IExtensionManager`）的对象。构造函数将该对象设置为类中的本地字段，供后续方法使用。 以下是使用构造函数注入技术为`LogAnalyzer`类编写测试的示例代码： ```csharp public class LogAnalyzer { private IExtensionManager manager; public LogAnalyzer(IExtensionManager mgr) { manager = mgr; } public bool IsValidLogFileName(string fileName) { return manager.IsValid(fileName); } } public interface IExtensionManager { bool IsValid(string fileName); } [TestFixture] public class LogAnalyzerTests { [Test] public void IsValidFileName_NameSupportedExtension_ReturnsTrue() { FakeExtensionMana ```