微信推文图片间距有缝的代码_使用记录接缝进行旧代码单元测试

微信推文图片间距有缝的代码

在大多数情况下，使用遗留代码可能很困难。但是，当涉及到添加新功能，重构或维护您不熟悉的代码时，它可能会变得势不可挡。如果您已经使用敏捷技术几年了，并且突然间您面对大量的代码并且就您所能看到的没有测试用例，这可能会特别困难。

那该怎么办呢？简单的答案是创建单元测试。但是，当您开始修改代码以打破依赖关系并启用可测试性时，这可能会给您带来更多麻烦。您真正需要的是一种轻松的方法来评估表达式，查找值并确定当前正在执行的代码分支。

迈克尔·费瑟斯（Michael Feathers）在他的《有效处理旧版代码》一书中谈到了在旧版代码中查找接缝以促进测试。他为接缝提供的定义是“一个地方，您无需修改即可在其中更改程序的行为”。接缝的类型因语言而异，对于Java，他定义了两个相关的类别，即“链接接缝”-通过这种方式对类路径进行不同的排序，可以用不同的类来代替测试。和“对象接缝”-使用子类或模拟实现而不是最初期望的类对构造函数或方法进行调用。（有关更多信息，请参阅Michael Feathers撰写的“有效使用旧版代码”的第4章）。

我发现另一个有利的接缝是测井接缝。使用此接缝，您可以轻松地在类周围创建不引人注意的单元测试，而无需编辑类逻辑并避免行为更改。

寻找接缝

当使用遗留代码或未考虑可测试性编写的代码时，上面未经测试的代码场景相当普遍。示例包括大型方法和类，复杂的分支（通常是同一方法中的许多分支级别）以及在需要时直接在代码中实例化的对象。在这些情况下（以及其他情况下），常规的测试工具包将无法正常工作。一个优点是大多数代码都使用日志记录框架。

从测试的角度来看，日志记录代码的原始目的实际上并不重要。无论是用于信息，调试还是跟踪，重要的是它提供遥测信息。然后，可以将该遥测信息重新调整用途并在单元测试中使用，从而提供可靠地重构代码和添加新功能所需的安全网。

此外，将新的日志记录代码添加到现有代码中是无害的-不会影响现有功能或行为。这意味着我们可以使用新的语句增强日志记录功能，以报告我们希望通过单元测试进行验证的信息（例如，表达式结果，对象实例值和分支信息）。本文稍后将提供有关此步骤的更多详细信息。

测试用例

让我们以真正的测试方式首先开发单元测试。

但是，在开始之前，我们假设正在使用的旧代码已经用Java编写，并且还利用了Apache基金会的log4j日志框架。

测试用例的结构应遵循模拟测试范例。这些步骤是：

为要测试的类所使用的对象创建一个模拟对象，以下称为“ ClassUnderTest”。
使用测试期望配置模拟对象
将模拟对象应用或注入到要测试的类中
运行被测试的方法
验证是否满足期望

在我们的例子中，我们用模拟对象代替了日志附加程序。附加程序的工作方式（功能）与模拟对象相同-在运行测试之前，它会以期望的值填充；它会在测试过程中捕获班级的呼叫；最后，它将报告是否满足了预期以及是否进行了其他任何致电。

这是代码中的测试用例的结构：

// create the testing appender   TestLoggingAppender appender = new TestLoggingAppender();

  // add expectations   appender.addMessageToVerify("count=3");    appender.addMessageToVerify("finished processing");

   // add the appender to those associated with the class under test Logger log = LogManager.getLogger(ClassUnderTest.class); log.setLevel(Level.INFO); log.addAppender(appender);

  // do usual test setup and configure the class under test ClassUnderTest testme = new ClassUnderTest();    ...

 // run the method under test and verify the results   testme.myMethod();

  // ensure all the expectations are met    assertTrue( appender.verify() );

这里唯一的技巧是记住使用log4j时，有许多不同的日志记录级别。在配置附加器以接收日志记录信息时，需要确保正确设置了日志记录级别。在上面的代码中，“ log.setLevel（Level.INFO）”执行此功能。

测试记录器

最后，是时候开发测试日志附加程序了。我们已经知道测试用例在附加器上调用的方法，因此这为我们提供了该类的初始结构。这些方法是“ addMessageToVerify”和“ verify”。

这是第一种方法。

public void addMessageToVerify( String msg  ) {
called.put( msg, new State( msg, true, false ) );
}

调用时，会将新条目添加到由附加程序管理的消息列表中。除了消息（用作更轻松查找的关键字）之外，还存储了状态对象。状态对象是一个简单的对象，用于存储消息和两个标志-表示是否应该接收消息以及是否调用了该消息。

接下来是“验证”。此方法使用已创建的内部消息列表。返回值“ true”表示实际上所有预期被调用的消息都已存在，并且没有其他消息记录到附加程序。否则，将返回“假”值。看起来是这样的：

