类设计
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) 良好的设计能带来最大的回报。简言之，对于一个特定的问题，通常会花较长的时间才能找到一种最恰当的解决方案。但一旦找到了正确的方法，以后的工作就轻松多了，再也不用经历数小时、数天或者数月的痛苦挣扎。我们的努力工作会带来最大的回报（甚至无可估量）。而且由于自己倾注了大量心血，最终获得一个出色的设计方案，成功的快感也是令人心动的。坚持抵制草草完工的诱惑——那样做往往得不偿失
--------------------------------------------------------------------------------------------------------------------------------------------
ASP.NET设计网络硬盘之两个重要类
ASP.NET设计网络硬盘之两个重要类
System.IO.File类和System.IO.FileInfo类
在设计和实现“网络硬盘”的过程中，将大量地使用和文件系统操作相关的内容。故本节先对和文件系统相关的两个.NET类进行简要介绍。
System.IO.File类和System.IO.FileInfo类主要提供有关文件的各种操作，在使用时需要引用System.IO命名空间。下面通过程序实例来介绍其主要属性和方法。
(1) 文件打开方法：File.Open
该方法的声明如下：
| public static FileStream Open(string path,FileMode mode) |
下面的代码打开存放在c:\tempuploads目录下名称为newFile.txt文件，并在该文件中写入hello。
| private void OpenFile() { FileStream.TextFile=File.Open(@"c:\tempuploads\newFile.txt",FileMode.Append); byte [] Info = {(byte)''h'',(byte)''e'',(byte)''l'',(byte)''l'',(byte)''o''}; TextFile.Write(Info,0,Info.Length); TextFile.Close(); } |
(2) 文件创建方法：File.Create
该方法的声明如下：
| public static FileStream Create(string path;) |
下面的代码演示如何在c:\tempuploads下创建名为newFile.txt的文件。
由于File.Create方法默认向所有用户授予对新文件的完全读/写访问权限，所以文件是用读/写访问权限打开的，必须关闭后才能由其他应用程序打开。为此，所以需要使用FileStream类的Close方法将所创建的文件关闭。
| private void MakeFile() { FileStream NewText=File.Create(@"c:\tempuploads\newFile.txt"); NewText.Close(); } |
(3) 文件删除方法：File.Delete
该方法声明如下：
| public static void Delete(string path); |
下面的代码演示如何删除c:\tempuploads目录下的newFile.txt文件。
| private void DeleteFile() { File.Delete(@"c:\tempuploads\newFile.txt"); } |
(4) 文件复制方法：File.Copy
该方法声明如下：
| public static void Copy(string sourceFileName,string destFileName,bool overwrite); |
下面的代码将c:\tempuploads\newFile.txt复制到c:\tempuploads\BackUp.txt。
由于Cope方法的OverWrite参数设为true，所以如果BackUp.txt文件已存在的话，将会被复制过去的文件所覆盖。
| private void CopyFile() { File.Copy(@"c:\tempuploads\newFile.txt",@"c:\tempuploads\BackUp.txt",true); } |
(5) 文件移动方法：File.Move
该方法声明如下：
| public static void Move(string sourceFileName,string destFileName); |
下面的代码可以将c:\tempuploads下的BackUp.txt文件移动到c盘根目录下。
注意：
只能在同一个逻辑盘下进行文件转移。如果试图将c盘下的文件转移到d盘，将发生错误。
| private void MoveFile() { File.Move(@"c:\tempuploads\BackUp.txt",@"c:\BackUp.txt"); } |
(6) 设置文件属性方法：File.SetAttributes
该方法声明如下：
| public static void SetAttributes(string path,FileAttributes fileAttributes); |
下面的代码可以设置文件c:\tempuploads\newFile.txt的属性为只读、隐藏。
| private void SetFile() { File.SetAttributes(@"c:\tempuploads\newFile.txt", FileAttributes.ReadOnly|FileAttributes.Hidden); } |
文件除了常用的只读和隐藏属性外，还有Archive(文件存档状态)，System(系统文件)，Temporary(临时文件)等。关于文件属性的详细情况请参看MSDN中FileAttributes的描述。
(7) 判断文件是否存在的方法：File.Exist
该方法声明如下：
| public static bool Exists(string path); |
下面的代码判断是否存在c:\tempuploads\newFile.txt文件。若存在，先复制该文件，然后其删除，最后将复制的文件移动；若不存在，则先创建该文件，然后打开该文件并进行写入操作，最后将文件属性设为只读、隐藏。
| if(File.Exists(@"c:\tempuploads\newFile.txt")) //判断文件是否存在 { CopyFile(); //复制文件 DeleteFile(); //删除文件 MoveFile(); //移动文件 } else { MakeFile(); //生成文件 OpenFile(); //打开文件 SetFile(); //设置文件属性 } |
此外，File类对于Text文本提供了更多的支持。
· AppendText：将文本追加到现有文件
· CreateText：为写入文本创建或打开新文件
· OpenText：打开现有文本文件以进行读取
但上述方法主要对UTF-8的编码文本进行操作，从而显得不够灵活。在这里推荐读者使用下面的代码对txt文件进行操作。
· 对txt文件进行“读”操作，示例代码如下：
| StreamReader TxtReader = new StreamReader(@"c:\tempuploads\newFile.txt",System.Text.Encoding.Default); string FileContent; FileContent = TxtReader.ReadEnd(); TxtReader.Close(); |
· 对txt文件进行“写”操作，示例代码如下：
| StreamWriter = new StreamWrite(@"c:\tempuploads\newFile.txt",System.Text.Encoding.Default); string FileContent; TxtWriter.Write(FileContent); TxtWriter.Close(); |
System.IO.Directory类和System.DirectoryInfo类
主要提供关于目录的各种操作，使用时需要引用System.IO命名空间。下面通过程序实例来介绍其主要属性和方法。
(1) 目录创建方法：Directory.CreateDirectory
该方法声明如下：
| public static DirectoryInfo CreateDirectory(string path); |
下面的代码演示在c:\tempuploads文件夹下创建名为NewDirectory的目录。
| private void MakeDirectory() { Directory.CreateDirectory(@"c:\tempuploads\NewDirectoty"); } |
(2) 目录属性设置方法：DirectoryInfo.Atttributes
下面的代码设置c:\tempuploads\NewDirectory目录为只读、隐藏。与文件属性相同，目录属性也是使用FileAttributes来进行设置的。
| private void SetDirectory() { DirectoryInfo NewDirInfo = new DirectoryInfo(@"c:\tempuploads\NewDirectoty"); NewDirInfo.Atttributes = FileAttributes.ReadOnly|FileAttributes.Hidden; } |
(3) 目录删除方法：Directory.Delete
该方法声明如下：
| public static void Delete(string path,bool recursive); |
下面的代码可以将c:\tempuploads\BackUp目录删除。Delete方法的第二个参数为bool类型，它可以决定是否删除非空目录。如果该参数值为true，将删除整个目录，即使该目录下有文件或子目录；若为false，则仅当目录为空时才可删除。
| private void DeleteDirectory() { Directory.Delete(@"c:\tempuploads\BackUp",true); } |
(4) 目录移动方法：Directory.Move
该方法声明如下：
| public static void Move(string sourceDirName,string destDirName); |
下面的代码将目录c:\tempuploads\NewDirectory移动到c:\tempuploads\BackUp。
| private void MoveDirectory() { File.Move(@"c:\tempuploads\NewDirectory",@"c:\tempuploads\BackUp"); } |
(5) 获取当前目录下的所有子目录方法：Directory.GetDirectories
该方法声明如下：
| public static string[] GetDirectories(string path;); |
下面的代码读出c:\tempuploads\目录下的所有子目录，并将其存储到字符串数组中。
| private void GetDirectory() { string [] Directorys; Directorys = Directory. GetDirectories (@"c:\tempuploads"); } |
(6) 获取当前目录下的所有文件方法：Directory.GetFiles
该方法声明如下：
| public static string[] GetFiles(string path;); |
下面的代码读出c:\tempuploads\目录下的所有文件，并将其存储到字符串数组中。
| private void GetFile() { string [] Files; Files = Directory. GetFiles (@"c:\tempuploads",); } |
(7) 判断目录是否存在方法：Directory.Exist
该方法声明如下：
| public static bool Exists( string path; ); |
下面的代码判断是否存在c:\tempuploads\NewDirectory目录。若存在，先获取该目录下的子目录和文件，然后其移动，最后将移动后的目录删除。若不存在，则先创建该目录,然后将目录属性设为只读、隐藏。
| if(File.Exists(@"c:\tempuploads\NewDirectory")) //判断目录是否存在 { GetDirectory(); //获取子目录 GetFile(); //获取文件 MoveDirectory(); //移动目录 DeleteDirectory(); //删除目录 } else { MakeDirectory(); //生成目录 SetDirectory(); //设置目录属性 } |
注意：
路径有3种方式，当前目录下的相对路径、当前工作盘的相对路径、绝对路径。以C:\Tmp\Book为例(假定当前工作目录为C:\Tmp)。“Book”，“\Tmp\Book”,“C:\Tmp\Book”都表示C:\Tmp\Book。
另外，在C#中 “\”是特殊字符，要表示它的话需要使用“\\”。由于这种写法不方便，C#语言提供了@对其简化。只要在字符串前加上@即可直接使用“\”。所以上面的路径在C#中应该表示为“Book”，@“\Tmp\Book”，@“C:\Tmp\Book”。
------------------------------------------------------------------------------------------------------------------------------------------------------------------------
面向对象的设计原则－类设计原则
中国系统分析员顾问团高级顾问 张华（来自CSAI.cn） 2004年06月24日
在面向对象设计中，如何通过很小的设计改变就可以应对设计需求的变化，这是令设计者极为关注的问题。为此不少OO先驱提出了很多有关面向对象的设计原则用于指导OO的设计和开发。下面是几条与类设计相关的设计原则。
1. 开闭原则（the Open Closed Principle OCP）
一个模块在扩展性方面应该是开放的而在更改性方面应该是封闭的。因此在进行面向对象设计时要尽量考虑接口封装机制、抽象机制和多态技术。该原则同样适合于非面向对象设计的方法，是软件工程设计方法的重要原则之一。
我们以收音机的例子为例，讲述面向对象的开闭原则。我们收听节目时需要打开收音机电源，对准电台频率和进行音量调节。但是对于不同的收音机，实现这三个步骤的细节往往有所不同。比如自动收缩电台的收音机和按钮式收缩在操作细节上并不相同。因此，我们不太可能针对每种不同类型的收音机通过一个收音机类来实现（通过重载）这些不同的操作方式。但是我们可以定义一个收音机接口，提供开机、关机、增加频率、降低频率、增加音量、降低音量六个抽象方法。不同的收音机继承并实现这六个抽象方法。这样新增收音机类型不会影响其它原有的收音机类型，收音机类型扩展极为方便。此外，已存在的收音机类型在修改其操作方法时也不会影响到其它类型的收音机。
图1是一个应用OCP生成的收音机类图的例子：
图1 OCP应用（收音机）
2. 替换原则 (the Liskov Substitution Principle LSP)
子类应当可以替换父类并出现在父类能够出现的任何地方。这个原则是Liskov于1987年提出的设计原则。它同样可以从Bertrand Meyer 的DBC (Design by Contract) 的概念推出。
我们以学生为例，夜校生为学生的子类，因此在任何学生可以出现的地方，夜校生均可出现。这个例子有些牵强，一个能够反映这个原则的例子时圆和椭圆，圆是椭圆的一个特殊子类。因此任何出现椭圆的地方，圆均可以出现。但反过来就可能行不通。
Liskov的相关图示见图2：
图2 Liskov 原则
运用替换原则时，我们尽量把类B设计为抽象类或者接口，让C类继承类B（接口B）并实现操作A和操作B，运行时，类C实例替换B，这样我们即可进行新类的扩展（继承类B或接口B），同时无须对类A进行修改。
3. 依赖原则 (the Dependency Inversion Principle DIP)
在进行业务设计时，与特定业务有关的依赖关系应该尽量依赖接口和抽象类，而不是依赖于具体类。具体类只负责相关业务的实现，修改具体类不影响与特定业务有关的依赖关系。
在结构化设计中，我们可以看到底层的模块是对高层抽象模块的实现（高层抽象模块通过调用底层模块），这说明，抽象的模块要依赖具体实现相关的模块，底层模块的具体实现发生变动时将会严重影响高层抽象的模块，显然这是结构化方法的一个"硬伤"。
面向对象方法的依赖关系刚好相反，具体实现类依赖于抽象类和接口（见图-3）。
为此，我们在进行业务设计时，应尽量在接口或抽象类中定义业务方法的原型，并通过具体的实现类（子类）来实现该业务方法，业务方法内容的修改将不会影响到运行时业务方法的调用。
图3依赖原则图示
4. 接口分离原则（the Interface Segregation Principle ISP）
采用多个与特定客户类有关的接口比采用一个通用的涵盖多个业务方法的接口要好。
ISP原则是另外一个支持诸如COM等组件化的使能技术。缺少ISP，组件、类的可用性和移植性将大打折扣。
这个原则的本质相当简单。如果你拥有一个针对多个客户的类，为每一个客户创建特定业务接口，然后使该客户类继承多个特定业务接口将比直接加载客户所需所有方法有效。
图4展示了一个拥有多个客户的类。它通过一个巨大的接口来服务所有的客户。只要针对客户A的方法发生改变，客户B和客户C就会受到影响。因此可能需要进行重新编译和发布。这是一种不幸的做法。
图4 带有集成接口的服务类
我们再看图-5中所展示的技术。每个特定客户所需的方法被置于特定的接口中，这些接口被Service类所继承并实现。
图5 使用接口分离的服务类设计
如果针对客户A的方法发生改变，客户B和客户C并不会受到任何影响，也不需要进行再次编译和重新发布。
以上四个原则是面向对象中常常用到的原则。此外，除上述四原则外，还有一些常用的经验诸如类结构层次以三到四层为宜、类的职责明确化（一个类对应一个具体职责）等可供我们在进行面向对象设计参考。但就上面的几个原则看来，我们看到这些类在几何分布上呈现树型拓扑的关系，这是一种良好、开放式的线性关系、具有较低的设计复杂度。一般说来，在软件设计中我们应当尽量避免出现带有闭包、循环的设计关系，它们反映的是较大的耦合度和设计复杂化。
7575
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
