SpringBoot测试：抽象类方法模拟与验证

在Spring Boot应用中，针对抽象类的单元测试，特别是当具体方法依赖抽象方法和外部资源时，面临诸多挑战。本文聚焦于如何利用JUnit 5和Mockito高效地测试抽象类中已实现的方法，以`CsvService`为例，该类负责从CSV文件读取数据并转换为Java对象列表。`readFromCsv()`方法依赖于`getFileName()`、`getColumns()`和`getData()`等抽象方法。本文将演示如何使用`Mockito.spy()`进行部分模拟，通过创建一个`AirportService`的间谍对象，模拟`getFileName()`、`getColumns()`和`getData()`方法，使其返回测试资源路径和符合测试预期的列映射，从而隔离`readFromCsv()`的逻辑，并避免`getData()`的副作用或复杂性，确保测试的隔离性和可重复性。本文还将提供详细的步骤和代码示例，帮助开发者掌握抽象类方法测试的技巧。

在Java和Spring Boot应用开发中，我们经常会遇到抽象类，它们定义了通用的行为骨架，并包含一些由子类实现（或覆盖）的抽象方法。当我们需要对抽象类中那些已经实现（即具体）的方法进行单元测试时，挑战在于这些具体方法往往会调用抽象方法，而抽象方法在抽象类本身中并没有实现。此外，如果这些方法还涉及外部资源（如文件系统），我们还需要一种方式来模拟这些外部依赖，以确保测试的隔离性和可重复性。

本文将以一个典型的CSV文件服务为例，演示如何使用JUnit 5和Mockito有效地测试抽象类 CsvService 中的具体方法 readFromCsv()。

场景描述

假设我们有一个抽象的 CsvService 类，它负责从CSV文件读取数据并将其转换为Java对象列表。该类包含一个具体的 readFromCsv 方法，但它依赖于抽象方法 getFileName()、getColumns() 和 getData() 的实现。

import com.opencsv.bean.ColumnPositionMappingStrategy;
import com.opencsv.bean.CsvToBean;
import com.opencsv.bean.CsvToBeanBuilder;
import com.opencsv.bean.CsvToBeanFilter;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;

import java.io.FileReader;
import java.io.IOException;
import java.io.Reader;
import java.util.ArrayList;
import java.util.List;

// 假设 CsvBean 是一个标记接口或基类
public abstract class CsvService<T extends CsvBean> {

    // 假设 log 和 FILE_READ_ERROR 已定义
    // private static final Logger log = LoggerFactory.getLogger(CsvService.class);
    // private static final String FILE_READ_ERROR = "Error reading CSV file";

    public List<T> readFromCsv(Class<T> type, CsvToBeanFilter filter) {
        List<T> data = new ArrayList<>();
        try {
            // 依赖 getFileName() 获取文件名
            Resource resource = new ClassPathResource("data/" + getFileName());
            Reader reader = new FileReader(resource.getFile());

            ColumnPositionMappingStrategy<T> strategy = new ColumnPositionMappingStrategy<>();
            strategy.setType(type);
            // 依赖 getColumns() 获取列映射
            strategy.setColumnMapping(getColumns());

            CsvToBean<T> csvToBean = new CsvToBeanBuilder<T>(reader)                    
                    .withFilter(filter)
                    .withMappingStrategy(strategy) // 添加映射策略
                    .build();

            // 依赖 getData() 处理 CsvToBean 结果
            data = getData(csvToBean);
            reader.close();

        } catch (IOException ex) {
            // log.error(FILE_READ_ERROR, ex);
            ex.printStackTrace(); // 简化错误处理
        }
        return data;
    }

    protected abstract String getFileName();
    protected abstract String[] getColumns();
    protected abstract List<T> getData(CsvToBean<T> csvToBean);
}

其具体实现类 AirportService 如下：

import com.opencsv.bean.CsvToBean;
import org.springframework.stereotype.Service;
import java.util.ArrayList;
import java.util.List;

// 假设 Airport 类和 CsvBean 接口/基类已定义
// public class Airport implements CsvBean { /* ... */ }
// public interface CsvBean {}

@Service
public class AirportService extends CsvService<Airport> {

    @Override
    protected String getFileName() {
        return "airports.csv"; // 实际文件名
    }

    @Override
    protected String[] getColumns() {
        return new String[]{"id", "name"}; // 机场数据列
    }

    @Override
    protected List<Airport> getData(CsvToBean<Airport> csvToBean) {
        List<Airport> airports = new ArrayList<>();
        for (Airport bean : csvToBean) {
            Airport airport = new Airport(bean.getId(), bean.getName());
            airports.add(airport);
        }
        return airports;
    }
}

我们的目标是测试 CsvService 中 readFromCsv() 方法的逻辑，包括它如何处理文件读取、应用过滤器以及构建 CsvToBean，同时不实际读取生产环境的CSV文件，并且隔离 getData() 方法的具体实现（假设 getData() 已经有独立的单元测试）。

解决方案一：使用 Mockito.spy() 进行部分模拟

Mockito.spy() 允许我们创建一个真实对象的间谍（spy）。与完全模拟（mock）不同，间谍对象会调用真实对象的方法，除非我们明确地对其某些方法进行模拟。这非常适合测试抽象类的具体方法，因为我们可以让具体方法正常执行，同时模拟其依赖的抽象方法。

核心思路：

1. 创建一个 AirportService 的间谍对象。
2. 模拟 getFileName() 方法，使其返回一个指向测试资源的路径（例如，src/test/resources/data/test-airports.csv）。
3. 模拟 getColumns() 方法，以确保列映射符合测试预期。
4. 模拟 getData() 方法，以隔离 readFromCsv 的逻辑，避免 getData 的副作用或复杂性。

步骤：

1. 准备测试资源： 在 src/test/resources/data/ 目录下创建一个名为 test-airports.csv 的文件，包含测试数据。

   id,name
   101,Test Airport A
   102,Test Airport B

2. 编写测试代码：

   import com.opencsv.bean.CsvToBean;
   import com.opencsv.bean.CsvToBeanFilter;
   import org.junit.jupiter.api.BeforeEach;
   import org.junit.jupiter.api.Test;
   import org.junit.jupiter.api

今天带大家了解了的相关知识，希望对你有所帮助；关于文章的技术知识我们会一点点深入介绍，欢迎大家关注golang学习网公众号，一起学习编程~