DRY原则与Web开发抽象

DRY不是口渴,而是Pythoner常说的 Don't Repeat Yourself 的缩写。写了一些工程之后,发现这个原则需要依赖于不断地知识积累以及代码重构的追求。

两大类Web框架:Twisted/Cyclone/Tornado和Flask/Flask-AppBuilder

我的物联网开发基于两大类Python框架平台:Twisted和Flask,其中基于Twisted的Bottle/Cyclone以及极其类似的近亲Tornado用于设备连接,而Flask用于应用服务的迭代。

最近使用过Flask-AppBuilder,以及类似的Flask-admin之后,回首发现自己在Cyclone上的开发有许多重复的地方,需要代码重构,抽取共同特性,砍去冗余代码。

Flask-AppBuilder开发后台程序极快,主要是将UI标准化了,而且ORM和UI整合后,几乎不用再修改前端代码。页面设计也标准化为List + CRUD五类操作,同时引入ORM的相关视图实现关联操作。页面中的大多数字符串资源都被抽取出来。

而我之前的Cyclone代码,虽然有最简单的ORM,但是我却没有采用,不仅仅底层的SQL/Redis操作需要手工编码,连带前端网页也都不那么标准化。

代码重构从建模开始

代码重构依然从建模开始评估,然后以每张表为主建立面向资源的终点URL,原则与RESTful API类似。然后增加List + CRUD五类操作的标准化页面。相关资源的视图需要抽取共同特性,在控制器中以手工代码关联。同时增加Form表单。而非标准的UI,例如地图,外部API等,以Widget方式插入。

UI的模板也需要评估一下,并且合并重复的部分。

List列表视图的抽象

每种资源的列表页面是可以最大程度进行抽象的。列表页面UI部分有页眉、边框、内容容器和页脚。其中内容部分与资源有关,除了上下文帮助,大体都与数据库一一对应。数据库的数据行大多使用表格方式呈现出来,我选择DataTable插件。

每个表格由th和tr两种标签组成,分别对应ORM的键值。其中键对应th,值对应tr。th和tr的数量、种类、字符串可以在controller里转换一次。每行数据打头为数据库数据主键id,可以直接拓展为CRUD中的RUD操作URL。

如果除了标注CURD操作,还有其他操作,比如相关视图等,可以在controller中为ORM实例对象添加属性或dict的键值对。这样在UI中可以直接产生对应的URL和图标。

同一组模板,如果抽取出资源名称、ORM对象属性和键值对、显示顺序、相关视图属性等,可以最大程度地统一视图,减少工作量。

CRUD的其他视图

在List视图中的表格中,可以实现CRUD操作。一般来说:

  • Create,需要一个单独的Form,目前只能够实现部分的抽象;
  • Read,详细表格可以实现抽象,但是如果同时显示相关视图就有些困难,此外还有一些定制的视图需求,比如地图、多媒体、以及其他非结构化数据的呈现方式;
  • Update,可以与Create复用,但是许多情况下Create和Update之间还有权限的差异;
  • Delete,直接在List视图中删除,没有专门视图。

所以,尽管DRY是个很好的原则,但是我们势必在标准化页面中夹杂不同的定制页面。

Form表单的抽象

Twisted/Cyclone/Tornado一脉的Form还是比较原始的。而Web Form表单在Flask一脉中大多使用wtforms组件。实际上,Tornado也有对应的版本,wtforms-tornado。所以即使前者也可以使用wtforms来减少工作量。

使用了Form表单之后,可以简化了Create/Update两个视图。Delete基本上是一个AJAX终点,而Show视图可以通过JSON/dict传输方式来统一视图。

Controller控制器的抽象

页面抽象后,我们会发现控制器代码也遵循某种特定的模式不断地重复。这个需要依赖类的继承、装饰器等各种方式进行抽象。

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

推荐阅读更多精彩内容

  • # Python 资源大全中文版 我想很多程序员应该记得 GitHub 上有一个 Awesome - XXX 系列...
    aimaile阅读 26,454评论 6 428
  • 原文链接: http://www.jianshu.com/p/9c6ae64a1bd7 GitHub 上有一个 A...
    李绍俊阅读 6,099评论 0 92
  • 环境管理管理Python版本和环境的工具。p–非常简单的交互式python版本管理工具。pyenv–简单的Pyth...
    MrHamster阅读 3,788评论 1 61
  • 那年搬家,我应该是四岁。土木结构的新房。门前有条铁路,每天上午一班,下午一班客车,晚上还有货车经过。客车是绿皮火车...
    晓康农哥阅读 614评论 2 1
  • 定西 清晨的阳光逐渐照亮了青岚乡,在蓝天白云的映衬下,我们走下层层坡路来到昨天的劳动地点。农田上的农民亲热地招呼我...
    习习晨风阅读 146评论 0 0