IT開發(fā)工作中寫代碼的16個(gè)好習(xí)慣
專欄內(nèi)容轉(zhuǎn)至于?撿田螺的小男孩
1.修改完代碼,記得自測(cè)一下
[?改完代碼,自測(cè)一下」是每位程序員必備的基本素養(yǎng)。尤其不要抱有這種僥幸[?心理:我只是改了一個(gè)變量或者我只改了一行配置代碼,不用自測(cè)了」。改完代碼,盡量要求自己都去測(cè)試一下哈,可以規(guī)避很多不必要bug的。
2.方法入?yún)⒈M量都校驗(yàn)
入?yún)⑿r?yàn)也是每個(gè)程序員必備的基本素養(yǎng)。你的方法處理,「必須先校驗(yàn)參數(shù)」。比如入?yún)⑹欠裨试S為空,入?yún)㈤L(zhǎng)度是否符合你的預(yù)期長(zhǎng)度。這個(gè)盡量養(yǎng)成習(xí)慣吧,很多「低級(jí)bug]都是[不校驗(yàn)參數(shù)]導(dǎo)致的。
如果你的數(shù)據(jù)庫字段設(shè)置為varchar(16),對(duì)方傳了一個(gè)32位的字符串過來,你不校驗(yàn)參數(shù),「插入數(shù)據(jù)庫直接異常」了。
3.修改老接口時(shí),思考接口的兼容性
很多bug都是因?yàn)樾薷牧藢?duì)外老接口,但是卻「不做兼容導(dǎo)致」的。關(guān)鍵這個(gè)問題多數(shù)是比較嚴(yán)重的,可能直接導(dǎo)致系統(tǒng)發(fā)版失敗的。新手程序員很容易犯這個(gè)錯(cuò)誤哦~
所以,如果你的需求是在原來接口上修改,,尤其這個(gè)接口是對(duì)外提供服務(wù)的話,一定要考慮接口兼容。舉個(gè)例子吧,比如dubbo接口,原本是只接收A,B參數(shù),現(xiàn)在你加了一個(gè)參數(shù)C,就可以考慮這樣處理。

