Java 函数通用原则解析

java 函数通用原则包括：单一职责，避免重复，仔细选择参数和返回值，处理异常，测试所有函数，可提高代码的可读性、可维护性和可测试性。

Java 函数通用原则解析

在 Java 中，函数（也称为方法）是代码的可重用单元，用于执行特定任务。遵循通用原则对于编写健壮且易于维护的函数至关重要。

原则 1：单一职责

立即学习“Java免费学习笔记（深入）”；

每个函数应只执行一项特定职责。避免在单个函数中执行多个 unrelated 操作。这有助于提高可读性、可测试性和可维护性。

代码示例：

MyBatis3.2.3帮助文档 中文CHM版

MyBatis 是支持普通 SQL 查询,存储过程和高级映射的优秀持久层框架。MyBatis 消除 了几乎所有的 JDBC 代码和参数的手工设置以及结果集的检索。MyBatis 使用简单的 XML 或注解用于配置和原始映射,将接口和 Java 的 POJOs(Plan Old Java Objects,普通的 Java 对象)映射成数据库中的记录。有需要的朋友可以下载看看

下载

// 违反单一职责原则
private void doEverything(int num) {
    System.out.println(num);
    System.out.println(num * num);
    return num + num;
}

// 遵循单一职责原则
private void printNumber(int num) {
    System.out.println(num);
}
private int squareNumber(int num) {
    return num * num;
}
private int addNumbers(int num) {
    return num + num;
}

原则 2：不要重复

避免在不同的函数中编写重复的代码。如果需要执行相同或类似的操作，请创建一个可重用的通用函数。

代码示例：

// 代码重复
private int foo(int a, int b) {
    if (a > b) {
        return a;
    } else {
        return b;
    }
}
private int bar(int a, int b) {
    if (a > b) {
        return a;
    } else {
        return b;
    }
}

// 使用通用函数
private int max(int a, int b) {
    if (a > b) {
        return a;
    } else {
        return b;
    }
}

原则 3：参数和返回值

精心选择函数的参数和返回值类型。避免使用原始值类型作为参数，而应使用对象。这有助于防止意外更改值，并提高可读性和可维护性。

代码示例：

// 传递原始值类型作为参数
public void setAge(int age) {
    this.age = age;
}

// 传递对象作为参数
public void setPerson(Person person) {
    this.person = person;
}

原则 4：异常处理

函数应明确处理可能发生的异常。不要从函数中传播异常，而应尝试处理它或传递给调用者。

代码示例：

public int divide(int a, int b) throws ArithmeticException {
    if (b == 0) {
        throw new ArithmeticException("Division by zero.");
    }
    return a / b;
}

原则 5： 测试

所有函数都应包含适当的测试以验证其正确性。使用单元测试框架（如 JUnit）来编写测试，以确保函数在各种输入下按预期工作。

实战案例：

// 一个计算两个数最大值的函数
public int findMax(int a, int b) {
    if (a > b) {
        return a;
    } else {
        return b;
    }
}

// 测试案例
@Test
public void testFindMax() {
    assertEquals(10, findMax(10, 5));
    assertEquals(100, findMax(100, 50));
    assertEquals(-10, findMax(-10, -20));
}