入职后初次写代码该注意什么

一、务必在正确的 Git 分支上开发#

开始编码前，第一件事是确认你所在的分支。

切勿直接在默认主分支（如 main/master）上修改代码。

要问清楚：该在什么分支开发、是否需要新建分支、如果需要新建分支基于哪个分支新建。 如果不确认就写代码，后面可能要返工甚至造成代码冲突。

二、务必确保需求已经理解清楚#

在动手写任何代码之前，确保你对需求的理解与产品、测试、导师的理解完全一致。

具体做法：

• 主动沟通不清楚的点：对模糊不清的需求点，立即提问。使用”确认一下…”的口吻，来复述你的理解，确认你的理解是没有问题的。
• 输出技术方案（可选但推荐）：对于稍复杂的功能，在编码前用简短的文档或注释梳理核心逻辑、关键数据结构、接口设计及潜在风险点。这能极大地减少返工，并培养你的设计思维。

不要没搞清楚需求就开始写代码，这样很容易返工。

三、边写边测，不要一次性写完再去测试#

如果一项功能需要开发 10 个接口，切忌全部写完再统一测试。

每完成一个接口，就立即进行自测（使用 Postman、Swagger 或单元测试）。这样可以把问题提前暴露出来，避免把问题带到后面的接口开发中。

一次性写完再测，如果出了问题，排查起来会非常痛苦。

四、推荐采用”自上而下”的编写顺序#

建议从**接口层（Controller）开始写，明确接口的入参、出参。再到业务层（Service）编写逻辑，此时仅定义你真正需要的实体类和 DAO 方法。最后才到数据层（Mapper/DAO）**实现具体数据库操作。

这种方式能有效避免提前过度设计，确保每一行代码都服务于明确的业务需求。

如果从 DAO 层开始写，可能会定义很多没有用的方法和实体类，浪费过多的时间。

五、合理使用 AI，让它成为你的”副驾驶”而非”代驾”#

对于刚入行的同学，在使用 AI 辅助编程时，需注意方法，避免过度依赖。

不要将完整的需求描述直接丢给 AI 并期望它生成最终代码，这容易导致生成的代码结构混乱、不符合业务上下文，且后期调试和修改会异常困难。

建议采用”分段提问，主动把控”的策略：

• 分解任务：先将复杂功能拆解成清晰的步骤和子问题，再针对具体环节（如”如何实现某个查询”、“这个异常该怎么处理”）进行提问。
• 理解而非照搬：对 AI 给出的代码，务必逐行理解其逻辑和意图，确保你知其所以然。
• 手动验证与调试：AI 生成的代码可能存在边界错误或性能隐患，关键部分一定要亲自测试、调试，并将其融入你整体的代码框架中。

**AI 是强大的辅助工具，而非替代你思考的”代驾”。**合理使用能提升效率，过度依赖则会阻碍你真正理解业务、积累解决问题的能力。保持主动思考，让 AI 为你的思路服务，而不是被它的输出牵着走。

六、编码常犯问题#

以下列出入职新人最常犯的几个编码问题，一定要注意避免。

1
// 7 和 "SUCCESS" 是什么，可读性和可维护性都比较差
2
if (order.getStatus() == 7) {
3
    return "SUCCESS";
4
}

1
// 定义枚举
2
public enum OrderStatus {
3
    COMPLETED(7, "已完成");
4
    // ...
5
}
6
if (order.getStatus() == OrderStatus.COMPLETED.getCode()) {
7
    return ResultEnum.SUCCESS.getMessage();
8
}

1
@Transactional
2
public void updateOrder(Order order) {
3
    try {
4
        orderMapper.update(order);     // 数据库操作1
5
        accountService.deductBalance(order.getAmount()); // 数据库操作2，可能抛异常
6
    } catch (Exception e) {
7
        log.error("更新失败", e);
8
        // 异常被捕获，事务标记为成功，即使扣款失败，订单状态也已被更新！
9
    }
10
}

1
public class OrderService {
2
    public OrderDTO getOrderDetail(Long orderId) {
3
        // 直接调用，查询结果可能为 null
4
        Order order = orderRepository.findById(orderId);
5

6
        // 直接转换，可能 NPE
7
        OrderDTO dto = convertToDTO(order);
8

9
        return dto; // 如果 order 为 null，convertToDTO 内部可能 NPE
10
    }
11

12
    private OrderDTO convertToDTO(Order order) {
13
        OrderDTO dto = new OrderDTO();
14
        dto.setOrderId(order.getId()); // 如果 order 为 null，这里 NPE
15
        dto.setAmount(order.getTotalAmount());
16
        dto.setItems(order.getItems().stream() // 如果 getItems() 返回 null，这里 NPE
17
                .map(this::convertItem)
18
                .collect(Collectors.toList()));
19
        return dto;
20
    }
21
}

1
// 遍历时删除元素会抛出异常
2
List<String> list = new ArrayList<>(Arrays.asList("A", "B", "C"));
3
for (String item : list) {
4
    if ("B".equals(item)) {
5
        list.remove(item); // 抛出 ConcurrentModificationException!
6
    }
7
}

1
Iterator<String> iterator = list.iterator();
2
while (iterator.hasNext()) {
3
    String item = iterator.next();
4
    if ("B".equals(item)) {
5
        iterator.remove(); // 安全删除
6
    }
7
}