【show-me-bad-code】改善既有代码的设计，谈谈我的真实案例-CSDN博客

本文链接：https://blog.csdn.net/rtthreadiotos/article/details/120984807

作者简介：

recan RT-Thread社区成员 http://yyds.recan-li.cn

一个专注于嵌入式软件架构设计的新生代农名工。

点击阅读原文去RT-Thread论坛认识他吧~

1.写在开头

在本活动开始之前，非常荣幸地收到小师弟的邀请，
看能否帮忙想想1024程序员节的论坛活动好点子，在此非常感谢对我的信任。
想起早年在浏览一些博文的时候，对国外代码社区举办的"烂代码比赛"印象深刻，
看到那些牛人提交的"眼花缭乱的bad-but-work-well的代码，简直是佩服得五体投地。
自然我们大部分的程序员还很难提供出这么秀的代码，
所以基于这个原则，结合我们的实际情况，
修改了下比赛规则，重在娱乐参与，旨在代码提升。

2. 我来提供一段代码

2.1 代码背景

这段代码的原型来自于早几年在一家POS行业内头部企业供职时的真实案例代码，基于这套代码也是过了各种POS机的行业认证。

经过10多年的沉淀，基于该模板代码移植/改造而来的应用程序，罐装的POS机累计装机量应该在KW级别，可谓就是传说中妥妥的【祖传代码】。

早期代码的运行环境是嵌入式Linux系统，总内存高达128MB，还是非常富余的；后面才慢慢切为RTOS系统，内存也锐减到64MB，但即便这样，给到应用程序的内存也是非常充足的。

2.2 代码功能

这段代码的主要功能就是在POS机触发交易时的界面（带LCD显示）下，能够自动识别出当前要使用的各种交易方式，其中包括：

是否刷了磁条卡？（刷了磁条卡，走刷磁条卡的交易流程）
是否插入了IC卡？（插入IC卡，走银联的IC卡交易流程，行内称PBOC流程）
是否使用了IC卡做非接触交易（俗称：挥卡）？（挥卡交易，走银联的IC卡快速交易，行内称qPBOC流程）
是否扫描到了微信/支付宝这类的支付条码？（条码支付与标准银行卡交易是完全不一样的流程）
是否按下了【取消键】，用户主动退出了交易？
是否在规定的时间内（一般60S）没有任何的交易发生，导致超时？

除这些功能外，因为POS机交易是需要保存最近N笔交易记录的，所以这个处理交易的流程中，还得维护交易记录的保存。而代码中用于保存交易记录的结构体也是非常非常非常的庞大，大到一个结构体就占用接近2KB，这是非常恐怖的。

2.3 代码片段

为了仅说明情况，而不透露具体的技术细节，这里我仅提供伪代码，注意代码里的注释，是我为了辅助介绍而自己添加的，原来的代码中，注释比这少得可怜。

1/**
  2  * 保存交易记录的结构体定义
  3  */
  4typedef struct _transaction_log_t {
  5       char time_stamp[32];
  6    uint8_t trans_type;
  7    uint8_t trans_no;
  8
  9    /* 各式各样的数据定义长达20-30个变量 */
 10    uint8_t data1[64];
 11    ...
 12    uint8_t datan[128];
 13} transaction_log_t;
 14
 15/* 全局的交易log变量，被各个处理流程的文件引用 */
 16transaction_log g_log_info;
 17
 18/**
 19  * 支持的交易方式的掩码
 20  */
 21#define TRANSACTION_SWIPE_CARD          0x01
 22#define TRANSACTION_INSERT_CARD         0x02
 23#define TRANSACTION_TAP_CARD            0x04
 24#define TRANSACTION_CODE_PAY            0x08
 25
 26/**
 27 * 处理交易的流程总入口
 28 */
 29int all_transaction_process(int timeouts_ms, int transaction_flag)
 30{
 31    int start_time, end_time;
 32
 33    end_time = 0;
 34    start_time = get_local_time();
 35
 36    /* 循环判断需要支持的交易方式，直到触发了某种交易或者超时 */
 37     while (1) {
 38        if (transaction_flag & TRANSACTION_SWIPE_CARD) {
 39             /* 判断刷卡：阻塞式的接口，带超时时间 */
 40            ret = get_swipe_card(10);
 41            if (ret == ok) {
 42                /* 处理刷卡流程 */
 43                ...
 44                return 0;
 45            }
 46        } else if (transaction_flag & TRANSACTION_SWIPE_CARD) {
 47             /* 判断插卡：阻塞式接口，带超时时间 */
 48            ret = get_insert_card(10);
 49            if (ret == ok) {
 50                /* 处理插卡流程 */
 51                ...
 52                return 0;
 53            }
 54        } else if (transaction_flag & TRANSACTION_SWIPE_CARD) {
 55             /* 判断挥卡：阻塞式接口，带超时时间 */
 56            ret = get_tap_card(10);
 57            if (ret == ok) {
 58                /* 处理挥卡流程 */
 59                ...
 60                return 0;
 61            }  
 62        } else if (transaction_flag & TRANSACTION_SWIPE_CARD) {
 63             /* 判断条码支付 */
 64            ret = get_code(10);
 65            if (ret == ok) {
 66                /* 处理条码流程 */
 67                ...
 68                return 0;
 69            }
 70        }
 71
 72        end_time = get_local_time();
 73        if (start_time + timeous_ms == end_time) {
 74            /* timeout */
 75            return -1;
 76        }
 77
 78        /* 界面显示倒计时 */
 79        lcd_update_timetous();
 80
 81        /* 循环延时 */
 82        delay_ms(10);
 83    }   
 84}
 85
 86/**
 87 * main函数总入口
 88 */
 89int main(int argc, const char *argv[])
 90{
 91    /* 应用初始化 */
 92    system_init();
 93
 94    /* 处理备份及系统异常断电引发的冲正交易 */
 95    handle_bakup();
 96
 97    /* main loop */
 98    while (1) {
 99         /* 每10ms获取下当前有没有按键触发交易 */
100        key = get_key_ms(10);
101        if (key1 == key) {
102            /* 有触发交易需求 */
103            ret = all_transaction_process(60*1000, );
104        } else if (key2 == key) {
105            /* 其他菜单操作 */
106            ...
107        } else {
108            /* 超时或未知按键输入 */
109            ...
110        }
111
112        /* 刷新显示在LCD上的时间 */
113        update _time_dispaly();
114    }
115
116    return 0;
117}