写代码如同写文章,好的文章是反复修改出来的,代码也同样是反复的重构出来的。今天给大家分享下,怎么从一个编程学习者变为一个程序猿(程序媛)!起码不要让别人一看你的代码就知道你是个小菜鸟!
我们通常写一个代码,必然会经过一个简单-难-简洁的过程,那么在重构的过程中需要注意哪些呢?
1、 代码可以正常运行
首先必然要保证,代码可以正常运行!
不论你是直接按逻辑写下来还是函数式编程,必须先能实现你的代码功能,可以正常运行起来
2、 精简代码,提高可读性
当你的代码可以运行起来以后,接着就要重新读一遍代码,以下几个方面是需要优化的地方:
- · 你的代码是否遵循了pep8原则,比如命名,每一行代码长度等等,这些细节要处理好
- · 函数的重构,返回值、缺省值等等,要保持函数式功能单一原则
- · 有没有过多的if else嵌套,是否可以提取
- · 全局变量有没有大写,有没有写到开头
3、 代码注释完整
代码初步精简过后或者过程中,顺手将注释写一下是一个很好的习惯
代码是要先给人看,然后才会给机器运行!所以注释是一个非常重要的东西,有的同学不是很喜欢写注释,觉得很麻烦,那么如果这个代码很短,那么确实可以不写,但是如果你的代码很长,成百上千行,不写注释会让你很懵逼!
4、 异常处理齐全,代码很健壮
代码有时效性!尤其在爬虫上更是深有体会,现在可以正常运行的代码,过段时间可能因为网页改版,或者cookie、sql语句等等的变动,都可能会导致你的代码报错,我们要提前将这些问题考虑进去,这就需要异常处理机制了,注意以下几点:
- · 如果是爬虫,是否需要写上cookie的相关函数,如果需要ip代理,是否考虑了代理ip的时效性
- · 循环遍历的时候是否有考虑错误,比如获取了空列表
- · If分支是否考虑齐全,有没有else的情况
- · 文件读写是否有try语句,是否考虑存储位置的问题
- · 拿到一个句柄,比如SSH,SQL,这样有没有考虑到句柄的有效性
代码所有的异常可能都需要考虑,以此来保证代码的健壮!
5、 配置文件
我们在刚才写好了全局变量,现在可以将这些全局变量放入一个配置文件中,来实现和接口分离,降低耦合度。对于用户来说只要改配置文件就行了。比如可以把整个的全局变量放到一个config.py里面,然后在主程序里面用from config import * 这样的话,对后续的修改方便很多。
如果可以,写一个Redeme文档,将你的代码中用到环境、版本、配置配置文件等等信息都写入里面,对人对己都是很方便的!
6、 各个单元功能完善,测试各种分支回路
程序虽然写好了,不管你的程序是几十行的小程序小脚本,还是几千上万行的项目,测试用例是一定要设计。
简单的程序可以设一些断言assert,看一些有无异常,对于复杂的逻辑,一定要针对性的设计多个分支回路反复测一下代码。
7、 添加日志功能
有同学说上面6步之后,我感觉代码已经很不错了,这么还有优化!Python的代码很多都是在服务区上运行的,你总不能一直都是print吧,尤其是对大型的程序,没有日志怎么行,建议用logging模块进行日志的记录
8、 性能优化
结构优化和线程、进程、协程、分布式等等提前设计好
如果你处理的任务仅仅是几百上千,对性能要求不高,对实时性要求也不高那还好。如果你要处理几十万条数据呢!这个时候一定要考虑并发的处理,到底是用多进程,还是多线程,线程池,还是用协程,需要思考!
当然性能上的优化并不单是单线程变多线程,还有数据结构的优化,比如什么时候该用列表,什么时候用元组,哪一种对内存消耗少,查询快。
9、 函数变类
为了让我们的代码更加易于扩展,适应变化!我们需要用类把变量和函数进行封装,设计一些接口,那些是对外开发的,那些是对外封闭的。
哪些用静态函数包裹,哪些用实例方法。是不是需要用一些装饰器来简化代码。
相同类别的函数,进行整合,合并要一个类里面。
多个功能用多个类来表示,方便维护和扩展。
类与类之间,考虑他们的内在关系。用组合还是继承,用一些简单的设计模式,根据程序的特性用比如工厂模式,观察者。