小弟我拒绝接受的几个最佳编程实践方法
import类,而不是import整个包
在很多语言里,这通常是一种被推荐的做法,有些甚至是必须的。如果是在C++里,这还算是有点意义,因为更少 #include 意味着更快的编译速度,然而,这种意义仅体现在需要花很长时间去编译的大型项目中。
而对很多像Java这样的语言,这毫无意义。因为它不影响编译的时间,所有你得到的回报只是花更多的努力来维护你的import语句。虽然IDE可以帮助你做这些事情,但你仍然需要时不时的多点几次鼠标/键盘,在版本控制系统里多留几条变更记录,干扰你的代码审查。有什么实际用处?向官僚机构表明代码很规范,无它用途。
面向接口编程
这项编程法则要求程序员定义接口,并针对接口来编程,而不是针对实现编程。理由非常简单:容易开发第二种实现,易于测试(真的吗?),更有效的使用代码。
问题就出在你不能凡事都按照这个原则。我个人认为,如果一个方法需要有多个实现,那使用接口是不二选择。但除此之外,如果你仍遵守的话,除了增加代码量,增添麻烦外,不会有任何好处。而且,把一个类重构成接口和它的实现并不困难,事实上是非常简单,所以,为什么一开始就要写接口呢,当需要时把它改造成接口也不晚。
禁用某种语言功能
在很多企业、组织使用的编码规范中,你会发现各种各样的类似于“不要使用goto语句”,“不要使用三元操作符”等规则。
如果一种语言的某种语法并未标志为“deprecated”,为什么不让人使用?当然,要正确的使用!即使像 goto 这样的语法同样可以让代码更可读、更易理解——只要你能以正确的方式、用在正确的地方。
使用Setters/getters,禁止public属性
这是最著名的Java风格,Java里任何公有属性都是不提倡的,任何属性都应该通过 setters 和 getters 操作,不允许有任何质疑。有些共用框架更加强化了这些。每次当我看到一个5年前的老类里只有一些私有属性和公有的无聊的 setters 和 getters ,我都会奇怪这是要干嘛?是为了增加代码量?是为了预防将来有可能出现意外的属性值修改?但是如果真的有人修改了,这又能起到什么预防效果?
单个返回语句
有人说多个返回语句会让代码变复杂。我发现却正好完全相反。当方法/函数在退出之前需要做一些收尾工作时,单一return语句会让函数更简单,但在其它很多情况下,这反而会让事情变得复杂,你需要添加额外的if-else来处理各种非正常退出情况。
尽量责任分离
我这里主要是针对“尽量”。有些人把这做到了极限,甚至有些变态。没错,把大的复杂的问题拆分成小的简单问题,这很好。但拆的太小就会引起新的问题。如果你把一棵树砍成牙签那么大小的块,你得到的就是一堆垃圾。
有些问题本身就是很复杂,你无法通过拆解来让它变简单。
为了让这篇文章有个比较积极的结尾,下面是我认为的放之四海皆准的最佳实践方法:
- 做任何事情都要有个理由
- 如果你做的未能符合预期,重做,替换方法或给予修正
- 扔掉垃圾通常是你最应该做的事情——不论这垃圾造价多高
本文转载自http://www.aqee.net/programming-best-practices-i-disaprove/
另外关于接口,我依然觉得文中说的有道理。事实上在当今世界上web开发中,90%的场景都是不需要第二实现的。
为什么这么说,原因就在于在web开发中,增删改查对于每一个实体几乎都是独立的,而对于每一个实体我们更愿意做的是分模块,对于相似的实体即便不分模块,也能通过代码和sql的改装做到复用,而不需要第二实现。
那么为什么j2ee会发展出这样的形式,那是因为在需求更多的系统中,除了sql相关的功能,会涉及到很多“server”相关的功能,涉及到file,io,socket,甚至操作系统操作。这部分其实是java server端软件开发的核心,比如我做一个nosql,涉及到存储模块,既需要文件存储,又需要内存存储,又需要可配置的其他存储,这时候接口实现继承等相关概念自然就出来了。而且做到外部可配置的存储,必然需要给用户提供一个interface。另外数据在网络中传输需要的序列化方式,数据的加密方式,这些都是可以做成接口,让用户自行扩展的。
但是这一切,在web中的使用场景非常的少。毕竟web系统是真实世界模型在网络上的投影,而增删改查几乎就是世界的全部。
但是,毕竟是前辈们总结出来的经验, 如果要反驳掉,必须拿出自己的最佳方式出来。这样才有效力,让别人闭嘴。
如果一味的反驳别人的劳动成果,估计就是招来一群人喷的。
大多数都是规定。 就跟暗号一样。不遵守这个规定,就不行的。
另外关于接口,我依然觉得文中说的有道理。事实上在当今世界上web开发中,90%的场景都是不需要第二实现的。
为什么这么说,原因就在于在web开发中,增删改查对于每一个实体几乎都是独立的,而对于每一个实体我们更愿意做的是分模块,对于相似的实体即便不分模块,也能通过代码和sql的改装做到复用,而不需要第二实现。
那么为什么j2ee会发展出这样的形式,那是因为在需求更多的系统中,除了sql相关的功能,会涉及到很多“server”相关的功能,涉及到file,io,socket,甚至操作系统操作。这部分其实是java server端软件开发的核心,比如我做一个nosql,涉及到存储模块,既需要文件存储,又需要内存存储,又需要可配置的其他存储,这时候接口实现继承等相关概念自然就出来了。而且做到外部可配置的存储,必然需要给用户提供一个interface。另外数据在网络中传输需要的序列化方式,数据的加密方式,这些都是可以做成接口,让用户自行扩展的。
但是这一切,在web中的使用场景非常的少。毕竟web系统是真实世界模型在网络上的投影,而增删改查几乎就是世界的全部。
另外关于接口,我依然觉得文中说的有道理。事实上在当今世界上web开发中,90%的场景都是不需要第二实现的。
为什么这么说,原因就在于在web开发中,增删改查对于每一个实体几乎都是独立的,而对于每一个实体我们更愿意做的是分模块,对于相似的实体即便不分模块,也能通过代码和sql的改装做到复用,而不需要第二实现。
那么为什么j2ee会发展出这样的形式,那是因为在需求更多的系统中,除了sql相关的功能,会涉及到很多“server”相关的功能,涉及到file,io,socket,甚至操作系统操作。这部分其实是java server端软件开发的核心,比如我做一个nosql,涉及到存储模块,既需要文件存储,又需要内存存储,又需要可配置的其他存储,这时候接口实现继承等相关概念自然就出来了。而且做到外部可配置的存储,必然需要给用户提供一个interface。另外数据在网络中传输需要的序列化方式,数据的加密方式,这些都是可以做成接口,让用户自行扩展的。
但是这一切,在web中的使用场景非常的少。毕竟web系统是真实世界模型在网络上的投影,而增删改查几乎就是世界的全部。
set/get并非只是规范,而是有益才被广泛使用,写代码和做设计久了就会明白得;
90%不需要第二实现?这个90%是从哪里来的?接口的用处到底是什么?还是请深入理解面向对象编程的内涵;
增删改查怎么会是世界的全部呢?只是数据的存取嘛!
另外关于接口,我依然觉得文中说的有道理。事实上在当今世界上web开发中,90%的场景都是不需要第二实现的。
为什么这么说,原因就在于在web开发中,增删改查对于每一个实体几乎都是独立的,而对于每一个实体我们更愿意做的是分模块,对于相似的实体即便不分模块,也能通过代码和sql的改装做到复用,而不需要第二实现。
那么为什么j2ee会发展出这样的形式,那是因为在需求更多的系统中,除了sql相关的功能,会涉及到很多“server”相关的功能,涉及到file,io,socket,甚至操作系统操作。这部分其实是java server端软件开发的核心,比如我做一个nosql,涉及到存储模块,既需要文件存储,又需要内存存储,又需要可配置的其他存储,这时候接口实现继承等相关概念自然就出来了。而且做到外部可配置的存储,必然需要给用户提供一个interface。另外数据在网络中传输需要的序列化方式,数据的加密方式,这些都是可以做成接口,让用户自行扩展的。
但是这一切,在web中的使用场景非常的少。毕竟web系统是真实世界模型在网络上的投影,而增删改查几乎就是世界的全部。
90%都会有第二种实现的。 其中一个是mock
就冲你第一点,我就不想往下看了,你先回去看看书,然后说话吧,楼主
set/get并非只是规范,而是有益才被广泛使用,写代码和做设计久了就会明白得;
90%不需要第二实现?这个90%是从哪里来的?接口的用处到底是什么?还是请深入理解面向对象编程的内涵;
增删改查怎么会是世界的全部呢?只是数据的存取嘛!
第一点我想说,同意“存在即合理”,但这只有指导意义,但不应该成为大家思维的阻碍。
第二点,接口的用处我已经用例子说明了,请看完嘛,不要只看一半就气冲冲回我让我“深入理解面向对象编程”……
get/set的用处还真不好去体现,但是做的久了就会发现。这是软件工程学的“信息隐藏”,成员变量里的一个属性,未必就等于get接口的返回值。
例如
Person类,有个属性是出生年月日,可以set,但是可能没有get这个属性的接口,只有get年龄的接口。
至于你说不应当成为障碍,这个很赞成。什么时候需要用这个,什么时候不需要,得用心思考的。
哈哈,我不是楼主
你的信息隐藏我觉得说得对,当然这种由业务控制,由程序员控制的事情是不是一定得靠getset代码来限制就说不清了,所以还是我说的不可证实,不可证伪。合理也是合理,不写也可以不写,哈哈。
关于第二点看来对后面的实质内容提不出什么异议,就算是也认可了吧,哈哈。至于这90%不知道我说估算出来的算不算 ,或者作为一个开放性命题,看到的大伙都来说说自己实践中都有怎样的多实现?反正这种接口的优势我只在做java server开发的经历中体会到过,web的确没体会过。
哎 , iteye论坛真是要完了!
1, 楼主除了发了个主贴就从来没出现过了
2, 文章涵盖太广泛, 观点也不尽相似.
结论: 这个楼主只是随随便便上网找了些文章发出来, 甚至<转载>这样的标签也懒得加上.
另外最近首页突然出现好几篇鸡汤……
这个好处体现在代码阅读时。
可以给阅读者一个总体的概览,粗粗浏览一下当前类依赖的外部类,结合当前类名、包结构,可以快速猜测当前类的实现目标、实现方式。
增强了代码的可读性。
接口体现的是业务模型中的“概念”,接口给了软件结构一个清晰的描述。
多人协作时,依赖其他(人/其他模块)提供的接口,是非常重要的。
如果连接口都无法清晰的划定,说明软件结构的职责、概念没有理清楚,
依赖于实现的代码,一般软件结构上都是混乱的。
接口体现的是业务模型中的“概念”,接口给了软件结构一个清晰的描述。
多人协作时,依赖其他(人/其他模块)提供的接口,是非常重要的。
如果连接口都无法清晰的划定,说明软件结构的职责、概念没有理清楚,
依赖于实现的代码,一般软件结构上都是混乱的。
楼主一个人能开发出一个魔兽,或者微软的一个操作系统,所以面向接口对他来说不是什么高级货,还会影响进度。。
文章作者(估计不是博主)可能没遇过因为种种历史原因同一个包名被分散在多个jar包中的情况。明确import类有助于在阅读代码时理清依赖关系。
2)面向接口编程
程序不仅仅是要一次运行,还要给别人看和用(二次开发)的。接口除了功能上可以轻易改变实现外,还可以告诉后续开发的程序员:这里是设计来给你改实现的。而不实现接口的类,则暗示这是一个内部实现,如果你改实现的话原作者在更新时不保证能向前兼容。
3)禁用某种语言功能
通用语言是设计来解决"所有“问题的,必然对各种边界场景有完善的应对措施,但某些边界条件不是企业业务的常态而且有明显副作用,一个企业针对自身情况从政策上禁用某些有明显副作用的语言特性,很正常。
4)使用Setters/getters,禁止public属性
这个作者可能不知道有动态代理这回事。
5)单个返回语句
这一点本来没有问题,在一个职责单一的方法里,先对一些简单边界情况进行处理返回,然后再处理正常主线逻辑,是很常见的做法(Java类库里这样的做法就有不少)。但这个作者同时又反对”尽量责任分离”则有很大问题,一个长方法里有多处返回点,会让阅读者不知道这个方法在干什么。而且如果你在排错时如果想跟踪这个方法每次被调用的返回值,则需要打多处断点。
6)尽量责任分离
比喻错误,如果你把一颗树砍成牙签那么大小的块,但这些牙签大小的块仍然有序地结合为树木的形状并且保持稳定(编程里你把方法按职责拆分后,仍然会有高层的方法把这些小方法有序组织起来),那就不是垃圾,而是卖得很贵的乐高积木
7) 放之四海皆准的最佳实践方法
做任何事情都要有个理由 ———— 反对任何事也应有个理由
如果你做的未能符合预期,重做,替换方法或给予修正 ———— 作者所反对的那些事情,恰恰是在保证程序能方便地“重做,替换或给予修正”
扔掉垃圾通常是你最应该做的事情——不论这垃圾造价多高 ————— 首先你得搞清楚为何这堆造价这么高的东西会被认为是垃圾。