`

写好Java代码的30条经验总结

 
阅读更多

转载自:http://www.codeceo.com/article/30-Java-tips.html

 

 

成为一个优秀的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条经验总结.docx

    Java编程经验总结是指为了提高Java代码的质量和可读性,编写良好的Java代码所需要遵守的一些规则和建议。本文总结了30条Java编程经验,其中包括类命名、方法设计、类设计、变量命名、注释、异常处理、清除工作等方面...

    java代码重构经验总结

    ### Java代码重构经验总结 在软件开发过程中,代码重构是一项重要的技能,它旨在不改变代码外部行为的前提下,改进其内部结构,从而提升代码质量和可维护性。本文将深入探讨Java代码重构的关键点,涵盖重构原则、...

    java设计模式与经验总结

    Java设计模式是软件工程中的一种最佳实践,它们是解决常见编程问题的经验总结,可以提高代码的可重用性、可维护性和可扩展性。在Java领域,熟练掌握设计模式是成为一个高级开发者的必要条件。本资源包含两部分:Java...

    java代码重构经验分享

    本文总结了 Java 代码重构的经验和技术规范,包括重构要求、重构的工作、代码的坏味道和异常处理。 重构要求 在进行代码重构时,需要遵守以下要求: 1. 安全第一,确保关键部分的代码正确无误,先做出 demo,各...

    Java学习笔记&工作经验总结.rar

    这份压缩包文件"Java学习笔记&工作经验总结.rar"包含了多个PDF文档,分别涵盖了Java的基础知识、高级特性、数据结构以及学员的学习总结,是深入理解Java编程的宝贵资料。 1. **Java SE基础全程学习笔记.pdf**: 这...

    java学习经验总结

    JSP主要用于创建动态网页,它将HTML代码与Java代码相结合,使开发者可以直接在页面上进行业务逻辑处理。Servlet则是服务器端的Java应用程序,用于处理客户端请求,提供服务。它们通常配合工作,JSP负责视图展示,...

    用java代码写的学生学籍管理系统

    对于学习Java的开发者来说,这是一个很好的实践项目,可以帮助理解面向对象编程思想,提升数据库操作技能,以及增强GUI编程经验。通过共同探讨和改进,我们可以进一步优化系统性能,提升用户体验,为教育信息化建设...

    Java编程超级马里奥全代码

    总结起来,《Java编程超级马里奥全代码》不仅是一个娱乐项目,更是一个学习资源,涵盖了Java编程、源码分析、游戏开发和GUI设计等多个方面的知识。无论是初学者还是有经验的开发者,都能从中受益匪浅,提升自己的...

    java程序员总结报告

    【Java程序员年终总结】 作为一名Java程序员,我在2010年的经历让我深刻理解到学习的重要性。从初入职场的新鲜人,到能在公司独立完成项目的开发者,这段历程充满了挑战和成长。2010年,我有幸加入北京联合兴辰公司...

    Java基础各章节个人总结代码

    "Java基础各章节个人总结代码"是一个针对Java初学者或有经验的开发者的学习资源,它涵盖了Java SE(标准版)的基础知识。在这个压缩包中,你可能会找到关于变量、数据类型、控制流、类和对象、封装、继承、多态性...

    Java经典例题代码

    10. **设计模式**:Java的经典例题中会涉及常见的设计模式,如工厂模式、单例模式、观察者模式、装饰器模式等,这些都是软件开发中的经验总结,有助于提高代码复用和结构化。 通过深入学习和实践"Java经典例题代码...

    JAVA代码、方法、运算符大全

    "JAVA代码、方法、运算符大全"这份资源将帮助开发者深入理解Java编程的核心要素,无论你是初学者还是有经验的开发者,都可以从中找到所需的知识。通过学习和实践这些基本概念,你将能够编写出高效、可维护的Java应用...

    郝斌Java源代码下

    设计模式是解决软件开发中常见问题的经验总结,理解和运用设计模式可以提高代码的可读性和可维护性。 通过学习这些源代码,不仅能巩固Java语法,还能理解实际项目中的代码组织和设计思路。同时,结合上课的PPT,...

    总结java编程中的经验教训

    标题:总结Java编程中的经验教训 在Java编程的漫长历程中,无数开发者通过实践与失败积累了宝贵的经验教训,这些经验和教训对于新晋程序员而言,是避免重蹈覆辙的捷径,也是提升代码质量和开发效率的关键。以下是从...

    Java程序代码总结

    Java编程语言是面向对象的、跨平台的编程语言,它由Sun ...以上就是Java程序代码的基础知识总结,这些内容涵盖了Java开发的核心要素,无论是初学者还是经验丰富的开发者,理解和掌握这些知识点都是至关重要的。

    一本介绍如何将现有的 Java 代码重构为 Kotlin 代码的书籍

    ### 《从Java到Kotlin:重构指南》关键知识点总结 #### 一、书籍概述与目标读者 本书《从Java到Kotlin:重构指南》由Duncan McGregor与Nat Pryce共同编写,是一本专为已经熟悉Java编程语言并希望将其现有代码转换...

    JAVA程序代码_设计模式大全

    设计模式并非具体的代码或库,而是经验丰富的开发者在面对特定问题时所采用的通用解决方案的总结。这些模式在多种情境下都已被证明有效,能够提高代码的可读性、可维护性和可扩展性。23种设计模式分为三大类:创建型...

    java 基础知识总结(经典)

    这篇“Java基础知识总结(经典)”涵盖了Java开发中的核心概念和重要知识点,旨在为初学者和有经验的开发者提供一个全面的回顾。以下是主要的学习点: 1. **Java环境配置**:在开始编程之前,必须安装Java ...

Global site tag (gtag.js) - Google Analytics