代码精进之路

很多书会讲什么是好代码,如《代码简洁之道》,《代码之丑》,《代码精进之路》,记录一下自己在项目实践和学习过程中的感悟

google代码review文档
How to do a code review

对待代码优化的态度

如果你是想长久的维护一个系统,那么代码就必须要优化,或者说要用高标准严格要求他,一旦不好的代码积累,后期就要拿出成倍的经理,也承担成倍的风险去修复

对于新代码,最高要求
对外老代码,每次功能点内的进行优化,不要做超出功能点的内容,任何优化必然有风险,一定要体现为一个功能点,在实际开发的后续阶段进行跟踪

一、什么是好代码

参考《代码精进之路》,我觉得是“经济”这个概念去衡量是我最认可的。代码归根到底是一个工具,那么它主要的目的就是用合适的“代价”去获得效益。而不是单纯的无限去优化,去重构。
“经济”是根据实际情况来的,如果你是一个人的独立开发者,可能任何文档都是无意义的,但当我们在公司作为团队开发较大项目时,文档注释能帮助提升整体的经济性。

即便具体环境千差万别,我还是有一些例子,可以和你一起分享:
代码写得又快又好,是“经济”的;代码写得快,但是错误多,不是一个“经济”的行为。
代码跑得又快又好,是“经济”的;代码跑得快,但是安全问题突出,不是一个“经济”的行为。
代码写得精简易懂,是“经济”的;代码写得精简,但是没人看得懂,不是一个“经济”的行为。

二、如何写出好代码

各种各样的书都会教你什么是好代码,有很多的原则和细节,但要记住,代码的规范也是随着编程语言在进步的,可能过去因为语言特性的好代码也是会过时的。
那么如何了解什么是好代码?
1.多看各种书
2.多看各种开源高星项目
3.最推荐的,使用各种工具如spotBugs,阿里P3C,等扫描自己的一个工程,改一遍,这样起码能避免大部分坏味道,也能保持团队的统一

三、一些广泛认可的原则

  • 命名
    命名有很多原则,如合理使用英文,动名词,但最基本是要做到达意
    如果一个方法里有方法名无法包含的逻辑,那么你应该考虑拆分方法
    关于中文,很多业务由于复杂性及业务特殊性,无法找到恰当的英文,那么建议此类业务专有名词,统一使用中文拼音
    如果有个方法你无法合适的命名,大概率是你的方法设计不合理

  • 注释
    终极的目标,代码结构赏心悦目,一目了然。什么文档注释都不要,但现实情况很难达到。
    因而注释是必须的,但切记不可滥用,如果一个变量,一个简单的方法你都要注释,说明你的代码结构有问题,需要优化

  • 如何设计一个良好的接口----保持接口的简单直观
    通常我们的接口设计时通过多年的工作经验和直觉去设计的,但还是有一些基本的原则可以参考
    1.从真实问题开始,把大问题逐层分解为“相互独立,完全穷尽”的小问题;
    这其实是一个原子服务的概念,但到底要分到多细,一般我们认为分到已有服务或者无法再分的情况。在实践中,我觉得从数据维度考虑也可以,如果是查询服务,可以将单一维度的或者密切关联的数据查询作为一个服务。而修改,则必须是“最小化”的
    2.问题的分解过程,对应的就是软件的接口以及接口之间的联系
    从问题和需求开始分析,这是为了有一条主线辅助分析,将问题的分解过程中,自然而然就出来了各个层级接口的框架
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345

推荐阅读更多精彩内容