基于.NET平臺的分層架構實戰(五)接口的設計與實現_.Net教程

推薦：基于.NET平臺的分層架構實戰(四)實體類的設計與實現
實體類是現實實體在計算機中的表示。它貫穿于整個架構，負擔著在各層次及模塊間傳遞數據的職責。一般來說，實體類可以分為“貧血實體類”和“充血實體類”，前者僅僅保存實

接下來，將進行接口的設計。這里包括數據訪問層接口和業務邏輯層接口。在分層架構中，接口扮演著非常重要的角色，它不但直接決定了各層中的各個操作類需要實現何種操作，而且它明確了各個層次的職責。接口也是系統實現依賴注入機制不可缺少的部分。

本項目的接口設計將按如下順序進行：
1.首先由前文的需求分析，列出主要的UI部分。
2.分析各個UI需要什么業務邏輯支持，從而確定業務邏輯層接口。
3.分析業務邏輯層接口需要何種數據訪問操作，從而確定數據訪問層接口。

另外，為保證完全的面向對象特性，接口之間的數據傳遞主要靠實體類或實體類集合，禁止使用DataTable等對象傳遞數據。

由需求分析，列出主要UI
需求分析部分，請參看基于.NET平臺的分層架構實戰（二）——需求分析與數據庫設計 。有需求分析，可以列出系統中主要應包括以下UI：
UI01——主頁面，列出全部的留言及相應評論，支持分頁顯示。留言按發表時間逆序顯示，評論緊跟在相應留言下。管理員可以通過相應鏈接對留言執行通過驗證、刪除、回復以及對評論進行刪除操作。游客可通過相應連接進入發表留言評論頁面。
UI02——發表留言頁面，供游客發表新留言。
UI03——發表評論頁面，供游客發表評論。
UI04——回復留言頁面，供管理員回復留言。
UI05——管理員登錄頁面。
UI06——管理員修改個人密碼的頁面。
UI07——超級管理員登錄后的頁面，主要提供管理員列表。可以通過相應鏈接將指定管理員刪除。
UI08——添加新管理員的頁面。
UI09——操作成功完成后的跳轉提示頁面。
UI10——系統出現異常時顯示友好出錯信息的頁面。

由UI識別業務邏輯操作
UI01：按分頁取得留言，按指定留言取得全部評論，將指定留言通過驗證，將指定留言刪除，將指定評論刪除
UI02：添加新留言
UI03：添加新評論
UI04：回復留言
UI05：管理員登錄
UI06：修改管理員密碼
UI07：取得全部管理員信息，刪除管理員
UI08：添加新管理員

經過整理，可得以下接口操作：
IAdminBLL：Add（添加管理員），Remove（刪除管理員），ChangePassword（修改管理員密碼），Login（管理員登錄），GetAll（取得全部管理員）
IMessageBLL：Add（添加留言），Remove（刪除留言），Revert（回復留言），Pass（將留言通過驗證），GetByPage（按分頁取得留言）
ICommentBLL：Add（添加評論），Remove（刪除評論），GetByMessage（按留言取得全部評論）

這三個接口文件都放在IBLL工程下，具體代碼如下：

