01.4.1.2 代码规范与 Code Review
所属:全栈开发面试题库 / 01 计算机基础与通用工程 / 01.4 工程素养 / 01.4.1 工程素养
01.4.1.2-001 代码规范覆盖哪些方面?
一句话结论
代码规范覆盖命名、格式缩进、文件与目录组织、注释文档、结构复杂度、错误处理、日志与依赖管理;规范由工具自动执行格式类约束,评审聚焦语义与设计类约束,降低人工争议。
概念解释
- 自动规范:缩进、换行、导入排序、格式由 lint/format 工具固定。
- 人工规范:命名意图、职责划分、抽象层次、边界处理。
- 目的:统一可读性,降低协作成本。
原理流程
- 团队约定规范并落地为工具配置。
- 提交前自动检查格式与静态问题。
- 评审补充语义与设计层面反馈。
代码或图示
工具管:格式 / 缩进 / 导入 / 静态规则
评审管:命名意图 / 职责 / 抽象 / 边界 / 设计
常见误区
- 规范全靠口头约定:无工具落地则执行不一致,争议多。
- 规范压制合理差异:风格项工具化,语义项保留讨论空间。
追问
- 团队规范不一致怎么办?答:以项目配置为准,历史代码逐步迁移,不要求一次性全改。
- 规范和框架惯例冲突?答:优先跟随框架生态惯例,项目配置补充差异点。
01.4.1.2-002 命名约定有哪些要点?
一句话结论
命名应见名知意,用名词/动词准确表达实体与行为,避免缩写歧义与匈牙利式类型前缀;类名名词、方法名动词、布尔值用肯定前缀,常量全大写,作用域与类型通过命名区分。
概念解释
- 类/对象:名词,表达职责。
- 方法:动词短语,表达动作。
- 布尔:
is/has/can等肯定形式,避免isNotXxx双重否定。
原理流程
- 确认标识符表达的概念。
- 选准确名词/动词,避免猜缩写。
- 按语言惯例大小写与复数形式。
代码或图示
// 好
OrderRepository orderRepository;
boolean isExpired();
int retryCount;
// 差
DataHelper2; doIt(); flag; mgr;
常见误区
- 用通用名(Manager/Helper/Utils)堆砌:职责仍不明确。
- 名称与实现不一致:改名要同步更新所有引用。
追问
- 变量名多长合适?答:作用域内概念清晰即可,短作用域可用短名,跨类概念用全名。
- 业务术语怎么统一?答:以领域术语表为准,避免同一概念多种叫法。
01.4.1.2-003 注释与文档规范怎么把握?
一句话结论
注释解释“为什么”而非复述“做什么”,代码自解释优先;公共接口、复杂算法、约定约束与坑位写文档,注释随代码同步更新,不保留大段注释代码。
概念解释
- 好注释:动机、约束、边界、外部契约。
- 冗余注释:逐行翻译代码。
- 文档:对外接口、模块职责、使用示例。
原理流程
- 先让代码命名与结构自解释。
- 对动机、约束、复杂逻辑补注释。
- 公共 API 写接口文档与示例。
代码或图示
// 为什么:重试只针对幂等读操作,写操作由调用方保证幂等
// 怎么做:见下文循环,注释不复述每一步
常见误区
- 注释描述错误实现:代码改了注释没更新,比无注释更误导。
- 用注释掩盖坏代码:先改善结构,再补说明。
追问
- 注释掉的代码怎么处理?答:删除,历史由版本管理追溯。
- 公共接口文档包含什么?答:用途、参数语义、返回、错误码、约束与示例。
01.4.1.2-004 文件与代码组织有什么规范?
一句话结论
按职责与模块组织文件,一文件一主要类型,目录对应模块边界;相关代码就近放置,跨模块通过接口协作;文件长度与方法长度作为复杂度信号,超阈值时评审拆分。
概念解释
- 物理组织:目录/文件对应业务模块。
- 逻辑组织:类内字段、方法顺序按职责分组。
- 信号:超长文件/方法提示职责膨胀。
原理流程
- 新代码归入对应模块目录。
- 类型与文件一一对应。
- 评审检查组织是否符合模块边界。
代码或图示
模块/
领域模型
服务
仓储/适配器
DTO/接口
常见误区
- 按技术层把所有 controller/service 平铺:业务边界被技术目录掩盖。
- 工具类文件堆积不相关方法:应按职责拆分。
追问
- 一个文件内多个类型允许吗?答:紧密相关的小值对象可同文件,主要类型独立成文件。
- 目录结构怎么随模块调整?答:按模块边界演进,移动后更新引用与导入。
01.4.1.2-005 Code Review 的目的是什么?
一句话结论
Code Review 是在合并前发现缺陷、保证可维护性、共享知识与统一设计的手段;目的不是挑错或审批走形式,而是集体对代码质量负责,作者与评审者共同改进交付物。
概念解释
- 质量门禁:合并前拦截问题。
- 知识共享:评审者理解设计取舍。
- 氛围:对事不对人,反馈针对代码。
原理流程
- 作者自评并拆分小批量变更。
- 评审者按 checklist 检查并留言。
- 作者讨论修改,结论达成后合并。
代码或图示
作者自评 → 小批量提交 → 评审留言 → 讨论修改 → 复核 → 合并
常见误区
- Review 变成审批盖章:不读代码直接通过,失去门禁价值。
- 反馈针对个人语气:应描述代码问题与影响,不评价能力。
追问
- 新人代码也要 Review 吗?答:需要,且可通过评审传递规范与设计思路。
- 评审发现问题谁负责修?答:作者修改,评审者复核;问题归属代码而非个人。
01.4.1.2-006 Review 正确性检查看什么?
一句话结论
正确性看:边界与空值处理、异常路径、并发与事务、条件分支是否完整、状态流转是否合法、输入校验与越权;核心业务规则与测试覆盖是否匹配。
概念解释
- 边界:空、零、超限、重复、并发。
- 异常:下游失败、超时、部分失败处理。
- 状态:迁移条件与不变式。
原理流程
- 读主流程与分支条件。
- 对照异常与边界清单检查。
- 核对并发、事务与状态约束。
- 确认关键路径有测试。
代码或图示
空值/边界 → 异常路径 → 并发/事务 → 状态迁移 → 输入校验/越权
常见误区
- 只看 happy path:异常与边界是缺陷高发区。
- 忽略事务边界:多步写入缺事务会产生部分提交。
追问
- 并发问题怎么在评审中识别?答:共享可变状态、非原子检查更新、缺同步/幂等键的点重点看。
- 状态迁移合法性怎么核对?答:对照状态机定义,检查每个出口事件与目标状态。
01.4.1.2-007 Review 可维护性检查看什么?
一句话结论
可维护性看命名是否达意、职责是否单一、是否有重复代码与过长方法、抽象层次是否一致、依赖方向是否清晰、复杂度可否降低;代码应让下一位维护者快速理解。
概念解释
- 清晰度:命名、结构、注释。
- 内聚:职责集中,无混杂。
- 耦合:依赖抽象而非具体实现。
原理流程
- 通读一遍判断理解成本。
- 标出长方法、重复段、模糊命名。
- 检查依赖方向与抽象合理性。
代码或图示
命名达意 / 职责单一 / 无重复 / 方法可理解
抽象一致 / 依赖方向正确 / 复杂度可控
常见误区
- 追求“能跑”忽略可读性:后续改动成本远高于短期省事。
- 评审只要求加注释:结构不清时应先改善代码。
追问
- 重复代码要不要拦?答:规则一致应抽取;两处重复可观察,三处重复优先治理。
- 抽象过度怎么提示?答:单实现接口、空适配层、无必要配置项应建议内联。
01.4.1.2-008 Review 安全检查看什么?
一句话结论
安全看注入风险、认证授权与越权、敏感信息处理、输入校验、依赖与配置风险;外部输入不可信,权限在服务端校验,日志与响应不泄露敏感数据。
概念解释
- 注入:SQL/命令/脚本/路径拼接。
- 越权:水平/垂直越权访问。
- 敏感:密码、令牌、证件号、密钥。
原理流程
- 追踪外部输入到使用点。
- 检查校验、转义与参数化。
- 核对权限判断与敏感信息处理。
代码或图示
外部输入 → 校验/参数化 → 权限校验 → 敏感信息脱敏 → 依赖/配置检查
常见误区
- 前端校验当安全边界:服务端必须重复校验。
- 日志打印请求全量:敏感字段需脱敏。
追问
- 越权怎么分类识别?答:水平越权访问他人资源,垂直越权访问高权限功能;评审检查资源归属与角色判断。
- 第三方依赖漏洞怎么拦?答:CI 依赖扫描告警,高危漏洞在合并前处理。
01.4.1.2-009 Review 性能检查看什么?
一句话结论
性能看循环内 IO/查询、N+1 读取、无界集合、重复计算、同步阻塞与锁粒度、大对象拷贝;热点路径关注算法复杂度与资源释放,非热点不过度优化。
概念解释
- 高频问题:循环查库、批量未聚合、集合无上限。
- 资源:连接/流未关闭、线程阻塞。
- 权衡:可读性与性能按场景平衡。
原理流程
- 定位高频调用路径。
- 检查循环内 IO 与批量操作。
- 核对集合边界、计算复用与资源释放。
代码或图示
循环内查询 → N+1 → 无界集合 → 重复计算 → 阻塞/锁 → 资源未释放
常见误区
- 所有代码都按高性能标准写:非热点过度优化损害可读性。
- 凭感觉判断性能:热点结论应结合压测或监控数据。
追问
- N+1 在评审中怎么发现?答:循环内触发仓储/远程调用,应改为批量查询或关联加载。
- 大集合要注意什么?答:容量上限、分页处理、内存占用与流式读取。
01.4.1.2-010 Review 测试检查看什么?
一句话结论
测试看关键路径与分支是否有覆盖、断言是否有效、测试是否隔离可重复、异常路径是否用例覆盖;变更涉及规则改动时,检查是否补充或更新了对应测试。
概念解释
- 覆盖:主流程、分支、异常。
- 断言:验证行为结果,不只执行不报错。
- 隔离:测试间无共享状态依赖。
原理流程
- 对照变更逻辑找未覆盖分支。
- 检查断言是否校验关键结果。
- 确认测试可独立重复运行。
代码或图示
主流程用例 / 分支用例 / 异常用例
断言校验结果 / 测试隔离 / 数据可重建
常见误区
- 测试只调用方法不检查结果:无法发现缺陷。
- 测试依赖执行顺序与外部脏数据:脆弱易误报。
追问
- 赶时间可以不带测试合并吗?答:核心规则必须有测试;临时缺口记技术债并安排补。
- 测试质量怎么评?答:看边界覆盖、断言强度、可读性与维护成本,而非只数用例条数。
01.4.1.2-011 评审流程怎么组织更高效?
一句话结论
作者先自评并拆成小批量变更,变更说明目的与风险;评审者按 checklist 分批留言,区分必须修改与建议项;作者回应修改,评审复核后合并,大变更提前预约评审时间。
概念解释
- 小批量:diff 可读,问题易定位。
- 留言分级:阻塞问题 vs 风格建议。
- 闭环:每条意见有结论(修改/保留/讨论)。
原理流程
- 作者写变更说明并自评。
- 拆分为小 PR/变更集。
- 评审留言分级,作者逐条处理。
- 复核通过后合并。
代码或图示
变更说明(目的/风险/测试)→ 小批量 → 评审分级留言
→ 作者处理 → 复核 → 合并
常见误区
- 一次提交上千行:评审流于浏览,问题漏检。
- 评审意见不回复:挂起问题随合并流失。
追问
- 评审等待久怎么办?答:提前预约、拆分小批量、指定主评审,紧急变更走备用评审路径。
- 变更说明写什么?答:背景、改动点、风险点、测试方式、回滚考虑。
01.4.1.2-012 评审冲突怎么处理与升级?
一句话结论
分歧先回到代码目标与事实依据(行为、约束、数据)讨论;风格类问题服从项目规范,设计类分歧列出方案与代价;无法达成一致时升级技术负责人决策并记录结论,不拖延合并也不硬压。
概念解释
- 事实优先:行为正确性、边界条件可验证。
- 规范兜底:格式风格按工具约定。
- 升级:高风险分歧由决策者拍板。
原理流程
- 澄清分歧点是事实、设计还是风格。
- 用约束与数据比较方案。
- 僵持时升级并记录决策理由。
代码或图示
分歧定位 → 事实/约束对照 → 方案代价对比 → 一致 or 升级决策 → 记录结论
常见误区
- 以资历或语气压人:决策应依据目标与事实。
- 分歧不记录:后续重复争论。
追问
- 评审者坚持不同方案怎么办?答:明确各自方案前提与代价,必要 spike 验证,升级后按决策执行。
- 作者不接受修改意见?答:说明问题影响,保留不同意见时记录,阻塞问题需解决后合并。
01.4.1.2-013 静态检查与格式化工具怎么落地?
一句话结论
把格式、导入排序、静态规则、类型检查接入提交前钩子与 CI,让工具消灭机械性问题;规则配置进项目仓库统一版本,评审不再为缩进格式争论。
概念解释
- 格式化:缩进、换行、引号。
- 静态检查:未使用变量、空指针风险、常见坏味道。
- 门禁:CI 中规则失败阻断合并。
原理流程
- 选择语言生态格式化与 lint 工具。
- 配置纳入仓库,团队统一版本。
- 提交前钩子自动修复,CI 校验阻断。
代码或图示
editorconfig / formatter / linter / type checker
本地 pre-commit → CI 门禁(失败不合并)
常见误区
- 工具规则随意关闭:绕过应记录理由,避免规则名存实亡。
- 静态告警长期堆积:分级清理,高危先治。
追问
- 历史代码不符合新规则怎么办?答:增量治理,新代码必须合规,存量按需重构。
- 工具误报怎么处理?答:局部抑制并注明理由,不全局关闭规则。
01.4.1.2-014 提交信息与分支规范怎么约定?
一句话结论
提交信息说明“做了什么、为什么”,遵循统一格式(类型 + 主题 + 必要正文);分支策略按团队协作模式选择,提交粒度小而完整,可独立回溯与回滚。
概念解释
- 提交信息:类型(feat/fix/refactor/docs)、主题、动机与影响。
- 分支:主干、功能分支、修复分支的命名与生命周期。
- 粒度:一个提交完成一件事。
原理流程
- 约定提交信息格式与分支命名。
- 功能开发从主干拉分支。
- 小步提交,信息说明动机。
代码或图示
提交:feat(order): 支持优惠券叠加计算
正文:说明动机、边界与影响
分支:feature/order-coupon、fix/pay-timeout
常见误区
- 提交信息写“更新代码”:无法回溯变更意图。
- 一个提交混杂多件事:回滚与 review 困难。
追问
- 提交信息要不要关联需求单号?答:需要时在正文关联,便于追溯。
- 多次调试提交怎么整理?答:合并推送前可 squash/rebase 整理为清晰历史,公共分支谨慎改写。
01.4.1.2-015 评审中发现烂代码怎么处理?
一句话结论
区分本次新增问题与存量烂代码:新增问题必须在本次修改中解决;存量问题标注技术债并记录位置、影响与偿还建议,不在本次大改中夹带重构,避免变更失控。
概念解释
- 新增:评审门禁内必须修。
- 存量:记录债务,排期偿还。
- 边界:顺手小改可做,大块重构单独走。
原理流程
- 判断问题属于本次改动还是历史遗留。
- 新增问题当场修改。
- 存量问题入技术债清单并跟踪。
代码或图示
本次引入 → 本次修复
历史遗留 → 记录技术债(位置/影响/优先级/偿还方案)
常见误区
- 借 Review 大范围重构存量:diff 失控,风险不可控。
- 看到烂代码直接忽略:不记录则债务持续累积。
追问
- 改动必须经过烂代码怎么办?答:最小修改通过,顺手整理局部,复杂重构另开任务。
- 技术债清单在哪维护?答:项目任务/文档中登记,迭代评审跟踪优先级。
01.4.1.2-016 评审不通过的常见理由有哪些?
一句话结论
常见阻塞理由:缺陷或边界未处理、并发/事务/权限问题、关键路径无测试、安全风险、职责混乱或重复严重、变更不可回滚;风格争议通常不构成阻塞,应分级处理。
概念解释
- 阻塞:影响正确性、安全、可维护性的硬问题。
- 建议:可读性、命名、小优化,可后续调整。
- 分级:避免把风格分歧当阻断理由。
原理流程
- 按 checklist 定位问题等级。
- 阻塞问题必须修改后复核。
- 建议项作者判断取舍并回复。
代码或图示
阻塞:缺陷/边界/并发/事务/越权/安全/无测试/不可回滚
建议:命名/注释/小重构/风格
常见误区
- 把个人偏好写成阻塞意见:应对照项目规范与实际影响。
- 阻塞问题草草通过:问题流入主干后修复成本更高。
追问
- 怎么判断意见是阻塞还是建议?答:不修改是否导致错误、安全漏洞或后续维护障碍;是则阻塞。
- 评审意见数量多说明什么?答:可能是拆分不足或作者缺少规范,需改善前置准备。
01.4.1.2-017 小改动也要评审吗?
一句话结论
高风险模块(资金、权限、核心链路)即使小改动也必须评审;低风险独立模块的文案、配置类小改可走简化评审,但合并前仍需自查与工具检查,规则按模块风险分级。
概念解释
- 风险分级:核心/敏感链路严审,边角改动简化。
- 底线:工具门禁、自测、变更说明不可省。
- 例外:简化不等于跳过质量检查。
原理流程
- 按模块风险定评审级别。
- 高风险走完整 Review。
- 低风险简化流程但保留自查与记录。
代码或图示
核心链路:完整评审(正确性/安全/测试)
边角文案/配置:自评 + 工具检查 + 简化复核
常见误区
- 小改动直接合并:看似简单的配置/正则/边界也可能引入故障。
- 所有改动同等流程:低风险占用评审资源,拖慢交付。
追问
- 配置变更风险怎么评估?答:看影响范围、是否可回滚、是否涉及权限/开关。
- 紧急修复走什么流程?答:可先快速评审止血,事后补充记录与测试。
01.4.1.2-018 大 diff 怎么拆分以提高评审质量?
一句话结论
大变更按职责/模块/步骤拆成独立可合并的小批量:格式整理与功能修改分开、重构与新功能分开、各层接口与实现分批;每批有明确目的与测试,评审可读、问题可定位、回滚可独立。
概念解释
- 拆分维度:模块、步骤、类型(重构/功能/修复)。
- 独立可合并:每批通过门禁后可入主干。
- 顺序:先重构后功能,降低理解干扰。
原理流程
- 通读大变更归类改动类型。
- 先提交无行为变化的重构/格式化。
- 再分批提交功能与修复,各自带测试。
代码或图示
批 1:格式/重命名(无行为变化)
批 2:抽取结构(无行为变化)
批 3:新功能 + 测试
批 4:缺陷修复
常见误区
- 拆分后批次间编译不过:批次应保持可构建可测试。
- 重构夹带行为变化:评审无法区分行为与结构改动。
追问
- 跨层改动怎么分批?答:先接口与模型,再服务实现,最后接入层;每层独立可测。
- 拆分后评审节奏?答:主评审提前对齐计划,逐批复核,避免积压到最后。