java

位置:IT落伍者 >> java >> 浏览文章

Java编程规则


发布日期:2018年09月19日
 
Java编程规则

本文大量有用的建议帮助大家进行低级程序设计并提供了代码编写的一般性指导

() 类名首字母应该大写字段方法以及对象(句柄)的首字母应小写对于所有标识符其中包含的所有单词都应紧靠在一起而且大写中间单词的首字母例如

ThisIsAClassName

thisIsMethodOrFieldName

若在定义中出现了常数初始化字符则大写static final基本类型标识符中的所有字母这样便可标志出它们属于编译期的常数

Java包(Package)属于一种特殊情况它们全都是小写字母即便中间的单词亦是如此对于域名扩展名称如comorgnet或者edu等全部都应小写(这也是Java 和Java 的区别之一)

() 为了常规用途而创建一个类时请采取经典形式并包含对下述元素的定义

equals()

hashCode()

toString()

clone()(implement Cloneable)

implement Serializable

() 对于自己创建的每一个类都考虑置入一个main()其中包含了用于测试那个类的代码为使用一个项目中的类我们没必要删除测试代码若进行了任何形式的改动可方便地返回测试这些代码也可作为如何使用类的一个示例使用

() 应将方法设计成简要的功能性单元用它描述和实现一个不连续的类接口部分理想情况下方法应简明扼要若长度很大可考虑通过某种方式将其分割成较短的几个方法这样做也便于类内代码的重复使用(有些时候方法必须非常大但它们仍应只做同样的一件事情)

() 设计一个类时请设身处地为客户程序员考虑一下(类的使用方法应该是非常明确的)然后再设身处地为管理代码的人考虑一下(预计有可能进行哪些形式的修改想想用什么方法可把它们变得更简单)

() 使类尽可能短小精悍而且只解决一个特定的问题下面是对类设计的一些建议

■一个复杂的开关语句考虑采用多形机制

■数量众多的方法涉及到类型差别极大的操作考虑用几个类来分别实现

■许多成员变量在特征上有很大的差别考虑使用几个类

() 让一切东西都尽可能地私有——private可使库的某一部分公共化(一个方法类或者一个字段等等)就永远不能把它拿出若强行拿出就可能破坏其他人现有的代码使他们不得不重新编写和设计若只公布自己必须公布的就可放心大胆地改变其他任何东西在多线程环境中隐私是特别重要的一个因素——只有private字段才能在非同步使用的情况下受到保护

() 谨惕巨大对象综合症对一些习惯于顺序编程思维且初涉OOP领域的新手往往喜欢先写一个顺序执行的程序再把它嵌入一个或两个巨大的对象里根据编程原理对象表达的应该是应用程序的概念而非应用程序本身

() 若不得已进行一些不太雅观的编程至少应该把那些代码置于一个类的内部

