一、背景

很多公司对分支单测覆盖率会有一定的要求，比如单测覆盖率要达到 60% 或者 80%才可以发布。

有时候工期相对紧张，就优先开发功能，测试功能，然后再去补单元测试。
在这里插入图片描述

但是编写单元测试又比较浪费时间，有没有能够很大程度上自动化生成单元测试的插件，自己简单改改即可呢？

自己尝试在 Idea 插件库里搜索相关插件并去尝试使用，发现 TestMe 还可以。后面和其他同学交流，谎伴同学推荐他一直在用的 Squaretest，我试用之后发现相当不错。

在这里简单介绍这两个插件。

如果先尝试其他单元测试相关插件，可以在 IDEA 里或者点这里：
https://plugins.jetbrains.com/search?orderBy=downloads&tags=Unit%20testing

二、推荐工具

2.1 Squaretest

2.1.1 使用介绍

官网地址：https://squaretest.com/
官方用户手册：https://squaretest.com/#user_guide
官网插件地址
https://plugins.jetbrains.com/plugin/10405-squaretest

优点：生成的代码比较规整，生成的代码比较，帮助构造一些参数等。
缺点：不使用 Confirm Mock功能时，对Spring 的 Bean 生成单测代码时，如果属性是通过 @Setter 注解注入，则不会生成 @Mock 属性；如果想实现暂时只能自己修改模板来支持(后面会给出)。

使用方法：
可以在顶部菜单 [Squaretest] 菜单中选择第一个或者使用对应快捷键创建单元测试。
在这里插入图片描述
生成的代码：

这个例子比较简单，只是给大家演示如何使用，实际使用中类复杂时，就能体会到该插件的强大。

示例代码：

import org.apache.commons.collections4.CollectionUtils;
import org.springframework.stereotype.Service;

import javax.annotation.Resource;
import java.util.ArrayList;
import java.util.List;
import java.util.stream.Collectors;

@Service
public class UserManager {

    @Resource
    private UserDAO userDAO;

    public List<UserDO> someThing(Param param) {

        List<UserDO> result = new ArrayList<>();

        if(param == null) {
            return result;
        }

        List<String> userIds = param.getUserIds();
        if(CollectionUtils.isEmpty(userIds)) {
            return result;
        }

        List<UserDO> users = userDAO.findByIds(userIds);
        if(CollectionUtils.isEmpty(users)) {
            return result;
        }

      return  users.stream().filter(UserDO::getCanShow).collect(Collectors.toList());
    }

}

生成的代码：

import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnitRunner;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import static org.junit.Assert.assertEquals;
import static org.mockito.Mockito.when;

@RunWith(MockitoJUnitRunner.class)
public class UserManagerTest {

    @Mock
    private UserDAO mockUserDAO;

    @InjectMocks
    private UserManager userManagerUnderTest;

    @Test
    public void testSomeThing() {
        // Setup
        final Param param = new Param();
        param.setUserIds(Arrays.asList("value"));
        param.setOthers("others");

        // Configure UserDAO.findByIds(...).
        final UserDO userDO = new UserDO();
        userDO.setCanShow(false);
        userDO.setName("name");
        final List<UserDO> userDOS = Arrays.asList(userDO);
        when(mockUserDAO.findByIds(Arrays.asList("value"))).thenReturn(userDOS);

        // Run the test
        final List<UserDO> result = userManagerUnderTest.someThing(param);

        // Verify the results
    }

    @Test
    public void testSomeThing_UserDAOReturnsNoItems() {
        // Setup
        final Param param = new Param();
        param.setUserIds(Arrays.asList("value"));
        param.setOthers("others");

        when(mockUserDAO.findByIds(Arrays.asList("value"))).thenReturn(Collections.emptyList());

        // Run the test
        final List<UserDO> result = userManagerUnderTest.someThing(param);

        // Verify the results
        assertEquals(Collections.emptyList(), result);
    }
}

官方演示1：选择性生成测试代码
在这里插入图片描述官方演示2：选择需要 mock 的属性

官方示例3：在单测里写 test 即可选择需要测试的方法自动生成测试代码
在这里插入图片描述

2.2.2 定制化

前面讲到默认的模板，对Spring 的 Bean 生成单测代码时，如果通过 xml 方式声明 bean ，属性都是通过 @Setter 注解注入，则不会生成 @Mock 属性。

