下面細(xì)數(shù)一下 降低代碼可讀性,增加維護(hù)難度的 12 個(gè)編碼“技巧”。
假設(shè)一個(gè)叫”二狗“ 的程序員,喜歡做以下事情。
1 二狗積極拆分微服務(wù),一個(gè)表對應(yīng)一個(gè)微服務(wù)
二狗十分認(rèn)可微服務(wù)的設(shè)計(jì)思想。認(rèn)為微服務(wù)可以獨(dú)立開發(fā)和發(fā)布,每次改動不會影響其他系統(tǒng)。大大提高了開發(fā)人員的效率和線上穩(wěn)定性。還可以在新服務(wù)里使用新的技術(shù),例如JDK 21
于是狗哥把微服務(wù)的思想發(fā)揮到極致,每一張表都是一個(gè)服務(wù)。系統(tǒng)的應(yīng)用架構(gòu)圖十分壯觀。狗哥自豪的跟新同學(xué)講解自己設(shè)計(jì)的系統(tǒng)。新同學(xué)看著十幾個(gè)服務(wù)陷入了思考,不停地問著每個(gè)服務(wù)的作用,干了什么。狗哥很滿足。
新同學(xué)第一次開發(fā)需求,表現(xiàn)很差。雖然他要改10個(gè)服務(wù),但是每個(gè)服務(wù)只改動了一點(diǎn)點(diǎn)。并且由于服務(wù)之間都是Rpc調(diào)用,需要定義大量的接口,他需要發(fā)布好多的 jar,定義版本號,解決測試環(huán)境版本沖突,測試和上線階段可把他忙壞了。
光是梳理上線順序,新同學(xué)就請教了狗哥 三次。最后還是狗哥幫他上線了3 個(gè)服務(wù),新同學(xué)才趕在 凌晨 3 點(diǎn)前把所有的服務(wù)發(fā)完??粗峦瑢W(xué)買了奶茶的份上,狗哥這次才沒有和領(lǐng)導(dǎo)吐槽,“這個(gè)同學(xué)不行啊,上個(gè)線都這么費(fèi)勁”
微服務(wù)過多,也困擾著狗哥。雖然線上流量不高,但是由于 “微服務(wù)太多,系統(tǒng)架構(gòu)復(fù)雜",接口性能不行。
于是狗哥開始進(jìn)行重構(gòu),他重新加了一個(gè)開關(guān),新邏輯可以減少Rpc,調(diào)用提高性能。狗哥在代碼中加了注釋 "新邏輯"。
狗哥把代碼上線了,但是在線上環(huán)境不敢放開,只在測試環(huán)境打開了開關(guān)。
2 二狗積極重構(gòu)代碼,但是線上不放量
狗哥喜歡對代碼進(jìn)行重構(gòu),狗哥和領(lǐng)導(dǎo)吹牛,說“ 重構(gòu)后的代碼性能更強(qiáng),更穩(wěn)定”。狗哥還添加了注釋 ”這是新邏輯 “。
但是狗哥在線上比較謹(jǐn)慎,并沒有進(jìn)行放量。只是在測試環(huán)境,放開了全量。
新接手的同學(xué)不知道線上還沒放量,看到“這是新邏輯” ,他就在狗哥的“新邏輯”上改代碼。測試環(huán)境驗(yàn)證一切正常,到了線上階段卻怎么也跑不通。
此時(shí)新同學(xué)才發(fā)現(xiàn) ”新邏輯“ 的開關(guān)沒有打開,你猜,他敢打開這個(gè)開關(guān)嗎?于是他只能刪代碼,在舊邏輯上重新開發(fā)。等到改完代碼,再上線時(shí),已經(jīng)天亮了。
由于這次上線問題,大家一起熬夜加班,需求上線被推遲。新同學(xué)被產(chǎn)品和測試一頓騎臉輸出。新同學(xué)委屈的想要離職。
3 二狗喜歡挑戰(zhàn)自我,方法長度一定要超過1000行
二狗寫代碼天馬行空。二狗認(rèn)為提煉新方法會打斷自己的編碼思路,代碼越長,邏輯越連貫,可讀性越高。二狗還認(rèn)為 優(yōu)秀的程序員寫的方法都是 非常長的。這能體現(xiàn)個(gè)人的能力。
二狗不光自己寫超長的方法,在改別人的代碼時(shí),也從不提煉新的方法。二狗總是在原來的方法中添加更長的一段代碼。
新同學(xué)接手代碼時(shí)速度很慢,即使加班到凌晨,也不理解狗哥代碼設(shè)計(jì)的藝術(shù)。狗哥還向領(lǐng)導(dǎo)抱怨,”你最近招的人不行啊,一個(gè)小需求開發(fā)這么久,上線還出了bug。“
4 二狗喜歡挑戰(zhàn)自我,一個(gè)方法 if/try/else 要嵌套10層以上
二狗寫代碼十分認(rèn)真,想到哪里就寫哪里。if/else/try catch 層層嵌套。狗哥的思路很快,并且思考全面, 嵌套十幾層的代碼一點(diǎn)bug都沒有,測試同學(xué)都夸贊狗哥 ”代碼質(zhì)量真高啊 “,一個(gè)bug都沒有。
新同學(xué)接手新代碼時(shí),看到嵌套十幾層的代碼,大腦瞬間就要爆炸。想要罵人,但是看到代碼作者是狗哥……
無奈之下,自己實(shí)在看不懂這段代碼,于是點(diǎn)了一杯奶茶,走到了狗哥工位旁,”狗哥,多喝點(diǎn)水,給你點(diǎn)了一杯奶茶?!@段代碼能給我講講嗎?“
狗哥過幾天和領(lǐng)導(dǎo)閑聊天,“新來的同學(xué)人不錯(cuò),還給我點(diǎn)奶茶喝”
5 二狗認(rèn)為變量命名是藝術(shù),要隨機(jī)命名,不要和業(yè)務(wù)邏輯有關(guān)系
二狗覺得寫代碼是藝術(shù),就好像畫畫一樣?!蹦阋娺^幾個(gè)人能看懂 梵高的畫?” 狗哥曾經(jīng)和旁邊人吹牛。
二狗寫代碼思路十分奇特,有時(shí)候來不及想變量如何命名,有時(shí)候是懶得想變量命名。狗哥經(jīng)常隨便就命名了,例如 str1,str2,list1,list2等等。不得不說,狗哥的思維還是敏捷的,這么多變量命名都能記住,還不出bug。
但是狗哥記性不大行,過一兩個(gè)月就不太記得這些變量的意義了。
6 二狗積極寫注釋,但是寫了錯(cuò)誤的注釋
一個(gè)成熟穩(wěn)重的程序員改別人代碼時(shí)會十分慎重,如果有代碼注釋,他們一定會十分認(rèn)真閱讀并嘗試?yán)斫馑?/p>
二狗喜歡把注釋引入錯(cuò)誤的方向,例如 “是” 改成 “不是”,“更好”改成”更差“,把兩處不相干的注釋交換一下位置 等。
新接手的同學(xué)點(diǎn)了一杯奶茶,虛心求助二狗,“狗哥,你寫的這段注釋有什么深意啊,我看了三天,也不理解啊”。
到時(shí)候狗哥就可以給新同學(xué)一邊裝B,一邊講代碼了。當(dāng)然還要看心情,要是不口渴,可以講講。
7 二狗改代碼很認(rèn)真,但是注釋從來不改
二狗改代碼真的非常認(rèn)真,但是他不喜歡改注釋。最終代碼大改特改,注釋紋絲不動。最終代碼和注釋不相干,部分正確,部分錯(cuò)誤。
新接手的同學(xué)研究了兩天也沒搞明白。于是求助了狗哥
到時(shí)候狗哥就可以大展神威了 ?!蹦嵌巫⑨屖清e(cuò)的,你別管,就當(dāng)沒有!“
狗哥順便還說了一句,”優(yōu)秀的代碼不需要寫注釋,也不知道是哪個(gè)XX 寫的注釋“,成功收割新同學(xué)的"欽佩"之情。
8 二狗喜歡復(fù)制代碼
狗哥寫代碼十分著急,根本來不及重構(gòu)。他總是想到一段代碼,就復(fù)制過來。神奇的是,狗哥經(jīng)常這么寫,但是也沒出什么問題。
但新同學(xué)就慘了,在改完狗哥的代碼后,總被測試同學(xué)背地里吐槽,“一點(diǎn)小需求咋這么多bug,跟狗哥比差遠(yuǎn)了”。原來新同學(xué)改了一處,忘了改另外幾處,代碼被復(fù)制了好多遍,他實(shí)在無法全面梳理。
于是每次代碼寫完,新同學(xué)都要不停的研究代碼,總是害怕自己少改了哪些地方,下班時(shí)間越來越晚。并且新同學(xué)也不敢把雷同的代碼重構(gòu)到一起。(“你們猜猜他為什么不敢?)
慢慢的,組里的人都被迫向狗哥學(xué)習(xí),狗哥成功輸出了自己的編碼習(xí)慣。
9 二狗積極寫技術(shù)方案,但是最終代碼實(shí)現(xiàn)不按照技術(shù)方案來
二狗非常喜歡寫技術(shù)方案,大部分時(shí)間都花在技術(shù)方案上,總是把技術(shù)方案打磨的 滑不留手。但是在寫代碼時(shí),狗哥總覺得按照方案設(shè)計(jì)寫代碼,時(shí)間上根本來不及啊,還是簡單來吧,湊活實(shí)現(xiàn)吧。
例如狗哥曾經(jīng)設(shè)計(jì)了一套復(fù)雜的Redis秒殺庫存系統(tǒng),但是實(shí)現(xiàn)時(shí)選擇了最Low的 數(shù)據(jù)庫同步扣減方案。
狗哥寫的流程圖和實(shí)際代碼也沒什么關(guān)系。但是流程圖旁邊加滿了注釋和說明,讓人覺得 ”這個(gè)技術(shù)方案很權(quán)威“。
新同學(xué)熟悉項(xiàng)目時(shí),從公司文檔中搜到了很多技術(shù)方案,本以為可以很快熟悉系統(tǒng),但是發(fā)現(xiàn)技術(shù)方案和代碼不太一樣。越看越迷惑。
于是點(diǎn)了奶茶再次走向了狗哥,狗哥告訴他,“那個(gè)技術(shù)方案太復(fù)雜,排期緊張,開發(fā)來不及。你就當(dāng)沒那個(gè)技術(shù)方案。”
10 二狗十分自信,從不打日志。
二狗對自己的代碼十分自信,認(rèn)為不會出現(xiàn)任何問題,所以他從來不打日志。每次開發(fā)代碼時(shí),狗哥的思維天馬行空,但是從來不想加個(gè)日志會有助于排查問題。
直到有一天,線上真的出問題了,除了異常堆棧,找不到其他有效的日志。大家面面相覷,不知道怎么辦。狗哥挺身而出,重新加了日志,上線。故障持續(xù)了不知道有多久……,看著狗哥忙碌,領(lǐng)導(dǎo)不停地詢問還需要多久才能上線。
復(fù)盤會上,有人對狗哥不寫日志的行為進(jìn)行批判,狗哥卻在 狡辯 “加了日志,就能避免這次故障嗎?出問題還不是因?yàn)槟銈兿到y(tǒng)出了bug,跟我不打日志有啥關(guān)系?!?雙方陷入了無限的扯皮之中……
11 二狗積極學(xué)習(xí),引用一個(gè)高大上的框架 解決一個(gè)小問題
二狗非常喜歡學(xué)習(xí),學(xué)習(xí)了很多高大上的框架。最近二狗學(xué)習(xí)了規(guī)則引擎,覺得這是個(gè)好東西,恰好最近在進(jìn)行重構(gòu)。于是二狗把 drools、avatior、SPEL等規(guī)則引擎、表達(dá)式求值 等框架引入系統(tǒng)。只是為了解決策略模式的問題。即何種條件下使用哪種策略。狗哥在系統(tǒng)架構(gòu)圖里,著重講了規(guī)則引擎部分,十分自豪。
新同學(xué)熟悉系統(tǒng)后,光是規(guī)則引擎部分就看了足足一周。但是還是不知道怎么修改代碼。于是向狗哥請教。狗哥告訴他說," 你在這個(gè)地方 加一行代碼 rule.type == 12 ,走這個(gè) CommonStrategy 策略類就可以了。“
新同學(xué)恍然大悟,原來這就是規(guī)則引擎啊。但是為什么不用策略模式呢?好像策略模式不費(fèi)事啊!狗哥技術(shù)就是強(qiáng)啊,殺雞用核彈。
12 二狗積極造輪子,能造輪子的程序員才是牛掰的程序員
二狗非常喜歡造輪子,他對開源軟件的大神們心向往之,覺得自己應(yīng)該向他們學(xué)習(xí)。狗哥認(rèn)為 造輪子才能更快地成長。
于是在狗哥的積極學(xué)習(xí)下,組里的 分布式鎖 沒有使用 redission,而是自己用setnx搞的。雖然后面出了問題,但是狗哥的技術(shù)得到了鍛煉。
總結(jié)
降低代碼可讀性的方式方法 包括但不限于以上12種;
像二狗這樣的程序員包括但不限于二狗。
審核編輯:劉清
-
編碼器
+關(guān)注
關(guān)注
45文章
3808瀏覽量
138086 -
RPC
+關(guān)注
關(guān)注
0文章
111瀏覽量
11893 -
SPEL
+關(guān)注
關(guān)注
0文章
3瀏覽量
6181
原文標(biāo)題:降低代碼可讀性,增加維護(hù)難度的 12 個(gè)編碼“小技巧”,地位穩(wěn)了!
文章出處:【微信號:芋道源碼,微信公眾號:芋道源碼】歡迎添加關(guān)注!文章轉(zhuǎn)載請注明出處。
發(fā)布評論請先 登錄
Google軟件工程中主要的過程部分
《圖解運(yùn)算放大器電路》輔以大量插圖,有較強(qiáng)的可讀性...
吐槽這本書的代碼實(shí)在晦澀難懂,代碼風(fēng)格的可讀性也較差
Verilog HDL代碼書寫規(guī)范
注釋那些事兒:前端代碼質(zhì)量系列文章(一)
優(yōu)先提高代碼的可讀性的必要
你了解Linux平臺相關(guān)代碼的C++解決方案

嵌入式代碼之編寫規(guī)范
科普一下Verilog代碼命名規(guī)范
如何寫出易維護(hù)的嵌入式代碼怎么寫?

python如何換行而不運(yùn)行代碼
如何提升嵌入式C語言代碼可讀性

評論