我的第一個(gè)python web開發(fā)框架（5）——開發(fā)前準(zhǔn)備工作（了解編碼前需要知道的一些常識(shí)）

中午吃飯時(shí)間到了，小白趕緊向老菜坐的位置走過去。

小白：老大，中午請(qǐng)你吃飯。

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

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

......

小白：老大，我照您上次講的辦法都做完了，一步步執(zhí)行，方向和條理清晰了很多，現(xiàn)在馬上要進(jìn)入編碼了，所以想讓您再指點(diǎn)一下。

老菜：嗯嗯，做的還不錯(cuò)嘛，孺子可教也。

編碼相關(guān)的一些內(nèi)容也是老生常談的東西，它就好像起一座高樓大廈，如果沒有設(shè)計(jì)圖紙，沒有將基礎(chǔ)打好，那么可想而知建造出來的質(zhì)量怎么樣了。主要有下面幾點(diǎn)要注意的：

1.編碼規(guī)范

對(duì)于這個(gè)，Python做的挺不錯(cuò)的，有統(tǒng)一的規(guī)范PEP8指導(dǎo)，只要按要求去做就可以了，當(dāng)然要重點(diǎn)注意的有兩點(diǎn)，一是命名一定要按有意義的可讀性強(qiáng)的英文單詞來使命名；二是代碼注釋上，盡量表達(dá)清楚到位，盡量多點(diǎn)注釋，不然一段時(shí)間后你重新維護(hù)舊系統(tǒng)時(shí)，你就知道痛苦了。

2.代碼要適度封裝

簡(jiǎn)單來說，你要將相同或類似功能的代碼放到統(tǒng)一的文件當(dāng)中，給其他需要調(diào)用相同功能的地方調(diào)用。

比如說我們經(jīng)常要用到MD5進(jìn)行加密，不可能每次要用到時(shí)，都要導(dǎo)入hashlib包，然后創(chuàng)建實(shí)例對(duì)象，再根據(jù)當(dāng)前加密對(duì)象是bytes還是字符串，然后做相應(yīng)處理，這樣重復(fù)代碼就會(huì)很多。萬一那個(gè)地方要進(jìn)行修改時(shí)，就得修改所有使用MD5加密的代碼，而如果處理過程中有所遺忘，就會(huì)產(chǎn)生問題了。所以我們將md5、base64編碼與解碼、aes加密與解密等內(nèi)容統(tǒng)一放到encrypt_helper.py這個(gè)加密操作包中，那么我們要使用時(shí)就非常方便了。

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

為什么說適度封裝呢？因?yàn)檫^度封裝的話，會(huì)令代碼的可讀性下降，使代碼變的難于理解，所以適度就好。當(dāng)然對(duì)于你這種初學(xué)者來說，可能一開始很難理解，這不用擔(dān)心，你就按你自己的經(jīng)驗(yàn)正常實(shí)現(xiàn)功能需求就行了，等你完成這個(gè)項(xiàng)目后就會(huì)發(fā)現(xiàn)好多代碼可以重用，需要封裝重構(gòu)了，到時(shí)再進(jìn)行處理既容易理解，能力也會(huì)提升很快。

3.程序文件分類擺放

如果你的項(xiàng)目文件隨便擺放，當(dāng)程序文件越來越多時(shí)，就會(huì)非常混亂，要找某些功能函數(shù)時(shí)，就會(huì)很困難，所以在開發(fā)前要做好規(guī)劃。

比如common文件夾放各種工具函數(shù)包；config放各種配置文件；api放各種接口文件等

4.面向?qū)ο?/p>

理解什么是面向?qū)ο螅宄嫦驅(qū)ο蟮膸状笤瓌t，并能應(yīng)用到編碼當(dāng)中。

5.做好開發(fā)文檔管理工作

