Java 函数通用原则解析

雨浩大大_2208

雨浩大大_2208

2024-09-03

751人浏览

原创

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

Java 函数通用原则解析

Java 函数通用原则解析

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

原则 1:单一职责

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

代码示例:

// 违反单一职责原则
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:参数和返回值

Java注释规范Skills
Java注释规范Skills

当用户要求为 Java 代码添加注释、修改注释、审查注释、整理注释格式,或要求按照代码注释规范处理 Java 文件时,使用本技能。本技能用于统一生成和维护 Java 类注释模板、按 Git 对比 release 判断版本号、补充每行代码上方中文块注释、调整注释空行规则,并保持 Java 文件 UTF-8 无 BOM 编码。典型触发场景包括:补充类注释、更新 @version、检查 @author 来源、整理行尾注释、把注释放到代码上一行、检查注释是否符合规范、构建前检查 Java 注释风格。

下载

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

代码示例:

// 传递原始值类型作为参数
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));
}

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
软件测试常用工具
软件测试常用工具

软件测试常用工具有Selenium、JUnit、Appium、JMeter、LoadRunner、Postman、TestNG、LoadUI、SoapUI、Cucumber和Robot Framework等等。测试人员可以根据具体的测试需求和技术栈选择适合的工具,提高测试效率和准确性 。

2023.10.13

4890

8

java测试工具有哪些
java测试工具有哪些

java测试工具有JUnit、TestNG、Mockito、Selenium、Apache JMeter和Cucumber。php还给大家带来了java有关的教程,欢迎大家前来学习阅读,希望对大家能有所帮助。

2023.10.23

3281

10

Java 单元测试
Java 单元测试

本专题聚焦 Java 在软件测试与持续集成流程中的实战应用,系统讲解 JUnit 单元测试框架、Mock 数据、集成测试、代码覆盖率分析、Maven 测试配置、CI/CD 流水线搭建(Jenkins、GitHub Actions)等关键内容。通过实战案例(如企业级项目自动化测试、持续交付流程搭建),帮助学习者掌握 Java 项目质量保障与自动化交付的完整体系。

2025.10.24

1146

26

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

2026.10.28

40

16

Vite 如何搭配 Vue.js
Vite 如何搭配 Vue.js

Vite搭配Vue.js专题汇集创建Vue 3项目、配置开发环境、路径别名、Vue插件、代理、多环境构建与调试的已审核文章,帮助读者完成从初始化到日常开发的配置。

2026.10.28

20

15

Vite 项目目录怎么看
Vite 项目目录怎么看

Vite项目目录专题汇集入口文件、src源码、public静态资源、路径别名、项目根目录和构建输出目录相关的已审核文章,帮助读者理解各文件夹的用途与引用方式。

2026.10.28

0

10

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

2026.10.22

120

11

Gradle Wrapper配置教程
Gradle Wrapper配置教程

本专题介绍Gradle Wrapper的基本作用,涵盖文件组成、生成方法、版本配置和任务调用,帮助你理解项目如何使用指定的Gradle版本,减少不同开发环境带来的构建差异。

2026.10.22

80

10

Golangci-lint检查器使用教程
Golangci-lint检查器使用教程

本专题整理Golangci-lint常用Linters的用途与配置方法,覆盖错误处理、无效代码、安全、复杂度、命名和依赖检查,帮助项目合理选规则。

2026.10.22

60

15

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Gradle Kotlin DSL API 参考
Gradle Kotlin DSL API 参考

共0课时 | 0人学习

LLVM 语言参考手册
LLVM 语言参考手册

共0课时 | 0人学习