JAVA根蒂根基:JAVA代码编写的30条建议
添加时间:2013-6-11 点击量:
JAVA代码编写的30条建议
(1) 类名首字母应当大写。字段、办法以及对象(句柄)的首字母应小写。对于所有标识符,此中包含的所有单词都应紧靠在一路,并且大写中心单词的首字母。例如:
ThisIsAClassName
thisIsMethodOrFieldName
若在定义中呈现了常数初始化字符,则大写static final根蒂根基类型标识符中的所有字母。如许便可标记出它们属于编译期的常数。
Java包(Package)属于一种特别景象:它们全都是小写字母,即便中心的单词亦是如此。对于域名扩大名称,如com,org,net或者edu等,全部都应小写(这也是Java 1.1和Java 1.2的差别之一)。
(2) 为了常规用处而创建一个类时,请采取"经典情势",并包含对下述元素的定义:
equals()
hashCode()
toString()
clone()(implement Cloneable)
implement Serializable
(3) 对于本身创建的每一个类,都推敲置入一个main(),此中包含了用于测试那个类的代码。为应用一个项目中的类,我们没须要删除测试代码。若进行了任何情势的批改,可便利地返回测试。这些代码也可作为如何应用类的一个示例应用。
(4) 应将办法设计成扼要的、功能性单位,用它描述和实现一个不连气儿的类接口项目组。幻想景象下,办法应简明扼要。若长度很大,可推敲经由过程某种体式格式将其分别成较短的几个办法。如许做也便于类内代码的反复应用(有些时辰,办法必须很是大,但它们仍应只做同样的一件工作)。
(5) 设计一个类时,请设身处地为客户法度员推敲一下(类的应用办法应当是很是明白的)。然后,再设身处地为经管代码的人推敲一下(估计有可能进行哪些情势的批改,想想用什么办法可把它们变得更简单)。
(6) 使类尽可能短小精干,并且只解决一个特定的题目。下面是对类设计的一些建议:
■一个错杂的开关语句:推敲采取"多形"机制
■数量浩繁的办法涉及到类型差别极大的操纵:推敲用几个类来分别实现
■很多成员变量在特点上有很大的差别:推敲应用几个类
(7) 让一切器材都尽可能地"私有"--private。可使库的某一项目组"公共化"(一个办法、类或者一个字段等等),就永远不克不及把它拿出。若强行拿出,就可能破损其他人现有的代码,使他们不得不从头编写和设计。若只发布本身必须发布的,就可宁神大胆地改变其他任何器材。在多线程景象中,是希罕首要的一个身分--只有private字段才干在非同步应用的景象下受到保护。
(8) 谨惕"重大对象综合症"。对一些习惯于次序编程思维、且初涉OOP范畴的新手,往往喜好先写一个次序履行的法度,再把它嵌入一个或两个重大的对象里。按照编程道理,对象表达的应当是应用法度的概念,而非应用法度本身。
(9) 若不得已进行一些不太美观的编程,至少应当把那些代码置于一个类的内部。
(10) 任何时辰只要发明类与类之间连络得很是慎密,就须要推敲是否采取内部类,从而改良编码及保护工作(拜见第14章14.1.2末节的"用内部类改进代码")。
(11) 尽可能详尽地加上注释,并用javadoc注释文档语法生成本身的法度文档。
(12) 避免应用"魔法术字",这些数字很难与代码很好地共同。如今后须要批改它,无疑会成为一场恶梦,因为底子不知道"100"到底是指"数组大小"还是"其他全然不合的器材"。所以,我们应创建一个常数,并为其运器具有说服力的描述性名称,并在全部法度中都采取常数标识符。如许可使法度更易懂得以及更易保护。
(13) 涉及构建器和异常的时辰,凡是从头丢弃在构建器中捕获的任何异常--若是它造成了那个对象的创建失败。如许一来,调用者就不会认为那个对象已正确地创建,从而盲目地持续。
(14) 当客户法度员用完对象今后,若你的类请求进行任何清除工作,可推敲将清除代码置于一个杰出定义的办法里,采取类似于cleanup()如许的名字,明白注解本身的用处。除此以外,可在类内放置一个boolean(布尔)标识表记标帜,指出对象是否已被清除。在类的finalize()办法里,请断定对象已被清除,并已丢弃了从RuntimeException持续的一个类(若是还没有的话),从而指出一个编程错误。在采取象如许的规划之前,请断定finalize()可以或许在本身的体系中工作(可能须要调用System.runFinalizersOnExit(true),从而确保这一行动)。
(15) 在一个特定的感化域内,若一个对象必须清除(非由垃圾收集机制处理惩罚),请采取下述办法:初始化对象;若成功,则立即进入一个含有finally从句的try块,开端清除工作。
(16) 若在初始化过程中须要覆盖(作废)finalize(),请记住调用super.finalize()(若Object属于我们的直接超类,则无此须要)。在对finalize()进行覆盖的过程中,对super.finalize()的调用应属于最后一个步履,而不该是第一个步履,如许可确保在须要根蒂根基类组件的时辰它们依然有效。
(17) 创建大小固定的对象集应时,请将它们传输至一个数组(若筹办从一个办法里返回这个凑集,更应如此操纵)。如许一来,我们就可享受到数组在编译期进行类型搜检的益处。此外,为应用它们,数组的接管者也许并不须要将对象"造型"到数组里。
(18) 尽量应用interfaces,不要应用abstract类。若已知某样器材筹办成为一个根蒂根基类,那么第一个选择应是将其变成一个interface(接口)。只有在不得不应用办法定义或者成员变量的时辰,才须要将其变成一个abstract(抽象)类。接口首要描述了客户做什么工作,而一个类则致力于(或容许)具体的实验细节。
(19) 在构建器内部,只进行那些将对象设为正确状况所需的工作。尽可能地避免调用其他办法,因为那些办法可能被其他人覆盖或作废,从而在构建过程中产生不成预知的成果(拜见第7章的具体申明)。
(20) 对象不该只是简单地容纳一些数据;它们的行动也应获得杰出的定义。
(21) 在现成类的根蒂根基上创建新类时,请起推荐择"新建"或"创作"。只有本身的设计请求必须持续时,才应推敲这方面的题目。若在底本容许新建的场合应用了持续,则全部设计会变得没有须要地错杂。
(22) 用持续及办法覆盖来默示行动间的差别,而用字段默示状况间的差别。一个很是极端的例子是经由过程对不合类的持续来默示色彩,这是绝对应当避免的:应直接应用一个"色彩"字段。
(23) 为避免编程时碰到麻烦,请包管在本身类路径指到的任何处所,每个名字都仅对应一个类。不然,编译器可能先找到同名的另一个类,并呈报失足消息。若思疑本身碰着了类路径题目,请尝尝在类路径的每一个出发点,搜刮一下同名的.class文件。
(24) 在Java 1.1 AWT中应用事务"适配器"时,希罕轻易碰着一个陷阱。若覆盖了某个适配器办法,同时拼写办法没有希罕讲求,最后的成果就是新添加一个办法,而不是覆盖现成办法。然而,因为如许做是完全合法的,所以不会从编译器或运行期体系获得任何失足提示--只不过代码的工作就变得不正常了。
(25) 用公道的设计规划打消"伪功能"。也就是说,假若只须要创建类的一个对象,就不要提前限制本身应用应用法度,并加上一条"只生成此中一个"注释。请推敲将其封装成一个"独生子"的情势。若在主法度里有多量狼藉的代码,用于创建本身的对象,请推敲采取一种发明性的规划,将些代码封装起来。
(26) 警惕"解析瘫痪"。请记住,无论如何都要提前懂得全部项目标状况,再去查核此中的细节。因为把握了全局,可快速熟悉本身未知的一些身分,防止在查核细节的时辰陷入"死逻辑"中。
(27) 警惕"过早优化"。起首让它运行起来,再推敲变得更快--但只有在本身必须如许做、并且经证其实某项目组代码中的确存在一个机能瓶颈的时辰,才应进行优化。除非用专门的对象解析瓶颈,不然很有可能是在浪费本身的时候。机能提拔的隐含价格是本身的代码变得难于懂得,并且难于保护。
(28) 请记住,浏览代码的时候比写代码的时候多得多。思路清楚的设计可获得易于懂得的法度,但注释、详尽的申明以及一些示例往往具有不成估计的价值。无论对你本身,还是对后来的人,它们都是相当首要的。如对此仍有思疑,那么请试想本身试图从联机Java文档里找出有效信息时碰着的挫折,如许或许能将你说服。
(29) 如认为本身已进行了杰出的解析、设计或者实验,那么请稍微调换一下思维角度。尝尝邀请一些外来人士--并不必然是专家,但可所以来自本公司其他项目组的人。请他们用完全新鲜的目光查核你的工作,看看是否能找出你一度熟视无睹的题目。采取这种体式格式,往往能在合适批改的阶段找出一些关键性的题目,避免产品发行后再解决题目而造成的金钱及精力方面的丧失。
(30) 杰出的设计能带来大回报。简言之,对于一个特定的题目,凡是会花较长的时候才干找到一种最恰当的解决规划。但一旦找到了正确的办法,今后的工作就轻松多了,再也不消经验数小时、数天或者数月的疾苦挣扎。我们的尽力工作会带来大回报(甚至无可估计)。并且因为本身倾泻了多量心血,终极获得一个超卓的设计规划,成功的快感也是令人心动的。对峙草草落成的诱惑--那样做往往得不偿失。
容易发怒的意思就是: 别人做了蠢事, 然后我们代替他们, 表现出笨蛋的样子。—— 蔡康永
JAVA代码编写的30条建议
(1) 类名首字母应当大写。字段、办法以及对象(句柄)的首字母应小写。对于所有标识符,此中包含的所有单词都应紧靠在一路,并且大写中心单词的首字母。例如:
ThisIsAClassName
thisIsMethodOrFieldName
若在定义中呈现了常数初始化字符,则大写static final根蒂根基类型标识符中的所有字母。如许便可标记出它们属于编译期的常数。
Java包(Package)属于一种特别景象:它们全都是小写字母,即便中心的单词亦是如此。对于域名扩大名称,如com,org,net或者edu等,全部都应小写(这也是Java 1.1和Java 1.2的差别之一)。
(2) 为了常规用处而创建一个类时,请采取"经典情势",并包含对下述元素的定义:
equals()
hashCode()
toString()
clone()(implement Cloneable)
implement Serializable
(3) 对于本身创建的每一个类,都推敲置入一个main(),此中包含了用于测试那个类的代码。为应用一个项目中的类,我们没须要删除测试代码。若进行了任何情势的批改,可便利地返回测试。这些代码也可作为如何应用类的一个示例应用。
(4) 应将办法设计成扼要的、功能性单位,用它描述和实现一个不连气儿的类接口项目组。幻想景象下,办法应简明扼要。若长度很大,可推敲经由过程某种体式格式将其分别成较短的几个办法。如许做也便于类内代码的反复应用(有些时辰,办法必须很是大,但它们仍应只做同样的一件工作)。
(5) 设计一个类时,请设身处地为客户法度员推敲一下(类的应用办法应当是很是明白的)。然后,再设身处地为经管代码的人推敲一下(估计有可能进行哪些情势的批改,想想用什么办法可把它们变得更简单)。
(6) 使类尽可能短小精干,并且只解决一个特定的题目。下面是对类设计的一些建议:
■一个错杂的开关语句:推敲采取"多形"机制
■数量浩繁的办法涉及到类型差别极大的操纵:推敲用几个类来分别实现
■很多成员变量在特点上有很大的差别:推敲应用几个类
(7) 让一切器材都尽可能地"私有"--private。可使库的某一项目组"公共化"(一个办法、类或者一个字段等等),就永远不克不及把它拿出。若强行拿出,就可能破损其他人现有的代码,使他们不得不从头编写和设计。若只发布本身必须发布的,就可宁神大胆地改变其他任何器材。在多线程景象中,是希罕首要的一个身分--只有private字段才干在非同步应用的景象下受到保护。
(8) 谨惕"重大对象综合症"。对一些习惯于次序编程思维、且初涉OOP范畴的新手,往往喜好先写一个次序履行的法度,再把它嵌入一个或两个重大的对象里。按照编程道理,对象表达的应当是应用法度的概念,而非应用法度本身。
(9) 若不得已进行一些不太美观的编程,至少应当把那些代码置于一个类的内部。
(10) 任何时辰只要发明类与类之间连络得很是慎密,就须要推敲是否采取内部类,从而改良编码及保护工作(拜见第14章14.1.2末节的"用内部类改进代码")。
(11) 尽可能详尽地加上注释,并用javadoc注释文档语法生成本身的法度文档。
(12) 避免应用"魔法术字",这些数字很难与代码很好地共同。如今后须要批改它,无疑会成为一场恶梦,因为底子不知道"100"到底是指"数组大小"还是"其他全然不合的器材"。所以,我们应创建一个常数,并为其运器具有说服力的描述性名称,并在全部法度中都采取常数标识符。如许可使法度更易懂得以及更易保护。
(13) 涉及构建器和异常的时辰,凡是从头丢弃在构建器中捕获的任何异常--若是它造成了那个对象的创建失败。如许一来,调用者就不会认为那个对象已正确地创建,从而盲目地持续。
(14) 当客户法度员用完对象今后,若你的类请求进行任何清除工作,可推敲将清除代码置于一个杰出定义的办法里,采取类似于cleanup()如许的名字,明白注解本身的用处。除此以外,可在类内放置一个boolean(布尔)标识表记标帜,指出对象是否已被清除。在类的finalize()办法里,请断定对象已被清除,并已丢弃了从RuntimeException持续的一个类(若是还没有的话),从而指出一个编程错误。在采取象如许的规划之前,请断定finalize()可以或许在本身的体系中工作(可能须要调用System.runFinalizersOnExit(true),从而确保这一行动)。
(15) 在一个特定的感化域内,若一个对象必须清除(非由垃圾收集机制处理惩罚),请采取下述办法:初始化对象;若成功,则立即进入一个含有finally从句的try块,开端清除工作。
(16) 若在初始化过程中须要覆盖(作废)finalize(),请记住调用super.finalize()(若Object属于我们的直接超类,则无此须要)。在对finalize()进行覆盖的过程中,对super.finalize()的调用应属于最后一个步履,而不该是第一个步履,如许可确保在须要根蒂根基类组件的时辰它们依然有效。
(17) 创建大小固定的对象集应时,请将它们传输至一个数组(若筹办从一个办法里返回这个凑集,更应如此操纵)。如许一来,我们就可享受到数组在编译期进行类型搜检的益处。此外,为应用它们,数组的接管者也许并不须要将对象"造型"到数组里。
(18) 尽量应用interfaces,不要应用abstract类。若已知某样器材筹办成为一个根蒂根基类,那么第一个选择应是将其变成一个interface(接口)。只有在不得不应用办法定义或者成员变量的时辰,才须要将其变成一个abstract(抽象)类。接口首要描述了客户做什么工作,而一个类则致力于(或容许)具体的实验细节。
(19) 在构建器内部,只进行那些将对象设为正确状况所需的工作。尽可能地避免调用其他办法,因为那些办法可能被其他人覆盖或作废,从而在构建过程中产生不成预知的成果(拜见第7章的具体申明)。
(20) 对象不该只是简单地容纳一些数据;它们的行动也应获得杰出的定义。
(21) 在现成类的根蒂根基上创建新类时,请起推荐择"新建"或"创作"。只有本身的设计请求必须持续时,才应推敲这方面的题目。若在底本容许新建的场合应用了持续,则全部设计会变得没有须要地错杂。
(22) 用持续及办法覆盖来默示行动间的差别,而用字段默示状况间的差别。一个很是极端的例子是经由过程对不合类的持续来默示色彩,这是绝对应当避免的:应直接应用一个"色彩"字段。
(23) 为避免编程时碰到麻烦,请包管在本身类路径指到的任何处所,每个名字都仅对应一个类。不然,编译器可能先找到同名的另一个类,并呈报失足消息。若思疑本身碰着了类路径题目,请尝尝在类路径的每一个出发点,搜刮一下同名的.class文件。
(24) 在Java 1.1 AWT中应用事务"适配器"时,希罕轻易碰着一个陷阱。若覆盖了某个适配器办法,同时拼写办法没有希罕讲求,最后的成果就是新添加一个办法,而不是覆盖现成办法。然而,因为如许做是完全合法的,所以不会从编译器或运行期体系获得任何失足提示--只不过代码的工作就变得不正常了。
(25) 用公道的设计规划打消"伪功能"。也就是说,假若只须要创建类的一个对象,就不要提前限制本身应用应用法度,并加上一条"只生成此中一个"注释。请推敲将其封装成一个"独生子"的情势。若在主法度里有多量狼藉的代码,用于创建本身的对象,请推敲采取一种发明性的规划,将些代码封装起来。
(26) 警惕"解析瘫痪"。请记住,无论如何都要提前懂得全部项目标状况,再去查核此中的细节。因为把握了全局,可快速熟悉本身未知的一些身分,防止在查核细节的时辰陷入"死逻辑"中。
(27) 警惕"过早优化"。起首让它运行起来,再推敲变得更快--但只有在本身必须如许做、并且经证其实某项目组代码中的确存在一个机能瓶颈的时辰,才应进行优化。除非用专门的对象解析瓶颈,不然很有可能是在浪费本身的时候。机能提拔的隐含价格是本身的代码变得难于懂得,并且难于保护。
(28) 请记住,浏览代码的时候比写代码的时候多得多。思路清楚的设计可获得易于懂得的法度,但注释、详尽的申明以及一些示例往往具有不成估计的价值。无论对你本身,还是对后来的人,它们都是相当首要的。如对此仍有思疑,那么请试想本身试图从联机Java文档里找出有效信息时碰着的挫折,如许或许能将你说服。
(29) 如认为本身已进行了杰出的解析、设计或者实验,那么请稍微调换一下思维角度。尝尝邀请一些外来人士--并不必然是专家,但可所以来自本公司其他项目组的人。请他们用完全新鲜的目光查核你的工作,看看是否能找出你一度熟视无睹的题目。采取这种体式格式,往往能在合适批改的阶段找出一些关键性的题目,避免产品发行后再解决题目而造成的金钱及精力方面的丧失。
(30) 杰出的设计能带来大回报。简言之,对于一个特定的题目,凡是会花较长的时候才干找到一种最恰当的解决规划。但一旦找到了正确的办法,今后的工作就轻松多了,再也不消经验数小时、数天或者数月的疾苦挣扎。我们的尽力工作会带来大回报(甚至无可估计)。并且因为本身倾泻了多量心血,终极获得一个超卓的设计规划,成功的快感也是令人心动的。对峙草草落成的诱惑--那样做往往得不偿失。