草庐IT

springboot项目使用Junit5 + mockito + jacoco 实现单元测试以及代码覆盖率检查

wk_jl 2024-04-21 原文

以springboot3.0.2为例

在创建springboot项目时会默认添加spring-boot-starter-test依赖,其中已经包含了junit、mockito依赖,根据springboot版本的不同junit和mockito的版本也会有所不同

先说一下各自功能:

  • junit只说一点,junt4和junit5的注解不同,使用方式略有差异,其他不赘述了,基本用法都懂。
  • mockito是mock的一种框架,相比其他框架来说,mockito比较流行,并且springboot默认集成的就是mockito。主要用于模拟一些假数据,以完成单元测试。举例来说就是:A服务已经开发完成,但是A服务中存在需要调用B服务的代码,但是B服务还未开发完成,为了对A服务进行测试,可以使用Mock框架,当A服务中调用B服务时,就是用Mock框架返回一个模拟的假数据(返回的假数据的数据格式和B服务返回的数据格式一致),以实现对A服务业务逻辑代码的测试
  • jacoco:代码覆盖率检查,在idea中通过配置就可以使用,后面会说,还有一种方式就是在pom问价中添加jacoco插件也可以实现代码覆盖率检查,后面同样会介绍。

直接上代码

@RestController
public class UserController {
   @Resource
   private UserService userService;

   @RequestMapping(value = "/selectUser",method = RequestMethod.GET)
   public String selectUserById(@RequestParam String id){
       UserVO userVO = userService.selectUserById(id);
       return userVO.toString();
   }
}
@Service
public class UserServiceImpl implements UserService {

   @Resource
   private UserMapper userMapper;
   @Override
   public UserVO selectUserById(String id) {
       if(StringUtil.isEmpty(id)){
           throw new NullPointerException("id is null");
       }
       return userMapper.selectUserById(id);
   }
}

@SpringBootTest
public class UserControllerTest {
   @MockBean
   private UserMapper userMapper;
   @Resource
   private UserService userService;
   @Resource
   private UserController userController;
   @Test
   public void selectUserById() {
       UserVO user = new UserVO();
       user.setId("1001");
       user.setName("test01");
       Mockito.when(userMapper.selectUserById(Mockito.anyString())).thenReturn(user);
       String result = userController.selectUserById("1002");
       Assertions.assertEquals(user.toString(),result);
   }
}
简单解释一下:

@SpringBootTest 是一个组合注解,由spring提供,标注该类是一个测试类
@MockBean 被MockBean标注的类,表示会为该类创建一个模拟的假对象,这个模拟的假对象的方法的方法体和返回值都为空,该注解也是由spring提供的。
所以上面代码的意思是,当我的代码逻辑中用到UserMapper这个类中的方法时都返回null。但是因为我代码中存在 Mockito.when(userMapper.selectUserById(Mockito.anyString())).thenReturn(user); 这句代码的意思是,当我调用userMapper.selectUserById()时返回自定义的UserVO对象。

Mockito常用注解

@Mock 被@Mock标记的类会创建一个虚拟的对象,该对象的方法的方法体和返回值都为空
@Spy 被@Spy标记的类会创建这个类的真实实例,并且如果调用时没有打桩,则会执行该类的真实逻辑。
@InjectMocks 被@InjectMocks标记的类会创建该类的真实实例,并且该类中依赖注入的其他类会使用被@Mock 或者@Spy 标记的类注入

Spring中和Mock相关的注解

@MockBean 作用和@Mock相同,不同点是,被@MockBean标注的类会被Spring容器管理,而被@Mock标记的类不会。@MockBean是由Spring提供的注解,@Mock是Mockito框架的注解
@SpyBean 作用和@Spy相同。区别与 @MockBean和@Mock的区别一致。

常用的注解组合使用方式

