Java JUnit测试实现控制台输入的正确姿势

一、背景

个别时候有在控制台输入数据，然后通过Scanner读取，去运行某个函数测试的需求。

代码语言：javascript复制

@Test
public void testScanner() throws Exception{
       Scanner scanner = new Scanner(System.in);
       String line = scanner.nextLine();
       System.out.println(line);
}

发现带@Test注解的方法里无法使用Scanner去读取控制台的文本。

常见的解决方案是写一个main方法中。

但是单测不应该依赖控制台的输入，应该转换成其他方式。

另外《阿里巴巴Java开发规范》中以下内容值得参考：

【强制】单元测试应该是全自动执行的，并且非交互式的。测试用例通常是被定期执行的，执行过程必须完全自动化才有意义。输出结果需要人工检查的测试不是一个好的单元测试。单元测试中不准使用 System.out 来进行人肉验证，必须使用 assert 来验证。【强制】单元测试是可以重复执行的，不能受到外界环境的影响。说明:单元测试通常会被放到持续集成中，每次有代码check in时单元测试都会被执行。如果单测对外部环境(网络、服务、中间件等)有依赖，容易导致持续集成机制的不可用。正例:为了不受外界环境影响，要求设计代码时就把 SUT 的依赖改成注入，在测试时用 spring 这样的 DI 框架注入一个本地(内存)实现或者 Mock 实现。

因此不应该人工随意输入，而是应该自动设置各种正常的和边界的数据，然后通过assert来验证。

二、方案

待测试的方法

代码语言：javascript复制

public class SomeClass {

      /**
     * 模拟一个需要输入的函数
     */
    public String someMethod(String input) {
        return input;
    }
}

2.1 方案1：使用main函数

主要是获取输入，然后人肉执行。

代码语言：javascript复制

import java.util.Scanner;

public class MainTest0 {

    public static void main(String[] args) {
        SomeClass someClass = new SomeClass();
        Scanner scanner = new Scanner(System.in);

        while (scanner.hasNextLine()) {
            System.out.println(someClass.someMethod(scanner.nextLine()));
        }
    }

}

2.2 方案2：参数化测试

使用参数化测试，具体可以参考我的另外一篇文章：https://cloud.tencent.com/developer/article/1868878

写法如下：

代码语言：javascript复制

package com.chujianyun.common.param;

import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;

import java.util.Arrays;
import java.util.Collection;


@RunWith(Parameterized.class)
public class MainTest {

    @Parameterized.Parameters
    public static Collection data() {
        return Arrays.asList(new String[][]{{"第1行", "第1行"}, {"第二行", "第2行"}});
    }

    // 输入的
    @Parameterized.Parameter
    public String fInput;

    // 期待的结果
    @Parameterized.Parameter(1)
    public String expectInput;


    @Test
    public void testScanner()  {
        SomeClass someClass = new SomeClass();
        Assert.assertEquals(expectInput, someClass.someMethod(fInput));
    }

}

也可以不写构造函数，通过@Parameter注解来实现，也可以定制左侧单测的名称，详情参考上面文章。

这种方式比较优雅，建议采用此种方式。

另外测试的函数可能更加复杂，expect的数据也可能更加复杂，这里只是给一个简单的例子。

2.3 方案3：读取资源文件

可以将待测试的类放到test的资源文件中。

如果是想构造复杂对象的话，可以是json文件，读取后用Json库解析成对象。

然后读取数据文件后使用

代码语言：javascript复制

import org.apache.commons.io.IOUtils;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;

import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.Charset;
import java.util.List;

public class MainTest2 {

    private List datas;

    @Before
    public void init() throws IOException {
        InputStream inputStream = this.getClass().getResource("/data.txt").openStream();
        datas = IOUtils.readLines(inputStream, Charset.forName("utf-8"));
    }

    @Test
    public void test() {
        SomeClass someClass = new SomeClass();
        for (String line : datas) {
            String[] split = line.split(",");
            Assert.assertEquals(split[1], someClass.someMethod(split[0]));
        }

    }
}

这种方式也是非常推荐的方式，尤其是复杂对象，将其json串放到资源文件中，读取后反序列化，用来测试非常方便，优雅。

读取资源文件这里也可以封装成一个工具类，JSON类型的传入Class,资源文件名称利用泛型和Json解析返回对应对象。

也可以封装读取普通txt的方法，一行一个字符串返回一个字符串List或者数组，方便测试中使用。