基于.NET平台的分层架构实战(五)——接口的设计与实现

出处:http://www.cnblogs.com/leoo2sk/archive/2008/06/18/1224764.html


基于.NET平台的分层架构实战(五)——接口的设计与实现

2008-06-18 19:50 by T2噬菌体, 11669 阅读, 41 评论, 收藏编辑

接下来,将进行接口的设计。这里包括数据访问层接口和业务逻辑层接口。在分层架构中,接口扮演着非常重要的角色,它不但直接决定了各层中的各个操作类需要实现何种操作,而且它明确了各个层次的职责。接口也是系统实现依赖注入机制不可缺少的部分。

本项目的接口设计将按如下顺序进行:
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:

复制代码
using  System;
using  System.Collections.Generic;
using  System.Text;
using  NGuestBook.Entity;

namespace  NGuestBook.IBLL
{
    
///   <summary>
    
///  业务逻辑层接口-管理员
    
///   </summary>
     public   interface  IAdminBLL
    {
        
///   <summary>
        
///  添加管理员
        
///   </summary>
        
///   <param name="admin"> 新管理员实体类 </param>
        
///   <returns> 是否成功 </returns>
         bool  Add(AdminInfo admin);

        
///   <summary>
        
///  删除管理员
        
///   </summary>
        
///   <param name="id"> 欲删除的管理员的ID </param>
        
///   <returns> 是否成功 </returns>
         bool  Remove( int  id);

        
///   <summary>
        
///  修改管理员密码
        
///   </summary>
        
///   <param name="id"> 欲修改密码的管理员的ID </param>
        
///   <param name="password"> 新密码 </param>
        
///   <returns> 是否成功 </returns>
         bool  ChangePassword( int  id, string  password);

        
///   <summary>
        
///  管理员登录
        
///   </summary>
        
///   <param name="name"> 管理员登录名 </param>
        
///   <param name="password"> 管理员密码 </param>
        
///   <returns> 如果登录成功,则返回相应管理员的实体类,否则返回null </returns>
        AdminInfo Login( string  name, string  password);

        
///   <summary>
        
///  取得全部管理员信息
        
///   </summary>
        
///   <returns> 管理员实体类集合 </returns>
        IList < AdminInfo >  GetAll();
    }
}
复制代码


IMessageBLL.cs:

复制代码
using  System;
using  System.Collections.Generic;
using  System.Text;
using  NGuestBook.Entity;
namespace  NGuestBook.IBLL
{
    
///   <summary>
    
///  业务逻辑层接口-留言
    
///   </summary>
     public   interface  IMessageBLL
    {
        
///   <summary>
        
///  添加留言
        
///   </summary>
        
///   <param name="message"> 新留言实体类 </param>
        
///   <returns> 是否成功 </returns>
         bool  Add(MessageInfo message);

        
///   <summary>
        
///  删除留言
        
///   </summary>
        
///   <param name="id"> 欲删除的留言的ID </param>
        
///   <returns> 是否成功 </returns>
         bool  Remove( int  id);

        
///   <summary>
        
///  回复留言
        
///   </summary>
        
///   <param name="id"> 要回复的留言的ID </param>
        
///   <param name="reply"> 回复信息 </param>
        
///   <returns> 是否成功 </returns>
         bool  Revert( int  id,  string  reply);

        
///   <summary>
        
///  将留言通过验证
        
///   </summary>
        
///   <param name="id"> 通过验证的留言的ID </param>
        
///   <returns> 是否成功 </returns>
         bool  Pass( int  id);

        
///   <summary>
        
///  按分页取得留言信息
        
///   </summary>
        
///   <param name="pageSize"> 每页显示几条留言 </param>
        
///   <param name="pageNumber"> 当前页码 </param>
        
///   <returns> 留言实体类集合 </returns>
        IList < MessageInfo >  GetByPage( int  pageSize, int  pageNumber);
    }
}
复制代码


ICommentBLL.cs

复制代码
using  System;
using  System.Collections.Generic;
using  System.Text;
using  NGuestBook.Entity;

namespace  NGuestBook.IBLL
{
    
///   <summary>
    
///  业务逻辑层接口-评论
    
///   </summary>
     public   interface  ICommentBLL
    {
        
///   <summary>
        
///  添加评论
        
///   </summary>
        
///   <param name="comment"> 新评论实体类 </param>
        
///   <returns> 是否成功 </returns>
         bool  Add(CommentInfo comment);

        
///   <summary>
        
///  删除评论
        
///   </summary>
        
///   <param name="id"> 欲删除的评论的ID </param>
        
///   <returns> 是否成功 </returns>
         bool  Remove( int  id);

        
///   <summary>
        
///  取得指定留言的全部评论
        
///   </summary>
        
///   <param name="messageId"> 指定留言的ID </param>
        
///   <returns> 评论实体类集合 </returns>
        IList < CommentInfo >  GetByMessage( int  messageId);
    }
}
复制代码

 
由业务逻辑确定数据访问操作
IAdminBLL需要的数据访问操作:插入管理员,删除管理员,更新管理员信息,按ID取得管理员信息,按登录名与密码取得管理员,取得全部管理员
IMessageBLL需要的数据访问操作:插入留言,删除留言,更新留言信息,按ID取得留言信息,按分页取得留言
ICommentBLL需要的数据访问操作:插入评论,删除评论,按留言取得全部评论
另外,添加管理员时需要验证是否存在同名管理员,所以需要添加一个“按登录名取得管理员”。