1. @SpringBootTest + @MockBean / @SpyBean + @Resource / @Autowired

  @SpringBootTest  标注在测试类上。
  @MockBean  标注在被测试类中需要的注入的其他类上,表示该类如果在测试过程中遇到,不需要执行真实逻辑,直接返回空。
  @SpyBean  标注在被测试类中需要的注入的其他类上,表示该类如果在测试过程中遇到,如果没有打桩,则执行真实逻辑,返回真实的执行结果,如果打桩了,则返回打桩的值。
   @Service
   public class UserServiceImpl implements UserService {

 	    @Resource
 	    private UserMapper userMapper;
 	    
 	    @Override
 	    public UserVO selectUserById(String id) {
 	        if(StringUtil.isEmpty(id)){
 	            throw new NullPointerException("id is null");
 	        }
 	        UserVO user = userMapper.selectUserById(id);
 	        user.setName("change name");
 	        return user;
 	    }
 	    @Override
 	    public int insertUser(UserVO user) {
 	        return 0;
 	    }
 }

 @SpringBootTest
 public class UserControllerTest {
     @MockBean
     private UserMapper userMapper;
     @SpyBean
     private UserService userService;
     @Resource
     private UserController userController;
     @Test
     public void selectUserById() {
         UserVO user = new UserVO();
         user.setId("1001");
         user.setName("test01");
         //Mockito.when().thenReturn()  这句代码的意思就是 打桩
         Mockito.when(userMapper.selectUserById(Mockito.anyString())).thenReturn(user);
         String result = userController.selectUserById("1002");
         Assertions.assertEquals(user.toString(),result);
         int uid1 = userService.insertUser(user); //打桩前
         Mockito.when(userService.insertUser(Mockito.any(UserVO.class))).thenReturn(22);
         int uid2 = userService.insertUser(user); // 打桩后
         Assertions.assertEquals(uid1,uid2);
     }
 }

执行结果

2. @ExtendWith(MockitoExtension.class) + @Mock / @Spy + @InjectMocks

@ExtendWith(MockitoExtension.class)  标注在测试类上用于声明上下文环境。@SpringBootTest中也存在这个注解默认是 SpringExtension.class.
@Mock 和@MockBean作用一致
@Spy  和@SpyBean作用一致
@ExtendWith(MockitoExtension.class)
public class UserServiceImplTest {

    @Mock
    private UserMapper userMapper;

    @InjectMocks
    private UserServiceImpl userService;

    @Test
    public void selectUserById() {
        UserVO user = new UserVO();
        user.setName("test123");
        user.setId("20001");
        Mockito.when(userMapper.selectUserById(Mockito.anyString())).thenReturn(user);
        UserVO result = userService.selectUserById("30001");
        Assertions.assertEquals(user.toString(),result.toString());
    }
}

3. MockMvc模拟HTTP请求测试controller

@RestController
public class UserController {
    @Resource
    private UserService userService;

    @RequestMapping(value = "/selectUser",method = RequestMethod.GET)
    public String selectUserById(@RequestParam String id){
        UserVO userVO = userService.selectUserById(id);
        return userVO.toString();
    }

    @PostMapping("/insertUser")
    public int insertUser(@RequestBody UserVO userVO){
        userService.insertUser(userVO);
        return 12345;
    }
}

@SpringBootTest
@AutoConfigureMockMvc
public class UserControllerTest3 {
    @MockBean
    private UserMapper userMapper;
    @SpyBean
    private UserService userService;
    @Resource
    private MockMvc mockMvc;
    @Test
    public void selectUserById() throws Exception {
        UserVO user = new UserVO();
        user.setId("1001");
        user.setName("test01");
        //Mockito.when().thenReturn()  这句代码的意思就是 打桩
        Mockito.when(userMapper.selectUserById(Mockito.anyString())).thenReturn(user);
        /* 模拟一次get请求*/
        RequestBuilder rb = MockMvcRequestBuilders.get("/selectUser")
                .contentType(MediaType.TEXT_HTML_VALUE)
                .param("id","123456");
        MvcResult result = mockMvc.perform(rb).andReturn();
        Assertions.assertEquals(user.toString(),result.getResponse().getContentAsString());
    }


    @Test
    public void insertUserTest() throws Exception {
        UserVO user = new UserVO();
        user.setId("1001");
        user.setName("test01");
        Gson gson = new Gson();
        String jsonStr = gson.toJson(user);
        Mockito.when(userService.insertUser(Mockito.any(UserVO.class))).thenReturn(789);
        /* 模拟一次POST请求*/
        RequestBuilder rb = MockMvcRequestBuilders.post("/insertUser")
                .contentType(MediaType.APPLICATION_JSON_VALUE)
                .content(jsonStr);
        MvcResult result = mockMvc.perform(rb).andReturn();
        Assertions.assertEquals("12345",result.getResponse().getContentAsString());
    }
}

运行截图

Jacoco 代码覆盖率

Jacoco有以下两种使用方式

1. Idea中配置Jacoco




运行结果

查看代码覆盖率


