单元测试实战#xff08;一#xff09;Controller

单元测试实战特分门别类示例各种组件的测试代码并进行解说供开发人员参考。

单元测试实战一Controller

框架都提供根据一定规约自动生成查询/更新的操作如代理接口。

这一部分责任在框架本身我们不需测试。

因此DAO的测试应主要针对自定义查询/更新操作。

JPA的测试注解是DataJpaTestMybatis-Plus的是MyBatisPlusTest它们的思想是一致的此次先讲JPA。

Data

JPA标准的Repository且使用接口代理那么理论上是不需要测试的但实际中不排除想验证订制代码native

boot测试框架提供的功能因此它是有Spring上下文的使用JUnit的SpringExtension扩展类。

测试还是遵循经典三段式given、when、***n即假设xxx……那么当yyy时……应该会zzz。

dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-test/artifactIdscopetest/scope

/dependency

dependencygroupIdorg.junit.jupiter/groupIdartifactIdjunit-jupiter-api/artifactIdscopetest/scope

/dependency

dependencygroupIdcom.h2database/groupIdartifactIdh2/artifactIdscopetest/scope

/dependency

com.aaa.api.auth.repository;import

org.springframework.data.jpa.repository.JpaRepository;

import

org.springframework.stereotype.Repository;import

java.util.List;

findTop10ByNameContaining(String

keyword);

上面的Repository虽然没有订制代码但不妨碍我们用它来演示Repository测试的写法。

package

com.aaa.api.auth.repository;import

import

org.junit.jupiter.api.BeforeEach;

import

org.springframework.beans.factory.annotation.Autowired;

import

org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;

import

org.springframework.boot.test.autoconfigure.orm.jpa.TestEntityManager;

import

org.springframework.test.context.TestPropertySource;import

static

org.assertj.core.api.Assertions.assertThat;DataJpaTest

//AutoConfigureTestDatabase(replace

AutoConfigureTestDatabase.Replace.NONE)

{//spring.datasource.driver-class-nameorg.h2.Driver,//spring.datasource.urljdbc:h2:mem:api_auth_test;DB_CLOSE_DELAY-1;DB_CLOSE_ON_EXITFALSE;MODEMySQL;DATABASE_TO_LOWERTRUE;NON_KEYWORDSuser,//spring.datasource.usernamesa,spring.jpa.hibernate.ddl-autocreate-drop,spring.jpa.properties.hibernate.hbm2ddl.autocreate-drop,spring.jpa.properties.hibernate.globally_quoted_identifierstrue

class

{u1.setName(张三);u1.setUserCode(zhangsan);u1.setRole(User.ADMIN);u1.setEmail(zhangsanaaa.net.cn);u1.setMobile(13600001234);u2.setName(李四);u2.setUserCode(lisi);u2.setRole(User.ADMIN);u2.setEmail(lisiaaa.net.cn);u2.setMobile(13800001234);u3.setName(王五);u3.setUserCode(wangwu);u3.setRole(User.USER);u3.setEmail(wangwuaaa.net.cn);u3.setMobile(13900001234);}Testvoid

testSave()

entityManager.getEntityManager().createQuery(from

User);repo.save(u1);assertThat(q.getResultList()).hasSize(1);repo.save(u2);assertThat(q.getResultList()).hasSize(2);User

repo.save(u3);assertThat(q.getResultList()).hasSize(3);u3.setRole(User.ADMIN);repo.save(u3);assertThat(q.getResultList()).hasSize(3);assertThat(entityManager.find(User.class,

u.getId()).getRole()).isEqualTo(User.ADMIN);}

Testvoid

{entityManager.persist(u1);entityManager.persist(u2);entityManager.persist(u3);ListUser

entities

repo.findAll();assertThat(entities).size().isEqualTo(3);assertThat(entities.get(0).getId()).isNotNull();assertThat(entities.get(1).getId()).isNotNull();assertThat(entities.get(2).getId()).isNotNull();}Testvoid

testFindByUserCode()

{entityManager.persist(u1);entityManager.persist(u2);entityManager.persist(u3);User

repo.findByUserCode(zhangsan).orElse(null);assertThat(u1).isNotNull();assertThat(u1.getRole()).isEqualTo(User.ADMIN);User

repo.findByUserCode(lisi).orElse(null);assertThat(u2).isNotNull();assertThat(u2.getRole()).isEqualTo(User.ADMIN);User

repo.findByUserCode(wangwu).orElse(null);assertThat(u3).isNotNull();assertThat(u3.getRole()).isEqualTo(User.USER);u3.setRole(User.ADMIN);entityManager.persist(u3);u3

repo.findByUserCode(wangwu).orElse(null);assertThat(u3).isNotNull();assertThat(u3.getRole()).isEqualTo(User.ADMIN);}Testvoid

testFindTop10ByNameContaining()

{entityManager.persist(u2);entityManager.persist(u3);ListUser

users

repo.findTop10ByNameContaining(张三);assertThat(users).isEmpty();users

repo.findTop10ByNameContaining(李四);assertThat(users).hasSize(1);users

repo.findTop10ByNameContaining(五);assertThat(users).hasSize(1);}}

测试类说明

DataJpaTest、WebMvcTest以及SpringBootTest等测试其实是需要Spring

Boot的Configuration的因此我们在测试目录里可能尤其在多模块工程里有个专用于测试的Mock

Application注解为SpringBootApplication空类不需要main方法并且在src/test/resources下还可以有application.properties或yaml。

而更灵活的方式是使用第18行的TestPropertySource的properties属性。

DataJpaTest这个注解会在测试时自动将数据源替换为内存数据库H2的如果不想要这种替换或者要订制其url等属性那么就可以将第17行、第19-21行的注释放开。

第24行的spring.jpa.properties.hibernate.globally_quoted_identifierstrue可以避免数据库保留字与表名/列名冲突。

第29行我们将待测试类对象作为测试类的一个属性并使用Autowired进行注入。

第32行我们注入了一个TestEntityManager它作为一个实用工具帮我们在测试中插数据、查数据这样就避免了直接使用repo的方法插数据、查数据因为这些方法本身就是待测目标。

第34-36行提供了三个测试数据并在setUp()方法中进行初始化/重置。

BeforeEach注解使得setUp()方法在每个测试之前都会执行一遍。

从59行开始是测试方法。

该测试类中没有任何Mock对象因此也就不存在given

when

***n三段式结构。

测试方法都是直接对测试数据进行CRUD操作并检查操作结果代码都是自解释的。

对于JPA

Repository的测试推荐使用DataJpaTest注解。

如需订制内存数据库datasource的属性则令AutoConfigureTestDatabase(replace

AutoConfigureTestDatabase.Replace.NONE)然后在TestPropertySource.properties里写订制属性。

Repository应设计为单纯的对数据实体的CRUD操作因此通常不需Mock任何依赖对象。