• 打造可高效维护代码的几个原则


    来源:http://blog.csdn.net/lezhiyong

    1      问题

    1.1                  project

    功能越来越多,逻辑越来越复杂。模块越来越混乱、架构越来越复杂

    常见问题:

    1、模块A发消息给其它模块处理。B模块-》转发消息给C-》转发给D-》转发给A

    2、初始头文件功能定义清晰,越到后面里面东西越混乱。

    3、各模块内反复实现基础功能。

    1.2                  个人开发

    1、对前人代码:

    不能理解前人代码的思想,新功能自成一套体系。

    造成大量反复代码和反复变量。造成命名反复、冲突的函数、类与变量。

    案例1:两个iStartRecorder,仅參数不一样。


    两个iStartRecorder,仅參数不一样,但一个表示启动录制编码器。一个表示启动录制server,依据两个函数编写时间,非常明显这是后者不理解前人Recorder的含义而加入上的代码。后把后者命名调整为iStartRecordService:


    案例2:

    对于下面的一个project:


    以****Impl.cpp标志的类。一个是继承****类或者是****的创建者,本案例中须要从类实例化过程中非常easy体会到RssMgrlmpl、RssManager、CrssImpl之间的组合/聚合关系。

    RssMgrlmpl:继承rmManager,是接受到sip信令的实现,是RssManager的创建者。

    RssManager:录制任务的管理者

    CRssImpl:是CRssAvRecorderMgr的创建者。

    CRssAvRecorderMgr:是任务中ReCorder的管理者

    当须要创建新类的时候尽量保持与前人思想一致。(无优劣之分时按加入的代码量少数服从多数)

    2、对自己代码:

    忌不遵从当前project所用的架构,使用自己熟悉的其它方式。

    1、使用通用软件规范和模式设计思想。

    2、对有自己想法和创新的代码做好标注,以便别人理解。

    案例:

    慎用递归架构            (递归函数)

    一个视频窗体中实现双流视频(标准流+低流),原来已经实现标准流

    Class VideoCell//单路标准视频处理逻辑

    {

    Public:

        //视频流接收函数

      …

     Private:

       ////标准流变量

    }

    Class WinVideoCell//windows视频窗体

    {

    Public:

        //windows对视频窗体的操作方法

      …

     Private:

       VideoCell m_videoCell;

    }

    Class WinVideoLayout//视频面板

    {

      

       WinVideoCell m_arrWinCell[25];

    }

    递归方式实现:

    Class VideoCell//视频窗体

    {

    Public:

        //标准流方法

      …

     Private:

       //标准流变量

       …

      VideoCellm_LowFlowCell;

    }

    弊端:VideoCell的类函数调用假设控制不好,将陷入VideoCell函数递归调用的迷魂阵

    标准实现方式:

    Class WinVideoCell //windows视频窗体

    {

    Public:

        //windows对视频窗体的操作方法

     

     Private:

       VideoCell m_videoCell;

    VideoCellm_LowFlowCell;

    }

    3、其它常见问题:

    数据都以 void * 形式传递。然后再造型为合适的结构

    Switch 里边还有 Switch,这样的嵌套方式是人类大脑难以破解的

    2      几个原则

    2.1                  唯一性原则

    1、库函数:仅仅在一个类中使用

    2、相同的功能仅仅使用一个接口对外提供功能。

    3、仅仅要是反复的东西尽量合并

       同样特征抽象成基类

       同样方法抽象成虚基类或同样接口

       同样逻辑抽象成同样函数

    2.2                  一致性原则

    1、不同模块中的语言与风格、信令结构、宏定义方式

    2、分配和释放资源的结构一致:在同一代码结构层面上使用,同一个类中提供。同一个各cpp全局函数中提供。

    2.3                  对称性原则

    1、 命名对称start-stop。init-uninit。

    函数位置对称

    2、project结构对称,了解一个project结构。其它project结构类似。

    3、

    3      怎样做到

    3.1              个人要求

    1、对自己代码:持续开发,持续改进

    2、对别人代码:从全局的角度理解前人代码思想,未了解前保持现状

    3、别人到自己:规范的传承

    3.2              project要求

    1、 头文件看护,架构头文件,专人看管,提交审核

    2、 定期检视与整改,将走错门的代码又一次归队,将违规的代码纠正

    3、 新人了解项目结构和头文件


  • 相关阅读:
    07 MySQL之视图
    05 MySQL之查询、插入、更新与删除
    04 MySQL之函数
    02 MySQL之数据表的基本操作
    03 MySQL之数据类型和运算符
    Django之通用视图
    01 MySQL之数据库基本操作
    Elasticsearch-Head基本使用方法
    PinPoint使用手册(转)
    rest-assured学习资料
  • 原文地址:https://www.cnblogs.com/lxjshuju/p/7202172.html
Copyright © 2020-2023  润新知