2. POM文件中引用Jacoco插件

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.0.2</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.wangkai</groupId>
    <artifactId>junitMockitoJacoco</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>junitMockitoJacoco</name>
    <description>junitMockitoJacoco</description>
    <properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>com.google.code.gson</groupId>
            <artifactId>gson</artifactId>
            <version>2.9.0</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <version>0.8.8</version>
                <!-- 可选配置,可以不写,默认运行所有包下的代码-->
                <configuration>
                    <includes>
                        <include>com/**/*</include>
                    </includes>
                </configuration>
                <executions>
                    <execution>
                        <id>pre-test</id>
                        <goals>
                            <goal>prepare-agent</goal>
                        </goals>
                    </execution>
                    <execution>
                        <id>post-unit-test</id>
                        <phase>test</phase>
                        <goals>
                            <goal>report</goal>
                        </goals>
                        <!-- 可选配置,指定文件输出路径。默认路径为:target/site/jacoco-->
<!--                        <configuration>-->
<!--                            <dataFile>target/jacoco.exec</dataFile>-->
<!--                            <outputDirectory>target/jacoco</outputDirectory>-->
<!--                        </configuration>-->
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>

运行结果

有关springboot项目使用Junit5 + mockito + jacoco 实现单元测试以及代码覆盖率检查的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri,根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

    我有一个Ruby程序,它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重,我想提高压缩级别,因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗?是否有另一个允许指定压缩级别的Ruby库? 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

  3. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法? - 2

    类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

  4. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

    很好奇,就使用ruby​​onrails自动化单元测试而言,你们正在做什么?您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您?git中的预提交Hook?只是手动调用?我完全理解测试,但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的,并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您? 最佳答案 不确定您到底想听什么,但是有几个级别的自动代码库控制:在处理某项功能时,您可以使用类似autotest的内容获得关于哪些有效,哪些无效的即时反馈。要确保您的提

  5. ruby - 在 Ruby 中使用匿名模块 - 2

    假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外,还有什么方法可以访问C和m中的其他内容?我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)?如何在使用完匿名模块后将其删除,使其定义的常量不再存在? 最佳答案 三个答案:是的,使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于

  6. ruby - 使用 ruby​​ 和 savon 的 SOAP 服务 - 2

    我正在尝试使用ruby​​和Savon来使用网络服务。测试服务为http://www.webservicex.net/WS/WSDetails.aspx?WSID=9&CATID=2require'rubygems'require'savon'client=Savon::Client.new"http://www.webservicex.net/stockquote.asmx?WSDL"client.get_quotedo|soap|soap.body={:symbol=>"AAPL"}end返回SOAP异常。检查soap信封,在我看来soap请求没有正确的命名空间。任何人都可以建议我

  7. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声? - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点?我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等),但我确实想创建一个输出文件。

  8. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗?当我运行compasswatch时,它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行?文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们?我自己编译的.sass文件编译成compiled/t

  9. ruby - 使用 ruby​​ 将 HTML 转换为纯文本并维护结构/格式 - 2

    我想将html转换为纯文本。不过,我不想只删除标签,我想智能地保留尽可能多的格式。为插入换行符标签,检测段落并格式化它们等。输入非常简单,通常是格式良好的html(不是整个文档,只是一堆内容,通常没有anchor或图像)。我可以将几个正则表达式放在一起,让我达到80%,但我认为可能有一些现有的解决方案更智能。 最佳答案 首先,不要尝试为此使用正则表达式。很有可能你会想出一个脆弱/脆弱的解决方案,它会随着HTML的变化而崩溃,或者很难管理和维护。您可以使用Nokogiri快速解析HTML并提取文本:require'nokogiri'h

  10. ruby - 在 64 位 Snow Leopard 上使用 rvm、postgres 9.0、ruby 1.9.2-p136 安装 pg gem 时出现问题 - 2

    我想为Heroku构建一个Rails3应用程序。他们使用Postgres作为他们的数据库,所以我通过MacPorts安装了postgres9.0。现在我需要一个postgresgem并且共识是出于性能原因你想要pggem。但是我对我得到的错误感到非常困惑当我尝试在rvm下通过geminstall安装pg时。我已经非常明确地指定了所有postgres目录的位置可以找到但仍然无法完成安装:$envARCHFLAGS='-archx86_64'geminstallpg--\--with-pg-config=/opt/local/var/db/postgresql90/defaultdb/po

随机推荐