4.對(duì)于復(fù)雜的代碼邏輯,添加清楚的注釋
寫代碼的時(shí)候,是沒有必要寫太多的注釋的,好的方法變量命名就是最好的注釋。但是,如果是「業(yè)務(wù)邏輯很復(fù)雜的代碼」,真的非常有必要寫[清楚注釋]。清楚的注釋,更有利于后面的維護(hù)。
5.使用完 IO資源流,需要關(guān)閉
應(yīng)該大家都有過這樣的經(jīng)歷,windows系統(tǒng)桌面如果「打開太多文件]或者系統(tǒng)軟件,就會(huì)覺得電腦很卡。當(dāng)然,我們linux服務(wù)器也一樣,平時(shí)操作文件,或者數(shù)據(jù)庫連接,IO資源流如果沒關(guān)閉,那么這個(gè)IO資源就會(huì)被它占著,這樣別人就沒有辦法用了,這就造成[資源浪費(fèi)」。

6.代碼采取措施避免運(yùn)行時(shí)錯(cuò)誤(如數(shù)組邊界溢出等)
日常開發(fā)中,我們需要采取措施規(guī)避[數(shù)組邊界溢出,被零整除,空指針]等運(yùn)行時(shí)錯(cuò)誤。

7.盡量不在循環(huán)里遠(yuǎn)程調(diào)用、或者數(shù)據(jù)庫操作,優(yōu)先考慮批量進(jìn)行。
遠(yuǎn)程操作或者數(shù)據(jù)庫操作都是「比較耗網(wǎng)絡(luò)、IO資源」的,所以盡量不在循環(huán)里遠(yuǎn)程調(diào)用、不在循環(huán)里操作數(shù)據(jù)庫,能「批量一次性查回來盡量不要循環(huán)多次去查」。(但是呢,也不要一次性查太多數(shù)據(jù)哈,要分批500一次醬紫)

8.寫完代碼,腦洞一下多線程執(zhí)行會(huì)怎樣,注意并發(fā)一致性問題
我們經(jīng)常見的一些業(yè)務(wù)場(chǎng)景,就是先查下有沒有記錄,再進(jìn)行對(duì)應(yīng)的操作(比如修改)。但是呢,(查詢+修改)合在一起不是周子操作哦,腦洞下多線程,就會(huì)發(fā)現(xiàn)有問題了。

9.獲取對(duì)象的屬性,先判斷對(duì)象是否為空
這個(gè)點(diǎn)本來也屬于「采取措施規(guī)避運(yùn)行時(shí)異常」的,但是我還是把它拿出來,當(dāng)做一個(gè)重點(diǎn)來寫,因?yàn)槠綍r(shí)空指針異常太常見了,一個(gè)手抖不注意,就導(dǎo)致空指針報(bào)到生產(chǎn)環(huán)境去了。
所以,你要獲取對(duì)象的屬性時(shí),盡量不要相信[理論上不為空」,我們順手養(yǎng)成習(xí)慣判斷一下是否為空,再獲取對(duì)象的屬性。

10.多線程異步優(yōu)先考慮恰當(dāng)?shù)木€程池,而不是new thread
為什么優(yōu)先使用線程池?使用線程池有這幾點(diǎn)好處呀
它幫我們管理線程,避免增加創(chuàng)建線程和銷毀線程的資源損耗。
提高響應(yīng)速度。
重復(fù)利用。
同時(shí)呢,盡量不要所有業(yè)務(wù)都共用一個(gè)線程池,需要考慮[線程池隔離」。就是不同的關(guān)鍵業(yè)務(wù),分配不同的線程池,然后線程池參數(shù)也要考慮恰當(dāng)哈。
11.手動(dòng)寫完代碼業(yè)務(wù)的SQL,先拿去數(shù)據(jù)庫跑一下,同時(shí)也explain看下執(zhí)行計(jì)劃。
手動(dòng)寫完業(yè)務(wù)代碼的SQL,可以先把它拿到數(shù)據(jù)庫跑一下,看看有沒有語法錯(cuò)誤嘛。有些小伙伴不好的習(xí)慣就是,寫完就把代碼打包上去測(cè)試服務(wù)器,其實(shí)把SQL放到數(shù)據(jù)庫執(zhí)行一下,可以規(guī)避很多錯(cuò)誤的。
同時(shí)呢,也用[explain看下你Sql的執(zhí)行計(jì)劃],尤其走不走索引這一塊。
12.調(diào)用第三方接口,需要考慮異常處理,安全性,超時(shí)重試這幾個(gè)點(diǎn)
調(diào)用第三方服務(wù),或者分布式遠(yuǎn)程服務(wù)的的話,需要考慮
異常處理(比如,你調(diào)別人的接口,如果異常了,怎么處理,是重試還是當(dāng)做失?。?/p>
超時(shí)(沒法預(yù)估對(duì)方接口一般多久返回,一般設(shè)置個(gè)超時(shí)斷開時(shí)間。以保護(hù)你的援口)
重試次數(shù)(你的接口調(diào)失敗,需不需要重試,需要站在業(yè)務(wù)上角度思考這個(gè)問題)
簡(jiǎn)單一個(gè)例子,你一個(gè)http請(qǐng)求別人的服務(wù),需要考慮設(shè)置connect-time,和retry次數(shù)。
如果是轉(zhuǎn)賬等重要的第三方服務(wù),還需要考慮[簽名驗(yàn)簽」,[加密]等
13.接口需要考慮冪等性
接口是需要考慮冪等性的,尤其搶紅包、轉(zhuǎn)賬這些重要接口。最直觀的業(yè)務(wù)場(chǎng)景,就是[用戶連著點(diǎn)擊兩次」,你的接口有沒有hold住。
冪等(idempotent、idempotence)是一個(gè)數(shù)學(xué)與計(jì)算機(jī)學(xué)概念,常見于抽象代數(shù)中。
在編程中一個(gè)冪等操作的特點(diǎn)是其任意多次執(zhí)行所產(chǎn)生的影響均與一次執(zhí)行的影響相同。冪等函數(shù),或冪等方法,是指可以使用相同參數(shù)重復(fù)執(zhí)行,并能獲得相同結(jié)果的函數(shù)。
一般[冪等技術(shù)方案]有這幾種:
查詢操作。唯一索引
token機(jī)制,防止重復(fù)提交。數(shù)據(jù)庫的delete刪除操作
樂觀鎖。悲觀鎖
Redis、zookeeper分布式鎖(以前搶紅包需求,用了Redis分布式鎖)
狀態(tài)機(jī)器等
14.多線程情況下,考慮線性安全問題
在[高并發(fā)]情況下,HashMap可能會(huì)出現(xiàn)死循環(huán)。因?yàn)樗欠蔷€性安全的,可以考慮使用ConcurrentHashMap。所以這個(gè)也盡量養(yǎng)成習(xí)慣,不要上來反手就是一個(gè)new HashMap();
Hashmap、Arraylist、LinkedList、TreeMap等都是線性不安全的;
Vector、Hashtable、ConcurrentHashMap等都是線性安全的
15.主從延遲問題考慮
先插入,接著就去查詢,這類代碼邏輯比較常見,這「可能」
會(huì)有問題的。一般數(shù)據(jù)庫都是有主庫,從庫的。寫入的話是寫主庫,讀一般是讀從庫。如果發(fā)生主從延遲,很可能出現(xiàn)你插入成功了,但是卻查詢不到的情況。
如果是重要業(yè)務(wù),需要考慮是否強(qiáng)制讀主庫,還是再修改設(shè)計(jì)方案。
但是呢,有些業(yè)務(wù)場(chǎng)景是可以接受主從稍微延遲一點(diǎn)的,但是這個(gè)習(xí)慣還是要有吧。
寫完操作數(shù)據(jù)庫的代碼,想下是否存在主從延遲問題。
16.緩存的時(shí)候,考慮緩存跟DB的一致性,還有(緩存穿透、緩存雪崩和緩存擊穿)
通俗點(diǎn)說,我們使用緩存就是為了「查得快,接口耗時(shí)小」。但是呢,用到緩存,就需要「注意緩存與數(shù)據(jù)庫的一致性]問題。同時(shí),還需要規(guī)避緩存穿透、緩存雪崩和緩存擊穿三大問題。
緩存雪崩:指緩存中數(shù)據(jù)大批量到過期時(shí)間,而查詢數(shù)據(jù)量巨大,引起數(shù)據(jù)庫壓力過大甚至down機(jī)。
緩存穿透:指查詢一個(gè)一定不存在的數(shù)據(jù),由于緩存是不命中時(shí)需要從數(shù)據(jù)庫查詢,查不到數(shù)據(jù)則不寫入緩存,這將導(dǎo)致這個(gè)不存在的數(shù)據(jù)每次請(qǐng)求都要到數(shù)據(jù)庫去查詢,進(jìn)而給數(shù)據(jù)庫帶來壓力。
緩存擊穿:指熱點(diǎn)key在某個(gè)時(shí)間點(diǎn)過期的時(shí)候,而恰好在這個(gè)時(shí)間點(diǎn)對(duì)這個(gè)Key有大量的并發(fā)請(qǐng)求過來,從而大量的請(qǐng)求打到db。