Java开发规范

最新推荐文章于 2024-07-22 02:08:54 发布

Keep forward upup

最新推荐文章于 2024-07-22 02:08:54 发布

阅读量823

点赞数 11

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

本文链接：https://blog.csdn.net/weixin_45594172/article/details/140468496

版权

Java基础专栏收录该内容

54 篇文章 0 订阅

订阅专栏

Java开发规范有助于提高代码的可读性、可维护性和一致性。以下是一些常见的Java开发规范和最佳实践：

1. 代码风格

a. 缩进和格式

使用 4 个空格进行缩进，不使用制表符。
每行代码的长度不超过 120 个字符，尽量保持在 80 个字符以内。

b. 命名约定

类名：采用大驼峰命名法（PascalCase）。例：CustomerOrder。
方法名：采用小驼峰命名法（camelCase）。例：calculateTotalPrice。
变量名：采用小驼峰命名法（camelCase）。例：totalPrice。
常量名：全部大写，单词间用下划线分隔。例：MAX_CONNECTIONS。
包名：全部小写，单词间不使用分隔符。例：com.example.project。

2. 注释

a. 类和方法注释

使用 Javadoc 注释类和方法，简要描述它们的用途和功能。

/**
 * This class represents a customer order.
 */
public class CustomerOrder {
    
    /**
     * Calculates the total price of the order.
     * 
     * @param items the list of items in the order
     * @return the total price
     */
    public double calculateTotalPrice(List<Item> items) {
        // ...
    }
}

b. 行内注释

对复杂的逻辑和算法使用行内注释。

public double calculateTotalPrice(List<Item> items) {
    double total = 0.0;
    for (Item item : items) {
        // Multiply item price by quantity and add to total
        total += item.getPrice() * item.getQuantity();
    }
    return total;
}

3. 代码组织

a. 包结构

根据功能模块和层次结构组织包结构。常见的分层结构包括控制层（controller）、服务层（service）、数据访问层（repository/dao）等。

com.example.project
    ├── controller
    ├── service
    ├── repository
    ├── model
    └── util

b. 单一职责原则

每个类和方法应只负责一项职责。避免大而全的类和方法。

public class OrderService {
    
    public void createOrder(Order order) {
        // Create a new order
    }

    public void cancelOrder(Order order) {
        // Cancel an existing order
    }
}

4. 处理异常

a. 使用自定义异常

使用自定义异常类来描述特定的异常情况。

public class OrderNotFoundException extends RuntimeException {
    public OrderNotFoundException(String message) {
        super(message);
    }
}

b. 捕获和处理异常

在适当的地方捕获和处理异常，避免吞掉异常。

public void processOrder(Order order) {
    try {
        // Process the order
    } catch (OrderNotFoundException e) {
        // Handle the exception
        log.error("Order not found: " + order.getId(), e);
    }
}

5. 测试

a. 单元测试

编写单元测试来验证各个类和方法的功能。使用JUnit或TestNG等测试框架。

import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;

public class OrderServiceTest {

    @Test
    public void testCalculateTotalPrice() {
        OrderService orderService = new OrderService();
        List<Item> items = Arrays.asList(new Item("item1", 10, 2), new Item("item2", 5, 3));
        double totalPrice = orderService.calculateTotalPrice(items);
        assertEquals(35, totalPrice, 0.001);
    }
}

b. 集成测试

编写集成测试来验证各个模块之间的协作。可以使用Spring Boot Test等框架。

import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.beans.factory.annotation.Autowired;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;

@SpringBootTest
public class OrderControllerTest {

    @Autowired
    private OrderController orderController;

    @Test
    public void contextLoads() {
        assertThat(orderController).isNotNull();
    }
}

6. 代码审查

a. 同行评审

进行代码审查时，至少有一位开发人员审查代码，以确保代码质量和一致性。

b. 自动化工具

使用自动化代码分析工具（如 SonarQube）来检测代码中的潜在问题和坏味道。

7. 安全性

a. 输入验证

对所有用户输入进行验证，防止SQL注入、XSS攻击等安全漏洞。

public void setEmail(String email) {
    if (!email.matches("[^@]+@[^\\.]+\\..+")) {
        throw new IllegalArgumentException("Invalid email address");
    }
    this.email = email;
}