代码架构设计-1.为什么要做好代码架构设计

在项目的开始阶段,一件必不可少的的事情就是就是确定代码的分层和架构。该分层和架构在一定程度上决定了未来整个项目的代码风格和维护性,对于项目的长期维护,代码架构的设计是一件非常重要的事情。
在介绍代码架构的设计之前,首先我们先谈论下为什么代码架构的设计师是一件非常重要的事情。

为什么要有代码架构

简单来讲,代码架构是为了提供更好的可读性和可维护性。

提高可读性和可维护性

大家可能还记得刚开始写代码的时候,所有的代码都会集中在一个文件,甚至一个函数中,比如:

# main.py

def main(args: List[str]):
    input args validation...
    ...
    do first thing...
    ...
    do second thing...
    ...
    do third thing...
    ...

随着需求的增长,代码量的扩大,这样的代码是很难阅读和进行维护的,于是我们会使用重构的手段去让代码更便于维护和阅读:

# main.py

def do_first_thing(args: List[str]):
    ...

def do_second_thing(args: List[str]):
    ...

def do_third_thing(args: List[str]):
    ...

def validation(args: List[str]):
    ...

def main(args: List[str]):
    validation(args)
    do_first_thing(args)
    do_second_thing(args)
    do_third_thing(args)

进一步,我们将代码分散在不同的文件、文件夹中,通过良好的命名,我们甚至可以在不去看具体的代码实现的情况下,仅仅通过文件名就能判断出在做的事情:

│   main.py
│
├───job
│       first.py
│       second.py
│       third.py
│
└───validation
        input_params_validation.py

而更深层次的,代码架构的设计会降低代码的腐化速度

降低代码的腐化速度

通常在一个项目新起的时候,项目代码的可读性,维护性都会做的很好,然而随着项目的庞大,不同背景不同能力的开发人员的进场和离场,代码的可读性和可维护性都会渐渐的变差,这个是一个项目进行过程中不可避免的,聪明的团队通常不但会制定一系列的比如代码质量扫描,代码review等手段降低代码的腐化速度,还会在在需求的开发过程中安排一定资源的代码重构的任务,去不断重构腐化的代码。
而一个好的代码架构,也会在一定程度上制约开发人员“生产”腐化代码的可能,从而降低了代码的腐化速度。这是因为在制定了代码架构之后,入场的开发人员们通常会选择遵从代码架构的规则编写代码,通过规则的制约,可以很好的制止一些不谨慎的代码的产生。
我们通过一个反例来看看,一个不好的代码架构会对项目的开发产生怎样的影响。
在一个真实项目中,大家制订了一个这样的简单代码架构:


项目代码使用简单的Controller->Service->Repository->Entity分层,其中Entity层作为数据库的映射,并且整个代码架构中,可以随意传递entity, 甚至直接将entity传递出去

这样的代码架构会导致以下几个问题:

  1. 没有DTO的存在,开发人员会因为方便倾向于把entity直接丢出去作为request和response的数据映射。这样当出现传入参数和数据库table设计出现不一致时,会出现很多的代码问题。
  2. 由于并没有任何相关的约束并且由于#1,开发人员有可能将业务逻辑相关的代码同时放在controller和service中。这种做法会导致controller和service层出现强耦合,并且业务逻辑被分散在代码的各个角落,导致很难去阅读进一步降低可维护性。
  3. 由于代码的事务控制是在service层做的,因为#2的原因,很多人在开发过程中并没有一个对系统的全局概念,直接导致了很多的业务代码出现了只能部分回滚数据的问题,直接导致的很多bug的出现。

由上文可以看到,一个好的代码架构设计对于项目的必要性。接下来将介绍在web service中,比较常使用的代码组织架构。

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,745评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,629评论 18 139
  • 1. 操作步骤 进入到东方财富通界面,在左侧任意位置点击鼠标右键,在弹出的界面中选择“添加技术指标” 点击添加技术...
    小闫小闫阅读 38,338评论 0 2
  • 三毛【撒哈拉的故事】也许生活本身就是一片广袤的沙漠,需得我们自己用心装点自己的小世界,营造一片世外桃源,这样我们也...
    老高cua阅读 335评论 0 0
  • 和木屑、刨花一起,可制成质轻、隔音、绝热、耐火的纤维板。
    Plasmnova阅读 351评论 0 0