一次代码评审,差点过不了试用期! 作者:小傅哥
博客: https://bugstack.cn (opens new window) 原文: https://mp.weixin.qq.com/s/8tkJCD84W48PdvZLE9uzmA (opens new window) 沉淀、分享、成长,让自己和他人都能有所收获!😄 # 一、前言 好的代码往往也很好看 代码是给机器运行的,但同样也是给人看的,并且随着上线还需要由人来运维。那么写出 可扩展 、 易维护 、 好读懂 的代码就显得非常重要。 对于新人来说,互联网大厂项目开发与平常自己学习的代码还是有很大的差别的。日常学习时候通常只要能运行出结果即可,并不会有其他的要求。也不会说有;PRD评审、研发设计评审、代码开发、代码评审以及中间一些列的提交物,直到测试完成,上线验证,开量对外等等。 所以很多新人刚从学校毕业或者从小公司进入大厂,在规范制约下会有一些不习惯,甚至犯错误。那么为了让大家更好的知晓这些问题,小傅哥特意整理了一些例子,欢迎参考。 # 二、会议室 谢飞机 ,刚刚入职没多久,兴奋的写着leader给的需求,🐎码的飞快。恰巧组长走过来:“飞机,带着你的电脑,跟我来码云会议室,做下代码评审。” leader :飞机,你这代码咋这么粗鲁! 飞机 :啊?😱 leader :我要不拦着你,我感觉你这代码都能飞。 leader :你看哈,就说这行,这日志打的,上线后出了问题,你能查到原因吗? 飞机 :好像... leader :还有这,这idea都提示你了,都报黄色了,你怎么不看看。还有,这代码也不格式化,一个月后它认识你,你还认识它吗。 leader :给你发的入职编码规范看了? 飞机 :哦,看一些,写的时候忘了。 leader :先别着急写,看会了再写代码,这还有一个不错的工程: 《Netty+JavaFx实战:仿桌面版微信聊天》 (opens new window) ,可以参考。 写代码不是以完成功能就算完事,还需要写的漂亮。评审后,飞机,坐回工位,收起了躁动的心,安心熟读手册并练习。 # 三、代码评审 # 1. 日志规范 日志是整个代码开发过程中非常重要的环节,如果日志打的不好,那么遇到的线上bug就没法快速定位,定位不了问题也就没法快速解决问题。直接带来的结果可能包括;客诉更多、资损更大、修复更慢。 就像下面这段代码中的日志 ;
public Result execRule(RuleReq req) {
try {
logger.info("执行服务规则 req:{}", JSON.toJSONString(req));
// 业务流程
return Result.buildSuccess();
} catch (Exception e) {
logger.error("执行服务规则失败", e);
return Result.buildError(e);
}
}
1 2 3 4 5 6 7 8 9 10