public boolean verify() {       boolean result = true;       for( Iterator i=called.keySet().iterator(); i.hasNext(); ) {         State state = (State)called.get(i.next());           if( (!state.shouldCall() && state.wasCalled()) ||                 (state.shouldCall() && !state.wasCalled()) )              result = false;      }     return result;    }

我们一直在谈论来自日志记录框架的消息，但是这是怎么发生的呢？为了使我们的测试日志记录附加程序类接受日志记录消息，需要发生两件事。

首先是需要在测试案例中启用我们的测试日志附加程序。使用代码“ LogManager.getLogger（ClassUnderTest.class）”启用日志记录，然后将我们的测试日志记录附加程序添加到附加程序列表中，以通过调用“ log.addAppender（appender）”接收日志记录消息。

其次，我们的测试日志记录附加程序需要扩展ConsoleAppender类。这引入了一个新方法doAppend（LoggingEvent event），我们现在需要实现该方法：

public synchronized void doAppend(LoggingEvent loggingEvent) {       String msg = loggingEvent.getMessage().toString();       if( called.containsKey(msg) )         ((State)called.get(msg)).setCalled(true);     else          called.put( msg, new State( msg, false, true ) ); }

与addMessageToVerify方法类似，doAppend方法可处理内部消息列表。如果正在记录的消息退出，则doAppend方法将更新状态标志以表示已被调用。如果该消息不存在，则将新项添加到列表中，并设置标志以表示该消息不是预期的而是被调用的。

这样就完成了测试日志附加器类的实现。完整的实现可以在清单1中看到。

利用缝

最后一步是将日志记录语句添加到ClassUnderTest。

在上面的测试案例中，我们有以下两行代码，它们验证是否发生了3次事情，并且处理完成了（大概没有例外）。

appender.addMessageToVerify("count=3");    appender.addMessageToVerify("finished processing");

上述预期测试的一种可能方法是：

public void myMethod() {

     // lots of code before the section we are interested in

     try {         FileReader file = new FileReader("transactions.log");          BufferedReader reader = new BufferedReader(file);

          String data;          int count = 0;           while( (data = reader.readLine())!=null ) {                process(data,count++);           }

           LOG.info("count="+count);         LOG.info("finished processing");        } catch( Exception e ) {          // error processing       }

       // more code afterwards   }

这是一个简单的示例，并不表示通常会在旧版代码中找到的内容。要记住的重要一点是，为了在方法中测试此部分代码，只需添加两个日志记录语句。无需修改任何功能，也无需执行重构。

在考虑要记录什么时，可以使用以下准则：

可以记录静态文本以显示测试区域的开始和结束边界
静态文本可以记录在分支或循环中以确定位置
可以记录循环计数器的值以确定正在执行哪个循环迭代
可以记录分支确定逻辑（确定您执行“ if”还是“ else”的逻辑）
可以记录任何变量（类，方法或块作用域）的值
可以评估任何表达式并记录结果

结论

借助日志记录框架，为遗留代码创建单元测试可以很容易。您可以利用现有的日志记录，并且不加干扰地添加新的日志记录语句来评估表达式，查找值并确定当前正在执行代码的哪个分支。现在，使用工具包中的测试日志记录附加程序，您可以放心地重构现有的旧代码并添加新功能，而不必担心破坏现有功能。

清单1-完整的TestLoggingAppender清单。

public class TestLoggingAppender extends ConsoleAppender {

    private Map called = new HashMap();

    public boolean verify() {        boolean result = true;        for( Iterator i=called.keySet().iterator(); i.hasNext(); ) {            State state = (State)called.get(i.next());            if( (!state.shouldCall() && state.wasCalled()) ||                    (state.shouldCall() && !state.wasCalled()) )                result = false;        }        return result;    }

    public void printResults() {        for( Iterator i=called.keySet().iterator(); i.hasNext(); ) {            State state = (State)called.get(i.next());            StringBuffer sb = new StringBuffer();            sb.append("Logging message '").append(state.getMsg()).append("' ");            sb.append("was ").append( state.shouldCall()?"expected ":"not expected ");            sb.append( state.wasCalled()?"and called":"and was not called");            System.out.println(sb.toString());        }    }

    public void addMessageToVerify( String msg  ) {        called.put( msg, new State( msg, true, false ) );    }

    public synchronized void doAppend(LoggingEvent loggingEvent) {        String msg = loggingEvent.getMessage().toString();        if( called.containsKey(msg) )            ((State)called.get(msg)).setCalled(true);        else            called.put( msg, new State( msg, false, true ) );    }

    class State {

        private String msg;        private boolean shouldCall;        private boolean called;

        public State( String msg, boolean shouldCall, boolean wasCalled ) {            this.msg = msg;            this.shouldCall = shouldCall;            this.called = wasCalled;        }

        public String getMsg() {            return msg;        }

        public boolean shouldCall() {            return shouldCall;        }

        public boolean wasCalled() {            return called;        }

        public void setCalled(boolean called) {            this.called = called;        }    }}

翻译自: https://www.infoq.com/articles/Utilizing-Logging/?topicPageSponsorship=c1246725-b0a7-43a6-9ef9-68102c8d48e1

微信推文图片间距有缝的代码