类设计
類設計
類的設計方法 [轉] from:http://www.cnblogs.com/seandotnet/archive/2006/12/25/603114.html1) 類名首字母應該大寫。字段、方法以及對象(句柄)的首字母應小寫。對于所有標識符,其中包含的所有單詞都應緊靠在一起,而且大寫中間單詞的首字母。例如:
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設計網絡硬盤之兩個重要類
要進行“網絡硬盤”功能設計,首先要熟悉.NET中處理文件和文件夾的操作。File類和Directory類是其中最主要的兩個類。了解它們將對后面功能的實現提供很大的便利。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并不會受到任何影響,也不需要進行再次編譯和重新發布。
以上四個原則是面向對象中常常用到的原則。此外,除上述四原則外,還有一些常用的經驗諸如類結構層次以三到四層為宜、類的職責明確化(一個類對應一個具體職責)等可供我們在進行面向對象設計參考。但就上面的幾個原則看來,我們看到這些類在幾何分布上呈現樹型拓撲的關系,這是一種良好、開放式的線性關系、具有較低的設計復雜度。一般說來,在軟件設計中我們應當盡量避免出現帶有閉包、循環的設計關系,它們反映的是較大的耦合度和設計復雜化。
轉載于:https://www.cnblogs.com/yjkai/archive/2011/08/16/2140424.html
總結
- 上一篇: 兴业银行是正规银行吗 已挂牌上市股票代码
- 下一篇: WTL自绘滚动控件