Java泛型实现CSV转对象方法

本文介绍了如何使用 Java 泛型创建一个通用的 CSV 文件转换器，将 CSV 文件中的数据动态地转换为不同类型的 Java 对象，例如 Cat 和 Dog。 通过使用泛型，避免了为每种对象类型编写重复代码，提高了代码的可重用性和可维护性。 同时，推荐使用现有的 CSV 解析库，以简化开发并提高代码的健壮性。

使用 Java 泛型构建通用的 CSV 转换器

在 Java 开发中，经常需要将 CSV 文件中的数据转换为 Java 对象。 如果针对每种对象类型都编写一个特定的转换方法，会导致代码冗余且难以维护。 利用 Java 泛型，可以创建一个通用的 CSV 转换器，能够动态地将 CSV 数据转换为不同类型的 Java 对象。

1. 创建泛型 CSV 工具类

首先，创建一个泛型类 CsvUtils，使用类型参数 T 表示要转换成的 Java 对象类型。

public class CsvUtils {

    public List read(final String fileName, final Class clazz) throws IOException {
        List objectList = new ArrayList<>();
        Path pathToFile = Paths.get(fileName);

        try (BufferedReader br = Files.newBufferedReader(pathToFile)) {
            String line = br.readLine(); // Skip header line
            while ((line = br.readLine()) != null) {
                String[] attributes = line.split(",");
                T obj = createObject(attributes, clazz);
                if (obj != null) {
                    objectList.add(obj);
                }
            }
        } catch (IOException e) {
            e.printStackTrace();
        }

        return objectList;
    }

    private T createObject(String[] attributes, Class clazz) {
        try {
            T obj = clazz.getDeclaredConstructor().newInstance();
            // Assuming the attributes order matches the fields order in the class
            Field[] fields = clazz.getDeclaredFields();
            for (int i = 0; i < fields.length && i < attributes.length; i++) {
                fields[i].setAccessible(true); // Allow access to private fields
                // Attempt to convert the string value to the field's type
                try {
                    if (fields[i].getType() == int.class || fields[i].getType() == Integer.class) {
                        fields[i].set(obj, Integer.parseInt(attributes[i]));
                    } else if (fields[i].getType() == String.class) {
                        fields[i].set(obj, attributes[i]);
                    } // Add more type conversions as needed
                } catch (NumberFormatException e) {
                    System.err.println("Error converting value for field " + fields[i].getName() + ": " + e.getMessage());
                }
            }
            return obj;
        } catch (Exception e) {
            System.err.println("Error creating object of type " + clazz.getName() + ": " + e.getMessage());
            return null;
        }
    }
}

2. 使用泛型 CSV 工具类

现在，可以使用 CsvUtils 类将 CSV 文件转换为 Cat 或 Dog 对象列表。

public class Example {

    public void doSomeStuffWithMyDogs() throws IOException {
        CsvUtils csvUtils = new CsvUtils<>();
        List myDogs = csvUtils.read("MyDogs_V1.csv", Dog.class);

        // do something else with myDogs
        for (Dog dog : myDogs) {
            System.out.println(dog);
        }
    }

    public void doSomeStuffWithMyCats() throws IOException {
        CsvUtils csvUtils = new CsvUtils<>();
        List myCats = csvUtils.read("MyCats_V1.csv", Cat.class);

        // do something else with myCats
        for (Cat cat : myCats) {
            System.out.println(cat);
        }
    }
}

3. 注意事项和改进

• 异常处理: 在实际应用中，需要更完善的异常处理机制，例如记录错误日志、提供友好的错误提示等。
• 类型转换: createObject 方法中需要根据实际情况添加更多的类型转换逻辑，例如日期、布尔值等。
• CSV 解析库: 不建议手动解析 CSV 文件，推荐使用现有的 CSV 解析库，例如 Apache Commons CSV, OpenCSV, SimpleFlatMapper CSV parser, jackson-dataformat-csv, uniVocity-parsers, deephaven-csv 等。 这些库提供了更强大的功能和更好的性能，可以简化开发并提高代码的健壮性。
• 对象创建: createObject 方法使用反射来创建对象，这可能会影响性能。 可以考虑使用工厂模式或构建器模式来创建对象。
• 字段映射: 当前的实现假设 CSV 文件的列顺序与 Java 对象的字段顺序一致。 如果不一致，需要添加字段映射的逻辑。

4. 使用 Apache Commons CSV 示例

以下示例展示了如何使用 Apache Commons CSV 库来解析 CSV 文件。

首先，添加 Apache Commons CSV 的依赖：

    org.apache.commons
    commons-csv
    1.9.0

然后，修改 CsvUtils 类：

import org.apache.commons.csv.*;

public class CsvUtils {

    public List read(final String fileName, final Class clazz) throws IOException {
        List objectList = new ArrayList<>();
        Path pathToFile = Paths.get(fileName);

        try (BufferedReader br = Files.newBufferedReader(pathToFile);
             CSVParser parser = CSVFormat.DEFAULT.withFirstRecordAsHeader().parse(br)) {

            for (CSVRecord record : parser) {
                T obj = createObject(record, clazz);
                if (obj != null) {
                    objectList.add(obj);
                }
            }
        } catch (IOException e) {
            e.printStackTrace();
        }

        return objectList;
    }

    private T createObject(CSVRecord record, Class clazz) {
        try {
            T obj = clazz.getDeclaredConstructor().newInstance();
            Field[] fields = clazz.getDeclaredFields();
            for (Field field : fields) {
                field.setAccessible(true);
                String columnName = field.getName(); // Assuming column name matches field name
                String value = record.get(columnName);
                try {
                    if (field.getType() == int.class || field.getType() == Integer.class) {
                        field.set(obj, Integer.parseInt(value));
                    } else if (field.getType() == String.class) {
                        field.set(obj, value);
                    } // Add more type conversions as needed
                } catch (NumberFormatException e) {
                    System.err.println("Error converting value for field " + field.getName() + ": " + e.getMessage());
                } catch (IllegalArgumentException e) {
                    System.err.println("Column not found: " + columnName);
                }
            }
            return obj;
        } catch (Exception e) {
            System.err.println("Error creating object of type " + clazz.getName() + ": " + e.getMessage());
            return null;
        }
    }
}

这个示例使用了 CSVFormat.DEFAULT.withFirstRecordAsHeader() 来指定 CSV 文件的第一行是标题行，并使用 record.get(columnName) 来获取指定列的值。

5. 总结

使用 Java 泛型可以创建通用的 CSV 转换器，避免为每种对象类型编写重复代码。 为了简化开发并提高代码的健壮性，推荐使用现有的 CSV 解析库。 同时，需要注意异常处理、类型转换、对象创建和字段映射等方面的问题。