对以上操作进行整理,的如下接口操作:
IAdminDAL:Insert,Delete,Update,GetByID,GetByNameAndPassword,GetAll
IMessageDAL:Insert,Delete,Update,GetByID,GetByPage
ICommentDAL:Insert,Delete,GetByMessage


这三个接口文件放在IDAL工程下,具体代码如下:

IAdminDAL.cs:

 

复制代码
using  System;
using  System.Collections.Generic;
using  System.Text;
using  NGuestBook.Entity;

namespace  NGuestBook.IDAL
{
    
///   <summary>
    
///  数据访问层接口-管理员
    
///   </summary>
     public   interface  IAdminDAL
    {
        
///   <summary>
        
///  插入管理员
        
///   </summary>
        
///   <param name="admin"> 管理员实体类 </param>
        
///   <returns> 是否成功 </returns>
         bool  Insert(AdminInfo admin);

        
///   <summary>
        
///  删除管理员
        
///   </summary>
        
///   <param name="id"> 欲删除的管理员的ID </param>
        
///   <returns> 是否成功 </returns>
         bool  Delete( int  id);

        
///   <summary>
        
///  更新管理员信息
        
///   </summary>
        
///   <param name="admin"> 管理员实体类 </param>
        
///   <returns> 是否成功 </returns>
         bool  Update(AdminInfo admin);

        
///   <summary>
        
///  按ID取得管理员信息
        
///   </summary>
        
///   <param name="id"> 管理员ID </param>
        
///   <returns> 管理员实体类 </returns>
        AdminInfo GetByID( int  id);

        
///   <summary>
        
///  按管理员名取得管理员信息
        
///   </summary>
        
///   <param name="name"> 管理员名 </param>
        
///   <returns> 管理员实体类 </returns>
        AdminInfo GetByName( string  name);

        
///   <summary>
        
///  按用户名及密码取得管理员信息
        
///   </summary>
        
///   <param name="name"> 用户名 </param>
        
///   <param name="password"> 密码 </param>
        
///   <returns> 管理员实体类,不存在时返回null </returns>
        AdminInfo GetByNameAndPassword( string  name, string  password);

        
///   <summary>
        
///  取得全部管理员信息
        
///   </summary>
        
///   <returns> 管理员实体类集合 </returns>
        IList < AdminInfo >  GetAll();
    }
}
复制代码


IMessageDAL.cs:

复制代码
using  System;
using  System.Collections.Generic;
using  System.Text;
using  NGuestBook.Entity;

namespace  NGuestBook.IDAL
{
    
///   <summary>
    
///  数据访问层接口-留言
    
///   </summary>
     public   interface  IMessageDAL
    {
        
///   <summary>
        
///  插入留言
        
///   </summary>
        
///   <param name="message"> 留言实体类 </param>
        
///   <returns> 是否成功 </returns>
         bool  Insert(MessageInfo message);

        
///   <summary>
        
///  删除留言
        
///   </summary>
        
///   <param name="id"> 欲删除的留言的ID </param>
        
///   <returns> 是否成功 </returns>
         bool  Delete( int  id);

        
///   <summary>
        
///  更新留言信息
        
///   </summary>
        
///   <param name="message"> 留言实体类 </param>
        
///   <returns> 是否成功 </returns>
         bool  Update(MessageInfo message);

        
///   <summary>
        
///  按ID取得留言信息
        
///   </summary>
        
///   <param name="id"> 留言ID </param>
        
///   <returns> 留言实体类 </returns>
        MessageInfo GetByID( int  id);

        
///   <summary>
        
///  按分页取得留言信息
        
///   </summary>
        
///   <param name="pageSize"> 每页显示几条留言 </param>
        
///   <param name="pageNumber"> 当前页码 </param>
        
///   <returns> 留言实体类集合 </returns>
        IList < MessageInfo >  GetByPage( int  pageSize, int  pageNumber);
    }
}
复制代码


ICommentDAL.cs:

复制代码
using  System;
using  System.Collections.Generic;
using  System.Text;
using  NGuestBook.Entity;

namespace  NGuestBook.IDAL
{
    
///   <summary>
    
///  数据访问层接口-评论
    
///   </summary>
     public   interface  ICommentDAL
    {
        
///   <summary>
        
///  插入评论
        
///   </summary>
        
///   <param name="comment"> 评论实体类 </param>
        
///   <returns> 是否成功 </returns>
         bool  Insert(CommentInfo comment);

        
///   <summary>
        
///  删除评论
        
///   </summary>
        
///   <param name="id"> 欲删除的评论的ID </param>
        
///   <returns> 是否成功 </returns>
         bool  Delete( int  id);

        
///   <summary>
        
///  取得指定留言的全部评论
        
///   </summary>
        
///   <param name="messageId"> 指定留言的ID </param>
        
///   <returns> 评论实体类集合 </returns>
        IList < CommentInfo >  GetByMessage( int  messageId);
    }
}
复制代码

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值