适合受众:2年以下的初级程序员和0基础的门外汉
内容大纲:
1.为什么需要一个好的代码结构
2.什么样才是一个好的结构
3.每一个分类代表什么含义
4.是否适用于WEB,Android和IOS?
5.进一步的学习的话,是要学习系统架构么?
一 为什么需要一个好的代码结构
好的代码结构并不仅仅是为了看上去清晰,它更像是我们对一个系统的拆解和组装。
好的代码结构可以让你在遇到代码交接这种天理不容的情况时,减少提刀砍人的可能性。
好的代码结构可以让多人协作开发更容易,而不会缠缠绵绵到天涯,再相爱相杀。
我们经常形容一个坏的代码结构,像屎一样。
![cb72db670015c00a41e4ae94dca2f696.png](https://i-blog.csdnimg.cn/blog_migrate/373eb1764edcec998ccce77ecdc61c98.png)
我们称它为一坨,说真的,接手过烂代码之后,真的找不到比屎更能描述自己感受的词了。
“屎”代表着混乱,一坨,各种杂质。接手一堆烂代码的难度就像是用一坨屎来做沙画。
有时候我们还会用一团毛线来形容代码,大概是这样的。
![be20baa5a09d51e2a9673010f18e31af.png](https://i-blog.csdnimg.cn/blog_migrate/47ee5ec5d1ce5b840c598f455faf4169.jpeg)
对的,这种感受是绝对不会错的。而我们要做的就是把这团毛线,变成像瑞士军刀一样的清晰。
![91b25db823ebd9e80d29884a47f0faa7.png](https://i-blog.csdnimg.cn/blog_migrate/568d9ea520e404da70a53192925ef3d4.jpeg)
你们觉得哪个更有成就感?
二 什么样才是一个好的结构
好的结构应该保持单一职责。
好的结构应该是通用的。
好的结构应该是有明确定义的。
这其实就是所谓的脚手架提供的最大的价值,一般而言,Java,Android,IOS都有一套明确的框架体系,JS本来没有,后来有了,然后。。他们就打起来了。
就像。。。他们一样。
![cdba8dced358d931cfb392eb94672664.png](https://i-blog.csdnimg.cn/blog_migrate/d0578eced3be70bdc6cbd91d4db1e463.jpeg)
该喷火的喷火,该喷水的喷水,每个人分工都很明确。
三 每一个分类代表什么含义
1.Model
Model是模型,一般而言,会有人分的更细,VO,DTO等等。我并不推荐分的更细,这个Model常常和持久化的数据一一对应,如Mysql和MongoDB。
Model承载的作用就是数据的抽象,描述了一个数据的定义,Model的实例就是一组组的数据。整个系统都可以看成是数据的 流动,既然要流动,就一定是有流动的载体。
![a1eb1d43fb619fefd29783a264faaa60.png](https://i-blog.csdnimg.cn/blog_migrate/79fdcbaea9fc51ccc7d71b3157ed0b16.jpeg)
这个红圈标的就是Model。它就应该是一个纯数据的集合,就是被各种东西传来传去,被各种加工处理的数据团。
通常会有很多Model,一条业务流就是对应一条或者多条数据流,拿知乎为例子。
文章是一个Model,一般叫Article,包括Title,Summary,Author,Content等等。
评论也是一个Model,一般叫Comment,包括Content,userID等等。
对于初学者而言,第一个要学会,就是建模,把业务逻辑映射成数据模型。
2.Util
Util是工具的意思,一般来说,常常用来描述和业务逻辑没有关系的数据处理。
Util一般要和私有方法对比:私有方法一般来说是只是在特地场景下使用的,私有方法越多,代码结构越乱。常见的重构策略就是首先从一个越长行数的代码里抽象出若干个私有方法,然后再抽出公用的Util。
如果有可能,尽可能的少用私有方法,而是把他换成一个公用的Util,代表他和业务逻辑是不相关的。通常命名也是ArticleUtil,CommentUtil之类的。
![7c1f2d69d81610c3503d319e1bc8bab4.png](https://i-blog.csdnimg.cn/blog_migrate/7593dbcce0ce42b99aa8ae146967931b.jpeg)
像这种打包,不管是充气娃娃还是别的什么东西,都打包。你可以理解为图中的黑衣人就是一个Util。
某中程度上也会跟Service有点接近。但是Service一般而言,都是包含有业务逻辑的,很少能做单元测试。
Util一般来说,就是一个明确的输入和一个明确的输出结果。单元测试中,多数也是来测试Util。
积累好自己的Util是一件很重要的事儿。
3 Service
Service比Util的概念大很多,它的重点是在于提供一个服务。这个服务可能包括一系列的数据处理,也有可能会调用多个Util,或者是调用别的服务。总归一句话,就是,有什么事情,你来找我。
![321b9f9ce24fef78ee48961074cafd3e.png](https://i-blog.csdnimg.cn/blog_migrate/11ac3e7ab15e45c34890033e18ddc51e.jpeg)
就像这个图上的妹妹一样,她就是一个Service,她能提供什么样的服务?这个是必须定义好的。如果是洗脚,她要帮你脱鞋,要端盆子烫你的脚。这里面,你的脚就是一个Model,盆子里的水相当于Util,不管里面放进去啥都能烫一烫。
帮你脱鞋可以是一个Service,也可以是一个私有函数,也可以是一个Util。看你的是让这个小妹妹帮你脱,还是别的小妹妹脱,还是自动脱鞋机。
如果是你自动脱。。。说明你在Model里面加上了功能,你的脚就不是一个纯粹的数据模型了,而是一个包含业务功能在里面的充血模型。
这样不好。老老实实让小妹妹帮你拖鞋不好么。
4.Dao
Dao一般而言,都是用来和底层数据库通信,负责对数据库的增删改查。
![5252414fb7f4999cf197292e1faaa5b6.png](https://i-blog.csdnimg.cn/blog_migrate/155fd1f980728bdb42e923db5d59bfdf.jpeg)
是的。他就是一个Dao。他从来不关心这些货物要去哪里,他只关心。入库,出库,查询和更换。
所谓的CRUD就是创建,读取,更新,删除。
Dao最好都是要独立出来。
到现在为止,最佳实践就是一个Service只对应一个Dao。Service会做一些额外的检查,如货物是否损坏,入库单是否完整,等等等等。
我并不推荐在Service里调用多个Dao,也推荐在Service里调用多个Service,大多数情况下我都不推荐这么干。
具体原因以后再说,这也是一个开放性的话题。
现在我们分清楚了Model,Util,Service和Dao,可是谁来做总的调度呢?
5.Controller
![4fa4cb3631af106931a14d360960e97a.png](https://i-blog.csdnimg.cn/blog_migrate/8dc2437cb0c09cb6e2e71f37e9eebb2b.jpeg)
控制中心,所有的指令,调度都从这里发出去。
哪一个Service做什么事儿,谁的数据提供给谁,一般而言,都是在Controller里实现的。
Controller也是最常见的容易产生脏代码地方,通常他们会把一些不该放到Controller里东西也放进来。
大概的感觉就是这样的。
![6198bd9c87077c8ed172b4c400bd7862.png](https://i-blog.csdnimg.cn/blog_migrate/ca5dc6581802280e2cad2f65728105e1.jpeg)
干嘛的都有。想想如果打小针,抽血,查尿也混杂到门诊大厅的感觉?
可是大部分人写代码就是这样的。
四.是否适用于WEB,Android和IOS?
Java后台是有很清楚的结构的,毕竟在JSP里写Sql语句的蛮荒时代已经过去了。
Android本身就是一个良好的框架体系,基本上问题也不大,最多就是MVP和MVC的差别之类。
IOS虽然没有官方提供这种框架体系,特别是很多人喜欢直接在Dict里用key取数据,这本身就破坏了代码的层次性。
但是毕竟是有李明杰提供的Json解析Util,只是各家要求的力度而已。
最难以理解的是WEB,也就是JS。
我不是在黑JS,我是在黑JS程序员。分层结构一直都不是JS社区里最注重的,在JQuery时代更是如此,不管是Html还是JS还是CSS混在一起是正常的。
那个时候叫插件,现在改名了,叫组件。
你很难在JQuery里找到一套清晰的分层结构,就跟十几年前所有的人都在Jsp里写逻辑语句的道理差不多。
直到google的大神偶尔遛达过来一看,咦?你们怎么还在刀耕火种?我来给你们加点现代感的东西吧。
于是Angular横穿出世,一次性的构建了一个清晰的框架结构。每次看到Angular的时候都忍不住 惊叹,原来前端代码也可以这样!
![72505d5c5bd16801b08e51f7a69f18d0.png](https://i-blog.csdnimg.cn/blog_migrate/071c0b96284eb82042f1847bced8e371.jpeg)
而原来的感觉就是这样。。。
![72855cd30a5edaad4b6eca00b1a94add.png](https://i-blog.csdnimg.cn/blog_migrate/dd2f49087c8964ac19fd5eb301f5f0c5.jpeg)
现在基本上可以分成两大阵营,一个是React和Vue,一个是Angular。
React和Vue本身更偏得于插件化,哦,不,组件化。所以他们需要便宜桶,来拼接整个前端的架构体系。
Angular却是有典型的Java架构风格,妥妥的硬汉子。
所以,实际上说,这套体系也是可以应用在WEB上的,就像Android和IOS一样的,但是你喜欢,或者不喜欢,自己选啦。
五 进一步的学习的话,是要学习系统架构么?
是的。进一步要学习,并不仅仅是学习系统架构。
这里还没有讲到Service的设计,互相之间的调用,解耦,服务之间的通信和管理。
消息队列这个神器还没有登场,MongoDB这种战略要塞也没出场。
所以以上内容,仅适用于2年以内的各种工程师。
来源:zhihu.com/question/58410621/answer/156868800