Spring Boot乾貨系列：（十二）Spring Boot使用單元測試

本來地址：Spring Boot乾貨系列：（十二）Spring Boot使用單元測試
博客地址：tengj.top/

前言

此次來介紹下Spring Boot中對單元測試的整合使用，本篇會經過如下4點來介紹，基本知足平常需求

• Service層單元測試
• Controller層單元測試
• 新斷言assertThat使用
• 單元測試的回滾

正文

Spring Boot中引入單元測試很簡單，依賴以下：

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-test</artifactId>
	<scope>test</scope>
</dependency>
複製代碼

本篇實例Spring Boot版本爲1.5.9.RELEASE，引入spring-boot-starter-test後，有以下幾個庫：
• JUnit — The de-facto standard for unit testing Java applications.
• Spring Test & Spring Boot Test — Utilities and integration test support for Spring Boot applications.
• AssertJ — A fluent assertion library.
• Hamcrest — A library of matcher objects (also known as constraints or predicates).
• Mockito — A Java mocking framework.
• JSONassert — An assertion library for JSON.
• JsonPath — XPath for JSON.

Service單元測試

Spring Boot中單元測試類寫在在src/test/java目錄下，你能夠手動建立具體測試類，若是是IDEA，則能夠經過IDEA自動建立測試類，以下圖，也能夠經過快捷鍵⇧⌘T(MAC)或者Ctrl+Shift+T(Window)來建立，以下：

自動生成測試類以下：

而後再編寫建立好的測試類，具體代碼以下：

package com.dudu.service;
import com.dudu.domain.LearnResource;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import static org.hamcrest.CoreMatchers.*;

@RunWith(SpringRunner.class)
@SpringBootTest
public class LearnServiceTest {

    @Autowired
    private LearnService learnService;
    
    @Test
    public void getLearn(){
        LearnResource learnResource=learnService.selectByKey(1001L);
        Assert.assertThat(learnResource.getAuthor(),is("嘟嘟MD獨立博客"));
    }
}
複製代碼

上面就是最簡單的單元測試寫法，頂部只要@RunWith(SpringRunner.class)和SpringBootTest便可，想要執行的時候，鼠標放在對應的方法，右鍵選擇run該方法便可。

測試用例中我使用了assertThat斷言，下文中會介紹，也推薦你們使用該斷言。

Controller單元測試

上面只是針對Service層作測試，可是有時候須要對Controller層（API）作測試，這時候就得用到MockMvc了，你能夠沒必要啓動工程就能測試這些接口。

MockMvc實現了對Http請求的模擬，可以直接使用網絡的形式，轉換到Controller的調用，這樣可使得測試速度快、不依賴網絡環境，並且提供了一套驗證的工具，這樣可使得請求的驗證統一併且很方便。

Controller類：

package com.dudu.controller;

/** 教程頁面 * Created by tengj on 2017/3/13. */
@Controller
@RequestMapping("/learn")
public class LearnController extends AbstractController{
    @Autowired
    private LearnService learnService;
    private Logger logger = LoggerFactory.getLogger(this.getClass());

    @RequestMapping("")
    public String learn(Model model){
        model.addAttribute("ctx", getContextPath()+"/");
        return "learn-resource";
    }

    /** * 查詢教程列表 * @param page * @return */
    @RequestMapping(value = "/queryLeanList",method = RequestMethod.POST)
    @ResponseBody
    public AjaxObject queryLearnList(Page<LeanQueryLeanListReq> page){
        List<LearnResource> learnList=learnService.queryLearnResouceList(page);
        PageInfo<LearnResource> pageInfo =new PageInfo<LearnResource>(learnList);
        return AjaxObject.ok().put("page", pageInfo);
    }
    
    /** * 新添教程 * @param learn */
    @RequestMapping(value = "/add",method = RequestMethod.POST)
    @ResponseBody
    public AjaxObject addLearn(@RequestBody LearnResource learn){
        learnService.save(learn);
        return AjaxObject.ok();
    }

    /** * 修改教程 * @param learn */
    @RequestMapping(value = "/update",method = RequestMethod.POST)
    @ResponseBody
    public AjaxObject updateLearn(@RequestBody LearnResource learn){
        learnService.updateNotNull(learn);
        return AjaxObject.ok();
    }

    /** * 刪除教程 * @param ids */
    @RequestMapping(value="/delete",method = RequestMethod.POST)
    @ResponseBody
    public AjaxObject deleteLearn(@RequestBody Long[] ids){
        learnService.deleteBatch(ids);
        return AjaxObject.ok();
    }

