Python写业务逻辑的几个编码原则

小程序：扫一扫查出行
【扫一扫了解最新限行尾号】
复制小程序

作为一个写业务逻辑的boy，我需要专注的就是把业务逻辑写好。写业务逻辑并不复杂，就是把编程最基础的东西使用好，有 变量 、 循环 、 流程控制 、 函数 、 数据库 等。

但是写出的逻辑要通俗易懂、易于理解，避免炫技、晦涩。在目前团队中待了一段时间了，根据 code review 和自己的理解整理出一些基本原则。

业务代码思想原则

第一：代码要足够容易阅读。

代码是给程序员阅读的，首先要做到的就是逻辑清晰，易于阅读。所以要避免毫无意义的变量名、嵌套过多的逻辑判断、过于复杂的流程控制。在易读性和性能两者之间，首先要保证易读性，当然两者并不冲突。

第二：代码性能要有保证

python代码的执行速度比不上编译性语言，所以要在代码层面上保证性能的可靠。通常解决一个主要降低性能的点，就能提升整体的性能。

业务代码编码原则

变量

核心思想 ：清晰表示变量的功能

原则：

变量命名统一，python推荐使用下划线分隔命名法，即蛇形命名法，毕竟python就是蛇嘛。真实原因：Python 为什么要推荐蛇形命名法
变量命名中可以带数据类型，如 buy_user_list ， id_to_name_dict 。python的灵活性高，为了更加方便区分变量、函数、方法等，变量名加数据类型是个好方法
超过三个的常量都要用枚举值。善用枚举值，让枚举值的名字解释常量，这是遵守第一条原则，容易阅读
多使用局部变量少使用全局变量，命名空间中局部变量优先搜索

流程控制

核心思想 ：减少if else嵌套，逻辑越清晰越好

原则：

减少if else

可以使用字典的key value特性，直接用key命中条件，避免if判断。
使用装饰器装饰函数，装饰器实现里用字典特性做if else判断。可参考：如何简化大量的 if…elif…else 代码？
用in操作替换if else判断。
使用any 或 all 将多个判断一起处理，减少if else的分支

无法减少if else时要让逻辑清晰

存在复杂的判断条件时，可以先将判断条件处理一遍。如一个判断(a and b) or (c and d)操作时，先单独判断出 a and b 和 c and d，然后再判断两者结果
减少if else之间的处理流程。if或else中处理的流程过长时要尽量简化流程处理，抽象出函数。让if else对齐，处理的逻辑看起来清晰。
if条件的短路特性。if a or b 这种判断中，如果a是True就不会判断b，所以将True条件写在前面可以节省判断时间

简单小例子：使用 all 减少 if else



have_opencourse = True if plan_id in [1,2] else False

user_info = bayuser.get_user_info(user_id)

register_time = pendulum.parse(user_info.created_at)

register_at_today = True if register_time.date() == get_local_today() else False

checkin_days = uc.get_user_checkin_days(user_id)

checkin_zero_day = True if checkin_days == 0 else False

ab_test_id = 414

ab_test_name = words_utils.get_user_plan(user_id, ab_test_id).user_plan

no_provide = True if ab_test_name == "no_provide" else False

# 使用if else判断

if register_time.date() == get_local_today() and checkin_days == 0 and ab_test_name == "no_provide" and plan_id in [1,2]:

    return encoder.json_response(code=200)

# 使用all判断

if all([have_opencourse, register_at_today, checkin_zero_day, no_provide]):

    return encoder.json_response(code=200)

循环

核心思想 ：减少for循环

原则：

用for循环代替while循环，for循环比while循环快
使用隐式for循环代替显式for循环。如sum，map，filter，reduce等都是隐式for循环
尽量不要打断循环。打断循环的放在外面。有判断条件的语句和与循环不相关的操作语句尽量放在for外面
应当将最长的循环放在最内层，最短的循环放在最外层，以减少CPU跨切循环层的次数
for循环和集合都可以处理的选择集合解决，集合的效率远高于循环

简单小例子：集合替代for循环

# for循环

for user in pay_user_cet4_set:

    if user not in all_presale_user_set:

        cet4_push.append(user)

# 集合操作

cet4_push = pay_user_cet4_set - all_presale_user_set