開發(fā)時(shí)盡量編寫與維護(hù)好各種開發(fā)文檔，比如原型、數(shù)據(jù)字典、業(yè)務(wù)流程圖、接口文檔等，如果是團(tuán)隊(duì)合作項(xiàng)目，還要維護(hù)好甘特圖、開發(fā)進(jìn)度管理表和各種約束、分析、會(huì)議記要等文檔。

當(dāng)然小項(xiàng)目不用那么復(fù)雜，不維護(hù)一般來說也沒太大的問題，如果可能的話還是維護(hù)好接口文檔會(huì)比較好，不然二次開發(fā)或與別人合作開發(fā)時(shí)，就呵呵了...

一般接口文檔都會(huì)用wiki來記錄，有很多開源免費(fèi)的wiki，安裝使用都很方便，比如：ShowDoc

6.代碼版本控制

雖然是小項(xiàng)目，最好也用用SVN或Git等版本控制比較好。沒有版本控制的項(xiàng)目，有時(shí)寫著寫著，想回滾以前版本時(shí)，或代碼出現(xiàn)問題要回滾時(shí)，我只能呵呵了

7.開發(fā)時(shí)間的評(píng)估與控制

小項(xiàng)目在時(shí)間管理上也不要太大意了，有時(shí)一不留神就到了交付時(shí)間，如果還沒開發(fā)出來就慘了，怎么評(píng)估和控制好項(xiàng)目開發(fā)時(shí)間也是很有講究的。

在開始一個(gè)項(xiàng)目時(shí)，一般都會(huì)對(duì)項(xiàng)目進(jìn)行分解，細(xì)分到每個(gè)頁面和接口，甚至更細(xì)的都有，然后分配這些開發(fā)任務(wù)到個(gè)人，有了這些詳細(xì)的任務(wù)，要評(píng)估具體的開發(fā)周期就好辦多了。在評(píng)估的時(shí)候，因?yàn)殛P(guān)乎到個(gè)人的開發(fā)時(shí)間控制，都會(huì)去思考每個(gè)頁面與接口要處理的內(nèi)容是什么，會(huì)遇到哪些技術(shù)難題，要怎么處理；又或者是這些頁面或接口涉及的業(yè)務(wù)流程是什么，是否清晰，流轉(zhuǎn)是否存在問題等等。這等于在開發(fā)前就已經(jīng)在大腦里面將代碼寫過一便了，所以預(yù)估的時(shí)間大都八九不離十。

而項(xiàng)目控制又涉及到項(xiàng)目管理，這里就不再擴(kuò)展了，如果一個(gè)個(gè)往細(xì)說就沒完沒了了。

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

小白：老大，大哥，注意口下留情啊！！！您知道小弟囊中羞澀，放過我的錢包吧！！！等收了項(xiàng)目款后再請(qǐng)你大吃一餐，不然剩下的日子我得天天吃泡面了，嗯，我看這家不錯(cuò)，我經(jīng)常來，就去這家吧......

老菜：@.@

本文開發(fā)討論QQ群：669058475（本群已滿）、733466321（可以加2群）

Python web前端

版權(quán)聲明：本文內(nèi)容由網(wǎng)絡(luò)用戶投稿，版權(quán)歸原作者所有，本站不擁有其著作權(quán)，亦不承擔(dān)相應(yīng)法律責(zé)任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實(shí)的內(nèi)容，請(qǐng)聯(lián)系我們jiasou666@gmail.com 處理，核實(shí)后本網(wǎng)站將在24小時(shí)內(nèi)刪除侵權(quán)內(nèi)容。

版權(quán)聲明：本文內(nèi)容由網(wǎng)絡(luò)用戶投稿，版權(quán)歸原作者所有，本站不擁有其著作權(quán)，亦不承擔(dān)相應(yīng)法律責(zé)任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實(shí)的內(nèi)容，請(qǐng)聯(lián)系我們jiasou666@gmail.com 處理，核實(shí)后本網(wǎng)站將在24小時(shí)內(nèi)刪除侵權(quán)內(nèi)容。