Spring Boot Junit單元測試的介紹與使用

單元測試（模組測試）：是開發者編寫的一小段程式碼，用來檢驗被測程式碼的一個很小的、很明確的功能是否正確。通常而言，一個單元測試是用來判斷某個特定條件（或場景）下某個特定函數的行為。例如，你可能把一個很大的值放入一個有序list 中去，然後確認值出現在list 的尾端。或者，你可能會從字串中刪除符合某種模式的字符，然後確認字串確實不再包含這些字符了。

     簡單的說，單元測試就是對你程式中最小的功能模組進行測試，在c語言裡可能是一個函數，java中可能是一個方法或類別。

目的就是為了提高程式碼的品質。

Junit這種老技術，現在又拿出來說，不為別的，某種程度上來說，更是為了要說明它在專案中的重要性。 

以本人的感覺和經驗來說，在專案中完全以標準都寫Junit用例覆蓋大部分業務程式碼的，應該不會超過一半。

剛好前段時間寫了一些關於SpringBoot的帖子，正好現在把Junit再拿出來從幾個方面再說一下，也算是給一些新手參考了。

那麼先簡單說為什麼要寫測試案例

1. 可以避免測試點的遺漏，為了更好的進行測試，可以提高測試效率

#2. 可以自動測試，可以在專案打包前進行測試校驗

3. 可以及時發現因為修改程式碼導致新的問題的出現​​，並及時解決

那麼本文從以下幾點來說明怎麼使用Junit，Junit4比3要方便很多，細節大家可以自己了解下，主要就是版本4中對方法命名格式不再有要求，不再需要繼承TestCase，一切都基於註解實現。

1、SpringBoot Web專案中如何使用Junit

#建立一個普通的Java類，在Junit4中不再需要繼承TestCase類別了。

因為我們是Web項目，所以在建立的Java類別中加入註解：

@RunWith(SpringJUnit4ClassRunner.class) // SpringJUnit支持，由此引入Spring-Test框架支持！ 
@SpringApplicationConfiguration(classes = SpringBootSampleApplication.class) // 指定我们SpringBoot工程的Application启动类
@WebAppConfiguration // 由于是Web项目，Junit需要模拟ServletContext，因此我们需要给我们的测试类加上@WebAppConfiguration。

接下來就可以寫測試方法了，測試方法使用@Test註解標註即可。

在該類別中我們可以像平常開發一樣，直接@Autowired來注入我們要測試的類別實例。

下面是完整程式碼：

package org.springboot.sample;

import static org.junit.Assert.assertArrayEquals;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springboot.sample.service.StudentService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.SpringApplicationConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.web.WebAppConfiguration;

/**
 *
 * @author  单红宇(365384722)
 * @create  2016年2月23日
 */
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = SpringBootSampleApplication.class)
@WebAppConfiguration
public class StudentTest {

  @Autowired
  private StudentService studentService;

  @Test
  public void likeName() {
    assertArrayEquals(
        new Object[]{
            studentService.likeName("小明2").size() > 0,
            studentService.likeName("坏").size() > 0,
            studentService.likeName("莉莉").size() > 0
          }, 
        new Object[]{
            true,
            false,
            true
          }
    );
//   assertTrue(studentService.likeName("小明2").size() > 0);
  }

}

接下來，你需要新增無數個測試類，編寫無數個測試方法來保障我們所開發的程式的有效性。

2、Junit基本註解介紹

#

//在所有测试方法前执行一次，一般在其中写上整体初始化的代码 
@BeforeClass

//在所有测试方法后执行一次，一般在其中写上销毁和释放资源的代码 
@AfterClass

//在每个测试方法前执行，一般用来初始化方法（比如我们在测试别的方法时，类中与其他测试方法共享的值已经被改变，为了保证测试结果的有效性，我们会在@Before注解的方法中重置数据） 
@Before

//在每个测试方法后执行，在方法执行完成后要做的事情 
@After

// 测试方法执行超过1000毫秒后算超时，测试将失败 
@Test(timeout = 1000)

// 测试方法期望得到的异常类，如果方法执行没有抛出指定的异常，则测试失败 
@Test(expected = Exception.class)

// 执行测试时将忽略掉此方法，如果用于修饰类，则忽略整个类 
@Ignore(“not ready yet”) 
@Test

@RunWith

在JUnit中有很多Runner ，他們負責呼叫你的測試程式碼，每個Runner都有各自的特殊功能，你要根據需要選擇不同的Runner來執行你的測試程式碼。

如果我們只是簡單的做普通Java測試，不涉及spring Web項目，你可以省略@RunWith註解，這樣系統會自動使用預設Runner來運行你的程式碼。

