Java 开发规范

// 正例
StringBuilder sb = new StringBuilder()
    .append("first")
    .append("second");

// 反例：参数过多不换行
methodWithTooManyParams(param1, param2, param3, param4, param5);

/**
 * 用户服务类
 * @author Name
 * @date 2023-08-15
 * @version 1.0
 */
public class UserService {
    // ...
}

/**
 * 获取用户详细信息
 * @param userId 用户ID（必须大于0）
 * @return 用户实体对象，找不到时返回null
 * @throws IllegalArgumentException 参数不合法时抛出
 */
public User getUserById(long userId) {
    // ...
}

// 正例：记录完整异常信息
try {
    // ...
} catch (IOException e) {
    log.error("文件读取失败，文件路径：{}", filePath, e);
    throw new BizException("文件处理失败");
}

// 反例：吞掉异常
try {
    // ...
} catch (Exception e) {
    // 无处理
}

// 正例：使用占位符
log.info("用户[{}]登录成功，IP地址：[{}]", userId, ipAddress);

// 反例：字符串拼接
log.info("用户" + userId + "登录成功");