Spring + Mybatis 单元测试 (DAO)

主要依赖

  • Spring : 4.3.12.RELEASE
  • mybatis : 3.4.5
  • junit : 4.12
  • hamcrest-all : 1.3
  • h2 : 1.4.196
  • DbSetup : 2.1.0

DAO 层的单元测试应该怎么做

如果按照单元测试的定义,我们的不应该依赖于如数据库、网络、文件等,使用 Mockito 这类框架可以模拟这些外界因素。但是对于 DAO 层来说,脱离了数据库,单元测试还能发挥它应有的作用吗?

看下面使用 Mockito 的例子

@Test
public void testAdd() {
    Student student = new Student();
    StudentDao studentDao = mock(StudentDao.class);
    studentDao.add(student);
    verify(studentDao).add(student);
}

说实话,上面的测试没有任何作用,即使这个测试通过,它甚至不能保证这个DAO 所执行的 SQL 能在数据库中执行。DAO 层跟数据库耦合的是如此的紧密,以至于脱离数据库的测试没有一点意义。其实我们对 DAO 层的测试是为了两点:

  • 它执行了正确的 SQL 吗?
  • 它返回了我们所需要的数据吗?

这两点都是需要数据库环境支持的。那么我们需要连接本地的数据库进行测试吗?比如说连接本地的 MySQL ? 不,这样会使得测试过于依赖运行的电脑环境,如果别的同事 clone 了这个项目,他还需要搭建测试用的数据库,这很麻烦。所以我们使用内存数据库,像我这边是用 h2 数据库,这样我们只需添加依赖包即可。

如此看来这样的测试已经不能叫单元测试了,更像是集成测试?

哪些是需要测试的?

在我看来,除了最基本的 CURD,其它都测。因为 CURD 通常都是代码生成器,像 mybatis-generator 这样的工具生成的,测试这些生成的 SQL 就像测试第三方的类一样意义不大。只需要测试自己写的方法就好。

Spring Test

Spring 本身就有一套测试框架,很容易跟 Junit 整合。这里的例子使用 Maven 作为构建工具。

测试用到的依赖

<dependency>
    <groupId>junitgroupId>
    <artifactId>junitartifactId>
    <version>4.12version>
    <scope>testscope>
dependency>

<dependency>
    <groupId>org.hamcrestgroupId>
    <artifactId>hamcrest-allartifactId>
    <version>1.3version>
    <scope>testscope>
dependency>

<dependency>
    <groupId>org.springframeworkgroupId>
    <artifactId>spring-testartifactId>
    <version>${spring.version}version>
    <scope>testscope>
dependency>

<dependency>
    <groupId>com.h2databasegroupId>
    <artifactId>h2artifactId>
    <version>1.4.196version>
    <scope>testscope>
dependency>

<dependency>
    <groupId>com.ninja-squadgroupId>
    <artifactId>DbSetupartifactId>
    <version>2.1.0version>
    <scope>testscope>
dependency>

测试目录结构

Spring + Mybatis 单元测试 (DAO)_第1张图片

在 Spring 的测试配置文件 application-context.xml 中,使用 h2 数据库作为数据源

<jdbc:embedded-database id="dataSource" type="H2" generate-name="true"/>

//初始化数据库
<jdbc:initialize-database>
    <jdbc:script location="schema.sql" encoding="UTF-8"/>
jdbc:initialize-database>

这里我们有一个初始化数据库的文件 schema.sql ,用来建立使用到的表。本例使用的表有 student、clazz

create table student (
  id   int not null auto_increment primary key,
  name varchar(225),
  clazz_id int
);

create table clazz (
  id         int     not null auto_increment primary key,
  name       varchar(225),
  grade      tinyint not null
)

假设我们有一个 StudentDao 类,有一个方法 List findByGrade(Long grade) ,根据年级查找学生,我们建立相应的测试类

  • @RunWith(SpringJUnit4ClassRunner.class) 使用 Spring 提供的 runner。
  • @ContextConfiguration("classpath:application-context.xml") 指定 Spring 配置文件
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("classpath:application-context.xml")
public class StudentDaoTest {
    @Test
    public void testFindByGrade() {
    }
}

好了,现在我们有了一个内存数据库,表也有了,那就还差数据了。当然我们可以在初始化数据库表的时候将测试数据插入,但相对于每一个测试来说,数据不够细,且这些数据不好维护。我更倾向于在测试类中初始化相应的数据。我一开始看了下 DbUnit,它是使用 XML 来构造数据的,说实话,XML 也不好维护。后来发现了 DbSetup,感觉好用一点,虽然他们的功能是不完全相同的,对于测试有对数据库进行数据修改,如更新、插入、删除等方法,DbUnit还是比较在行。DbSetup 主要是关注于数据的初始化。具体的用法这些就自己去看了,这里给个简单的例子

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("classpath:application-context.xml")
public class StudentDaoTest {
    private static DbSetupTracker dbSetupTracker = new DbSetupTracker();
    @Autowired DataSource dataSource;
    @Autowired StudentDao studentDao;

    @Before
    public void setUp() {
        Operation operation = Operations.sequenceOf(
                Operations.deleteAllFrom("student", "clazz"),
                Operations.insertInto("student")
                        .columns("id", "name", "clazz_id")
                        .values(1L, "Tom", 1L)
                        .values(2L, "Jack", 2L)
                        .values(3L, "Red", 1L)
                        .build(),
                Operations.insertInto("clazz")
                        .columns("id", "name", "grade")
                        .values(1L, "1-A", 1L)
                        .values(2L, "2-B", 2L)
                        .build()
        );
        DbSetup dbSetup = new DbSetup(new DataSourceDestination(dataSource), operation);
        dbSetupTracker.launchIfNecessary(dbSetup);
    }

    @Test
    public void testFindByGrade() {
        dbSetupTracker.skipNextLaunch();

        List actual = studentDao.findByGrade(1L);

        assertThat(actual, hasSize(2));
        assertThat(actual, hasItems(
                hasProperty("id", is(1L)),
                hasProperty("id", is(2L))
        ));
    }
}

setUp 方法中,即使没有看过 DbSetup 的文档,相信你也很容易就看懂它是如何初始化数据的。然后在 testFindByGrade 方法中,就是典型的断言了。这里我只是对 Student 的 id 进行了比较,当然你可以对比所有的属性。

你可能感兴趣的:(Java,单元测试)