1 常見測試場景

1.1 MVC測試單個Controller

可通過MockMvc進行特定MVC的請求測試處理；
要進行單個Controller的測試，需要使用@WebMvcTest來指定需要測試的Controller。
WebMvcTest及MockMvc的使用分析見後文。

import com.liuqi.learn.learninterceptor.controller.TestController
import org.junit.Test
import org.junit.runner.RunWith
import org.slf4j.LoggerFactory
import
 
 org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.web.servlet.*
import org.springframework.test.context.junit4.SpringRunner
import org.springframework.test.web.servlet.MockMvc
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get
import
 
 org.springframework.test.web.servlet.result.MockMvcResultMatchers.*

@RunWith(SpringRunner::class)
@WebMvcTest(TestController::class)
class LearninterceptorApplicationTests {
    private val logger = LoggerFactory.getLogger(LearninterceptorApplicationTests::class.java)

    @Autowired
    private lateinit var mvc: MockMvc

    @Test
    fun testTestController
 
() {
        mvc.perform(get("/test/test")).andExpect(status().isOk)
                .andExpect(content().string("test"));
    }

}

1.2 MVC測試多個Controller

可以針對多個Controller進行測試，啟動的是同一個容器;
不需要指定待測試的Controller；
也可以通過MockMvc來啟動模擬請求；
示例如下：　

@RunWith(SpringRunner::class)
@SpringBootTest
@AutoConfigureMockMvc
class TestLearninterceptorApplication {
    @Autowired
    private lateinit var mvc: MockMvc

    @Test
    fun testTest() {
        mvc.perform(MockMvcRequestBuilders.get("/test/test")).andExpect(MockMvcResultMatchers.status().isOk)
                .andExpect(MockMvcResultMatchers.content().string("test"));
    }

    @Test
    fun testTest1() {
        mvc.perform(MockMvcRequestBuilders.get("/test2/test")).andExpect(MockMvcResultMatchers.status().isOk)
                .andExpect(MockMvcResultMatchers.content().string("test2"));
    }
}

1.3 測試打樁

可以通過MockBean進行測試打樁；
先看Service的定義：　

@Service
class TestService {
    fun test(): String {
        return "test"
    }
}

再看使用Service的Controller

@RestController
@RequestMapping("/test2")
class TestController2 {
    val logger = LoggerFactory.getLogger(TestController2::class.java)

    @Autowired
    private lateinit var testService: TestService

    @RequestMapping("/test")
    fun test(): String {
        logger.info("TestController2!")

        return "test2"
    }

    @RequestMapping("/service")
    fun testService(): String {
        return testService.test()
    }
}

最後編寫測試類：　

@SpringBootTest
@AutoConfigureMockMvc
class TestLearninterceptorApplication {
    @Autowired
    private lateinit var mvc: MockMvc

    @MockBean
    private lateinit var testService: TestService

    @Test
    fun testMock() {
        BDDMockito.given(this.testService.test()).willReturn("mockTest")
        mvc.perform(MockMvcRequestBuilders.get("/test/service")).andExpect(MockMvcResultMatchers.status().isOk)
                .andExpect(MockMvcResultMatchers.content().string("mockTest"))
    }
}

1.4 整合測試

可以通過TestRestTemplate來進行整合測試；即在應用已經部署並在測試環境啟動時，可以通過指定URL的方式進行測試用例的測試；
一般通過TestRestTemplate來進行測試（當然TestRestTemplate也可以進行單元測試，後文會進行詳細說明）；

import org.hamcrest.CoreMatchers.*
import org.junit.Assert
import org.junit.Test
import org.springframework.boot.test.web.client.TestRestTemplate

class SITest {
    private val restTemplate: TestRestTemplate = TestRestTemplate()

    @Test
    fun testRest() {
        val body = restTemplate.getForEntity("http://localhost/test2/service", String::class.java).body
        Assert.assertThat(body, `is`("test"))
    }
}

2 常見測試類

2.1 WebMvcTest

與SpringRunner一起使用，可測試指定的Controller；
注意在使用時需要指定待測試的Controller，可以指定多個待測試的Controller；

@WebMvcTest(*[TestController::class, TestController2::class])

WebMvcTest一般用於單元測試中測試Controller及其生效的Filter等場景；他會啟動一個Spring容器，但只會載入其中部分MVC相關的內容，如Component、Service或者Repository等註解的Bean不會進行載入。
會載入的：Controller/ControllerAdvice/JsonComponent/Converter/Filter/WebMvcConfigurer/HandlerMethodArgumentResolver等； 因此如果待測試的Controller中使用瞭如Service等內容，需要打樁處理。
它所啟動的Spring容器將會隨測試用例的開始執行而啟動，隨所有測試用例執行完畢而停止；因此它適合本地開發環境的測試用例執行。

