Java 参数化测试

什么是参数化测试？

参数化测试是一种测试方法，允许开发者使用不同的参数多次运行同一个测试。在不使用参数化测试的情况下，如果想要测试一个方法在不同输入下的表现，我们需要为每个输入编写单独的测试方法，这会导致大量重复代码。而参数化测试则允许我们编写一个测试方法，然后提供多组参数来测试该方法。

备注

参数化测试特别适合需要使用多种输入值测试相同逻辑的场景，可以显著减少测试代码的冗余。

为什么需要参数化测试？

参数化测试有以下几个优势：

减少代码重复：避免为相似的测试场景编写多个几乎相同的测试方法
提高测试覆盖率：轻松测试边界条件和各种输入场景
增强可维护性：当测试逻辑需要更改时，只需修改一个地方
简化测试数据管理：测试数据可以集中管理，便于维护和扩展

JUnit 5中的参数化测试

JUnit 5提供了强大的参数化测试支持。要使用参数化测试，首先需要添加相应的依赖：

xml
<dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter-params</artifactId>
    <version>5.8.2</version>
    <scope>test</scope>
</dependency>

基本参数化测试

最简单的参数化测试使用@ParameterizedTest和@ValueSource注解：

java
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
import static org.junit.jupiter.api.Assertions.assertTrue;

public class StringTests {
    
    @ParameterizedTest
    @ValueSource(strings = {"racecar", "radar", "level", "madam"})
    void testPalindromes(String word) {
        assertTrue(isPalindrome(word));
    }
    
    private boolean isPalindrome(String word) {
        String reversed = new StringBuilder(word).reverse().toString();
        return word.equals(reversed);
    }
}

这个测试将分别使用"racecar"、"radar"、"level"和"madam"这四个值执行testPalindromes方法，检查它们是否都是回文字符串。

常用参数源

JUnit 5提供多种参数源注解：

@ValueSource - 支持基本类型和String的数组
@NullSource - 提供单个null参数
@EmptySource - 提供空字符串、集合或数组
@NullAndEmptySource - 结合@NullSource和@EmptySource
@CsvSource - 提供逗号分隔的参数值
@CsvFileSource - 从CSV文件读取参数
@MethodSource - 从方法返回的集合或数组中获取参数
@EnumSource - 使用枚举常量作为参数

@CsvSource示例

java
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.CsvSource;
import static org.junit.jupiter.api.Assertions.assertEquals;

public class CalculatorTests {
    
    @ParameterizedTest
    @CsvSource({
        "1, 1, 2",
        "2, 3, 5",
        "10, 15, 25",
        "0, 0, 0"
    })
    void testAddition(int first, int second, int expectedResult) {
        Calculator calculator = new Calculator();
        assertEquals(expectedResult, calculator.add(first, second));
    }
    
    class Calculator {
        public int add(int a, int b) {
            return a + b;
        }
    }
}

这个测试将使用CSV格式的数据，每组数据包含三个参数：两个加数和预期的和。

@MethodSource示例

java
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.MethodSource;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.util.stream.Stream;

public class EvenNumberTests {
    
    @ParameterizedTest
    @MethodSource("evenNumbersProvider")
    void testIsEven(int number) {
        assertTrue(number % 2 == 0);
    }
    
    static Stream<Integer> evenNumbersProvider() {
        return Stream.of(2, 4, 6, 8, 10);
    }
}

这个测试使用evenNumbersProvider方法提供的数据作为参数，测试这些数是否都是偶数。

高级参数化测试

参数转换

有时我们需要将字符串参数转换为其他类型。JUnit 5提供了隐式和显式的参数转换机制：

java
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.converter.ConvertWith;
import org.junit.jupiter.params.converter.SimpleArgumentConverter;
import org.junit.jupiter.params.provider.ValueSource;
import static org.junit.jupiter.api.Assertions.assertNotNull;

public class CustomConverterTest {
    
    @ParameterizedTest
    @ValueSource(strings = {"2023-01-01", "2023-12-31"})
    void testWithImplicitConversion(LocalDate date) {
        // JUnit会自动将字符串转换为LocalDate
        assertNotNull(date);
    }
    
    // 自定义转换器示例
    static class PersonConverter extends SimpleArgumentConverter {
        @Override
        protected Object convert(Object source, Class<?> targetType) {
            String[] parts = ((String) source).split(",");
            return new Person(parts[0], Integer.parseInt(parts[1]));
        }
    }
    
    @ParameterizedTest
    @ValueSource(strings = {"John,30", "Alice,25"})
    void testWithCustomConverter(@ConvertWith(PersonConverter.class) Person person) {
        assertNotNull(person);
    }
    
