如何編寫單元測試-基於Spring

單元測試

首先單元測試真的算是一種“臟活累活”，但是我個人感覺還是有必要，至少本人最近開始寫單元測試后還是能發現一些“bug”的。

如何寫單元測試

單元測試的要求...網上很多。下面來分享一下我是如何寫單元測試。首先我們項目一般都是MVC分層的，而單元測試主要是在Dao層和Service層上進行編寫。從項目結構上來說，Service層是依賴Dao層的，但是從單元測試角度，對某個Service進行單元的時候，他所有依賴的類都應該進行Mock。而Dao層單元測試就比較簡單了（下面Dao層就以Jdbc為例子），只依賴數據庫中的數據。

DAO層單元測試。

dao層單元測試肯定要是連數據庫的，但是不需要本地起一個Mysql，可以使用H2內存數據庫來做單測就足夠了。

實戰

首先給一個通用模板吧，就是所有DAO層單元測試都會用到的，注：ORM使用Mybatis

@RunWith(SpringJUnit4ClassRunner.class)public class XXXDaoTest {

    @MapperScan({"com.xxx.xxx.mapper"})
    @Configuration
    public static class MybatisScanConfiguration {

        @Bean
        public XXXDao xxxDao() {
            return new XXXDaoImpl();
        }

        @Bean
        public DataSource h2DataSource() {

            EmbeddedDatabaseBuilder builder = new EmbeddedDatabaseBuilder();
            EmbeddedDatabase database = builder.setType(EmbeddedDatabaseType.H2)
                    .addScript("classpath:/xxx/init_table.sql") //啟動時初始化建表語句
                    .build();
            return database;
        }

        @Bean
        public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
            final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
            sessionFactory.setDataSource(dataSource);
            PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
            //加載所有的sql mapper文件
            Resource[] mapperLocations = resolver.getResources("classpath:com/xxx/xxx/XXXXMapper.xml");
            sessionFactory.setMapperLocations(mapperLocations);
            return sessionFactory.getObject();
        }

        @Bean
        public PlatformTransactionManager platformTransactionManager(DataSource dataSource) {
            return new DataSourceTransactionManager(dataSource);
        }

        @Bean
        public JdbcTemplate jdbcTemplate(DataSource dataSource) {
            return new JdbcTemplate(dataSource);
        }
    }

   @Autowired
   XXXDao xxxDao

　　@Test
　　@Transactional
　　public void xxxx() {

　　}

}

 

其中的一些需要稍微修改的，我使用“XXX”或者“xxx”，如果配過Spring的肯定知道怎么弄。其中init_table.sql就是用來創建數據庫表的，就不列出來的，下面需要注意的地方：

1. H2 DataBase有些語法是不支持的，例如 insert ignore，還有類似在創建數據庫時候"CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP"
2. 如果一些sql是Mapper不提供的，那么可以使用jdbcTemplate來執行
3. 每次單元測試執行完后，建議刪除當前單元測試方法上，加上 @Transactional 注解，保證每次執行完后數據回滾
4. 如果當前dao層存在其他依賴，其實是可以mock的（可以參考后面Service層的單元測試）

通用模板寫好以后，就可以按照不同情況來寫單測了，想想是不是很開心啊

    @Test
　　 @Transactional
    public void testUpdatexxx() {
        Long testUserId = 1L;
        //1.當數據不存在的時候，返回0
        int i = xxxDao.updateXxx(testUserId,1);
        Assert.assertTrue(i == 0);
        // 2.如果存在記錄,狀態是已經完成 返回0
        Domain domain = createBy(testUserId, 0);
        //插入一條數據
        mapper.insertSelective(domain);
        Assert.assertTrue(xxxDao.updateXxx(testUserId,1) == 0);
        //3.如果存在記錄,狀態是未完成 返回1
        ....

    }

 

Service層單元測試

說實話，Service層的單測是最麻煩的，特別是那種超級大方法。Service層的單元測試就是主要Mock其他依賴Bean來完成各種邏輯的判斷。

實戰

還是先給一個模板

@RunWith(SpringRunner.class)
@ContextConfiguration(classes = NeedTestService.Config.class)
public class NeedTestServiceTest {

    @TestConfiguration
    public static class Config {
        //這里直接創建一個待測試的類
        @Bean
        public NeedTestService needTestService() {
            return new NeedTestService();
        }
    }
    
    /*
     * Mock掉依賴的Bean
     */
    @MockBean
    private X1Dao x1Dao;

    @MockBean
    private X1Service x1Service;

 
    //這里是Autowired需要測試的類
    @Autowired
    private NeedTestService needTestService;
    
}

 

通用模板在上面，當然，遇到惡心的類，Mock十幾個Bean也是有可能的。 下面就開始開心的寫單元測試的了，例如

 @Test
    public void testCalculateUserClaims1() {
        Long testUserId = 1L;
        Date transTime = DateUtil.getStartDate(new Date());
        given(x1Dao.insertInitIgnore(testUserId, transTime)).willReturn(1);

        List<X2> list = Lists.newArrayList();
        list.addAll(createTenderCell(1L, "100.00", 10));
        list.addAll(createTenderCell(2L, "200.00", 5));
        Collections.shuffle(list);
        given(x1Dao.selectxxx(testUserId, transTime)).willReturn(list);

        
        ... 把改情況下 各種依賴的方法調用返回mock出來，

        //這里直接調用被測試的方法
        Result result = needTestService.needTestMethod(...)
        Assert.assertTrue(result != null);
        //... 省略掉各種 Assert.
       
    }

 注：一般單元測試可以分為：生成數據，mock數據，假設校驗

當然，這僅僅是一種情況，還有各種情況需要您進行測試，good luck！

小結

我也是最近才開始寫單元測試的，雖然很無腦，但是我個人還是覺得有必要的，一些很低級的錯誤至少能找出來(如果你稍微認真的寫，而不是敷衍)。這樣總比在Code Review的時候被指出來要好很多吧。而且寫單元測試也算是一種休息吧！