Java Function Refactoring Guidelines and Best Practices

This article presents a comprehensive set of coding rules and refactoring techniques for Java functions, aimed at improving code quality, maintainability, and readability in software projects.

1. Introduction

As software projects grow, maintenance costs increase. Continuously optimizing code and adhering to principles such as "Less coding, more thinking" can produce more elegant, high‑quality, and efficient code.

2. Use of Common Utility Functions

Examples demonstrate replacing verbose null‑checks and equality checks with concise utility calls such as Objects.equals(name, thisName) or Objects.nonNull(passThreshold). The recommended approach is to use Objects.equals or Objects.nonNull directly, reducing boilerplate.

3. Splitting Large Functions

Functions exceeding 80 lines should be split into smaller, purpose‑specific methods. Each code block should have a clear comment and be extracted into its own method (e.g., eat(), code(), sleep()). This improves readability and aligns the function’s hierarchy with its logical steps.

4. Consistent Code Block Levels

Within a function, code blocks should be at the same hierarchical level. For example, in a daily routine function, the high‑level actions (eat, code, sleep) should be represented as top‑level calls, while detailed implementations reside in separate private methods.

5. Encapsulating Repeated Logic

Repeated logic such as disabling users or handling order status should be extracted into shared helper methods (e.g., disableUser(Long userId), auditOrder(Long orderId, OrderStatus status)) to avoid duplication.

6. Encapsulating Parameter Retrieval

Separate functions for obtaining configuration values (e.g., getPassThreshold()) keep business logic clean and reusable.

7. Parameterizing Interfaces

Common patterns like sending settlement data can be abstracted with a generic method that accepts a data‑type enum and a provider functional interface, eliminating duplicated loops.

8. Reducing Function Code Levels

Use early return statements to exit functions promptly and continue to skip irrelevant loop iterations, thereby keeping nesting shallow.

9. Encapsulating Conditional Expressions

Complex conditions (e.g., discount date checks) should be moved to dedicated boolean methods ( isDiscountDate(Date)) to improve readability and reuse.

10. Avoiding Unnecessary Null Checks

When the caller guarantees non‑null arguments, the callee can omit redundant null checks. Similarly, MyBatis query methods return non‑null collections, allowing removal of defensive null checks.

Benefits

Shorter, clearer functions with single responsibilities.

Reduced code duplication and lower maintenance overhead.

Improved readability, making it easier for developers to understand and modify code.

Enhanced performance by eliminating dead‑code and unnecessary null checks.