还剩8页未读,继续阅读
本资源只提供10页预览,全部文档请下载后查看!喜欢就下载吧,查找使用更方便
文本内容:
JAVA代码编写的30条建议JAVA代码编写的30条建议1类名首字母应该大写字段、方法以及对象句柄的首字母应小写对于所有标识符,其中包含的所有单词都应紧靠在一起,而且大写中间单词的首字母例如ThisIsAClassName thisIsMethodOrFieldName若在定义中出现了常数初始化字符,则大写static final基本类型标识符中的所有字母这样便可标志出它们属于编译期的常数Java包Package属于一种特殊情况它们全都是小写字母,即便中间的单词亦是如此对于域名扩展名称,如com,org,net或者edu等,全部都应小写这也是Java
1.1和Java
1.2的区别之一2为了常规用途而创建一个类时,请采取经典形式,并包含对下述元素的定义equals hashCodetoString cloneimplementCloneable implementSerializable3对于自己创建的每一个类,都考虑置入一个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.runFinalizersOnExittrue,从而确保这一行为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.1AWT中使用事件适配器时,特别容易碰到一个陷阱若覆盖了某个适配器方法,同时拼写方法没有特别讲究,最后的结果就是新添加一个方法,而不是覆盖现成方法然而,由于这样做是完全合法的,所以不会从编译器或运行期系统获得任何出错提示--只不过代码的工作就变得不正常了25用合理的设计方案消除伪功能也就是说,假若只需要创建类的一个对象,就不要提前限制自己使用应用程序,并加上一条只生成其中一个注释请考虑将其封装成一个独生子的形式若在主程序里有大量散乱的代码,用于创建自己的对象,请考虑采纳一种创造性的方案,将些代码封装起来26警惕分析瘫痪请记住,无论如何都要提前了解整个项目的状况,再去考察其中的细节由于把握了全局,可快速认识自己未知的一些因素,防止在考察细节的时候陷入死逻辑中27警惕过早优化首先让它运行起来,再考虑变得更快--但只有在自己必须这样做、而且经证实在某部分代码中的确存在一个性能瓶颈的时候,才应进行优化除非用专门的工具分析瓶颈,否则很有可能是在浪费自己的时间性能提升的隐含代价是自己的代码变得难于理解,而且难于维护28请记住,阅读代码的时间比写代码的时间多得多思路清晰的设计可获得易于理解的程序,但注释、细致的解释以及一些示例往往具有不可估量的价值无论对你自己,还是对后来的人,它们都是相当重要的如对此仍有怀疑,那么请试想自己试图从联机Java文档里找出有用信息时碰到的挫折,这样或许能将你说服29如认为自己已进行了良好的分析、设计或者实施,那么请稍微更换一下思维角度试试邀请一些外来人士--并不一定是专家,但可以是来自本公司其他部门的人请他们用完全新鲜的眼光考察你的工作,看看是否能找出你一度熟视无睹的问题采取这种方式,往往能在最适合修改的阶段找出一些关键性的问题,避免产品发行后再解决问题而造成的金钱及精力方面的损失30良好的设计能带来最大的回报简言之,对于一个特定的问题,通常会花较长的时间才能找到一种最恰当的解决方案但一旦找到了正确的方法,以后的工作就轻松多了,再也不用经历数小时、数天或者数月的痛苦挣扎我们的努力工作会带来最大的回报甚至无可估量而且由于自己倾注了大量心血,最终获得一个出色的设计方案,成功的快感也是令人心动的坚持抵制草草完工的诱惑--那样做往往得不偿失3对于自己创建的每一个类,都考虑置入一个main,其中包含了用于测试那个类的代码为使用一个项目中的类,我们没必要删除测试代码若进行了任何形式的改动,可方便地返回测试这些代码也可作为如何使用类的一个示例使用this isabsolutly bad!4应将方法设计成简要的、功能性单元,用它描述和实现一个不连续的类接口部分理想情况下,方法应简明扼要若长度很大,可考虑通过某种方式将其分割成较短的几个方法这样做也便于类内代码的重复使用有些时候,方法必须非常大,但它们仍应只做同样的一件事情5设计一个类时,请设身处地为客户程序员考虑一下类的使用方法应该是非常明确的然后,再设身处地为管理代码的人考虑一下预计有可能进行哪些形式的修改,想想用什么方法可把它们变得更简单6使类尽可能短小精悍,而且只解决一个特定的问题下面是对类设计的一些建议■一个复杂的开关语句考虑采用多形机制■数量众多的方法涉及到类型差别极大的操作考虑用几个类来分别实现■许多成员变量在特征上有很大的差别考虑使用几个类7让一切东西都尽可能地私有--private可使库的某一部分公共化一个方法、类或者一个字段等等,就永远不能把它拿出若强行拿出,就可能破坏其他人现有的代码,使他们不得不重新编写和设计若只公布自己必须公布的,就可放心大胆地改变其他任何东西在多线程环境中,隐私是特别重要的一个因素--只有private字段才能在非同步使用的情况下受到保护not necessary,pretotect orpackage levelalso finein mostcase8谨惕巨大对象综合症对一些习惯于顺序编程思维、且初涉OOP领域的新手,往往喜欢先写一个顺序执行的程序,再把它嵌入一个或两个巨大的对象里根据编程原理,对象表达的应该是应用程序的概念,而非应用程序本身9若不得已进行一些不太雅观的编程,至少应该把那些代码置于一个类的内部10任何时候只要发现类与类之间结合得非常紧密,就需要考虑是否采用内部类,从而改善编码及维护工作参见第14章
14.
1.2小节的用内部类改进代码11尽可能细致地加上注释,并用javadoc注释文档语法生成自己的程序文档12避免使用魔术数字,这些数字很难与代码很好地配合如以后需要修改它,无疑会成为一场噩梦,因为根本不知道100到底是指数组大小还是其他全然不同的东西所以,我们应创建一个常数,并为其使用具有说服力的描述性名称,并在整个程序中都采用常数标识符这样可使程序更易理解以及更易维护13涉及构建器和异常的时候,通常希望重新丢弃在构建器中捕获的任何异常--如果它造成了那个对象的创建失败这样一来,调用者就不会以为那个对象已正确地创建,从而盲目地继续14当客户程序员用完对象以后,若你的类要求进行任何清除工作,可考虑将清除代码置于一个良好定义的方法里,采用类似于cleanup这样的名字,明确表明自己的用途除此以外,可在类内放置一个boolean布尔标记,指出对象是否已被清除在类的finalize方法里,请确定对象已被清除,并已丢弃了从RuntimeException继承的一个类如果还没有的话,从而指出一个编程错误在采取象这样的方案之前,请确定finalize能够在自己的系统中工作可能需要调用System.runFinalizersOnExittrue,从而确保这一行为15在一个特定的作用域内,若一个对象必须清除非由垃圾收集机制处理,请采用下述方法初始化对象;若成功,则立即进入一个含有finally从句的try块,开始清除工作16若在初始化过程中需要覆盖取消finalize,请记住调用super.finalize若Object属于我们的直接超类,则无此必要在对finalize进行覆盖的过程中,对super.finalize的调用应属于最后一个行动,而不应是第一个行动,这样可确保在需要基础类组件的时候它们依然有效17创建大小固定的对象集合时,请将它们传输至一个数组若准备从一个方法里返回这个集合,更应如此操作这样一来,我们就可享受到数组在编译期进行类型检查的好处此外,为使用它们,数组的接收者也许并不需要将对象造型到数组里18尽量使用interfaces,不要使用abstract类若已知某样东西准备成为一个基础类,那么第一个选择应是将其变成一个interface接口只有在不得不使用方法定义或者成员变量的时候,才需要将其变成一个abstract抽象类接口主要描述了客户希望做什么事情,而一个类则致力于或允许具体的实施细节they aretotal diffrent,19在构建器内部,只进行那些将对象设为正确状态所需的工作尽可能地避免调用其他方法,因为那些方法可能被其他人覆盖或取消,从而在构建过程中产生不可预知的结果参见第7章的详细说明20对象不应只是简单地容纳一些数据;它们的行为也应得到良好的定义21在现成类的基础上创建新类时,请首先选择新建或创作只有自己的设计要求必须继承时,才应考虑这方面的问题若在本来允许新建的场合使用了继承,则整个设计会变得没有必要地复杂22用继承及方法覆盖来表示行为间的差异,而用字段表示状态间的区别一个非常极端的例子是通过对不同类的继承来表示颜色,这是绝对应该避免的应直接使用一个颜色字段23为避免编程时遇到麻烦,请保证在自己类路径指到的任何地方,每个名字都仅对应一个类否则,编译器可能先找到同名的另一个类,并报告出错消息若怀疑自己碰到了类路径问题,请试试在类路径的每一个起点,搜索一下同名的.class文件classpath isnot thatsimple24在Java
1.1AWT中使用事件适配器时,特别容易碰到一个陷阱若覆盖了某个适配器方法,同时拼写方法没有特别讲究,最后的结果就是新添加一个方法,而不是覆盖现成方法然而,由于这样做是完全合法的,所以不会从编译器或运行期系统获得任何出错提示--只不过代码的工作就变得不正常了25用合理的设计方案消除伪功能也就是说,假若只需要创建类的一个对象,就不要提前限制自己使用应用程序,并加上一条只生成其中一个注释请考虑将其封装成一个独生子的形式若在主程序里有大量散乱的代码,用于创建自己的对象,请考虑采纳一种创造性的方案,将些代码封装起来26警惕分析瘫痪请记住,无论如何都要提前了解整个项目的状况,再去考察其中的细节由于把握了全局,可快速认识自己未知的一些因素,防止在考察细节的时候陷入死逻辑中27警惕过早优化首先让它运行起来,再考虑变得更快--但只有在自己必须这样做、而且经证实在某部分代码中的确存在一个性能瓶颈的时候,才应进行优化除非用专门的工具分析瓶颈,否则很有可能是在浪费自己的时间性能提升的隐含代价是自己的代码变得难于理解,而且难于维护but knowearly anddesign betterat firstis alwaysnecesary,or elseyou die28请记住,阅读代码的时间比写代码的时间多得多思路清晰的设计可获得易于理解的程序,但注释、细致的解释以及一些示例往往具有不可估量的价值无论对你自己,还是对后来的人,它们都是相当重要的如对此仍有怀疑,那么请试想自己试图从联机Java文档里找出有用信息时碰到的挫折,这样或许能将你说服29如认为自己已进行了良好的分析、设计或者实施,那么请稍微更换一下思维角度试试邀请一些外来人士--并不一定是专家,但可以是来自本公司其他部门的人请他们用完全新鲜的眼光考察你的工作,看看是否能找出你一度熟视无睹的问题采取这种方式,往往能在最适合修改的阶段找出一些关键性的问题,避免产品发行后再解决问题而造成的金钱及精力方面的损失30良好的设计能带来最大的回报简言之,对于一个特定的问题,通常会花较长的时间才能找到一种最恰当的解决方案但一旦找到了正确的方法,以后的工作就轻松多了,再也不用经历数小时、数天或者数月的痛苦挣扎我们的努力工作会带来最大的回报甚至无可估量而且由于自己倾注了大量心血,最终获得一个出色的设计方案,成功的快感也是令人心动的坚持抵制草草完工的诱惑--那样做往往得不偿失MSN空间完美搬家到新浪博客!特别声明1资料来源于互联网,版权归属原作者2资料内容属于网络意见,与本账号立场无关3如有侵权,请告知,立即删除。