如何用SpringBoot 進行測試
阿新 • • 發佈：2020-11-20
普通測試
假設要測試一個工具類 StringUtil（com.rxliuli.example.springboottest.util.StringUtil）
/**
* 用於測試的字串工具類
*
* @author rxliuli
*/
public class StringUtil {
/**
* 判斷是否為空
*
* @param string 要進行判斷的字串
* @return 是否為 null 或者空字串
*/
public static boolean isEmpty(String string) {
return string == null || string.isEmpty();
}
/**
* 判斷是否為空
*
* @param string 要進行判斷的字串
* @return 是否為 null 或者空字串
*/
public static boolean isNotEmpty(String string) {
return !isEmpty(string);
}
/**
* 判斷是否有字串為空
*
* @param strings 要進行判斷的一個或多個字串
* @return 是否有 null 或者空字串
*/
public static boolean isAnyEmpty(String... strings) {
return Arrays.stream(strings)
.anyMatch(StringUtil::isEmpty);
}
/**
* 判斷字串是否全部為空
*
* @param strings 要進行判斷的一個或多個字串
* @return 是否全部為 null 或者空字串
*/
public static boolean isAllEmpty(String... strings) {
return Arrays.stream(strings)
.allMatch(StringUtil::isEmpty);
}
}需要新增依賴 spring-boot-starter-test 以及指定 assertj-core 的最新版本
<dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> </dependencies> <dependencyManagement> <dependencies> <dependency> <groupId>org.assertj</groupId> <artifactId>assertj-core</artifactId> <version>3.9.1</version> <scope>test</scope> </dependency> </dependencies> </dependencyManagement>
這裡指定 assertj-core 的版本是為了使用較新的一部分斷言功能（例如屬性 lambda 斷言）
/**
* @author rxliuli
*/
public class StringUtilTest {
private String strNull = null;
private String strEmpty = "";
private String strSome = "str";
@Test
public void isEmpty() {
//測試 null
assertThat(StringUtil.isEmpty(strNull))
.isTrue();
//測試 empty
assertThat(StringUtil.isEmpty(strEmpty))
.isTrue();
//測試 some
assertThat(StringUtil.isEmpty(strSome))
.isFalse();
}
@Test
public void isNotEmpty() {
//測試 null
assertThat(StringUtil.isNotEmpty(strNull))
.isFalse();
//測試 empty
assertThat(StringUtil.isNotEmpty(strEmpty))
.isFalse();
//測試 some
assertThat(StringUtil.isNotEmpty(strSome))
.isTrue();
}
@Test
public void isAnyEmpty() {
assertThat(StringUtil.isAnyEmpty(strNull,strEmpty,strSome))
.isTrue();
assertThat(StringUtil.isAnyEmpty())
.isFalse();
}
@Test
public void isAllEmpty() {
assertThat(StringUtil.isAllEmpty(strNull,strSome))
.isFalse();
assertThat(StringUtil.isAnyEmpty(strNull,strEmpty))
.isTrue();
}
}這裡和非 SpringBoot 測試時沒什麼太大的區別，唯一的一點就是引入 Jar 不同，這裡雖然我們只引入了 spring-boot-starter-test，但它本身已經幫我們引入了許多的測試相關類庫了。
Dao/Service 測試
從這裡開始就和標準的 Spring 不太一樣了
首先，我們需要 Dao 層，這裡使用 H2DB 和 SpringJDBC 做資料訪問層（比較簡單）。
依賴
<dependency> <groupId>com.h2database</groupId> <artifactId>h2</artifactId> <scope>runtime</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-jdbc</artifactId> </dependency>
新增兩個初始化指令碼
資料庫結構 db_schema.sql（db/db_schema.sql）
drop table if exists user; create table user ( id int auto_increment not null comment '編號',name varchar(20) not null comment '名字',sex boolean null comment '性別',age int null comment '年齡' );
資料庫資料 db_data.sql（db/db_data.sql）
insert into user (id,name,sex,age) values (1,'琉璃',false,17),(2,'月姬',1000);
為 SpringBoot 配置一下資料來源及初始化指令碼
spring: datasource: driver-class-name: org.h2.Driver platform: h2 schema: classpath:db/db_schema.sql data: classpath:db/db_data.sql
然後是實體類與 Dao
使用者實體類 User（com.rxliuli.example.springboottest.entity.User）
/**
* @author rxliuli
*/
public class User implements Serializable {
private Integer id;
private String name;
private Boolean sex;
private Integer age;
public User() {
}
public User(String name,Boolean sex,Integer age) {
this.name = name;
this.sex = sex;
this.age = age;
}
public User(Integer id,String name,Integer age) {
this.id = id;
this.name = name;
this.sex = sex;
this.age = age;
}
//getter() and setter()
}
使用者 Dao UserDao（com.rxliuli.example.springboottest.dao.UserDao）
/**
* @author rxliuli
*/
@Repository
public class UserDao {
private final RowMapper<User> userRowMapper = (rs,rowNum) -> new User(
rs.getInt("id"),rs.getString("name"),rs.getBoolean("sex"),rs.getInt("age")
);
@Autowired
private JdbcTemplate jdbcTemplate;
/**
* 根據 id 獲取一個物件
*
* @param id id
* @return 根據 id 查詢到的物件，如果沒有查到則為 null
*/
public User get(Integer id) {
return jdbcTemplate.queryForObject("select * from user where id = ?",userRowMapper,id);
}
/**
* 查詢全部使用者
*
* @return 全部使用者列表
*/
public List<User> listForAll() {
return jdbcTemplate.query("select * from user",userRowMapper);
}
/**
* 根據 id 刪除使用者
*
* @param id 使用者 id
* @return 受影響行數
*/
public int deleteById(Integer id) {
return jdbcTemplate.update("delete from user where id = ?",id);
}
}
接下來才是正事，測試 Dao 層需要載入 Spring 容器，自動回滾以避免汙染資料庫。
/**
* {@code @SpringBootTest} 和 {@code @RunWith(SpringRunner.class)} 是必須的，這裡貌似一直有人誤會需要使用 {@code @RunWith(SpringJUnit4ClassRunner.class)}，但其實並不需要了
* 下面的 {@code @Transactional} 和 {@code @Rollback}則是開啟事務控制以及自動回滾
*
* @author rxliuli
*/
@SpringBootTest
@RunWith(SpringRunner.class)
@Transactional
@Rollback
public class UserDaoTest {
@Autowired
private UserDao userDao;
@Test
public void get() {
int id = 1;
User result = userDao.get(id);
//斷言 id 和 get id 相同
assertThat(result)
.extracting(User::getId)
.contains(id);
}
@Test
public void listForAll() {
List<User> userList = userDao.listForAll();
//斷言不為空
assertThat(userList)
.isNotEmpty();
}
@Test
public void deleteById() {
int result = userDao.deleteById(1);
assertThat(result)
.isGreaterThan(0);
}
}
Web 測試
與傳統的 SpringTest 一樣，SpringBoot 也分為兩種。
- 獨立安裝測試：
手動載入單個 Controller，所以測試其他 Controller 中的介面會發生異常。但測試速度上較快，所以應當優先選擇。
- 整合 Web 環境測試：
將啟動並且載入所有的 Controller,所以效率上之於 BaseWebUnitTest 來說非常低下,僅適用於整合測試多個 Controller 時使用。
獨立安裝測試
主要是設定需要使用的 Controller 例項，然後用獲得 MockMvc 物件進行測試即可。
/**
* @author rxliuli
*/
@SpringBootTest
@RunWith(SpringRunner.class)
@Transactional
@Rollback
public class UserControllerUnitTest {
@Autowired
private UserController userController;
/**
* 用於測試 API 的模擬請求物件
*/
private MockMvc mockMvc;
@Before
public void before() {
//模擬一個 Mvc 測試環境，獲取一個 MockMvc 例項
mockMvc = MockMvcBuilders.standaloneSetup(userController)
.build();
}
@Test
public void testGet() throws Exception {
//測試能夠正常獲取
Integer id = 1;
mockMvc.perform(
//發起 get 請求
get("/user/" + id)
)
//斷言請求的狀態是成功的(200)
.andExpect(status().isOk())
//斷言返回物件的 id 和請求的 id 相同
.andExpect(jsonPath("$.id").value(id));
}
@Test
public void listForAll() throws Exception {
//測試正常獲取
mockMvc.perform(
//發起 post 請求
post("/user/listForAll")
)
//斷言請求狀態
.andExpect(status().isOk())
//斷言返回結果是陣列
.andExpect(jsonPath("$").isArray())
//斷言返回陣列不是空的
.andExpect(jsonPath("$").isNotEmpty());
}
}
整合 Web 環境測試
/**
* @author rxliuli
*/
@SpringBootTest
@RunWith(SpringRunner.class)
@Transactional
@Rollback
public class UserControllerIntegratedTest {
@Autowired
private WebApplicationContext context;
/**
* 用於測試 API 的模擬請求物件
*/
private MockMvc mockMvc;
@Before
public void before() {
//這裡把整個 WebApplicationContext 上下文都丟進去了，所以可以測試所有的 Controller
mockMvc = MockMvcBuilders.webAppContextSetup(context)
.build();
}
@Test
public void testGet() throws Exception {
//測試能夠正常獲取
Integer id = 1;
mockMvc.perform(
//發起 get 請求
get("/user/" + id)
)
//斷言請求的狀態是成功的(200)
.andExpect(status().isOk())
//斷言返回物件的 id 和請求的 id 相同
.andExpect(jsonPath("$.id").value(id));
}
@Test
public void listForAll() throws Exception {
//測試正常獲取
mockMvc.perform(
//發起 post 請求
post("/user/listForAll")
)
//斷言請求狀態
.andExpect(status().isOk())
//斷言返回結果是陣列
.andExpect(jsonPath("$").isArray())
//斷言返回陣列不是空的
.andExpect(jsonPath("$").isNotEmpty());
}
}
總結
其實上面的測試類的註解感覺都差不多，我們可以將一些普遍的註解封裝到基類，然後測試類只要繼承基類就能得到所需要的環境，吾輩自己的測試基類在 src/test/common 下面，具體使用方法便留到下次再說吧
以上程式碼已全部放到 GitHub 上面，可以直接 clone 下來進行測試
到此這篇關於如何用SpringBoot 進行測試的文章就介紹到這了,更多相關SpringBoot 測試內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！