如何用SpringBoot 进行测试

如何用SpringBoot 进行测试

普通测试

假设要测试一个工具类 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 的最新版本

org.springframework.boot

spring-boot-starter-test

test

org.assertj

assertj-core

3.9.1

test

这里WanrPECVu指定 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, strEmpty, strSome))

.isFalse();

assertThat(StringUtil.isAnyEmpty(strNull, strEmpty))

.isTrue();

}

}

这里和非 SpringBoot 测试时没什么太大的区别，唯一的一点就是引入 Jar 不同，这里虽然我们只引入了 spring-boot-starter-test，但它本身已经帮我们引入了许多的测试相关类库了。

Dao/Service 测试

从这里开始就和标准的 Spring 不太一样了

首先，我们需要 Dao 层，这里使用 H2DB 和 SpringJDBC 做数据访问层（比较简单）。

依赖

com.h2database

h2

runtime

org.springframework.boot

spring-boot-starter-jdbc

添加两个初始化脚本

数据库结构 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, '月姬', false, 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, Boolean sex, 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 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 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 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

@RoWanrPECVullback

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 下来进行测试

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。