    /** * 獲取教程 * @param id */
    @RequestMapping(value="/resource/{id}",method = RequestMethod.GET)
    @ResponseBody
    public LearnResource qryLearn(@PathVariable(value = "id") Long id){
       LearnResource lean= learnService.selectByKey(id);
        return lean;
    }
}

複製代碼

這裏咱們也自動建立一個Controller的測試類，具體代碼以下：

package com.dudu.controller;

import com.dudu.domain.User;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.mock.web.MockHttpSession;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.result.MockMvcResultHandlers;
import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.context.WebApplicationContext;

@RunWith(SpringRunner.class)
@SpringBootTest

public class LearnControllerTest {
    @Autowired
    private WebApplicationContext wac;

    private MockMvc mvc;
    private MockHttpSession session;


    @Before
    public void setupMockMvc(){
        mvc = MockMvcBuilders.webAppContextSetup(wac).build(); //初始化MockMvc對象
        session = new MockHttpSession();
        User user =new User("root","root");
        session.setAttribute("user",user); //攔截器那邊會判斷用戶是否登陸，因此這裏注入一個用戶
    }

    /** * 新增教程測試用例 * @throws Exception */
    @Test
    public void addLearn() throws Exception{
        String json="{\"author\":\"HAHAHAA\",\"title\":\"Spring\",\"url\":\"http://tengj.top/\"}";
        mvc.perform(MockMvcRequestBuilders.post("/learn/add")
                    .accept(MediaType.APPLICATION_JSON_UTF8)
                    .content(json.getBytes()) //傳json參數
                    .session(session)
            )
           .andExpect(MockMvcResultMatchers.status().isOk())
           .andDo(MockMvcResultHandlers.print());
    }

    /** * 獲取教程測試用例 * @throws Exception */
    @Test
    public void qryLearn() throws Exception {
        mvc.perform(MockMvcRequestBuilders.get("/learn/resource/1001")
                    .contentType(MediaType.APPLICATION_JSON_UTF8)
                    .accept(MediaType.APPLICATION_JSON_UTF8)
                    .session(session)
            )
           .andExpect(MockMvcResultMatchers.status().isOk())
           .andExpect(MockMvcResultMatchers.jsonPath("$.author").value("嘟嘟MD獨立博客"))
           .andExpect(MockMvcResultMatchers.jsonPath("$.title").value("Spring Boot乾貨系列"))
           .andDo(MockMvcResultHandlers.print());
    }

    /** * 修改教程測試用例 * @throws Exception */
    @Test
    public void updateLearn() throws Exception{
        String json="{\"author\":\"測試修改\",\"id\":1031,\"title\":\"Spring Boot乾貨系列\",\"url\":\"http://tengj.top/\"}";
        mvc.perform(MockMvcRequestBuilders.post("/learn/update")
                .accept(MediaType.APPLICATION_JSON_UTF8)
                .content(json.getBytes())//傳json參數
                .session(session)
        )
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andDo(MockMvcResultHandlers.print());
    }

    /** * 刪除教程測試用例 * @throws Exception */
    @Test
    public void deleteLearn() throws Exception{
        String json="[1031]";
        mvc.perform(MockMvcRequestBuilders.post("/learn/delete")
                .accept(MediaType.APPLICATION_JSON_UTF8)
                .content(json.getBytes())//傳json參數
                .session(session)
        )
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andDo(MockMvcResultHandlers.print());
    }

}

複製代碼

上面實現了基本的增刪改查的測試用例，使用MockMvc的時候須要先用MockMvcBuilders使用構建MockMvc對象，以下

@Before
public void setupMockMvc(){
    mvc = MockMvcBuilders.webAppContextSetup(wac).build(); //初始化MockMvc對象
    session = new MockHttpSession();
    User user =new User("root","root");
    session.setAttribute("user",user); //攔截器那邊會判斷用戶是否登陸，因此這裏注入一個用戶
}
複製代碼

由於攔截器那邊會判斷是否登陸，因此這裏我注入了一個用戶，你也能夠直接修改攔截器取消驗證用戶登陸，先測試完再開啓。

這裏拿一個例子來介紹一下MockMvc簡單的方法

/** * 獲取教程測試用例 * @throws Exception */
@Test
public void qryLearn() throws Exception {
    mvc.perform(MockMvcRequestBuilders.get("/learn/resource/1001")
                .contentType(MediaType.APPLICATION_JSON_UTF8)
                .accept(MediaType.APPLICATION_JSON_UTF8)
                .session(session)
        )
       .andExpect(MockMvcResultMatchers.status().isOk())
       .andExpect(MockMvcResultMatchers.jsonPath("$.author").value("嘟嘟MD獨立博客"))
       .andExpect(MockMvcResultMatchers.jsonPath("$.title").value("Spring Boot乾貨系列"))
       .andDo(MockMvcResultHandlers.print());
}
複製代碼