2.2 SpringBootTest

與SpringRunner一起使用，不需要指定Controller進行測試。
SpringBootTest會啟動一個完整的Spring容器，這意味著它會載入所有Spring的內容；類似於將應用部署到了測試環境的Tomcat中；
與WebMvcTest一樣，啟動的只是一個臨時的環境，隨著測試用例的執行而啟動，在所有測試用例執行完畢後這個環境會將會停止， 適合本地開發環境的測試用例執行。

2.3 TestRestTemplate

TestRestTemplate可使用在以下兩個場景的測試：

2.3.1 遠端測試

TestRestTemplate可用於Rest服務的遠端測試；針對的是應用已經部署在測試環境應用伺服器中的場景；
它可通過指定http://ip:port/…這種路徑的方式來訪問特定連結進行整合測試；

2.3.1 本地測試

TestRestTemplate也可用於本地開發環境的測試，與MockMvc類似，可通過指定相對路徑的方式呼叫本地啟動的SpringMVC來進行MVC測試；這種情況下也需要與SpringBootTest整合使用。
它與MockMVC不一樣的是，MockMVC只能針對返回的內容進行測試，而TestRestTemplate可對Body、Headers等進行測試；
使用方式如下：　

@RunWith(SpringRunner::class)
@SpringBootTest(webEnvironment=SpringBootTest.WebEnvironment.RANDOM_PORT)
class TestLearninterceptorApplication2 {
    @Autowired
    private lateinit var template: TestRestTemplate

    @Test
    fun test() {
        val body = template.getForEntity("/test2/service", String::class.java).body
        Assert.assertThat(body, CoreMatchers.`is`("test"))
    }

//    @TestConfiguration
//    class Config {
//        @Bean
//        fun restTemplateBuilder(): RestTemplateBuilder {
//            return RestTemplateBuilder()
//        }
//    }
}

注意如果在SpringBootTest中不指定埠，則會報TestRestTemplate無法注入的錯誤。
TestRestTemplate的常用方法介紹如下：　

部分場景下會返回ResponseEntity物件，該物件的常用方法如下：　

2.4 MockMvc

MockMvc用於對本地啟動的Spring環境進行測試，通過它的perform方法，它會模擬一個Http請求訪問SpringMVC並返回ResultActions物件；
它一般要與SpringBootTest或者是WebMvcTest一起使用；
MockMvc的使用主要是使用其perform方法，這個方法返回型別是ResultActions物件；
這個物件包含以下方法：　

andExpect方法中的Matcher可以使用MockMvcResultMatchers來進行構建，其可構建的Matcher包括：

三者結構使用的示例見1.1章節

2.5 MockBean

MockBean用於打樁，一般與BDDMockito結合使用。
MockBean本身功能較簡單，主要是BDDMockito的使用。

2.6 BDDMockito

詳細請參考此文
用於替換被打樁的Bean中的指定方法；
其包含的常用方法如下：

2.6.1 given

替換被打樁的物件的指定方法；
使用方式如：

val result = BDDMockito.given(this.testService.test())

其返回的型別為：BDDMyOngoingStubbing，其包含有以下常用方法：
- willAnswer: 根據傳入引數定製返回結果；
- will: 與willAnswer類似
- willReturn: 定製直接的返回結果；
- willThrow: 定製將會丟擲的異常
使用方法如：

val result = BDDMockito.given(this.testService.test())
result.willReturn("test") 

表示將這個方法的返回替換成test字串。

2.6.2 then

請參考此文。

3 其它

3.1 WebMvcTest與SpringBootTest

這兩個註解只能新增一個，如果混合使用會報錯：　

java.lang.IllegalStateException: Configuration error: found multiple declarations of @BootstrapWith for test class 

其區別在於：
WebMvcTest用於單元測試場景，需要指定待測試的Controller；他也會啟動一個Spring容器，但只會載入其中部分MVC相關的內容，如Component、Service或者Repository等註解的Bean不會進行載入。
會載入的：Controller/ControllerAdvice/JsonComponent/Converter/Filter/WebMvcConfigurer/HandlerMethodArgumentResolver等；
SpringBootTest：用於整合測試場景，不需要指定待測試的Controller；它會啟動一個完整的Spring容器，所有的Bean都會進行載入與初始化。