Visual C#自定義組件的設(shè)計：Pop3Com組件
Pop3Com組件基本原理
要完成一個Pop3組件，就要完成對該組件的屬性（Property）、方法（Method）和事件（Event）等的設(shè)計。屬性是一個組件的重要特征，一個組件一般有多項屬性。我們可以通過get和set取得和設(shè)置各個屬性的值。完成了各個屬性的設(shè)置，我們可以通過該組件的各種方法進(jìn)行相應(yīng)的操作。而事件則是在某些特定的消息下觸發(fā)的。在C#中，我們用代表（delegate）進(jìn)行事件的聲明。
在該Pop3組件中，我們?yōu)槠涮砑恿酥鳈C名（Host）、端口號（Port）、用戶名（UserName）、密碼（PassWord）、郵件數(shù)目（NumOfMails）、郵件大?。═otalSize）等屬性，通過ReceiveMessage（）和ReceiveMessageAsync（）方法完成與服務(wù)器的連接、通訊和結(jié)束會話等功能，在調(diào)用了該方法后，我們就可以從郵件數(shù)目和郵件大小等屬性中獲得郵箱中的相關(guān)信息，進(jìn)而運用該組件就可以輕松地開發(fā)出諸如郵件信史之類的程序了。同時，該組件中還包含了一個OnMailReceived（）事件，該事件在完成了郵件的接收后被觸發(fā)。
在組件的設(shè)計過程中，與主機的連接通訊是該組件的核心部分，所以我們不妨專門設(shè)計一個與主機的連接類－Pop3Connection類，該類是主要運用了TcpClient類的對象，和主機建立基于TCP/IP網(wǎng)絡(luò)協(xié)議的連接。在完成連接后，可以和主機進(jìn)行通訊。完成通訊后，則關(guān)閉與主機的連接。在大致介紹了實現(xiàn)原理后，下面就是具體的實現(xiàn)方法了。
Pop3Com組件實現(xiàn)方法
首先，打開VS.net，新建一個Visual C#的項目：在項目類型中選擇"Visual C#項目"，在模板中選擇"類庫"，不妨將該項目命名為"Pop3Com"（這樣，由該項目生成的組件的命名空間就為Pop3Com了），圖示如下：
1．Pop3Connection類：
這樣，項目向?qū)Ь屯瓿闪?，接著我們將原來的Class1.cs改名為Pop3.cs，同時添加一個類Pop3Connection（文件名不妨為Pop3Connection.cs）。
如上所述，Pop3Connection類完成了與主機的連接、通訊和關(guān)閉連接等功能，所以我們必須調(diào)用.Net框架中進(jìn)行網(wǎng)絡(luò)通訊的類庫，在此我們運用的是TcpClient類的對象作為網(wǎng)絡(luò)連接的客戶端。同時，在與主機的通訊過程中必然少不了對于輸入輸出流的控制。于是，我們在設(shè)計該類的時候，首先得添加如下命名空間：
- using System.IO;
- using System.Net.Sockets;
- Pop3Connection類的成員變量包括以下幾個：
- private TcpClient socket;
- private StreamReader reader;
- private StreamWriter writer;
- private bool connected;
其中，bool類型的connected變量用于判斷是否與主機取得了連接，它是該類的一個屬性，對其操作如下：
- public bool Connected
- {
- get{return connected;}
- }
- Pop3Connection類的主要方法包含以下幾個：
- internal void Open(string host, int port)
- {
- if(host == null || host.Trim().Length == 0 || port < = 0)
- {
- throw new System.ArgumentException("Invalid Argument found.");
- }
- socket.Connect(host, port);
- reader = new StreamReader(socket.GetStream(), System.Text.Encoding.ASCII);
- writer = new StreamWriter(socket.GetStream(), System.Text.Encoding.ASCII);
- connected = true;
- }
- internal void SendCommand(string cmd)
- {
- writer.WriteLine(cmd);
- writer.Flush();
- }
- internal void GetReply(out string reply, out int code)
- {
- reply = reader.ReadLine();
- code = reply == null ? -1 : Int32.Parse(reply.Substring(0, 3));
- }
- internal void Close()
- {
- reader.Close();
- writer.Flush();
- writer.Close();
- reader = null;
- writer = null;
- socket.Close();
- connected = false;
- }
根據(jù)這些方法的名稱，我們不難知道它們的作用。第一個方法Open（）就是根據(jù)主機名和端口號取得和服務(wù)器的連接。一旦連接成功，就通過TcpClient類的對象獲取網(wǎng)絡(luò)通訊流并新建一個StreamReader對象和一個StreamWriter對象。不言而喻，這兩個對象的作用是控制網(wǎng)絡(luò)通訊的輸出和輸入。最后，還要將connected的屬性設(shè)置為true。第二個方法SendCommand（）就是在上面的StreamWriter類的對象writer的基礎(chǔ)上往網(wǎng)絡(luò)套接字中輸入信息。而第三個方法GetReply（）則正好相反，它是用來從網(wǎng)絡(luò)套接字中獲取信息的。最后一個方法Close（）的作用則是關(guān)閉輸出、輸入流的對象，然后調(diào)用TcpClient類的對象Close（）方法并將connected屬性設(shè)置為false，從而關(guān)閉連接，結(jié)束會話。
2．Pop3類：
這樣，我們就完成了Pop3Connection類的設(shè)計和編碼工作，也就完成了整個組件最關(guān)鍵的部分。接下來，我們就在該類的基礎(chǔ)上設(shè)計Pop3類。Pop3類包含了郵件通訊所必須的基本屬性、方法和事件。
首先，我們來設(shè)計其中的屬性。該類應(yīng)該包括主機名、端口號、用戶名、密碼、郵件數(shù)量、郵件總體積、郵件內(nèi)容和狀態(tài)信息等屬性。其中前四個屬性是可讀又可寫的，后四個屬性是只可讀的。具體的設(shè)置如下：
- ///
- /// 主機名
- ///
- public string Host
- {
- get {return host;}
- set
- {
- if(value == null || value.Trim().Length == 0)
- {
- throw new ArgumentException("Invalid host name.");
- }
- host = value;
- }
- }
- ///
- /// 端口號
- ///
- public int Port
- {
- get {return port;}
- set
- {
- if(value < = 0)
- {
- throw new ArgumentException("Invalid port.");
- }
- port = value;
- }
- }
- ///
- /// 用戶名
- ///
- public string UserName
- {
- get {return username;}
- set
- {
- if(value == null || value.Trim().Length == 0)
- {
- throw new ArgumentException("Invalid user name.");
- }
- username = value;
- }
- }
- ///
- /// 密碼
- ///
- public string PassWord
- {
- get {return password;}
- set
- {
- if(value == null)
- {
- throw new ArgumentException("Invalid password.");
- }
- password = value;
- }
- }
- ///
- /// 郵件數(shù)量
- ///
- public int NumOfMails
- {
- get {return numofmails;}
- }
- ///
- /// 郵件總體積
- ///
- public double TotalSize
- {
- get {return totalsize;}
- }
- ///
- /// 郵件內(nèi)容
- ///
- public string Body
- {
- get {return body;}
- }
- ///
- /// 狀態(tài)信息
- ///
- public string Status
- {
- get {return status;}
- }
完成了該類的屬性設(shè)計，我們接下來就完成該類的方法設(shè)計。該類主要的方法就一個ReceiveMessage（），顧名思義就是接收郵件信息的意思。在這個方法中，我們運用了上面的Pop3Connection類的對象。通過這個對象，我們就可以更加方便的進(jìn)行網(wǎng)絡(luò)通訊的操作。不過，在具體介紹這個方法的實現(xiàn)以前，我先得向大家介紹一下郵件接收的基本原理。
其基本原理如下：
一開始便是客戶端與服務(wù)器的連接。不過，在客戶端連接到服務(wù)器之前，注意把端口設(shè)為POP3協(xié)議默認(rèn)的110號。
客戶端連接服務(wù)器成功后，服務(wù)器會返回以下信息：
+OK……
字符+OK是POP3協(xié)議的返回信息。它的回應(yīng)信息不像SMTP協(xié)議那樣用豐富多變的數(shù)字表示，只有兩個：+OK或者-ERR。其中，+OK表示連接成功，而-ERR則表示連接失敗。
接下來，客戶端輸入USER < 用戶名>
該命令告訴服務(wù)器你的用戶名。注意，有些服務(wù)器會區(qū)分大小寫字母的。
服務(wù)器返回+OK后，客戶端輸入PASS < 口令>
服務(wù)器返回+OK后，還返回一些郵箱的統(tǒng)計信息，比如：+OK 1 message(s) [1304 byte(s)]
不同的服務(wù)器返回的信息格式不太一樣，所以我們可以用STAT命令來查看郵箱的情況。STAT命令的回應(yīng)中有兩個數(shù)字，分別表示郵件的數(shù)量和郵件的大小。
如果信箱里有信，就可以用RETR命令來獲取郵件的正文。RETR命令的格式為：
RETR < 郵件編號>
如果返回結(jié)果第一行是+OK信息，則表示成功。第二行起便是郵件的正文。最后一行和SMTP協(xié)議一樣，是一個單獨的英文句號，表示郵件的結(jié)尾部分。
把郵件存儲起來后要用DELE命令刪除郵箱中的郵件，否則原有的郵件會繼續(xù)保留在服務(wù)器上，一旦郵件一多，你的郵箱就爆了。DELE命令的格式為：
DELE < 郵件編號>
如果刪錯了，可以用RSET命令來恢復(fù)所有已被刪除的郵件。條件是你還沒有退出，一旦退出，那就一切Bye Bye了。全部完成以后，輸入QUIT命令就可以退出POP3服務(wù)器了。
在了解了郵件接收的基本原理的基礎(chǔ)上，我就向大家介紹ReceiveMessage（）方法的具體實現(xiàn)：
- ///
- /// 接收郵件信息
- ///
- public void ReceiveMessage()
- {
- // 避免線程沖突
- lock(this)
- {
- // 設(shè)置初始連接
- con = new Pop3Connection();
- if(port < = 0) port = 110;
- con.Open(host, port);
- StringBuilder buf = new StringBuilder();
- string response;
- int code;
- // 獲取歡迎信息
- con.GetReply(out response, out code);
- status += response;
- //登錄服務(wù)器過程
- buf.Append("USER");
- buf.Append(username);
- buf.Append(CRLF);
- con.SendCommand(buf.ToString());
- con.GetReply(out response, out code);
- status += response;
- buf.Length = 0;
- buf.Append("PASS");
- buf.Append(password);
- buf.Append(CRLF);
- con.SendCommand(buf.ToString());
- con.GetReply(out response, out code);
- status += response;
- //向服務(wù)器發(fā)送STAT命令，從而取得郵箱的相關(guān)信息：郵件數(shù)量和大小
- buf.Length = 0;
- buf.Append("STAT");
- buf.Append(CRLF);
- con.SendCommand(buf.ToString());
- con.GetReply(out response, out code);
- status += response;
- //將總郵件數(shù)和郵件大小分離
- string[] TotalStat = response.Split(new char[] {' '});
- numofmails = Int32.Parse(TotalStat[1]);
- totalsize = (double)Int32.Parse(TotalStat[2]);
- for( int x = 0; x < numofmails; ++x)
- {
- //根據(jù)郵件編號從服務(wù)器獲得相應(yīng)郵件
- buf.Length = 0;
- buf.Append("RETR");
- buf.Append(x.ToString());
- buf.Append(CRLF);
- con.SendCommand(buf.ToString());
- con.GetReply(out response, out code);
- if(response[0]!='-')
- {
- //不斷地讀取郵件內(nèi)容，只到結(jié)束標(biāo)志：英文句號
- while(response!=".")
- {
- body += response;
- con.GetReply(out response, out code);
- }
- }
- else
- status += response;
- }
- //向服務(wù)器發(fā)送QUIT命令從而結(jié)束和POP3服務(wù)器的會話
- buf.Length = 0;
- buf.Append("QUIT");
- buf.Append(CRLF);
- con.SendCommand(buf.ToString());
- con.GetReply(out response, out code);
- status += response;
- con.Close();
- // 郵件接收成功后觸發(fā)的事件
- if(OnMailReceived != null)
- {
- OnMailReceived();
- }
- }
- }
根據(jù)郵件接收的基本原理和代碼中的注釋，我想讀者應(yīng)該不難讀懂上面的代碼。不過下面幾點仍得說明：其中的CRLF為"\r\n"，它的作用是在每個命令后面加上一個換行符。另外，在該方法的一開始處有一句：lock(this)，它的作用是避免線程沖突?？紤]到接收郵件的過程比較漫長而且占用的資源較多，所以在設(shè)計的時候我用到了多線程（有關(guān)多線程的資料讀者可參考相關(guān)的書籍或文章，此處不再贅述）。在實際的程序中，上面的方法其實被另一個方法ReceiveMessageAsync（）作為一個單獨的線程調(diào)用。方法如下：
- ///
- /// 通過一個獨立的線程接收郵件
- ///
- public void ReceiveMessageAsync()
- {
- new Thread(new ThreadStart(ReceiveMessage)).Start();
- }
最后，在ReceiveMessge（）方法的末尾處，它調(diào)用了事件處理函數(shù)OnMailReceived（）。在C#中，事件的聲明是用代表完成的，首先我們在Pop3類的開始處進(jìn)行聲明如下：
- public delegate void MailReceivedDelegate();
接著，就進(jìn)行事件的聲明：
- public event MailReceivedDelegate OnMailReceived;
這樣，只要在應(yīng)用程序中調(diào)用了OnMailReceived（）事件，在郵件接收成功后，OnMailReceived（）事件就會被觸發(fā)。
到此為止，我們已經(jīng)完成了核心類－Pop3類的屬性、方法和事件的設(shè)計，這樣整個組件也就完成了（按Ctrl+Shift+B就可以生成解決方案）。不過，由于是組件，所以不可以直接運行，我們必須做一個測試程序來測試之。下面我就用該組件做了一個簡單的郵件信史，它可以向用戶報告郵箱中的新郵件數(shù)目。
測試程序
首先，在原來的解決方案的基礎(chǔ)上添加一個新項目。項目類型為"Visual C#項目"，模板為"Windows應(yīng)用程序"，名稱不妨為"MailNotifier"。
接著，設(shè)計主界面如下：
設(shè)計好主界面后，我們進(jìn)行代碼設(shè)計。首先，要添加對上面的組件－Pop3Com的引用。在項目菜單下選擇"添加引用"，出現(xiàn)"添加引用"對話框，在"項目"一頁下將Pop3Com組件添加到本項目中。圖示如下：
同時，在代碼的開始處添加引用：using Pop3Com。這樣，我們就可以在本程序中調(diào)用Pop3Com組件中的類的方法完成相應(yīng)功能了。下面就是"開始檢查"按鈕的事件處理函數(shù)了：
- private void checkBtn_Click(object sender, System.EventArgs e)
- {
- // 正確性檢查
- if(host == null || host.Text.Trim().Length == 0)
- {
- MessageBox.Show("請?zhí)钊敕?wù)器地址！");
- }
- else
- if(username == null || username.Text.Trim().Length == 0)
- {
- MessageBox.Show("請?zhí)钊胗脩裘?);
- }
- else
- if(password == null || password.Text.Trim().Length == 0)
- {
- MessageBox.Show("請?zhí)钊朊艽a！");
- }
- else
- {
- mailer = new Pop3();
- mailer.Host = host.Text;
- mailer.Port = Int32.Parse(port.Text);
- mailer.UserName = username.Text;
- mailer.PassWord = password.Text;
- statusBar.Text = "正在接收信息……";
- mailer.OnMailReceived += new Pop3.MailReceivedDelegate(OnMailReceived);
- mailer.ReceiveMessageAsync();
- }
- }
其中，mailer為Pop3類的一個實例對象，它是完成郵件檢查的核心對象。同時，OnMailReceived（）事件函數(shù)如下：
- private void OnMailReceived()
- {
- statusBar.Text = "郵件接收完畢！";
- MessageBox.Show("你有" + mailer.NumOfMails.ToString() + "個郵件！","信息",
- MessageBoxButtons.OK,MessageBoxIcon.Information);
- }
如此，測試程序－郵件信史也就完成了。最后，按下Ctrl+F5運行我們的程序如下：
通過對Pop3Com組件的設(shè)計，我想讀者對Visual C#組件編程應(yīng)該有了個基本的了解，對其中類的屬性、方法和事件的設(shè)計也應(yīng)該是相當(dāng)清楚了。組件編程是Visual C#的強項，所以希望讀者能進(jìn)一步學(xué)習(xí)。同時，對于上面的組件，讀者也可試著進(jìn)一步完善，并不妨將之運用于自己的應(yīng)用程序中，讓它發(fā)揮其強大的重用功能。
【編輯推薦】
