个人第一个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/