個人第一個python web開發框架（5）——開發前準備工做（瞭解編碼前須要知道的一些常識）

　　中午吃飯時間到了，小白趕忙向老菜坐的位置走過去。

　　小白：老大，中午請你吃飯。

　　老菜：哈哈...又遇到問題了吧，此次得狠狠宰你一頓才行。

　　小白：行行行，只要您賞臉，米飯任吃，嘻嘻，咱們邊走邊聊。

　　......

　　小白：老大，我照您上次講的辦法都作完了，一步步執行，方向和條理清晰了不少，如今立刻要進入編碼了，因此想讓您再指點一下。

　　老菜：嗯嗯，作的還不錯嘛，孺子可教也。

　　編碼相關的一些內容也是老生常談的東西，它就好像起一座高樓大廈，若是沒有設計圖紙，沒有將基礎打好，那麼可想而知建造出來的質量怎麼樣了。主要有下面幾點要注意的：

　　1.編碼規範

　　對於這個，python作的挺不錯的，有統一的規範PEP8指導，只要按要求去作就能夠了，固然要重點注意的有兩點，一是命名必定要按有意義的可讀性強的英文單詞來使命名；二是代碼註釋上，儘可能表達清楚到位，儘可能多點註釋，否則一段時間後你從新維護舊系統時，你就知道痛苦了。

　　2.代碼要適度封裝

　　簡單來講，你要將相同或相似功能的代碼放到統一的文件當中，給其餘須要調用相同功能的地方調用。

　　好比說咱們常常要用到MD5進行加密，不可能每次要用到時，都要導入hashlib包，而後建立實例對象，再根據當前加密對象是bytes仍是字符串，而後作相應處理，這樣重複代碼就會不少。萬一那個地方要進行修改時，就得修改全部使用MD5加密的代碼，而若是處理過程當中有所遺忘，就會產生問題了。因此咱們將md五、base64編碼與解碼、aes加密與解密等內容統一放到encrypt_helper.py這個加密操做包中，那麼咱們要使用時就很是方便了。

 

import hashlib

def md5(text):
    """md5加密函數"""
    md5 = hashlib.md5()
    if not isinstance(text, bytes):
        text = str(text).encode('utf-8')
    md5.update(text)
    return md5.hexdigest()

 

　　爲何說適度封裝呢？由於過分封裝的話，會令代碼的可讀性降低，使代碼變的難於理解，因此適度就好。固然對於你這種初學者來講，可能一開始很難理解，這不用擔憂，你就按你本身的經驗正常實現功能需求就好了，等你完成這個項目後就會發現好多代碼能夠重用，須要封裝重構了，到時再進行處理既容易理解，能力也會提高很快。

　　3.程序文件分類擺放

　　若是你的項目文件隨便擺放，當程序文件愈來愈多時，就會很是混亂，要找某些功能函數時，就會很困難，因此在開發前要作好規劃。

　　好比common文件夾放各類工具函數包；config放各類配置文件；api放各類接口文件等

　　4.面向對象

　　理解什麼是面向對象，清楚面向對象的幾大原則，並能應用到編碼當中。

　　5.作好開發文檔管理工做

　　開發時儘可能編寫與維護好各類開發文檔，好比原型、數據字典、業務流程圖、接口文檔等，若是是團隊合做項目，還要維護好甘特圖、開發進度管理表和各類約束、分析、會議記要等文檔。

　　固然小項目不用那麼複雜，不維護通常來講也沒太大的問題，若是可能的話仍是維護好接口文檔會比較好，否則二次開發或與別人合做開發時，就呵呵了...

　　通常接口文檔都會用wiki來記錄，網上有不少開源免費的wiki，安裝使用都很方便，好比：ShowDoc

　　6.代碼版本控制

　　雖然是小項目，最好也用用SVN或Git等版本控制比較好。沒有版本控制的項目，有時寫着寫着，想回滾之前版本時，或代碼出現問題要回滾時，我只能呵呵了

　　7.開發時間的評估與控制

　　小項目在時間管理上也不要太大意了，有時一不留神就到了交付時間，若是還沒開發出來就慘了，怎麼評估和控制好項目開發時間也是頗有講究的。

　　在開始一個項目時，通常都會對項目進行分解，細分到每一個頁面和接口，甚至更細的都有，而後分配這些開發任務到我的，有了這些詳細的任務，要評估具體的開發週期就好辦多了。在評估的時候，由於關乎到我的的開發時間控制，都會去思考每一個頁面與接口要處理的內容是什麼，會遇到哪些技術難題，要怎麼處理；又或者是這些頁面或接口涉及的業務流程是什麼，是否清晰，流轉是否存在問題等等。這等於在開發前就已經在大腦裏面將代碼寫過一便了，因此預估的時間大都八九不離十。

　　而項目控制又涉及到項目管理，這裏就再也不擴展了，若是一個個往細說就沒完沒了了。

　　唔唔，到吃飯的地方了，我看看哪家比較貴又吃不飽的，得好好挑一下才行。

　　小白：老大，大哥，注意口下留情啊！！！您知道小弟囊中羞澀，放過個人錢包吧！！！等收了項目款後再請你大吃一餐，否則剩下的日子我得每天吃泡麪了，嗯，我看這家不錯，我常常來，就去這家吧......

　　老菜：@.@

 

 

版權聲明：本文原創發表於 博客園，做者爲 AllEmpty 本文歡迎轉載，但未經做者贊成必須保留此段聲明，且在文章頁面明顯位置給出原文鏈接，不然視爲侵權。

python開發QQ羣：669058475（本羣已滿）、733466321（能夠加2羣）    做者博客：http://www.cnblogs.com/EmptyFS/