Optional转List：空值处理与内容验证技巧

引言：类型转换的必要性

在Java编程中，Optional通常用于表示一个值可能存在也可能不存在的场景，旨在避免NullPointerException。而List则是一个集合接口，用于表示一个有序的、可包含零个或多个元素的序列。在某些业务逻辑演进或代码重构时，我们可能会遇到需要将原本返回Optional的方法修改为返回List的情况，例如当一个查询操作原本只预期返回一个结果（或没有），但现在可能返回多个结果时。这种类型转换涉及对空值处理和内容检查逻辑的相应调整。

处理空值返回：从Optional.empty()到空List

当一个方法使用Optional作为返回类型时，如果没有任何结果，它通常会返回Optional.empty()来明确表示值的缺失。在转换为List后，对应的“没有结果”状态应该通过返回一个不包含任何元素的空列表来表示。

• Optional的空值表示：

  // 原始 Optional 返回，表示没有值
  return Optional.empty();

• List的空值表示： 在List的上下文中，返回一个空列表（即列表的size()为0）是表示没有元素的标准方式。通常有两种推荐的做法：
  1. 返回可变的空LinkedList或ArrayList：

     return new LinkedList<>(); // 返回一个空的 LinkedList 实例
     // 或者
     // return new ArrayList<>(); // 返回一个空的 ArrayList 实例

     这种方式返回的列表是可变的，调用者可以向其中添加元素。

  2. 返回不可变的空List：

     return List.of(); // Java 9+ 推荐，返回一个不可变的空列表

     List.of()方法（Java 9及更高版本）提供了一种简洁的方式来创建不可变列表。对于返回空列表的场景，List.of()是更推荐的选择，因为它能保证返回的列表不会被意外修改，从而提升代码的健壮性。

检查内容存在性：从isPresent()到!isEmpty()

Optional.isPresent()方法是Optional类的一个核心功能，用于判断Optional实例是否包含一个非空值。当我们将类型转换为List后，List接口并没有isPresent()方法。因此，我们需要使用List接口提供的相应方法来检查列表是否包含元素。

• Optional的内容检查：

  // 原始 Optional 检查，判断 Optional 是否包含值
  if (existingOptional.isPresent()) {
      // ... 执行包含值时的逻辑
  }

• List的内容检查： 对于List类型，我们应该使用isEmpty()方法来判断列表是否为空。

  List existingDepartments = get(departmentId);
  if (!existingDepartments.isEmpty()) { // 检查列表是否非空，即是否包含元素
      // ... 执行包含元素时的逻辑
  }

  这里需要注意的是，existingDepartments变量本身不应为null。在良好的Java编程实践中，如果一个方法声明返回List，它应该始终返回一个List实例（即使是空列表），而不是null。这样可以避免调用者进行额外的null检查，直接使用!isEmpty()即可。如果存在List变量可能为null的极少数情况，则可以增加Objects.nonNull()进行防御性检查：

  if (Objects.nonNull(existingDepartments) && !existingDepartments.isEmpty()) {
      // ...
  }

  但在大多数情况下，如果遵循返回空列表而非null的约定，此处的Objects.nonNull()检查是不必要的。

整合示例：delete方法重构

以下是一个将Optional转换为List的delete方法重构示例，它整合了上述的空值处理和内容检查的最佳实践。

import java.util.LinkedList;
import java.util.List;
import java.util.Objects; // 用于 Objects.nonNull()，如果需要
import org.springframework.jdbc.core.namedparam.MapSqlParameterSource;
import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate;

// 假设 Department 类已定义，包含 departmentId 字段
class Department {
    private String departmentId;
    // ... 构造函数, getter, setter, toString 等
    public Department(String departmentId) {
        this.departmentId = departmentId;
    }
    public String getDepartmentId() {
        return departmentId;
    }
    // 简化示例，实际类会更复杂
}

public class DepartmentService { // 假设这是某个服务类
    private NamedParameterJdbcTemplate jdbcTemplate; // 假设已通过构造函数或@Autowired注入

    // 构造函数注入 jdbcTemplate
    public DepartmentService(NamedParameterJdbcTemplate jdbcTemplate) {
        this.jdbcTemplate = jdbcTemplate;
    }

