代码质量：写优雅的代码，而不是“临时工”作品

最新推荐文章于 2024-10-12 22:35:37 发布

你可以自己看

最新推荐文章于 2024-10-12 22:35:37 发布

阅读量389

点赞数 5

分类专栏： Java 文章标签： java 开发语言

本文链接：https://blog.csdn.net/weixin_47260194/article/details/142107604

版权

Java 专栏收录该内容

5 篇文章 1 订阅

订阅专栏

写优雅的代码而非“临时工”作品是每一个有经验的Java工程师都应该追求的目标。这不仅是为了提升代码的可读性、可维护性，还能减少未来可能遇到的Bug和技术债务。下面我将从代码质量的几个核心方面入手，详细阐述如何编写优雅的代码，避免“临时工”心态。

1. 代码的可读性

优雅的代码首先应该是可读的。代码不仅仅是写给机器的，更是写给人看的——包括你未来的自己和其他开发者。我们常说“代码即文档”，代码的自解释性至关重要。

1.1 命名

变量、方法、类的命名是代码可读性的第一步。好的命名应该清晰表达其含义，不需注释就能明白其用途：

类命名：应以名词或名词短语命名，反映类的职责。比如UserService表示处理用户相关的服务逻辑。
方法命名：使用动词或动词短语命名，表明动作或行为。比如calculateTotalPrice()或fetchUserById()清晰表明方法的意图。
变量命名：避免使用过于简短的名称，如a、b等，应根据上下文提供有意义的名字，如totalAmount或userList。

1.2 简洁和清晰

编写简洁而不冗长的代码，避免不必要的复杂性。不要过度优化或使用过于复杂的设计模式，优先选择最简单可行的解决方案。简洁不等于短小，而是指在功能清晰的前提下，去掉不必要的装饰或复杂逻辑。

示例：

// 糟糕的写法
if (flag == true) {
    return true;
}

// 优雅的写法
if (flag) {
    return true;
}

2. 保持代码的单一职责

每个类、方法、模块都应该只负责一件事，这就是单一职责原则 (SRP)。过多的职责会导致类变得臃肿，难以维护。

2.1 方法和类的职责划分

方法的长度：通常方法的行数不要过长，保持一个方法只做一件事。若方法过长，可以考虑拆分成多个子方法，确保每个方法只关注某个具体任务。
类的职责：如果一个类承担了过多职责，它会变得难以维护和测试。你可以将不同的功能拆分为多个类，通过依赖注入（如使用Spring的@Autowired）来协同工作。

示例：

// 糟糕的写法：User类既包含用户属性，又负责持久化逻辑
public class User {
    private String name;
    private String email;

    public void saveToDatabase() {
        // 数据库操作代码
    }
}

// 优雅的写法：分离用户模型和持久化逻辑
public class User {
    private String name;
    private String email;
}

public class UserRepository {
    public void save(User user) {
        // 数据库操作代码
    }
}

3. 代码的可维护性

可维护性是指代码在未来能够轻松修改、扩展或修复的能力。为了达到这一点，我们需要考虑设计模式和避免硬编码等原则。

3.1 遵循SOLID原则

SOLID是一组五个面向对象设计原则，遵循这些原则可以极大提高代码的可维护性：

单一职责原则 (SRP)：一个类应当只有一个引起它变化的原因。
开放封闭原则 (OCP)：软件实体应该对扩展开放，对修改关闭。
里氏替换原则 (LSP)：子类对象应当可以替换其父类对象。
接口隔离原则 (ISP)：客户端不应强迫依赖它不需要的接口。
依赖倒置原则 (DIP)：高层模块不应该依赖低层模块，二者都应依赖于抽象。

3.2 避免硬编码

硬编码是导致代码难以维护的主要原因之一。应尽量将可变的信息（如配置、常量）抽离到配置文件或常量类中，避免将逻辑写死在代码中。

示例：

// 糟糕的写法：硬编码
public class ApiService {
    public String getBaseUrl() {
        return "https://api.example.com";  // 硬编码的URL
    }
}

// 优雅的写法：使用配置文件
@Configuration
public class AppConfig {
    @Value("${api.base.url}")
    private String baseUrl;
    
    public String getBaseUrl() {
        return baseUrl;
    }
}

4. 写可测试的代码

优雅的代码不仅仅是为了自己写的代码更好看，更重要的是它可以通过单元测试和集成测试来验证功能。为了实现这一点，代码应该是可测试的，意味着类和方法不应该与外部系统（如数据库、网络请求）紧耦合。

4.1 依赖注入和Mocking

通过依赖注入，你可以将外部依赖（如数据库连接、外部API调用）抽象成接口并注入到类中，使得测试时可以轻松地Mock这些依赖，从而测试逻辑。

示例：

// 糟糕的写法：无法轻松测试
public class UserService {
    private UserRepository userRepository = new UserRepository();  // 强依赖
    
    public User getUserById(String id) {
        return userRepository.findById(id);
    }
}

// 优雅的写法：通过依赖注入实现松耦合
public class UserService {
    private UserRepository userRepository;
    
    public UserService(UserRepository userRepository) {
        this.userRepository = userRepository;
    }
    
    public User getUserById(String id) {
        return userRepository.findById(id);
    }
}

// 测试时可以轻松Mock依赖
UserRepository mockRepository = mock(UserRepository.class);
UserService userService = new UserService(mockRepository);

5. 代码的一致性和约定

一致性是代码整洁和可维护的关键之一。你和团队应该遵循统一的编码风格和约定，这不仅让代码看起来整齐，也能够降低阅读、理解和维护的难度。

使用统一的代码格式：例如一致的缩进、括号的摆放位置等。
注释清晰且简洁：不应该用过多的注释解释代码做了什么，而是注释为什么这么做。

6. 减少重复代码 (DRY原则)

“不要重复你自己” (Don’t Repeat Yourself) 是编写优雅代码的重要原则。重复的代码增加了维护的复杂度，并且增加了Bug的风险。

示例：

// 糟糕的写法：重复代码
public class UserService {
    public User getUserById(String id) {
        User user = userRepository.findById(id);
        if (user == null) {
            throw new UserNotFoundException();
        }
        return user;
    }
    
    public User getUserByEmail(String email) {
        User user = userRepository.findByEmail(email);
        if (user == null) {
            throw new UserNotFoundException();
        }
        return user;
    }
}

// 优雅的写法：消除重复
public class UserService {
    private User getUser(Supplier<User> supplier) {
        User user = supplier.get();
        if (user == null) {
            throw new UserNotFoundException();
        }
        return user;
    }
    
    public User getUserById(String id) {
        return getUser(() -> userRepository.findById(id));
    }
    
    public User getUserByEmail(String email) {
        return getUser(() -> userRepository.findByEmail(email));
    }
}