    static class Person {
        String name;
        int age;
        
        Person(String name, int age) {
            this.name = name;
            this.age = age;
        }
    }
}

自定义显示名称

可以自定义参数化测试的显示名称，使测试报告更加清晰：

java
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
import static org.junit.jupiter.api.Assertions.assertTrue;

public class DisplayNameTest {
    
    @ParameterizedTest(name = "第{index}次测试，输入值: {0}")
    @ValueSource(ints = {2, 4, 6, 8})
    void testEvenNumbers(int number) {
        assertTrue(number % 2 == 0);
    }
}

这样在测试报告中会显示如"第1次测试，输入值: 2"这样的名称。

实际应用场景

场景1：边界值测试

java
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.CsvSource;
import static org.junit.jupiter.api.Assertions.assertEquals;

public class AgeValidatorTest {
    
    @ParameterizedTest
    @CsvSource({
        "0, 未成年",
        "17, 未成年",
        "18, 成年",
        "19, 成年",
        "65, 成年",
        "66, 老年",
        "120, 老年"
    })
    void testAgeCategory(int age, String expectedCategory) {
        AgeValidator validator = new AgeValidator();
        assertEquals(expectedCategory, validator.getCategory(age));
    }
    
    static class AgeValidator {
        public String getCategory(int age) {
            if (age < 0 || age > 120) {
                throw new IllegalArgumentException("年龄必须在0-120之间");
            }
            if (age < 18) {
                return "未成年";
            } else if (age < 66) {
                return "成年";
            } else {
                return "老年";
            }
        }
    }
}

这个测试使用不同的年龄值测试年龄分类器的边界条件。

场景2：输入验证

java
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
import org.junit.jupiter.params.provider.NullAndEmptySource;
import static org.junit.jupiter.api.Assertions.*;

public class EmailValidatorTest {
    
    @ParameterizedTest
    @ValueSource(strings = {
        "[email protected]", 
        "[email protected]", 
        "[email protected]"
    })
    void testValidEmails(String email) {
        EmailValidator validator = new EmailValidator();
        assertTrue(validator.isValid(email), "应该是有效的邮箱地址");
    }
    
    @ParameterizedTest
    @ValueSource(strings = {
        "invalid-email", 
        "user@", 
        "@example.com", 
        "[email protected]"
    })
    @NullAndEmptySource
    void testInvalidEmails(String email) {
        EmailValidator validator = new EmailValidator();
        assertFalse(validator.isValid(email), "应该是无效的邮箱地址");
    }
    
    static class EmailValidator {
        public boolean isValid(String email) {
            if (email == null || email.isEmpty()) {
                return false;
            }
            return email.matches("^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$");
        }
    }
}

这个测试使用多个有效和无效的电子邮件地址来测试电子邮件验证器。

最佳实践

保持测试清晰：每个参数化测试应该专注于测试一个特定方面
选择合适的参数源：根据测试需求选择最适合的参数提供方式
使用有意义的显示名称：定制测试名称，使报告更加清晰
设置合理的测试数据：包括正常值、边界值和异常情况
避免过度参数化：如果测试逻辑因参数而异，可能需要拆分成多个测试

警告

参数化测试虽然强大，但也容易使测试结果难以解释。确保每组参数的测试目的明确，避免在一个参数化测试中混合测试多个无关的功能点。

总结

参数化测试是一种强大的测试技术，可以帮助我们用更少的代码编写更全面的测试。JUnit 5提供了丰富的参数化测试功能，包括多种参数源、参数转换器和显示名称自定义等。通过参数化测试，我们可以更有效地测试不同输入条件下的代码行为，提高测试的覆盖率和可维护性。

练习

为一个计算器类编写参数化测试，测试加法、减法、乘法和除法功能
使用@MethodSource为字符串处理方法（如大小写转换）编写参数化测试
设计一个自定义转换器，将字符串转换为复杂对象，并编写参数化测试
为一个日期处理类编写参数化测试，测试其对不同格式日期字符串的解析能力

额外资源

JUnit 5 官方参数化测试文档
《实用 JUnit 测试》第8章 - 参数化测试技术
《Java 测试驱动开发》第5章 - 高效测试策略

通过本章的学习，你已经掌握了Java参数化测试的基础知识和高级技术，可以开始在实际项目中应用参数化测试，提高测试效率和代码质量。

什么是参数化测试？​

为什么需要参数化测试？​

JUnit 5中的参数化测试​

基本参数化测试​

常用参数源​

@CsvSource示例​

@MethodSource示例​

高级参数化测试​

参数转换​

自定义显示名称​

实际应用场景​

场景1：边界值测试​

场景2：输入验证​

最佳实践​

总结​

练习​

额外资源​