    /**
     * 根据部门ID删除部门及其关联员工。
     *
     * @param departmentId 部门ID
     * @return 返回被删除的部门列表（如果存在），否则返回一个空列表。
     *         注意：此方法的返回类型语义可能需要根据实际业务需求进一步评估。
     */
    public List delete(String departmentId) { // 遵循Java命名规范：departmentId
        // 1. 处理输入参数为空或空字符串的情况
        if (departmentId == null || departmentId.isEmpty()) {
            return List.of(); // 推荐使用 List.of() 返回不可变空列表
        }

        // 2. 获取待删除的现有部门信息
        // 假设 get 方法返回一个 List
        List existingDepartments = get(departmentId);

        // 3. 检查列表是否非空，以决定是否执行删除操作
        if (!existingDepartments.isEmpty()) { // 使用 !isEmpty() 替代 isPresent()
            // 使用Java 15+ 的文本块（Text Blocks）提升SQL语句的可读性
            String sql = """
                DELETE employee.*, department.*
                FROM employee, department
                WHERE employee.department_ID = :departmentId AND department.department_ID = :departmentId;
                """;

            MapSqlParameterSource parameters = new MapSqlParameterSource();
            parameters.addValue("departmentId", departmentId); // 参数名也应遵循命名规范

            int rowsAffected = jdbcTemplate.update(sql, parameters);
            if (rowsAffected > 0) {
                // 如果删除成功，返回之前获取的被删除部门列表
                // 注意：这里返回的是删除前的快照，如果业务需要返回实际删除的列表，需要进一步查询确认
                return existingDepartments;
            }
        }
        // 4. 如果没有找到要删除的部门，或者删除失败，返回空列表
        return List.of(); // 推荐使用 List.of()
    }

    /**
     * 模拟获取部门信息的方法。
     * 实际应用中会从数据库查询。
     *
     * @param departmentId 部门ID
     * @return 匹配的部门列表，如果不存在则返回空列表。
     */
    private List get(String departmentId) {
        // 模拟数据获取逻辑
        if ("dept123".equals(departmentId)) {
            List departments = new LinkedList<>();
            departments.add(new Department("dept123"));
            // 假设还有其他部门信息
            return departments;
        }
        return List.of(); // 返回不可变空列表
    }
}

Java编程最佳实践与注意事项

在进行类型转换和代码重构时，除了功能上的正确性，还应关注以下几点最佳实践，以提升代码质量和可维护性：

1. 返回不可变列表： 当一个方法返回List时，如果调用者不应修改此列表的内容，那么返回一个不可变列表是最佳实践。这可以防止意外的副作用和并发问题。

   • List.of() (Java 9+)： 最简洁的方式，用于创建小的、固定的不可变列表。
   • Collections.unmodifiableList()： 如果你有一个现有的可变列表，并希望提供一个不可变的视图给外部，可以使用此方法。

     List mutableList = new ArrayList<>();
     // ... 添加元素到 mutableList
     return Collections.unmodifiableList(mutableList);

     在上面的delete方法中，我们使用了List.of()来返回空列表，这确保了返回的空列表是不可变的。

2. 命名规范： Java有明确的命名约定，遵循这些约定可以使代码更易读、更专业。

   • 变量和方法名： 使用camelCase（驼峰命名法），首字母小写。例如：departmentId优于department_ID。
   • 常量： 通常使用全大写和下划线分隔。 在示例代码中，我们将department_ID改为了departmentId。

3. 方法返回类型语义：delete方法返回List的语义需要仔细考量。

   • 常见做法： delete操作通常返回void（不返回任何值）、boolean（表示删除是否成功）或int（表示受影响的行数）。
   • 返回被删除实体： 如果业务需求确实需要返回被删除的实体列表，那么当前实现需要确保返回的是实际被删除的实体（例如，在删除操作成功后，再次查询以获取被删除的实体，而不是返回删除前的快照）。否则，返回删除前的existingDepartments可能会引起误解。 在示例中，我们暂时保留了返回List，但添加了注释提醒对其语义的评估。

4. 使用文本块（Text Blocks）： 对于多行字符串，特别是像SQL查询这样的场景，Java 15引入的文本块（Text Blocks）可以显著提升代码的可读性，避免了繁琐的字符串拼接和转义字符。

   String sql = """
       DELETE employee.*, department.*
       FROM employee, department
       WHERE employee.department_ID = :departmentId AND department.department_ID = :departmentId;
       """;

   这比传统的字符串拼接或单行字符串更清晰。

总结

从Optional到List的类型转换是Java开发中常见的重构场景。核心在于理解两种类型处理“无值”和“有值”的机制差异：Optional.empty()对应List.of()或new LinkedList<>()，而Optional.isPresent()则对应!list.isEmpty()。

在进行此类转换时，除了功能上的正确性，还应积极采纳Java的编程最佳实践，包括：优先返回不可变列表以增强代码安全性、遵循标准的命名规范以提高可读性、以及审慎评估方法返回类型的语义以确保其与业务逻辑一致。通过这些实践，我们能够构建出更健壮、更易于维护和理解的Java应用程序。

以上就是《Optional转List：空值处理与内容验证技巧》的详细内容，更多关于的资料请关注golang学习网公众号！