高质量单元测试要求和依据阿里巴巴编码规范的Java单元测试示例

易之阴阳

已于 2024-03-21 15:49:03 修改

阅读量216

点赞数 1

分类专栏： web 代码质量文章标签： java 单元测试

于 2024-03-21 15:38:36 首次发布

本文链接：https://blog.csdn.net/liuzk423/article/details/136910600

版权

web 同时被 2 个专栏收录

29 篇文章 0 订阅

订阅专栏

代码质量

23 篇文章 0 订阅

订阅专栏

当前程序员的基本功必须会写单元测试。根据业界最佳实践总结，单元测试的基本要求和原则，大致包括但不限于以下几点：

1.单元测试覆盖率要求

单元测试应尽可能覆盖所有的业务逻辑分支，包括正常流程、异常处理和边界条件。

通常提倡至少达到80%以上的代码覆盖率，核心业务模块和关键算法应实现更高的覆盖率。

2.测试粒度

单元测试应专注于测试最小可测试单元（如方法级别），确保单一方法在隔离环境下正确运作。

3.可读性和维护性

测试代码同样应该具有良好的可读性和易于维护，命名应清晰地反映测试意图和场景。

每个测试用例应简洁明了，尽量模拟单一条件或场景。

4.模拟和隔离依赖

使用Mock框架（如Mockito）模拟和隔离外部依赖，如数据库、第三方API等，只测试被测试单元本身的逻辑。

5.断言明确

在每个测试用例中，使用恰当的断言语句来精确验证预期的结果，确保测试结果可确定性。

6.测试数据准备

使用固定的或随机生成的数据集进行测试，确保数据的可控性和复用性。

7.测试用例组织

测试类和测试方法应按照一定的逻辑结构组织，如按照功能模块划分，并保持测试用例的原子性和独立性，即每个测试用例之间互不影响。

8.自动化执行

单元测试应作为CI/CD流程的一部分，确保每次代码提交后都能自动执行并通过测试。

9.持续改进

根据代码变化不断迭代和优化测试用例，保持测试的有效性和准确性。

10.异常处理

特别针对可能抛出的异常情况进行测试，确保异常被正确捕获和处理。

依据阿里巴巴编码规范，单元测试应当保证代码的可测性、覆盖率和独立性。如下Java单元测试示例：

// 引入必要的单元测试依赖
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.Mockito.*;

// 假设我们有一个服务类UserService需要进行单元测试
@SpringBootTest
public class UserServiceTest {

    // 注入模拟对象（Mockito库用于模拟依赖）
    @Mock
    private UserRepository userRepository;

    // 使用@InjectMocks注解注入真实的UserService实例，并使用mocked UserRepository
    @InjectMocks
    private UserService userService;

    @BeforeEach
    public void setUp() {
        MockitoAnnotations.initMocks(this);
    }

    // 测试用例1：验证用户注册功能
    @Test
    public void testUserRegistration() {
        // 配置模拟行为：当调用userRepository.save时返回一个已保存的用户实体
        User mockUser = new User("testUser", "password");
        when(userRepository.save(mockUser)).thenReturn(mockUser);

        // 调用待测试方法
        User registeredUser = userService.register(mockUser);

        // 验证结果
        assertEquals(mockUser, registeredUser);
        verify(userRepository).save(mockUser);
    }

    // 测试用例2：检查异常处理边界条件 - 用户名重复
    @Test
    public void testDuplicateUsernameRegistration() {
        // 设置模拟场景：用户名已存在
        when(userRepository.findByUsername(anyString())).thenReturn(new User("existingUser", "anotherPassword"));

        // 调用待测试方法并捕获预期的异常
        DuplicateUsernameException exception = assertThrows(DuplicateUsernameException.class,
                () -> userService.register(new User("existingUser", "newPassword")));

        // 验证抛出的异常类型及信息
        assertEquals("用户名 existingUser 已存在", exception.getMessage());
    }

    // 测试用例3：确保清理资源（例如数据库连接）在每次测试后都会自动回滚
    @Test
    @Transactional // 如果使用Spring框架，可以使用@Transactional注解确保事务回滚
    public void testTransactionRollback() {
        // 执行一些更新操作...
        userService.doSomeUpdate();

        // 由于@Transactional注解的作用，此处无需手动验证事务是否回滚，
        // 因为在测试结束后，所有对数据库的操作都将被自动撤销。
    }
}

在这个例子中，展示了几个关键点：