# Java 开发 - 阿里巴巴编码指南 ## 概述该技能基于阿里巴巴Java编码指南（松山版）提供全面的Java开发指导。它确保所有 Java 代码遵循行业最佳实践，涵盖命名约定、编码标准、并发性、异常处理、数据库设计、安全性、测试和架构设计。 ## 核心原则编写 Java 代码时，请始终遵循以下基本原则： 1. **代码可读性**：编写易于理解和维护的代码 2. **一致性**：遵循一致的命名和格式约定 3. **安全第一**：防止NPE、SQL注入和并发问题等常见陷阱 4. **性能意识**：考虑设计决策的性能影响 5. **测试覆盖率**：确保关键代码有足够的单元测试覆盖率 ## 快速参考 ### 命名约定 * **类** ：大驼峰式命名（例如，`UserService`、`OrderController`） * **方法/变量**：小驼峰命名法（例如，`getUserById`、`userName`） * **常量**：UPPER_SNAKE_CASE（例如，`MAX_COUNT`、`DEFAULT_SIZE`） * **包** ：小写、单个单词优先（例如，`com.company.module`） ### 常见模式 * 抽象类：`Abstract*` 或 `Base*` 前缀 * 异常类：`*Exception`后缀 * 测试类：`*Test`后缀 * 服务实现：`*Impl`后缀 * 布尔变量：POJO 类中没有 `is` 前缀 * DAO 方法：`get*`（单个）、`list*`（多个）、`count*`、`save*`、`remove*`、`update*` ### 关键规则 * ❌ 切勿在代码中直接使用幻数 * ❌永远不要捕获异常而不对其进行处理 * ❌ 切勿使用 `==` 来比较包装类型（使用 `equals()`） * ❌永远不要直接创建线程（使用线程池） * ❌ 切勿在 SQL 查询中使用 `SELECT *` * ✅ 始终使用参数化查询来防止 SQL 注入 * ✅ 当大小已知时，始终指定集合的初始容量 * ✅ 始终关闭“finally”块中的资源或使用 try-with-resources * ✅ 始终验证外部输入 ## 工作流程 ### 1\.编写代码之前 **查看详细指南：** * 命名规则 → 请参阅 [naming-conventions.md]() * 编码标准 → 请参阅 [coding-standards.md]() * 对于并发 → 请参阅 [concurrency.md]() * 数据库设计 → 参见[database.md]() * 为了安全 → 请参阅 [security.md]() * 用于测试 → 请参阅 [testing.md]() * 设计模式 → 请参阅 [design.md]() ### 2\.编写代码在编写时应用以下检查： **命名** * 类名使用大驼峰命名法 * 方法/变量名称使用小驼峰命名法 * 常量使用 UPPER_SNAKE_CASE * 有意义的英文名字（无拼音） **代码结构** * 80行以下的方法 * 每个类/方法的单一职责 * 适当的访问修饰符（默认为私有） * 使用`@Override`来覆盖方法 **需要避免的常见陷阱** // ❌ 错误：幻数 if (状态 == 1) { ... } // ✅ 正确：命名常量私有静态最终 int STATUS_ACTIVE = 1; 如果（状态== STATUS_ACTIVE）{...} // ❌ 错误：将包装类型与 == 进行比较整数a = 128；整数 b = 128； if (a == b) { ... } // 可能会失败！ // ✅ 正确：使用 equals() if (a.equals(b)) { ... } // ❌ 错误：catch 块为空尝试{ 做某事（）； } catch (异常 e) { // 无声失败 } // ✅ 正确：处理或重新抛出尝试{ 做某事（）； } catch (异常 e) { logger.error("未能执行某操作", e); throw new BusinessException("操作失败", e); } // ❌错误：直接创建线程新线程(() -> doWork()).start(); // ✅ 正确：使用线程池 ExecutorService 执行器 = new ThreadPoolExecutor( corePoolSize、maxPoolSize、keepAliveTime、 TimeUnit.SECONDS, new LinkedBlockingQueue<>(), new ThreadFactoryBuilder().setNameFormat("worker-%d").build() ）；执行器.submit(() -> doWork()); ### 3\.数据库操作 **桌子设计** * 表名：小写并带下划线（例如，`user_order`） * 必填字段：`id`、`create_time`、`update_time` * 布尔字段：`is_*` 前缀（例如，`is_deleted`） * 对 ID 使用“BIGINT UNSIGNED” * 使用“DECIMAL”表示货币值（切勿使用“FLOAT”或“DOUBLE”） **SQL 最佳实践** // ✅ 正确：参数化查询 String sql = "从用户中选择 id、用户名、电子邮件，其中 id = ?"; 准备语句 ps = conn.prepareStatement(sql); ps.setLong(1, userId); // ✅ 正确：MyBatis 参数绑定 @Select("SELECT * FROM user WHERE user_name = #{userName}") 用户 selectByUserName(@Param("userName") String userName); // ❌ 错误：字符串连接（SQL 注入风险！） String sql = "SELECT * FROM user WHERE user_name = '" + userName + "'"; ### 4\.异常处理 **异常层次结构** * 使用特定的异常类型 * 检查可恢复错误的异常 * 未经检查的编程错误异常 * 始终在异常消息中包含上下文 // ✅ 正确的异常处理公共用户 getUserById(长用户ID) { if (userId == null) { throw new IllegalArgumentException("userId 不能为 null"); } 用户 user = userDao.selectById(userId); 如果（用户==空）{ throw new NotFoundException("未找到用户：" + userId); } 返回用户； } // ✅ 正确记录异常尝试{ 处理订单（订单）； } catch (异常 e) { logger.error("订单处理失败，orderId: {}", order.getId(), e); throw new BusinessException("订单处理失败", e); } ### 5\.并发性 **线程安全规则** * 使用`ThreadPoolExecutor`代替`Executors` * 为调试线程命名 * 使用 `volatile` 来实现可见性，使用 `AtomicXxx` 来实现原子操作 * 在多线程代码中避免使用`SimpleDateFormat`（使用`DateTimeFormatter`） * 清理`ThreadLocal`变量 // ✅ 正确：具有正确配置的线程池 ThreadPoolExecutor 执行器 = new ThreadPoolExecutor( 10, // 核心池大小 20, // 最大池大小 60L, // 保持活动时间时间单位.秒, 新的 LinkedBlockingQueue<>(100), new ThreadFactoryBuilder().setNameFormat("订单处理器-%d").build(), 新的 ThreadPoolExecutor.CallerRunsPolicy() ）； // ✅ 正确：ThreadLocal 清理私有静态最终ThreadLocal<用户> USER_CONTEXT = new ThreadLocal<>(); 公共无效processRequest（）{ 尝试{ USER_CONTEXT.set(getCurrentUser()); // 处理请求 }最后{ USER_CONTEXT.remove(); // 关键：防止内存泄漏 } } ### 6\.安全 **输入验证** * 验证所有外部输入 * 使用参数化查询（不要字符串连接） * 清理 HTML 输出以防止 XSS * 实现CSRF保护 * 屏蔽日志中的敏感数据 // ✅ 正确：输入验证公共无效createUser（UserCreateRequest请求）{ if (StringUtils.isBlank(request.getUserName())) { throw new ValidationException("用户名不能为空"); } if (!ValidationUtils.isValidMobile(request.getMobile())) { throw new ValidationException("手机号格式不正确"); } // 处理... } // ✅ 正确：敏感数据屏蔽 logger.info("用户登录，手机：{}", maskMobile(user.getMobile())); ### 7\.单元测试 **测试标准** * 测试类命名：`*Test` * 测试方法命名：`test*` * 目标覆盖率：至少 70% 的语句覆盖率 * 使用 JUnit 5 + Mockito * 遵循BCDE原则（边界、正确、设计、错误） @ExtendWith(MockitoExtension.class) 公共类 UserServiceTest { @模拟私有 UserDao userDao； @InjectMocks 私有 UserService 用户服务； @测试 @DisplayName("根据ID获取用户-正常情况") 公共无效testGetUserById_Success（）{ // 给定长用户ID=1L；用户模拟用户=新用户（）； mockUser.setId(userId); mockUser.setUserName(“测试”); when(userDao.selectById(userId)).thenReturn(mockUser); // 当用户结果 = userService.getUserById(userId); // 然后断言NotNull（结果）； assertEquals(userId, result.getId()); verify(userDao, times(1)).selectById(userId); } @测试 @DisplayName("根据ID获取用户-参数为null") 公共无效testGetUserById_NullParameter（）{ assertThrows(IllegalArgumentException.class, () -> { userService.getUserById(null); }); } } ## 代码审查清单检查 Java 代码时，请验证： ### 命名和风格 * 类名使用大驼峰命名法 * 方法/变量名称使用小驼峰命名法 * 常量使用 UPPER_SNAKE_CASE * 代码中没有魔法数字 * 有意义的英文名字（无拼音） ### 代码质量 * 80行以下的方法 * 遵循单一责任原则 * 使用正确的访问修饰符 * 没有重复的代码 * 正确的异常处理 ### 安全 * 无 NPE 风险（需要时进行空检查） * 包装类型与 `equals()` 相比，而不是与 `==` * 资源正确关闭（try-with-resources 或finally） * 如果在并发上下文中使用，则线程安全 * 外部数据的输入验证 ### 数据库 * 参数化查询（无SQL注入风险） * 选择特定列（无“SELECT *”） * 定义适当的索引 * 交易边界正确 ### 性能 * 集合初始容量在大小已知时指定 * 字符串连接在循环中使用“StringBuilder” * 选择适当的数据结构 * 循环中不会创建不必要的对象 ### 测试 * 新代码存在单元测试 * 涵盖边缘情况 * 测试异常情况 * 正确模拟依赖关系 ## 参考文档有关特定主题的详细指南，请参阅以下参考文档： ### [naming-conventions.md]() 类、方法、变量、包和域模型的完整命名规则。 ### [coding-standards.md]() 详细的编码标准，包括常量、格式、OOP 规则、日期/时间处理、集合和控制语句。 ### [concurrency.md]() 全面的并发指南，涵盖线程池、锁、易失性、并发集合和常见模式。 ### [异常日志记录.md]() 使用 SLF4J 的异常处理最佳实践和日志记录标准。 ### [database.md]() MySQL 数据库设计规则、索引策略、SQL 优化和 ORM 映射约定。 ### [security.md]() 安全指南涵盖输入验证、SQL 注入防护、XSS 保护、CSRF 防御、加密和敏感数据处理。 ### [testing.md]() 单元测试标准、框架（JUnit 5、Mockito）、覆盖率要求和测试模式。 ### [design.md]() 设计原则、分层架构、领域模型、设计模式和 API 设计约定。 ## 常见场景 ### 场景 1：创建新服务类 1. 阅读 [naming-conventions.md]() 了解服务命名规则 2. 阅读 [coding-standards.md]() 了解类结构 3. 阅读 [exception-logging.md]() 进行错误处理 4. 按照上面所示的模式实施 5. 在 [testing.md]() 之后添加单元测试 ### 场景2：数据库表设计 1. 阅读[database.md]()了解表设计规则 2. 确保必填字段：`id`、`create_time`、`update_time` 3. 使用正确的数据类型（DECIMAL 代表货币，BIGINT 代表 ID） 4.添加适当的索引 5. 按照命名约定创建相应的DO类 ### 场景 3：实现并发处理 1. 阅读 [concurrency.md]() 进行线程池配置 2. 使用带有适当参数的`ThreadPoolExecutor` 3. 为调试命名线程 4. 处理工作线程中的异常 5. 清理ThreadLocal变量 ### 场景 4：安全审查 1. 阅读 [security.md]() 了解安全检查表 2. 验证输入验证是否存在 3.检查SQL注入漏洞 4. 确保敏感数据在日志中被屏蔽 5. 验证身份验证和授权 ## 与开发工作流程集成这项技能可以无缝集成到您的开发过程中： 1. **开发期间**：根据需要参考上面的快速规则和详细指南 2. **代码审查**：使用检查表确保合规性 3. **重构**：应用指南来改进现有代码 4. **入职**：用作新团队成员的培训材料 ## 总结这项技能确保所有 Java 代码都遵守阿里巴巴的行业标准编码指南。始终优先考虑： * **可读性**胜过聪明 * **安全**胜于便利 * **可维护性**优于快速修复 * **标准**高于个人喜好如有疑问，请查阅详细的参考文档以获取具体指导。

Java开发

包含技能