IAdminBLL.cs:
IAdminBLL
1using System;
2using System.Collections.Generic;
3using System.Text;
4using NGuestBook.Entity;
5
6namespace NGuestBook.IBLL
7{
8 /**//// <summary>
9 /// 業務邏輯層接口-管理員
10 /// </summary>
11 public interface IAdminBLL
12 {
13 /**//// <summary>
14 /// 添加管理員
15 /// </summary>
16 /// <param name="admin">新管理員實體類</param>
17 /// <returns>是否成功</returns>
18 bool Add(AdminInfo admin);
19
20 /**//// <summary>
21 /// 刪除管理員
22 /// </summary>
23 /// <param name="id">欲刪除的管理員的ID</param>
24 /// <returns>是否成功</returns>
25 bool Remove(int id);
26
27 /**//// <summary>
28 /// 修改管理員密碼
29 /// </summary>
30 /// <param name="id">欲修改密碼的管理員的ID</param>
31 /// <param name="password">新密碼</param>
32 /// <returns>是否成功</returns>
33 bool ChangePassword(int id,string password);
34
35 /**//// <summary>
36 /// 管理員登錄
37 /// </summary>
38 /// <param name="name">管理員登錄名</param>
39 /// <param name="password">管理員密碼</param>
40 /// <returns>如果登錄成功，則返回相應管理員的實體類，否則返回null</returns>
41 AdminInfo Login(string name,string password);
42
43 /**//// <summary>
44 /// 取得全部管理員信息
45 /// </summary>
46 /// <returns>管理員實體類集合</returns>
47 IList<AdminInfo> GetAll();
48 }
49}
IMessageBLL.cs:
IMessageBLL
1using System;
2using System.Collections.Generic;
3using System.Text;
4using NGuestBook.Entity;
5
6namespace NGuestBook.IBLL
7{
8 /**//// <summary>
9 /// 業務邏輯層接口-留言
10 /// </summary>
11 public interface IMessageBLL
12 {
13 /**//// <summary>
14 /// 添加留言
15 /// </summary>
16 /// <param name="message">新留言實體類</param>
17 /// <returns>是否成功</returns>
18 bool Add(MessageInfo message);
19
20 /**//// <summary>
21 /// 刪除留言
22 /// </summary>
23 /// <param name="id">欲刪除的留言的ID</param>
24 /// <returns>是否成功</returns>
25 bool Remove(int id);
26
27 /**//// <summary>
28 /// 回復留言
29 /// </summary>
30 /// <param name="id">要回復的留言的ID</param>
31 /// <param name="reply">回復信息</param>
32 /// <returns>是否成功</returns>
33 bool Revert(int id, string reply);
34
35 /**//// <summary>
36 /// 將留言通過驗證
37 /// </summary>
38 /// <param name="id">通過驗證的留言的ID</param>
39 /// <returns>是否成功</returns>
40 bool Pass(int id);
41
42 /**//// <summary>
43 /// 按分頁取得留言信息
44 /// </summary>
45 /// <param name="pageSize">每頁顯示幾條留言</param>
46 /// <param name="pageNumber">當前頁碼</param>
47 /// <returns>留言實體類集合</returns>
48 IList<MessageInfo> GetByPage(int pageSize,int pageNumber);
49 }
50}
ICommentBLL.cs
ICommentBLL
1using System;
2using System.Collections.Generic;
3using System.Text;
4using NGuestBook.Entity;
5
6namespace NGuestBook.IBLL
7{
8 /**//// <summary>
9 /// 業務邏輯層接口-評論
10 /// </summary>
11 public interface ICommentBLL
12 {
13 /**//// <summary>
14 /// 添加評論
15 /// </summary>
16 /// <param name="comment">新評論實體類</param>
17 /// <returns>是否成功</returns>
18 bool Add(CommentInfo comment);
19
20 /**//// <summary>
21 /// 刪除評論
22 /// </summary>
23 /// <param name="id">欲刪除的評論的ID</param>
24 /// <returns>是否成功</returns>
25 bool Remove(int id);
26
27 /**//// <summary>
28 /// 取得指定留言的全部評論
29 /// </summary>
30 /// <param name="messageId">指定留言的ID</param>
31 /// <returns>評論實體類集合</returns>
32 IList<CommentInfo> GetByMessage(int messageId);
33 }
34}

由業務邏輯確定數據訪問操作
IAdminBLL需要的數據訪問操作：插入管理員，刪除管理員，更新管理員信息，按ID取得管理員信息，按登錄名與密碼取得管理員，取得全部管理員
IMessageBLL需要的數據訪問操作：插入留言，刪除留言，更新留言信息，按ID取得留言信息，按分頁取得留言
ICommentBLL需要的數據訪問操作：插入評論，刪除評論，按留言取得全部評論
另外，添加管理員時需要驗證是否存在同名管理員，所以需要添加一個“按登錄名取得管理員”。

分享：基于.NET平臺的分層架構實戰(三)架構概要設計
本文主要是對將要實現的架構進行一個總體的描述，使朋友們對這個架構有個宏觀上的認識。這篇文章理論性的東西會偏多一點，從下篇開始，將進行實際項目的開發。這篇文章的許多內容摘自我的畢業論