程序員版本的八榮八恥~
Python:編程的“八榮八恥”
一、以接口兼容為榮,怎麼理解呢?
很多bug都是因為修改了對外舊接口,但是卻不做兼容導致的。關鍵這個問題多數是比較嚴重的,可能直接導致系統發版失敗的。新手程序員很容易犯這個錯誤。所以我們修改老接口的時候,一般要做好兼容。
如果你的需求是在原來接口上修改,尤其這個接口是對外提供服務的話,一定要考慮接口兼容。舉個例子吧,比如dubbo接口(Dubbo是阿裡巴巴公司開源的一個高性能優秀的服務框架,使得應用可通過高性能的RPC實現服務的輸出和輸入功能,可以和Spring框架無縫集成),原本是只接收A,B參數,現在你加了一個參數C,就可以考慮這樣處理:
//老接口
void oldService(A,B){
//兼容新接口,傳個null代替C
newService(A,B,null);
}
//新接口,暫時不能刪掉老接口,需要做兼容。
void newService(A,B,C){
...
}
二、我們還要以接口裸奔為恥。
為了保證接口報文的安全性,拒絕接口報文裸奔。因此,我們可以使用https協議,還建議對接口加簽驗簽處理,數據加密等。
接口簽名很簡單,就是把接口請求相關信息(請求報文,包括請求時間戳、版本號、appid等),客戶端私鑰加簽,然後服務端用公鑰驗簽,驗證通過才認為是合法的、沒有被中間人篡改過的請求。
我們的業務邏輯代碼需要日志保駕護航。比如:你實現轉賬業務,轉個幾百萬,然後轉失敗了,接著客戶投訴,然後你還沒有打印到日志,想想那種水深火熱的困境下,你卻毫無辦法。
因此大家要打好日志,比如日志級別使用恰當,日志格式,在哪些地方打日志,參數打印哪個等等。不能亂打日志,要以規范日志為榮,亂打日志為恥。
修改完代碼,要自測一下,這個是每個程序員必備的素養,即使你只是修改了一個變量或者一個字段。
要杜絕過度自信,尤其不要抱有這種僥幸心理:我只是改了一個變量或者我只改了一行配置的代碼,不用自測了,怎麼可能有問題。
參數校驗是每個程序員必備的基本素養。你的方法處理,必須先校驗參數。比如入參是否允許為空,入參長度是否符合你的預期長度。因此,我們要以參數校驗為榮。
比如你的數據庫表字段設置為varchar(16),對方傳了一個32位的字符串過來,如果你不校驗參數,插入數據庫直接異常了。
我們要以運行時異常為恥。
比如你沒有做好一些非空校驗,數組邊界校驗等等,導致的空指針異常、數組邊界異常,尤其這些運行時異常還發生在生產環境的話,在有經驗的程序員看來,這些錯誤行為會顯得特別低級。
日常工作中,我們要以設計模式為榮。
比如策略模式、工廠模式、模板方法模式、觀察者模式、單例模式、責任鏈模式等等,都是很常用的。在恰當的業務場景,我們還是把設計模式用上吧。設計模式可以讓我們的代碼更優雅、更具有擴展性。但是不要過度設計哈,不要硬套設計模式。
我們還要以重復代碼為恥。重復代碼,我相信每個程序員都討厭的,尤其有時候你的開發工具還會給你提示出來。我們可以抽取公共方法,抽取公用變量、擴展繼承類等方式去消除重復代碼。
日常開發中,很多程序員在實現某個功能時,如果看到老代碼有類似的功能,他們很喜歡復制粘貼過來。這樣很容易產生重復代碼,所以我們要以復制粘貼為恥。
一般建議加自己的思考,怎麼優化這部分代碼,怎麼抽取公用方法,用什麼設計模式等等。
個人覺得,優化代碼的過程,可以讓自己取得更大的進步。因此我們要以優化代碼為榮,以復制粘貼為恥。
大家平時工作中,是不是經常看到魔法數字。魔法數字(Magic Number)是指擁有特殊意義,卻又不能明確表現出這種意義的數字。
程序裡面存在魔法數字,易讀性很差,且非常難以維護。
if(type==1){
System.out.println("關注公眾號:撿田螺的小男孩");
}else if(type==2){
System.out.println("關注公眾號:程序員田螺");
}else{
System.out.println("關注其他公眾號");
}
代碼中的1、2就表示魔法數字,我們可以用常量取代魔法數,或者定義枚舉去代替魔法數字。
比如你看完田螺哥的文章,可以總結思考一下,或者做做筆記,或者放到收藏夾,茶余飯後再看看。
再比如你日常工作中,看到一段不錯的代碼,也可以思考一下亮點在哪裡,如果是你自己來寫的話,怎麼寫出更好的代碼。反正就是要多總結,多思考,多復習,溫故而知新嘛。
我們要以混水摸魚為恥。比如工作中,一些小伙伴喜歡混水摸魚,當一天和尚敲一天鐘,代碼多是復制粘貼,做完需求就摸魚。實際上這個不可取的。
我們要在工作中成長,通過認真工作,使自己會得更多,將來換工作也可以拿到更高的薪水,對吧,加油吧,小伙子,以總結思考為榮,以混水摸魚為恥。
以動手實踐為榮,以只看不練為恥。
以打印日志為榮,以單步跟蹤為恥。
以空白分隔為榮,以制表分隔為恥。
以單元測試為榮,以手工測試為恥。
以代碼重用為榮,以復制粘貼為恥。
以多態應用為榮,以分支判斷為恥。
以Pythonic為榮,以冗余拖沓為恥。
以總結思考為榮,以不求甚解為恥。
【時間是檢驗真理的唯一標准】對於編程這活來說,這絕對是真理中的真理,任何編程語言學習均是如此。親自動手動手敲一下,編譯、調試一把,發現錯誤,更正,輸出打印結果,才能對語言的細節有更深入的了解。
好多東東看似簡單,做起來可能更本不是那麼一回事。所以,動手,必須的。並且,動手做一遍,也能加深印象和理解,只看不練一會就忘記。
這句話仁者見仁智者見智,對於一個成熟的軟件,記錄日志是最基本的。但是在開發的過程中,僅僅通過日志來分析並不是一個非常好的辦法,通常單步跟蹤和階段性打印日志,能更快地找出錯誤的原因和需要更正的方式,尤其記得參考錯誤的提示,能幫助我們更快的更改。
PEP 8 – Style Guide for Python Code
在PEP 8中Tabs or Spaces?一欄中,介紹到:
Spaces are the preferred indentation method.
空格是首選的縮進方法。
Tabs should be used solely to remain consistent with code that is already indented with tabs.
制表符應該僅用於與已經使用制表符縮進的代碼保持一致。
Python 3 disallows mixing the use of tabs and spaces for indentation.
Python 3禁止在縮進中混合使用制表符和空格。
建議:平時編碼,將TAB鏈設置為4個空格,好多的IDE或編輯器均有此選項設置,所以這個工具可以幫助我們解決。這個問題我也經常犯錯,畢竟TAB鍵確實比打四個空格要方便。
【沒做過太多的代碼測試,這句話引用網上大神答案】這句我覺得沒有寫好,這裡的手工測試定義不明確,單元測試個人通常使用單步跟蹤,這脫離不了手工,與之相對的就是自動化測試,我理解這裡說的是不是TDD(敏捷中的測試驅動開發)。不太明白。
這句真理,復制粘貼很容易造成好多冗余代碼,使用代碼越來越不好維護。例如:
from label_detect import classify_face
上述這句就是說從label_detect.py中復用classify_face這個函數,這是支持的。
將def classify_face給copy到該.py下,就是代碼復制。這樣在之後需要更改classify_face的定義時候,就需要對多個地方進行修改,這種方式不可取。
多態性是指具有不同功能的函數可以使用相同的函數名,這樣就可以用一個函數名調用不同內容的函數。在面向對象方法中一般是這樣表述多態性:向不同的對象發送同一條消息,不同的對象在接收時會產生不同的行為(即方法)。
也就是說,每個對象可以用自己的方式去響應共同的消息。所謂消息,就是調用函數,不同的行為就是指不同的實現,即執行不同的函數。
import abc
class Animal(metaclass=abc.ABCMeta): #同一類事物:動物
@abc.abstractmethod
def talk(self):
pass
class Cat(Animal): #動物的形態之一:貓
def talk(self):
print('say miaomiao')
class Dog(Animal): #動物的形態之二:狗
def talk(self):
print('say wangwang')
class Pig(Animal): #動物的形態之三:豬
def talk(self):
print('say aoao')
在一個函數中,如果我們接收一個變量 obj,則無論該obj是Cat、Dog還是Pig,都可以執行talk的動作:
def func(obj):
obj.talk()
c = Cat()
d = Dog()
p = Pig()
func(c)
func(d)
func(p)
運行結果:
>>> say miaomiao
>>> say wangwang
>>> say aoao
多態性的好處:
(1)增加了程序的靈活性,以不變應萬變,不論對象千變萬化,使用者都是同一種形式去調用,如func(obj)
(2)增加了程序可擴展性,通過繼承animal類創建了一個新的類,使用者無需更改自己的代碼,還是用func(obj)去調用
反觀分支判斷語句,分一下幾種:
單一if結構
if-else結構
if-elif-else結構
if嵌套結構
對應到上面的多態,就是需要根據判斷animal的不同類型,print不同的talk。
什麼是Pythonic呢,中心思想如下:簡單、清晰,不要過分強調技巧,盡量使用 Python 已經提供的功能以及符合Python的思維方式。
例如:C語言中,交換兩個數字a,b,需要如下操作:
t=a;
a=b;
b=t;
判斷數字a是否再在(c,d)區間內,需要:
if(a>c && a<d):
而在Python中,僅僅需要這樣就行:
a,b = b,a
if(c<a<d):
真理中的真理,不僅編程,凡事均應如此啊。