public class UserManager {

    @Setter
    private UserDAO userDAO;

    public List<UserDO> someThing(Param param) {
// 省略
    }

}

可以使用 Confirm Mocks 功能选择该属性需要 Mock
在这里插入图片描述

在这里插入图片描述
该插件也支持对生成的模板进行调整：

还可以对模板进行简单修改，所有 @Setter 都会自动加上 @Mock 注解：

1526 行：
在这里插入图片描述

在这里插入图片描述
在依赖的注解属性中添加 Setter 注解即可。

  ## Add the simple names or cannonical names of any custom dependency annotations to the method call below.
        #set($dependencyAnnotatedFields = $sourceClass.fieldsAnnotatedWith('Inject', 'Setter','Autowired', 'Resource', 'PersistenceContext'))

如果使用 powermock ，需要进行修改 1502 -1506 行：
在这里插入图片描述

#set($mockitoRunnerCanonicalName = 'org.powermock.modules.junit4.PowerMockRunner')
#set($mockitoRunnerName = 'PowerMockRunner')

删除部分

    #if(!$ClassUtils.isInTestClasspath('org.mockito.junit.MockitoJUnitRunner') && $ClassUtils.isInTestClasspath('org.mockito.runners.MockitoJUnitRunner'))
        #set($mockitoRunnerCanonicalName = 'org.mockito.runners.MockitoJUnitRunner')
    #end

2.2 TestMe

2.2.1 使用介绍

插件官网地址
https://plugins.jetbrains.com/plugin/9471-testme

功能：

自动生成 Java JUnit 4/5, TestNG 单元测试
自动生成 Mockito mocks
自动生成测试参数和断言语句
自动生成相关 mock 方法
IDEA 菜单: Code->TestMe, Code->Generate

优点：Spring 的 Bean 生成单测代码时，即使 @Component 这类注解标注，属性通过 Setter 注解注入时，也会自动给添加 @Mock 和 @InjectMock 这类属性。
缺点：默认模板会在生成的方法上都加上 throws Exception

示例代码1：
在这里插入图片描述
或者直接使用快捷键

生成的代码：

这个例子比较简单，只是给大家演示如何使用，实际使用中类复杂时，就能体会到该插件的强大。

示例代码2：

import org.apache.commons.collections4.CollectionUtils;
import org.springframework.stereotype.Service;

import javax.annotation.Resource;
import java.util.ArrayList;
import java.util.List;
import java.util.stream.Collectors;

@Service
public class UserManager {

    @Resource
    private UserDAO userDAO;

    public List<UserDO> someThing(Param param) {

        List<UserDO> result = new ArrayList<>();

        if(param == null) {
            return result;
        }

        List<String> userIds = param.getUserIds();
        if(CollectionUtils.isEmpty(userIds)) {
            return result;
        }

        List<UserDO> users = userDAO.findByIds(userIds);
        if(CollectionUtils.isEmpty(users)) {
            return result;
        }

      return  users.stream().filter(UserDO::getCanShow).collect(Collectors.toList());
    }

}

生成的代码

import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;

import java.util.Arrays;
import java.util.List;

import static org.mockito.Mockito.*;

public class UserManagerTest {
    @Mock
    UserDAO userDAO;
    @InjectMocks
    UserManager userManager;

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

    @Test
    public void testSomeThing() throws Exception {
        when(userDAO.findByIds(any())).thenReturn(Arrays.<UserDO>asList(new UserDO()));

        List<UserDO> result = userManager.someThing(new Param());
        Assert.assertEquals(Arrays.<UserDO>asList(new UserDO()), result);
    }
}

//Generated with love by TestMe :) Please report issues and submit feature requests at: http://weirddev.com/forum#!/testme

自己在此基础上简单修改即可。

2.2.2 定制化

大家还可以根据自己需要对模板进行修改：
在这里插入图片描述
默认模板存在几个问题：
1、没有在类上增加 @RunWith(MockitoJUnitRunner.class) 注解
2、单元测试方法后面默认会带上 throws Exception 没有太大必要
3、底部 TestMe Footer.java 的内容不需要
4、@Mock 和 @InjectMock 之间没空行

对 Junit4 & mockito 复制一份（原始文件是只读的）进行修改
在这里插入图片描述

