【QuotationTool的代码实现】总体代码结构

项目链接:https://gitee.com/xyjtysk/quotationTools

QuotationTools自动化脚本的部署和使用QuotationTool能做什么.

我们介绍了quotationTool能做什么以及如何安装部署,以下章节主要介绍具体的技术实现。

在开始讲解代码之前,我们来介绍一下整个的架构、思想。

代码的架构

架构应具有的特点

quotationTool自动化脚本其实要实现的就是从Excel读出数据,然后进行处理,加上导航页, 然后输出到Excel里面。

那么从Excel里面读出的数据以什么样的数据结构进行整合才最方便处理呢?

数据如何传递到其他模块呢?

我以后要加需求,能不能快速的添加到里面呢?

所以我们希望的整体代码应该具有如下特点

  • 松耦合的:

    也就是模块之间最好没有那多的联系,这样我们编写,增加需求也比较容易。

  • 希望一个功能模块一个文件的分开放置,这样显得有条理,而且方便查找

    这份代码我写了两次,第一次大概在17年5~6月份,当时写的代码把很多功能都糅合在一块了,写的时候无必畅快,读的时候无比痛苦。所以我在11月份的时候又把代码重写了一次,几乎推翻了之前的架构,现在代码就清爽多了。

  • 命名尽可能有规律。

    其实如果我们按照一定的命名规律去命名,找起来会方便很多。

流行的MVC模式就是一种非常好的,可以解决松耦合的问题的设计模式,本项目我参考了MVC设计模式。

下面我们来看MVC设计模式是什么,理解了MVC设计模式有助于我们理解后面的代码。

image.png

MVC模式

一般人的做法

一般来说,我们普通人考虑怎么写代码的时候,都是把所有功能都糅合到一块,就如同写作文一下,一气呵成,这样固然爽快,但是带来痛苦也是很明显的。

  • 难以排错。

    经常是发现了bug在那里,但是忘了bug的含义是什么,是在什么样的功能模块下的。

  • 难以添加功能。

    代码不可能一次就写完了,在上线过程中很定有各种各样的额外功能浮现出来,那么怎么加进去了?如果代码都揉在一块,光找的那个部分就很困难

MVC其实就是一种构建松耦合的代码的好方法。

MVC怎么来的

一般一个系统,可以天然的分为“业务逻辑+业务呈现”两个模块,这个时候,很多控制信息糅杂在“业务逻辑”里面。

那么我们完全可以把控制相关的代码剥离出来,形成一个“控制模块”,这就是解耦合

那么这个控制模块其实就有一个上帝视角,它可以知道业务模块视图模块在干嘛,而且可以控制它,所有的数据都必须经过它。

那么

  • 业务模块需要数据的时候,可以向控制模块索取

  • 业务模块每次处理完成以后,都需要把数据返回给控制模块

  • 视图模块需要数据的时候,同样向控制模块索取

image.png

那么我们整个代码的数据流向应该是:

  • 双击admin.py入口脚本

  • admin.py调用合适的控制器

  • 控制器根据指令选择合适的业务模型

  • 业务模型进行处理,将数据返回给控制器

  • 控制器调用视图模型,由视图模型进行数据呈现

下面我们总结一下MVC的角色

  • M(model):主要处理业务逻辑,包括加公司,与MySQL打交道,它就是一个执行者,一个工人

  • V(View):视图模块,主要是用来呈现的,在本项目里面,主要是输出Excel的。

  • C(Controller):控制模块,它有两个功能

    • 控制信息,控制整个流程的走向。

    • 数据的中转站,业务模块和视图模块都会把数据中转到这里面来。

目录结构

本小节我们来结合一下具体的代码来看一下

image.png

需要注意的是

  • framework存放的是一些固定的代码,可以复用到其他的项目中,比如

    • 调用第三方库读写Excel

    • 对log工具的改进包

    • 对MySQL的操纵包

  • libs是主要的业务逻辑,当然包含控制器、视图、业务模块三个部分


    image.png

ORG指的是引用第三方库,最后没有用到。

  • tpl:业务呈现的模板,里面的文档存放的是每个sheet对应的格式要求。
image.png

先大致了解一下即可,后面还会说到细节

约定

我们知道Controller其实是数据的中转站,所以其他Model处理以后的lists都要发到Controller中。

所以我们约定所有的Model里面

  • assign函数都是用来把controller中的数据赋值到本Model中的。

  • 另外一定还有一个主函数,可以把小函数组装起来。方便Controller的调度。

使用什么语言

选择了好的设计模式,那么选择什么样的语言呢。

所谓人生苦短,我用Python。Python的语言一向非常的简单明了,这也是我选择Python的重要原因。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,616评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,020评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,078评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,040评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,154评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,265评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,298评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,072评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,491评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,795评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,970评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,654评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,272评论 3 318
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,985评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,223评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,815评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,852评论 2 351

推荐阅读更多精彩内容