1. mockMvc.perform執行一個請求
2. MockMvcRequestBuilders.get("/user/1")構造一個請求，Post請求就用.post方法
3. contentType(MediaType.APPLICATION_JSON_UTF8)表明發送端發送的數據格式是application/json;charset=UTF-8
4. accept(MediaType.APPLICATION_JSON_UTF8)表明客戶端但願接受的數據類型爲application/json;charset=UTF-8
5. session(session)注入一個session，這樣攔截器才能夠經過
6. ResultActions.andExpect添加執行完成後的斷言
7. ResultActions.andExpect(MockMvcResultMatchers.status().isOk())方法看請求的狀態響應碼是否爲200若是不是則拋異常，測試不經過
8. andExpect(MockMvcResultMatchers.jsonPath("$.author").value("嘟嘟MD獨立博客"))這裏jsonPath用來獲取author字段比對是否爲嘟嘟MD獨立博客,不是就測試不經過
9. ResultActions.andDo添加一個結果處理器，表示要對結果作點什麼事情，好比此處使用MockMvcResultHandlers.print()輸出整個響應結果信息

本例子測試以下：

mockMvc 更多例子能夠本篇下方參考查看

新斷言assertThat使用

JUnit 4.4 結合 Hamcrest 提供了一個全新的斷言語法——assertThat。程序員能夠只使用 assertThat 一個斷言語句，結合 Hamcrest 提供的匹配符，就能夠表達所有的測試思想，咱們引入的版本是Junit4.12因此支持assertThat。

assertThat 的基本語法以下：

清單 1 assertThat 基本語法

assertThat( [value], [matcher statement] );
複製代碼

• value 是接下來想要測試的變量值；
• matcher statement 是使用 Hamcrest 匹配符來表達的對前面變量所指望的值的聲明，若是 value 值與 matcher statement 所表達的指望值相符，則測試成功，不然測試失敗。

assertThat 的優勢

• 優勢 1：之前 JUnit 提供了不少的 assertion 語句，如：assertEquals，assertNotSame，assertFalse，assertTrue，assertNotNull，assertNull 等，如今有了 JUnit 4.4，一條 assertThat 便可以替代全部的 assertion 語句，這樣能夠在全部的單元測試中只使用一個斷言方法，使得編寫測試用例變得簡單，代碼風格變得統一，測試代碼也更容易維護。
• 優勢 2：assertThat 使用了 Hamcrest 的 Matcher 匹配符，用戶可使用匹配符規定的匹配準則精確的指定一些想設定知足的條件，具備很強的易讀性，並且使用起來更加靈活。如清單 2 所示：

清單 2 使用匹配符 Matcher 和不使用之間的比較

// 想判斷某個字符串 s 是否含有子字符串 "developer" 或 "Works" 中間的一個
// JUnit 4.4 之前的版本：assertTrue(s.indexOf("developer")>-1||s.indexOf("Works")>-1 );
// JUnit 4.4：
assertThat(s, anyOf(containsString("developer"), containsString("Works"))); 
// 匹配符 anyOf 表示任何一個條件知足則成立，相似於邏輯或 "||"， 匹配符 containsString 表示是否含有參數子 
// 字符串，文章接下來會對匹配符進行具體介紹
複製代碼

• 優勢 3：assertThat 再也不像 assertEquals 那樣，使用比較難懂的「謂賓主」語法模式（如：assertEquals(3, x);），相反，assertThat 使用了相似於「主謂賓」的易讀語法模式（如：assertThat(x,is(3));），使得代碼更加直觀、易讀。

• 優勢 4：能夠將這些 Matcher 匹配符聯合起來靈活使用，達到更多目的。如清單 3 所示：

清單 3 Matcher 匹配符聯合使用

// 聯合匹配符not和equalTo表示「不等於」
assertThat( something, not( equalTo( "developer" ) ) ); 
// 聯合匹配符not和containsString表示「不包含子字符串」
assertThat( something, not( containsString( "Works" ) ) ); 
// 聯合匹配符anyOf和containsString表示「包含任何一個子字符串」
assertThat(something, anyOf(containsString("developer"), containsString("Works")));
複製代碼

• 優勢 5：錯誤信息更加易懂、可讀且具備描述性（descriptive） JUnit 4.4 之前的版本默認出錯後不會拋出額外提示信息，如：

assertTrue( s.indexOf("developer") > -1 || s.indexOf("Works") > -1 );
複製代碼