生成一个 Copy of Junit4 & mockito 的模板，可以对其进行修改
在这里插入图片描述

修改后的模板：

#parse("Copy of TestMe macros.java")
#set($hasMocks=$MockitoMockBuilder.hasMockable($TESTED_CLASS.fields))
#if($PACKAGE_NAME)
package ${PACKAGE_NAME};
#end

import static org.junit.Assert.*;
import org.junit.Test;
#if($hasMocks)
import org.junit.Before;
import org.junit.runner.RunWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.mockito.junit.MockitoJUnitRunner;
import org.junit.Assert;
//import static org.mockito.Mockito.*;
#end

#parse("File Header.java")
@RunWith(MockitoJUnitRunner.class)
public class ${CLASS_NAME} {
#renderMockedFields($TESTED_CLASS.fields)

#renderTestSubjectInit($TESTED_CLASS,$TestSubjectUtils.hasTestableInstanceMethod($TESTED_CLASS.methods),$hasMocks)
#if($hasMocks)

    @Before
    public void setUp() {
    }
#end
#foreach($method in $TESTED_CLASS.methods)
#if($TestSubjectUtils.shouldBeTested($method))

    @Test
    public void #renderTestMethodName($method.name)(){
#if($MockitoMockBuilder.shouldStub($method,$TESTED_CLASS.fields))
#renderMockStubs($method,$TESTED_CLASS.fields)

#end
        #renderMethodCall($method,$TESTED_CLASS.name)
#if($method.hasReturn())        #renderJUnitAssert($method)#end
    }
#end
#end
}

然后我们生成单元测试时选择该模板：
在这里插入图片描述
发现生成的代码格式好了不少：

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnitRunner;

import java.util.Arrays;
import java.util.List;

import static org.junit.Assert.assertEquals;

import static org.mockito.Mockito.*;

@RunWith(MockitoJUnitRunner.class)
public class UserManagerTest {
    @Mock
    UserDAO userDAO;

    @InjectMocks
    UserManager userManager;

    @Before
    public void setUp() {
    }

    @Test
    public void testSomeThing() {
        when(userDAO.findByIds(any())).thenReturn(Arrays.<UserDO>asList(new UserDO()));

        List<UserDO> result = userManager.someThing(new Param());
        assertEquals(Arrays.<UserDO>asList(new UserDO()), result);
    }
}

三、单测高效构造参数和返回值神器

我们还可以借助其他工具，自动生成测试的参数或者返回值。
https://github.com/j-easy/easy-random

可以参考我之前的一篇文章：
《Java高效构造对象的神器：easy-random 简介》

一两行就可以构造一个非常复杂的对象或者对象列表。

《Java 单元测试生成测试字符串的神器：java-faker》

如果我们想要随机构造人名、地名、天气、学校、颜色、职业，甚至符合某正则表达式的字符串

四、总结

灵活使用单元测试自动生成插件，可以节省很多时间。

大家可以安装并试用这两个插件，然后根据自己的喜好，选择最适合自己的那个插件使用。
也可以根据自己的喜好，对模板进行调整。
此外，大家不要对插件要求太高，生成的单元测试或多或少还是需要自己进行简单修改，如修改下参数、增加几个断言等。

创作不易，如果本文对你有帮助，欢迎点赞、收藏加关注，你的支持和鼓励，是我创作的最大动力。

告别加班/解放双手提高单测覆盖率之Java 自动生成单测代码神器推荐

一、背景

二、推荐工具

2.1 Squaretest

2.1.1 使用介绍

2.2.2 定制化

2.2 TestMe

2.2.1 使用介绍

2.2.2 定制化

三、单测高效构造参数和返回值神器

四、总结

热门文章

最新文章

相关课程

相关电子书

相关实验场景

热门

活动广场

任务中心

开发者评测

高校计划

乘风者计划

训练营

阿里云MVP

话题

直播

下载

镜像站

技术资料

插件

告别加班/解放双手提高单测覆盖率之Java 自动生成单测代码神器推荐

一、背景

二、推荐工具

2.1 Squaretest

2.1.1 使用介绍

2.2.2 定制化

2.2 TestMe

2.2.1 使用介绍

2.2.2 定制化

三、单测高效构造参数和返回值神器

四、总结

热门文章

最新文章

相关课程

相关电子书

相关实验场景