编写可重用 Java 函数的通用原则和准则

可重用 java 函数的原则和准则包括：单一职责原则：每个函数只负责一项明确的任务。dry 原则：避免重复类似的逻辑，并将共享逻辑提取到单独的函数或类别中。高内聚，低耦合：分组相关代码组件，降低依赖性。接口与抽象类：定义函数的公共契约，不需要具体实现。使用 javadoc 注释函数的输入、输出、异常和用途。

编写可重用 Java 函数的原则和准则

编写可重用的代码是 Java 开发中的关键实践可以提高代码的可维护性、可读性和可扩展性。本文将讨论编写可重用性 Java 函数的一般原则和标准，并提供实际案例来演示这些原则的应用。

单一职责原则

每个函数都应该只执行一个明确定义的任务。这有助于降低耦合度，使函数更容易理解和测试。

示例：

立即学习"Java免费学习笔记(深入)；

public String formatPhoneNumber(String phoneNumber) {
  // 标准化的电话号码，移除所有特殊字符
  String normalizedPhoneNumber = phoneNumber.replaceAll("[^0-9]", "");
  // 根据给定的格式格式化电话号码
  return String.format("(%s) %s-%s", normalizedPhoneNumber.substring(0, 3), normalizedPhoneNumber.substring(3, 6), normalizedPhoneNumber.substring(6));
}

DRY 原则(不要重复自己)

避免在代码中重复相同或相似的逻辑。将共享逻辑提取到单个函数或类别中。

示例：

立即学习“Java免费学习笔记(深入)；

// 验证电子邮件地址的逻辑提取在多个函数中使用
public boolean isValidEmailAddress(String emailAddress) {
  return emailAddress.matches("^[\\w-_.+]*@[\\w-_.+]*\\.[\\w-_.+]*$");
}

高内聚，低耦合

将相关代码组件组合到模块或子系统中，以减少相互依赖性。这使得函数更容易理解、更改和维护。

示例：

立即学习“Java免费学习笔记(深入)；

// 将与用户验证相关的函数分组到模块中
public class UserValidationModule {

  public static boolean isValidUsername(String username) {
    // 验证用户名是否有效
  }

  public static boolean isValidPassword(String password) {
    // 验证密码是否有效
  }
}

接口和抽象类

公共合同使用接口和抽象定义函数，而无需指定具体实现。这使得您可以在不破坏现有客户的情况下进行交换。

示例：

立即学习“Java免费学习笔记(深入)；

// 定义界面来表示排序算法
public interface SortingAlgorithm {
  int[] sort(int[] numbers);
}

// 提供具体实现的具体类别
public class BubbleSort implements SortingAlgorithm {
  @Override
  public int[] sort(int[] numbers) {
    // 冒泡排序算法的实现
  }
}

使用 JavaDoc

使用 JavaDoc 注释记录函数的输入、输出、异常和用途。这使得开发人员更容易理解和使用图书馆或第三方代码。

示例：

立即学习“Java免费学习笔记(深入)；

/**
 * 格式化电话号码
 *
 * @param phoneNumber 电话号码
 * @return 电话号码格式化
 */
public String formatPhoneNumber(String phoneNumber) {
  // ...
}

实战案例

使用上述原则和准则，让我们考虑一个可重用函数的实际案例，将数字列表转换为字符串列表：

import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;

public class NumberToStringConverter {

  public static List<String> convertNumbersToStrings(List<Integer> numbers) {
    return numbers.stream()
        .map(Object::toString)
        .collect(Collectors.toList());
  }
}

该函数遵循单一职责原则，因为它只负责将数字列表转换为字符串列表。它还避免了重复的代码，因为它使用了它 Java 8 的流 API 执行转换。该函数具有较高的内聚度，与任何特定集合的实现无关 JavaDoc 记录良好。

以上是可重用的写作 Java 请多关注图灵教育的其他相关文章，了解函数的一般原则和准则！