本文的目的
单元测试无疑是软件开发中特别重要的一个环节,只有有了单元测试,你的代码才有可能具备可重构的能力。本文主要讲述单元测试中如何解决数据库的问题。
问题
有人可能存在疑问,为什么单元测试需要用到数据库呢?随着软件的复杂程度不断的增加,针对某个类或方法的测试已经远远无法满足我们的需求。我们需要有一种更加高效,投入产出比更高的测试方式,我们称之为组件测试。而组件测试是需要用到数据库的。我后面会单独开一篇文章来讲述什么是组件测试,为什么组件测试的投入产出比更高。这里先暂时略过。
当我们的测试代码需要用到数据库时,如果我们使用一个单独的数据库专门用来做测试时,存在以下问题:
- 维护成本高,如果测试数据库中的数据被更改,有可能导致单测运行失败,增加排查成本。
- 测试运行不能并发运行。
- 资源浪费,需要有一个数据库服务器专门用来做测试。
问题解决
最好的解决办法是使用一个基于内存的数据库,单测运行时启动数据库,单测结束时销毁数据库。目前比较轻量级的内存数据库是H2,H2官网
但目前H2还不支持Json语法,在mysql版本5.7时,加入了对Json的支持,如果你的应用中用到了Json语法,那对不起不能使用H2了,目前我们在使用一个可以从Java中启动Mysql的一个小工具,wix-embedded-mysql,基于这个小工具,我可以在测试机上完成自动安装并启动Mysql。
下面我详细讲一下如何使用这两个工具来解决我们单测中的问题。
H2内存数据库
Maven依赖
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<version>1.0.0.ali.fix1</version>
<scope>test</scope>
</dependency>
H2的DataSource的创建代码如下:
@Bean
public DataSource dataSource() {
EmbeddedDatabaseBuilder databaseBuilder = new EmbeddedDatabaseBuilder();
EmbeddedDatabase db = databaseBuilder.setName("testDb" + dnIndex.getAndIncrement())
.setType(EmbeddedDatabaseType.H2)
//启动时初始化建表语句
.addScript("classpath:ddlScript/xxx.sql")
.addScript("classpath:ddlScript/yyy.sql")
.build();
return db;
}
其中xxx.sql和yyy.sql是建表的DDL和初始化的一些sql。
Mysql内置数据库
Maven依赖
<dependency>
<groupId>com.wix</groupId>
<artifactId>wix-embedded-mysql</artifactId>
<version>4.6.1</version>
<scope>test</scope>
</dependency>
内置Mysql的DataSource的创建代码如下:
@Bean
public DataSource mysqlDataSource() {
MysqldConfig config = aMysqldConfig(v5_7_27)
.withCharset(UTF8)
.withPort(port)
.withUser(userName, testPW)
.withTimeZone(TimeZone.getTimeZone("GMT+:08:00").getID())
.withTimeout(2, TimeUnit.MINUTES)
.withServerVariable("max_connect_errors", 666)
.build();
List scriptList = new ArrayList();
scriptList.add(ScriptResolver.classPathScript("ddlScript/xxx.sql"));
scriptList.add(ScriptResolver.classPathScript("ddlScript/yyy.sql"));
DownloadConfig downloadConfig = DownloadConfig.aDownloadConfig().build();
EmbeddedMysql mysqld = anEmbeddedMysql(config)
.addSchema(databaseName, scriptList)
.withDownloadConfig(downloadConfig)
.start();
MysqlDataSource dataSource = new MysqlDataSource();
dataSource.setDatabaseName(databaseName);
dataSource.setServerName("localhost");
dataSource.setPort(2215);
dataSource.setUser(userName);
dataSource.setPassword(testPW);
dataSource.setUseSSL(false);
dataSource.setServerTimezone(TimeZone.getTimeZone("GMT+:08:00").getID());
return dataSource;
}
这里还有一个小问题,wix-embedded-mysql在第一次启动Mysql时,需要去下载一个mysql的安装文件(700M左右),在本地开发机器上,下载后会放到$user.home/.embedmysql目录下,因此只需要下载一次。但如果你的单测希望是在集成环境中也能跑的,那这个下载有时会很慢。 通常下载1分钟左右,有时也会持续1小时。
为了解决这个问题,我们在本地测试环境中部署了一个下载服务器,把mysql的下载代码改成下面例子中的,你将会从测试环境中下载mysql安装文件,时间也会缩短到7秒钟。
DownloadConfig downloadConfig = DownloadConfig.aDownloadConfig()
.withBaseUrl("http://wdk-test.hemaos.test:7001/mysql/download")
.build();
内存数据库图形界面
当然在跑复杂的测试时,有时需要查看一下内存数据库中的数据怎么办?
H2的工具包当时刚好自带了一个很好用的网页版工具,我写了一个简单的启动类,运行单测时打好断点,然后单独运行下面的类,就会弹出一个浏览器,然后就可以查询内存数据库中的数据了。
import java.sql.SQLException;
/**
* 内置mysql图形界面
* 使用方法:
* 1.启动测试类,并停在断点处
* 2.在最后一行加上断点,然后debug这个main方法,将会打开图形界面
*
* @description:
* @author: zhenghui.lzh
* @create: 2021-11-15 11:06 上午
*/
public class TestDBWebClient {
private static String DB_URL_MYSQL = "jdbc:mysql://localhost:2215/wdk-fee?useUnicode=true&useSSL=false";
public static void main(String[] args) {
try {
new org.h2.tools.Console().runTool("-url",DB_URL_MYSQL,"-user","fee","-password","fee");
} catch (SQLException throwables) {
throwables.printStackTrace();
}
System.out.println("test");
}
}
图形界面如下:
总结
当有了如此强大的内存数据库,我们还有什么理由不写单测呢?