若是該斷言出錯，只會拋出無用的錯誤信息，如：junit.framework.AssertionFailedError：null。 若是想在出錯時想打印出一些有用的提示信息，必須得程序員另外手動寫，如：

assertTrue( "Expected a string containing 'developer' or 'Works'", 
    s.indexOf("developer") > -1 || s.indexOf("Works") > -1 );
複製代碼

很是的不方便，並且須要額外代碼。 JUnit 4.4 會默認自動提供一些可讀的描述信息，如清單 4 所示： 清單 4 JUnit 4.4 默認提供一些可讀的描述性錯誤信息

String s = "hello world!"; 
assertThat( s, anyOf( containsString("developer"), containsString("Works") ) ); 
// 若是出錯後，系統會自動拋出如下提示信息：
java.lang.AssertionError: 
Expected: (a string containing "developer" or a string containing "Works") 
got: "hello world!"
複製代碼

如何使用 assertThat

JUnit 4.4 自帶了一些 Hamcrest 的匹配符 Matcher，可是隻有有限的幾個，在類 org.hamcrest.CoreMatchers 中定義，要想使用他們，必須導入包 org.hamcrest.CoreMatchers.*。

清單 5 列舉了大部分 assertThat 的使用例子：

字符相關匹配符
/**equalTo匹配符斷言被測的testedValue等於expectedValue， * equalTo能夠斷言數值之間，字符串之間和對象之間是否相等，至關於Object的equals方法 */
assertThat(testedValue, equalTo(expectedValue));
/**equalToIgnoringCase匹配符斷言被測的字符串testedString *在忽略大小寫的狀況下等於expectedString */
assertThat(testedString, equalToIgnoringCase(expectedString));
/**equalToIgnoringWhiteSpace匹配符斷言被測的字符串testedString *在忽略頭尾的任意個空格的狀況下等於expectedString， *注意：字符串中的空格不能被忽略 */
assertThat(testedString, equalToIgnoringWhiteSpace(expectedString);
/**containsString匹配符斷言被測的字符串testedString包含子字符串subString**/
assertThat(testedString, containsString(subString) );
/**endsWith匹配符斷言被測的字符串testedString以子字符串suffix結尾*/
assertThat(testedString, endsWith(suffix));
/**startsWith匹配符斷言被測的字符串testedString以子字符串prefix開始*/
assertThat(testedString, startsWith(prefix));
通常匹配符
/**nullValue()匹配符斷言被測object的值爲null*/
assertThat(object,nullValue());
/**notNullValue()匹配符斷言被測object的值不爲null*/
assertThat(object,notNullValue());
/**is匹配符斷言被測的object等於後面給出匹配表達式*/
assertThat(testedString, is(equalTo(expectedValue)));
/**is匹配符簡寫應用之一，is(equalTo(x))的簡寫，斷言testedValue等於expectedValue*/
assertThat(testedValue, is(expectedValue));
/**is匹配符簡寫應用之二，is(instanceOf(SomeClass.class))的簡寫， *斷言testedObject爲Cheddar的實例 */
assertThat(testedObject, is(Cheddar.class));
/**not匹配符和is匹配符正好相反，斷言被測的object不等於後面給出的object*/
assertThat(testedString, not(expectedString));
/**allOf匹配符斷言符合全部條件，至關於「與」（&&）*/
assertThat(testedNumber, allOf( greaterThan(8), lessThan(16) ) );
/**anyOf匹配符斷言符合條件之一，至關於「或」（||）*/
assertThat(testedNumber, anyOf( greaterThan(16), lessThan(8) ) );
數值相關匹配符
/**closeTo匹配符斷言被測的浮點型數testedDouble在20.0¡À0.5範圍以內*/
assertThat(testedDouble, closeTo( 20.0, 0.5 ));
/**greaterThan匹配符斷言被測的數值testedNumber大於16.0*/
assertThat(testedNumber, greaterThan(16.0));
/** lessThan匹配符斷言被測的數值testedNumber小於16.0*/
assertThat(testedNumber, lessThan (16.0));
/** greaterThanOrEqualTo匹配符斷言被測的數值testedNumber大於等於16.0*/
assertThat(testedNumber, greaterThanOrEqualTo (16.0));
/** lessThanOrEqualTo匹配符斷言被測的testedNumber小於等於16.0*/
assertThat(testedNumber, lessThanOrEqualTo (16.0));
集合相關匹配符
/**hasEntry匹配符斷言被測的Map對象mapObject含有一個鍵值爲"key"對應元素值爲"value"的Entry項*/
assertThat(mapObject, hasEntry("key", "value" ) );
/**hasItem匹配符代表被測的迭代對象iterableObject含有元素element項則測試經過*/
assertThat(iterableObject, hasItem (element));
/** hasKey匹配符斷言被測的Map對象mapObject含有鍵值「key」*/
assertThat(mapObject, hasKey ("key"));
/** hasValue匹配符斷言被測的Map對象mapObject含有元素值value*/
assertThat(mapObject, hasValue(value));
複製代碼

單元測試回滾

單元個測試的時候若是不想形成垃圾數據，能夠開啓事物功能，記在方法或者類頭部添加@Transactional註解便可,以下：

@Test
@Transactional
public void add(){
    LearnResource bean = new LearnResource();
    bean.setAuthor("測試回滾");
    bean.setTitle("回滾用例");
    bean.setUrl("http://tengj.top");
    learnService.save(bean);
}
複製代碼

這樣測試完數據就會回滾了，不會形成垃圾數據。若是你想關閉回滾，只要加上@Rollback(false)註解便可。@Rollback表示事務執行完回滾，支持傳入一個參數value，默認true即回滾，false不回滾。

若是你使用的數據庫是Mysql，有時候會發現加了註解@Transactional 也不會回滾，那麼你就要查看一下你的默認引擎是否是InnoDB，若是不是就要改爲InnoDB。

MyISAM與InnoDB是mysql目前比較經常使用的兩個數據庫存儲引擎，MyISAM與InnoDB的主要的不一樣點在於性能和事務控制上。這裏簡單的介紹一下二者間的區別和轉換方法：

• MyISAM：MyISAM是MySQL5.5以前版本默認的數據庫存儲引擎。MYISAM提供高速存儲和檢索，以及全文搜索能力，適合數據倉庫等查詢頻繁的應用。但不支持事務、也不支持外鍵。MyISAM格式的一個重要缺陷就是不能在表損壞後恢復數據。

• InnoDB：InnoDB是MySQL5.5版本的默認數據庫存儲引擎，不過InnoDB已被Oracle收購，MySQL自行開發的新存儲引擎Falcon將在MySQL6.0版本引進。InnoDB具備提交、回滾和崩潰恢復能力的事務安全。可是比起MyISAM存儲引擎，InnoDB寫的處理效率差一些而且會佔用更多的磁盤空間以保留數據和索引。儘管如此，可是InnoDB包括了對事務處理和外來鍵的支持，這兩點都是MyISAM引擎所沒有的。

• MyISAM適合：(1)作不少count 的計算；(2)插入不頻繁，查詢很是頻繁；(3)沒有事務。

• InnoDB適合：(1)可靠性要求比較高，或者要求事務；(2)表更新和查詢都至關的頻繁，而且表鎖定的機會比較大的狀況。(4)性能較好的服務器，好比單獨的數據庫服務器，像阿里雲的關係型數據庫RDS就推薦使用InnoDB引擎。

修改默認引擎的步驟

查看MySQL當前默認的存儲引擎:

mysql> show variables like '%storage_engine%';
複製代碼

你要看user表用了什麼引擎(在顯示結果裏參數engine後面的就表示該表當前用的存儲引擎):

mysql> show create table user;
複製代碼

將user表修爲InnoDB存儲引擎(也能夠此命令將InnoDB換爲MyISAM)：

mysql> ALTER TABLE user ENGINE=INNODB;
複製代碼

若是要更改整個數據庫表的存儲引擎，通常要一個表一個表的修改，比較繁瑣，能夠採用先把數據庫導出，獲得SQL，把MyISAM所有替換爲INNODB，再導入數據庫的方式。 轉換完畢後重啓mysql

service mysqld restart
複製代碼

總結

到此爲止，Spring Boot整合單元測試就基本完結，關於MockMvc以及assertThat的用法你們能夠繼續深刻研究。後續會整合Swagger UI這個API文檔工具，即提供API文檔又提供測試接口界面，至關好用。

想要查看更多Spring Boot乾貨教程,可前往：Spring Boot乾貨系列總綱

參考

Junit學習筆記之五：MockMVC 探索 JUnit 4.4 新特性

# 源碼下載  (￣︶￣)↗[相關示例完整代碼]  - chapter12==》Spring Boot乾貨系列：（十二）Spring Boot使用單元測試

一直以爲本身寫的不是技術，而是情懷，一篇篇文章是本身這一路走來的痕跡。靠專業技能的成功是最具可複製性的，但願個人這條路能讓你少走彎路，但願我能幫你抹去知識的蒙塵，但願我能幫你理清知識的脈絡，但願將來技術之巔上有你也有我。