3、參數化測試

Junit為我們提供的參數化測試需要使用@RunWith(Parameterized.class)

#然而因為Junit 使用@RunWith指定一個Runner，在我們更多情況下需要使用@RunWith(SpringJUnit4ClassRunner.class)來測試我們的Spring工程方法，所以我們使用assertArrayEquals 來對方法進行多種可能性測試便可。

以下是關於參數化測試的一個簡單範例：

package org.springboot.sample;

import static org.junit.Assert.assertTrue;

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

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

@RunWith(Parameterized.class)
public class ParameterTest {

  private String name;
  private boolean result;

  /**
   * 该构造方法的参数与下面@Parameters注解的方法中的Object数组中值的顺序对应
   * @param name
   * @param result
   */
  public ParameterTest(String name, boolean result) {
    super();
    this.name = name;
    this.result = result;
  }

  @Test
  public void test() {
    assertTrue(name.contains("小") == result);
  }

  /**
   * 该方法返回Collection
   *
   * @return
   * @author SHANHY
   * @create 2016年2月26日
   */
  @Parameters
  public static Collection<?> data(){
    // Object 数组中值的顺序注意要和上面的构造方法ParameterTest的参数对应
    return Arrays.asList(new Object[][]{
      {"小明2", true},
      {"坏", false},
      {"莉莉", false},
    });
  }
}

4、打包測試

正常情況下我們寫了5個測試類，我們需要一個一個執行。

打包測試，就是新增一個類，然後將我們寫好的其他測試類配置在一起，然後直接運行這個類就達到同時運行其他幾個測試的目的。

程式碼如下：

@RunWith(Suite.class) 
@SuiteClasses({ATest.class, BTest.class, CTest.class}) 
public class ABCSuite {
  // 类中不需要编写代码
}

#5、使用Junit測試HTTP的API介面

我們可以直接使用這個來測試我們的Rest API，如果內部單元測試要求不是很嚴格，我們保證對外的API進行完全測試即可，因為API會調用內部的很多方法，姑且把它當做是整合測試吧。

下面是一個簡單的範例：

package org.springboot.sample;

import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.assertTrue;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.hamcrest.Matchers;
import org.junit.After;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Ignore;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.test.SpringApplicationConfiguration;
import org.springframework.boot.test.TestRestTemplate;
import org.springframework.boot.test.WebIntegrationTest;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.web.client.RestTemplate;

/**
 *
 * @author  单红宇(365384722)
 * @create  2016年2月23日
 */
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = SpringBootSampleApplication.class)
//@WebAppConfiguration // 使用@WebIntegrationTest注解需要将@WebAppConfiguration注释掉
@WebIntegrationTest("server.port:0")// 使用0表示端口号随机，也可以具体指定如8888这样的固定端口
public class HelloControllerTest {

  private String dateReg;
  private Pattern pattern;
  private RestTemplate template = new TestRestTemplate();
  @Value("${local.server.port}")// 注入端口号
  private int port;

  @Test
  public void test3(){
    String url = "http://localhost:"+port+"/myspringboot/hello/info";
    MultiValueMap<String, Object> map = new LinkedMultiValueMap<String, Object>(); 
    map.add("name", "Tom"); 
    map.add("name1", "Lily");
    String result = template.postForObject(url, map, String.class);
    System.out.println(result);
    assertNotNull(result);
    assertThat(result, Matchers.containsString("Tom"));
  }

}

#6、擷取輸出

使用OutputCapture來捕獲指定方法開始執行以後的所有輸出，包括System.out輸出和Log日誌。

OutputCapture 需要使用@Rule註解，且實例化的物件需要使用public修飾，如下程式碼：

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = SpringBootSampleApplication.class)
//@WebAppConfiguration // 使用@WebIntegrationTest注解需要将@WebAppConfiguration注释掉
@WebIntegrationTest("server.port:0")// 使用0表示端口号随机，也可以具体指定如8888这样的固定端口
public class HelloControllerTest {

  @Value("${local.server.port}")// 注入端口号
  private int port;

  private static final Logger logger = LoggerFactory.getLogger(StudentController.class);

  @Rule
  // 这里注意，使用@Rule注解必须要用public
  public OutputCapture capture = new OutputCapture();

  @Test
  public void test4(){
    System.out.println("HelloWorld");
    logger.info("logo日志也会被capture捕获测试输出");
    assertThat(capture.toString(), Matchers.containsString("World"));
  }
}

以上是Spring Boot Junit單元測試的介紹與使用的詳細內容。更多資訊請關注PHP中文網其他相關文章！