() 任何时候只要发现类与类之间结合得非常紧密就需要考虑是否采用内部类从而改善编码及维护工作(参见第小节的用内部类改进代码

() 尽可能细致地加上注释并用javadoc注释文档语法生成自己的程序文档

() 避免使用魔术数字这些数字很难与代码很好地配合如以后需要修改它无疑会成为一场噩梦因为根本不知道到底是指数组大小还是其他全然不同的东西所以我们应创建一个常数并为其使用具有说服力的描述性名称并在整个程序中都采用常数标识符这样可使程序更易理解以及更易维护

() 涉及构建器和异常的时候通常希望重新丢弃在构建器中捕获的任何异常——如果它造成了那个对象的创建失败这样一来调用者就不会以为那个对象已正确地创建从而盲目地继续

() 当客户程序员用完对象以后若你的类要求进行任何清除工作可考虑将清除代码置于一个良好定义的方法里采用类似于cleanup()这样的名字明确表明自己的用途除此以外可在类内放置一个boolean(布尔)标记指出对象是否已被清除在类的finalize()方法里请确定对象已被清除并已丢弃了从RuntimeException继承的一个类(如果还没有的话)从而指出一个编程错误在采取象这样的方案之前请确定finalize()能够在自己的系统中工作(可能需要调用SystemrunFinalizersOnExit(true)从而确保这一行为)

() 在一个特定的作用域内若一个对象必须清除(非由垃圾收集机制处理)请采用下述方法初始化对象若成功则立即进入一个含有finally从句的try块开始清除工作

() 若在初始化过程中需要覆盖(取消)finalize()请记住调用superfinalize()(若Object属于我们的直接超类则无此必要)在对finalize()进行覆盖的过程中对superfinalize()的调用应属于最后一个行动而不应是第一个行动这样可确保在需要基础类组件的时候它们依然有效

() 创建大小固定的对象集合时请将它们传输至一个数组(若准备从一个方法里返回这个集合更应如此操作)这样一来我们就可享受到数组在编译期进行类型检查的好处此外为使用它们数组的接收者也许并不需要将对象造型到数组里

() 尽量使用interfaces不要使用abstract类若已知某样东西准备成为一个基础类那么第一个选择应是将其变成一个interface(接口)只有在不得不使用方法定义或者成员变量的时候才需要将其变成一个abstract(抽象)类接口主要描述了客户希望做什么事情而一个类则致力于(或允许)具体的实施细节

() 在构建器内部只进行那些将对象设为正确状态所需的工作尽可能地避免调用其他方法因为那些方法可能被其他人覆盖或取消从而在构建过程中产生不可预知的结果(参见第章的详细说明)

() 对象不应只是简单地容纳一些数据它们的行为也应得到良好的定义

() 在现成类的基础上创建新类时请首先选择新建创作只有自己的设计要求必须继承时才应考虑这方面的问题若在本来允许新建的场合使用了继承则整个设计会变得没有必要地复杂

() 用继承及方法覆盖来表示行为间的差异而用字段表示状态间的区别一个非常极端的例子是通过对不同类的继承来表示颜色这是绝对应该避免的应直接使用一个颜色字段

() 为避免编程时遇到麻烦请保证在自己类路径指到的任何地方每个名字都仅对应一个类否则编译器可能先找到同名的另一个类并报告出错消息若怀疑自己碰到了类路径问题请试试在类路径的每一个起点搜索一下同名的class文件

() 在Java AWT中使用事件适配器特别容易碰到一个陷阱若覆盖了某个适配器方法同时拼写方法没有特别讲究最后的结果就是新添加一个方法而不是覆盖现成方法然而由于这样做是完全合法的所以不会从编译器或运行期系统获得任何出错提示——只不过代码的工作就变得不正常了

() 用合理的设计方案消除伪功能也就是说假若只需要创建类的一个对象就不要提前限制自己使用应用程序并加上一条只生成其中一个注释请考虑将其封装成一个独生子的形式若在主程序里有大量散乱的代码用于创建自己的对象请考虑采纳一种创造性的方案将些代码封装起来

() 警惕分析瘫痪请记住无论如何都要提前了解整个项目的状况再去考察其中的细节由于把握了全局可快速认识自己未知的一些因素防止在考察细节的时候陷入死逻辑

() 警惕过早优化首先让它运行起来再考虑变得更快——但只有在自己必须这样做而且经证实在某部分代码中的确存在一个性能瓶颈的时候才应进行优化除非用专门的工具分析瓶颈否则很有可能是在浪费自己的时间性能提升的隐含代价是自己的代码变得难于理解而且难于维护

() 请记住阅读代码的时间比写代码的时间多得多思路清晰的设计可获得易于理解的程序但注释细致的解释以及一些示例往往具有不可估量的价值无论对你自己还是对后来的人它们都是相当重要的如对此仍有怀疑那么请试想自己试图从联机Java文档里找出有用信息时碰到的挫折这样或许能将你说服

() 如认为自己已进行了良好的分析设计或者实施那么请稍微更换一下思维角度试试邀请一些外来人士——并不一定是专家但可以是来自本公司其他部门的人请他们用完全新鲜的眼光考察你的工作看看是否能找出你一度熟视无睹的问题采取这种方式往往能在最适合修改的阶段找出一些关键性的问题避免产品发行后再解决问题而造成的金钱及精力方面的损失

() 良好的设计能带来最大的回报简言之对于一个特定的问题通常会花较长的时间才能找到一种最恰当的解决方案但一旦找到了正确的方法以后的工作就轻松多了再也不用经历数小时数天或者数月的痛苦挣扎我们的努力工作会带来最大的回报(甚至无可估量)而且由于自己倾注了大量心血最终获得一个出色的设计方案成功的快感也是令人心动的坚持抵制草草完工的诱惑——那样做往往得不偿失

() 可在Web上找到大量的编程参考资源甚至包括大量新闻组讨论组邮寄列表等下面这个地方提供了大量有益的链接

Links/Java/joodcs/l

上一篇:Java套接字编程(下)

下一篇:JavaBean 在jsp和serlvle中传递技术要点