基于.NET平臺的分層架構實戰(zhàn)(五)接口的設計與實現(xiàn)
基于.NET平臺的分層架構實戰(zhàn)(五)接口的設計與實現(xiàn)
接下來,將進行接口的設計。這里包括數(shù)據(jù)訪問層接口和業(yè)務邏輯層接口。在分層架構中,接口扮演著非常重要的角色,它不但直接決定了各層中的各個操作類需要實現(xiàn)何種操作,而且它明確了各個層次的職責。接口也是系統(tǒng)實現(xiàn)依賴注入機制不可缺少的部分。 本項目的接口設計將按如下順序進行:1.首先由前文的需求分析,列出主要的UI部分。 2.分析各個UI需要什么業(yè)務邏輯支持,從而確定業(yè)務邏輯層接口。 3.分析業(yè)務邏輯層接口需要何種數(shù)據(jù)訪問操作,從而確定數(shù)據(jù)訪問層接口。 另外,為保證完全的面向對象特性,接口之間的數(shù)據(jù)傳遞主要靠實體類或實體類集合,禁止使用DataTable等對象傳遞數(shù)據(jù)。由需求分析,列出主要UI 需求分析部分,請參看基于.NET平臺的分層架構實戰(zhàn)(二)——需求分析與數(shù)據(jù)庫設計 。有需求分析,可以列出系統(tǒng)中主要應包括以下UI: UI01——主頁面,列出全部的留言及相應評論,支持分頁顯示。留言按發(fā)表時間逆序顯示,評論緊跟在相應留言下。管理員可以通過相應鏈接對留言執(zhí)行通過驗證、刪除、回復以及對評論進行刪除操作。游客可通過相應連接進入發(fā)表留言評論頁面。 UI02——發(fā)表留言頁面,供游客發(fā)表新留言。 UI03——發(fā)表評論頁面,供游客發(fā)表評論。 UI04——回復留言頁面,供管理員回復留言。 UI05——管理員登錄頁面。 UI06——管理員修改個人密碼的頁面。 UI07——超級管理員登錄后的頁面,主要提供管理員列表?梢酝ㄟ^相應鏈接將指定管理員刪除。 UI08——添加新管理員的頁面。 UI09——操作成功完成后的跳轉提示頁面。 UI10——系統(tǒng)出現(xiàn)異常時顯示友好出錯信息的頁面。 由UI識別業(yè)務邏輯操作 UI01:按分頁取得留言,按指定留言取得全部評論,將指定留言通過驗證,將指定留言刪除,將指定評論刪除 UI02:添加新留言 UI03:添加新評論 UI04:回復留言 UI05:管理員登錄 UI06:修改管理員密碼 UI07:取得全部管理員信息,刪除管理員 UI08:添加新管理員 經(jīng)過整理,可得以下接口操作: 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 /**//// 9 /// 業(yè)務邏輯層接口-管理員 10 /// 11 public interface IAdminBLL 12 { 13 /**//// 14 /// 添加管理員 15 /// 16 /// 新管理員實體類 17 /// 是否成功 18 bool Add(AdminInfo admin); 19 /**//// 21 /// 刪除管理員 22 /// 23 /// 欲刪除的管理員的ID 24 /// 是否成功 25 bool Remove(int id); 26 27 /**//// 28 /// 修改管理員密碼 29 /// 30 /// 欲修改密碼的管理員的ID 31 /// 新密碼 32 /// 是否成功 33 bool ChangePassword(int id,string password); 34 35 /**//// 36 /// 管理員登錄 37 /// 38 /// 管理員登錄名 39 /// 管理員密碼 40 /// 如果登錄成功,則返回相應管理員的實體類,否則返回null 41 AdminInfo Login(string name,string password); 42 43 /**//// 44 /// 取得全部管理員信息 45 /// 46 /// 管理員實體類集合 47 IList GetAll(); 48 } 49} IMessageBLL.cs: IMessageBLL 1using System; 2using System.Collections.Generic; 3using System.Text; 4using NGuestBook.Entity; 5 6namespace NGuestBook.IBLL 7{ 8 /**//// 9 /// 業(yè)務邏輯層接口-留言 10 /// 11 public interface IMessageBLL 12 { 13 /**//// 14 /// 添加留言 15 /// 16 /// 新留言實體類 17 /// 是否成功 18 bool Add(MessageInfo message); 19 /**//// 21 /// 刪除留言 22 /// 23 /// 欲刪除的留言的ID 24 /// 是否成功 25 bool Remove(int id); 26 27 /**//// 28 /// 回復留言 29 /// 30 /// 要回復的留言的ID 31 /// 回復信息 32 /// 是否成功 33 bool Revert(int id, string reply); 34 35 /**//// 36 /// 將留言通過驗證 37 /// 38 /// 通過驗證的留言的ID 39 /// 是否成功 40 bool Pass(int id); 41 42 /**//// 43 /// 按分頁取得留言信息 44 /// 45 /// 每頁顯示幾條留言 46 /// 當前頁碼 47 /// 留言實體類集合 48 IList 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 /**//// 9 /// 業(yè)務邏輯層接口-評論 10 /// 11 public interface ICommentBLL 12 { 13 /**//// 14 /// 添加評論 15 /// 16 /// 新評論實體類 17 /// 是否成功 18 bool Add(CommentInfo comment); 19 /**//// 21 /// 刪除評論 22 /// 23 /// 欲刪除的評論的ID 24 /// 是否成功 25 bool Remove(int id); 26 27 /**//// 28 /// 取得指定留言的全部評論 29 /// 30 /// 指定留言的ID 31 /// 評論實體類集合 32 IList GetByMessage(int messageId); 33 } 34} 由業(yè)務邏輯確定數(shù)據(jù)訪問操作 IAdminBLL需要的數(shù)據(jù)訪問操作:插入管理員,刪除管理員,更新管理員信息,按ID取得管理員信息,按登錄名與密碼取得管理員,取得全部管理員 IMessageBLL需要的數(shù)據(jù)訪問操作:插入留言,刪除留言,更新留言信息,按ID取得留言信息,按分頁取得留言 ICommentBLL需要的數(shù)據(jù)訪問操作:插入評論,刪除評論,按留言取得全部評論 另外,添加管理員時需要驗證是否存在同名管理員,所以需要添加一個“按登錄名取得管理員”。 對以上操作進行整理,的如下接口操作: IAdminDAL:Insert,Delete,Update,GetByID,GetByNameAndPassword,GetAll IMessageDAL:Insert,Delete,Update,GetByID,GetByPage ICommentDAL:Insert,Delete,GetByMessage 這三個接口文件放在IDAL工程下,具體代碼如下: IAdminDAL.cs: IAdminDAL 1using System; 2using System.Collections.Generic; 3using System.Text; 4using NGuestBook.Entity; 5 6namespace NGuestBook.IDAL 7{ 8 /**//// 9 /// 數(shù)據(jù)訪問層接口-管理員 10 /// 11 public interface IAdminDAL 12 { 13 /**//// 14 /// 插入管理員 15 /// 16 /// 管理員實體類 17 /// 是否成功 18 bool Insert(AdminInfo admin); 19 /**//// 21 /// 刪除管理員 22 /// 23 /// 欲刪除的管理員的ID 24 /// 是否成功 25 bool Delete(int id); 26 27 /**//// 28 /// 更新管理員信息 29 /// 30 /// 管理員實體類 31 /// 是否成功 32 bool Update(AdminInfo admin); 33 34 /**//// 35 /// 按ID取得管理員信息 36 /// 37 /// 管理員ID 38 /// 管理員實體類 39 AdminInfo GetByID(int id); 40 41 /**//// 42 /// 按用戶名及密碼取得管理員信息 43 /// 44 /// 用戶名 45 /// 密碼 46 /// 管理員實體類,不存在時返回null 47 AdminInfo GetByNameAndPassword(string name,string password); 48 49 /**//// 50 /// 取得全部管理員信息 51 /// 52 /// 管理員實體類集合 53 IList GetAll(); 54 } 55} IMessageDAL.cs: IMessageDAL 1using System; 2using System.Collections.Generic; 3using System.Text; 4using NGuestBook.Entity; 5 6namespace NGuestBook.IDAL 7{ 8 /**//// 9 /// 數(shù)據(jù)訪問層接口-留言 10 /// 11 public interface IMessageDAL 12 { 13 /**//// 14 /// 插入留言 15 /// 16 /// 留言實體類 17 /// 是否成功 18 bool Insert(MessageInfo message); 19 /**//// 21 /// 刪除留言 22 /// 23 /// 欲刪除的留言的ID 24 /// 是否成功 25 bool Delete(int id); 26 27 /**//// 28 /// 更新留言信息 29 /// 30 /// 留言實體類 31 /// 是否成功 32 bool Update(MessageInfo message); 33 34 /**//// 35 /// 按ID取得留言信息 36 /// 37 /// 留言ID 38 /// 留言實體類 39 MessageInfo GetByID(int id); 40 41 /**//// 42 /// 按分頁取得留言信息 43 /// 44 /// 每頁顯示幾條留言 45 /// 當前頁碼 46 /// 留言實體類集合 47 IList GetByPage(int pageSize,int pageNumber); 48 } 49} ICommentDAL.cs: ICommentDAL 1using System; 2using System.Collections.Generic; 3using System.Text; 4using NGuestBook.Entity; 5 6namespace NGuestBook.IDAL 7{ 8 /**//// 9 /// 數(shù)據(jù)訪問層接口-評論 10 /// 11 public interface ICommentDAL 12 { 13 /**//// 14 /// 插入評論 15 /// 16 /// 評論實體類 17 /// 是否成功 18 bool Insert(CommentInfo comment); 19 /**//// 21 /// 刪除評論 22 /// 23 /// 欲刪除的評論的ID 24 /// 是否成功 25 bool Delete(int id); 26 27 /**//// 28 /// 取得指定留言的全部評論 29 /// 30 /// 指定留言的ID 31 /// 評論實體類集合 32 IList GetByMessage(int messageId); 33 } 34}