新闻发布系统详细设计说明书.docx
《新闻发布系统详细设计说明书.docx》由会员分享，可在线阅读，更多相关《新闻发布系统详细设计说明书.docx（17页珍藏版）》请在冰豆网上搜索。
新闻发布系统详细设计说明书
新闻发布系统需求分析报告
1引言4
1.1编写目的4
1.2背景4
1.3定义4
1.4参考资料5
2程序系统的结构5
3程序1（三层构架）设计说明8
3.1程序描述8
3.2功能9
3.3性能9
3.4输人项10
3.5输出项10
3.6算法11
3.7流程逻辑11
3.8接口11
3.9存储分配11
3.10注释设计11
3.11限制条件12
3.12测试计划12
3.13尚未解决的问题12
4程序2（网站前台的实现）设计说明12
4.1程序描述12
4.2功能13
4.3性能13
4.4输人项13
4.5输出项13
4.6算法13
4.7流程逻辑13
4.8接口14
4.9存储分配14
4.10注释设计14
4.11限制条件14
4.12测试计划14
4.13尚未解决的问题14
5程序3（网站前台的实现）设计说明15
5.1程序描述15
5.2功能15
5.3性能16
5.4输人项16
5.5输出项16
5.6算法16
5.7流程逻辑16
5.8接口17
5.9存储分配17
5.10注释设计17
5.11限制条件17
5.12测试计划17
5.13尚未解决的问题18
1引言
1.1编写目的
需求分析的完成仍然不能详细的确定子系统和各模块的具体方法，所以为了建立一个完善的软件系统并为开发人员提供代码设计，我们需要进行详细设计。
1.2背景
当今社会是信息竞争的社会，企业的信息化建设是提高企业管理效率的必要途径，在这样一个信息化建设中，企业的新闻发布系统是企业对外快速传播信息的门户。
随着互连网的进一步发展网络媒体在人们心中的地位进一步提高新闻发布系统作为网络媒体的核心系统其重要性是越来越重要:
一方面它提供一个新闻管理和发布的功能另一方面现在的新闻发布要求实现与普通的用户实现交互用户可以很方便地参加一些调查和相关新闻的评论。
同时，随着网络应用的丰富和发展，很多网站往往不能迅速跟进大量信息衍生及业务模式变革的脚步，常常需要花费许多时间、人力和物力来处理信息更新和维护工作；遇到网站扩充的时候，整合内外网及分支网站的工作就变得更加复杂，甚至还需重新建设网站；本系统主要采用了B/S设计模式，基于asp.NETSQLServer2008技术开发了一个新闻发布系统。
待开发软件系统名称：
新闻发布系统
1.3定义
列出本文件中用到专门术语的定义和外文首字母组词的原词组。
Html：
超文本标记语言（HypertextMarkupLanguage）
Css：
全称是级联样式表，CascadingStyleSheet的缩写，用来设计网页风格。
JavaScript：
JavaScript是由Netscape公司开发的一种脚本语言（scriptinglanguage），或者称为描述语言。
Ajax：
全称是AsynchronousJavaScript+XML，即“异步JavaScript和XML”。
1.4参考资料
（1）企业级网站开发项目教程（ASP.NET）
（2）软件工程案例开发与实践
2程序系统的结构
功能模型图：
企业新闻发布管理系统文件结构设计如图所示：
包
类名
说明
Web
Default
前台主页页面类
BigTypeNews
前台新闻栏目页面类
ListView.aspx
前台新闻内容浏览及评论页面类
MoreComments
前台新闻全部评论浏览页面类
AllNews
前台全部新闻页面类
Search
前台新闻搜索页面类
UserReg
前台用户注册页面类
UserAddNews
前台用户发表新闻页面类
UserCenter
前台个人管理信息页面类
adminManager
Admin_Login
后台登录页面类
Admin_Index
后台主页页面类
Admin_NewsList
后台管理现有新闻页面类
Admin_EditNews
后台修改新闻页面类
Admin_DeletNews
后台删除新闻页面类
Admin_AddNews
后台发布新闻页面类
Admin_CheckNews
后台审核新闻页面类
CheckNews
管理审核功能页面类
Admin_Comments
后台管理新闻评论页面类
Admin_BigClass
后台管理新闻类别页面类
Admin_EditBig
后台修改新闻类别页面类
Admin_DeletBig
后台删除新闻类别页面类
Admin_AllUsers
后台管理系统用户页面类
Admin_EditlUsers
后台修改用户信息页面类
Admin_DeletlUsers
后台删除用户信息页面类
BLL
NewsLogic
新闻信息管理逻辑类
BigClassLogic
新闻类别管理逻辑类
CommentsLogic
新闻评论管理逻辑类
UserLogic
用户管理逻辑类
DAL
DBbase
数据库操作类
NewsAccess
新闻数据访问类
BigClassAccess
新闻类别数据访问类
CommentsAccess
新闻评论数据访问类
UserAccess
用户数据访问类
FromatString
截取字符串类
MODEL
NewsInfo
新闻信息类
BigClassInfo
新闻类别信息类
CommentsInfo
新闻评论信息类
UserInfo
用户信息类
系统业务流程
新闻发布系统分为前台和后台管理系统两部分，业务流程图如图1所示：
前台实现的功能主要包括：
（1）用户注册、修改已注册用户信息功能
（2）注册用户发布新闻功能
（3）新闻搜索功能
（4）各新闻类别中的新闻数量的统计功能
（5）用户对新闻进行评论功能
（6）热点新闻统计及浏览功能
（7）按类别浏览新闻
后台实现的功能主要包括：
（1）管理现有新闻
（2）发布新的新闻
（3）对要发布的新闻进行评审
（4）管理新闻评论
（5）管理新闻栏目
（6）管理系统用户
图1业务流程图
3程序1（三个类库）设计说明
本程序设计说明书以“新闻发布系统”的数据库及存储过程模块进行详细设计为例说明如何书写程序设计说明。
3.1程序描述
3、
（1）新闻信息的显示与检索是本系统的重要功能之一。
在该任务中包括新闻内容的显示与检索和新闻栏目的显示与检索两部分。
本系统采用标准的三层构架。
在任务中实体层MODEL类库中的类NewsInfo、BigClassInfo主要完成对数据库中新闻内容表tb_News和新闻栏目表tb_BigClass中字段的定义。
DAL类中的类NewAccess、BigClassAccess主要是对新闻内容及类别操作的各种功能的具体实现。
BLL类库中的类NewsLogic、BigClassLogic则是对DAL类库中类的逻辑调用。
（2）新闻评论也是本系统的重要功能之一。
在本系统中MODEL类库中CommentsInfo类主要完成对数据库中tb_Comments字段的定义。
DAL类库中CommentsAccess类主要是对新闻评论的各种功能的具体实现。
BLL类库中AccessLogic类则是对DAL类库中类的逻辑调用。
（3）后台用户管理是本系统的重要功能之一。
在该系统中MODEL类库中UserInfo类主要完成数据库中的用户表tb_User中字段的定义。
DAL类库中UserAccess类主要是对用户操作的各种功能的具体实现。
BLL类库中UserLogic类则是对DAL类库中类的逻辑调用。
3.2功能
3、
（1）本系统采用标准的三层构架。
这三层构架是完成系统前后台功能的基础。
新闻内容的显示与检索需要完成以下类的操作
MODEL类库：
NewsInfo、BigClassInfo类
DAL类库：
DBbase、NewAccess、BigClassAccess类
BLL类库：
NewsLogic、BigClassLogic类
其中，NewsInfo类定义属性对应新闻内容tb_News中的字段。
NewAccess类用于实现新闻内容显示与索引的基本方法。
NewsLogic类则用于完成对NewAccess类的逻辑调用从而实现新闻内容显示与检索的功能。
新闻栏目的显示与检索要完成实体层MODEL类库中的BigClassInfo类、数据访问层DAL类库中的BigClassAccess类、逻辑层BLL类库中的BigClassLogic类。
其中BigClassInfo类中定义的属性对应新闻栏目表tb_BigClass中的字段。
BigClassAccess类用于实现新闻栏目显示与索引的基本方法。
BigClassLogic类则用于完成对BigClassAccess类的逻辑调用从而实现新闻类别显示与检索的功能。
DAL层的DBbase的类是完成以上功能的必要前提，FromatString类用于对字符串长度的控制。
（2）新闻评论的实现需要完成实体层MODEL类库中CommentsInfo类、数据访问层DAL类库中CommentsAccess、逻辑层BLL类库中AccessLogic类的逻辑调用从而实现新闻评论的功能。
本系统完成类的顺序如下：
MODEL类库中的CommentsInfo类
DAL类库中CommentsAccess类
BLL类库中AccessLogic类
（3）后台用户管理实现需要完成实体层MODEL类库中UserInfo类、数据访问层DAL类库中UserAccess类、逻辑层BLL类库中UserLogic类。
其中，UserInfo类中定义的属性对应用户表tb_User中的字段。
UserAccess类用于实现用户操作的基本方法。
UserLogic类则用于完成对UserAccess类的逻辑调用从而实现用户操作的功能。
本系统完成类的顺序如下：
MODEL类库中UserInfo类
DAL类库中UserAccess类
BLL类库中UserLogic类
3.3性能
根据新闻系统的需求进行开发设计，主要实现如下目标：
界面设计友好、美观、数据要准确、安全、可靠。
强大查询功能，方便用户浏览网站的所有信息。
设计会员登陆功能，保证新闻留言的安全性。
实现对信息的添加、修改、删除，便于更新网站内容。
系统最大限度地实现易维护性和易操作性。
因此操作的简易实用性就体现的尤其重要。
在此系统的开发中就很好的体现了这一点系统的界面美观典雅充满了人性化用户操作起来也容易上手。
对于一个新闻发布系统而言新闻信息是很多的，而且使用人数较多，所以对系统的安全性有比较高的要求：
对于数据库，要设置不同用户的权限，数据的修改必须由合法用户操作。
3.3.1精度
要按照严格的数据格式输入，否则操作不允许，系统将给出错误提示，或者系统不给予响应进行处理。
说明对该软件的输入、输出数据精度的要求，可能包括传输过程中的精度。
3.3.2时间特性要求
说明对于该软件的时间特性要求，如对：
a．响应时间；
b．更新处理时间；
c．数据的转换和传送时间；
d．解题时间等的要求。
3.3.3灵活性
说明对该软件的灵活性的要求，即当需求发生某些变化时，该软件对这些变化的适应能力，如：
a．操作方式上的变化；
b．运行环境的变化；支持WINDOWS和LINUX环境下的运行。
c．同其他软件的接口的变化；
d．精度和有效时限的变化；
e．计划的变化或改进。
对于为了提供这些灵活性而进行的专门设计的部分应该加以标明。
3.4输人项
输入项是用户的注册与登录。
登录时需要按要求输入符合条件的管理员用户和管理员密码。
管理员进入系统后便可以通过各种链接进入到所需管理的模块中。
3.5输出项
输出项是指用户可以直观浏览到的，且可以直接通过点击所得到的相应的界面，包括：
新闻的首页，搜索新闻，新闻数量统计、用户登录以及通过链接得到的新闻详细信息。
3.6算法
本模块没有涉及到特殊的算法
3.7流程逻辑
用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。
3.8接口
该模块与主模块及其他模块的关系如下：
1、该模块直接被主模块调用，通过添加、修改、删除新闻内容和文件上传等操作，同时进行超链接，生成相应的窗口，为用户提供方便。
2、该模块直接调用数据库连接模块，取得数据库连接，调用数据库里表，实现数据库中数据的查询、修改、删除等操作。
3.9存储分配
无特殊要求
3.10注释设计
说明准备在本程序中安排的注释，如：
1、加在模块首部的注释；
2、加在各分枝点处的注释；
3、对各变量的功能、范围、缺省条件等所加的注释；
4、对使用的逻辑所加的注释等等。
5、加在程序单元首部，说明本程序的作用
6、对程序中的变量代表的意思、范围进行注释
7、对程序中的函数或过程所起的作用进行注释
8、加在模块首部的注释
9、加在各分支点处的注释
10、对各变量的功能、范围、缺省条件等所加的注释
11、对使用的逻辑等所加的注释
3.11限制条件
1、在管理员登入模板中，管理员的权限不可以为空，登陆密码不能为空
2、在数据库中设置管理员登入密码时必须有字长的限制
3、网友对新闻进行评论时，网友名称不能为空，
4、网友联系QQ不能为空，只能为数字
5、网友Email不能为空，格式必须符合要求
6、网友评论内容不能为空，否则无法进行正常对发布评论操作。
3.12测试计划
1、发表评论的字数不能超过相应的数字，如果超过了所发表的评论将无法提交，并弹出“超过所限字数”提示窗口。
如果是则满足条件。
2、如果出现点击相应模块无法打开相应的界面，则是数据连接的原因。
如果是则满足条件
3、发表评论的内容必须满足设置的条件，否则无法正常操作
3.13尚未解决的问题
说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。
4程序2（网站前台的实现）设计说明
前台阅读模块的最终目的是能方便地让用户读取到新闻，设计一个界面友好及能及时显示用户最需要信息的首页是在设计新闻发布系统时需要着重考虑的。
在新闻首页，一般将热门信息和最新信息放置在最显眼的位置，并提供栏目导航，使用户能随意方便地进入需要的栏目，并能看到栏目的新闻列表内容。
4.1程序描述
为了使新闻阅读具有趣味性和交互性，需要为新闻添加发表意见，添加评论的支持。
新闻评论添加后会跳转到新闻详情页面，在此页面读者可以看到新闻评论列表内容，评比附加在新闻详细内容后面。
网站前台的实现最终包括界面设计及功能的实现。
在前台中，用户可以按照新闻类别浏览新闻，同时对新闻进行评论，还可以对需要查找的新闻进行搜索。
如果用户想发布自己的新闻内容，则需要在前台中进行注册，注册后可以修改自己的注册信息，同时具有发布信息的权利。
当用户发布新闻本后台的管理员审核通过后，其他用户就可以对新闻进行浏览和评论。
同时在新闻主页用户可以看到热点新闻的排名及各个新闻类别中新闻数量的统计。
4.2功能
1、网站前台的实现
前台的设计使各用户通过点击母版页上的链接进入到各窗口页，实现新闻栏目，新闻内容的浏览与评论的内容，新闻的搜索、分类，所有新闻信息的显示等。
网站前台的实现主页包括以下功能：
（1）用户注册、修改已注册用户信息功能
（2）注册用户发布新闻功能
（3）新闻搜索功能
（4）各新闻类别中的新闻熟练的统计功能
（5）用户对新闻进行评论功能
（6）热点新闻统计及浏览功能
（7）按类别浏览新闻功能
网站前台功能的设计主要为数据访问层类、业务流程层类的各功能页，而这三层又都可以调用实体类。
4.3性能
界面设计要美观、大方；数据要准确、安全、可靠；
4.4输人项
输入项是用户的注册与登录。
登录时需要按要求输入符合条件的用户名和用户密码。
其他的模块只需通过点击就可以进入相应的界面
4.5输出项
输出项是指用户可以直观浏览到的，且可以直接通过点击所得到的相应的界面，包括：
新闻的首页，搜索新闻，新闻数量统计、用户登录以及通过链接得到的新闻详细信息。
4.6算法
本模块没有涉及到特殊的算法
4.7流程逻辑
用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。
4.8接口
该模块直接被主模块调用，通过添加、修改、删除新闻内容和文件上传等操作，同时进行超链接，生成相应的窗口，为用户提供方便。
4.9存储分配
根据需要，设置本程序的存储分配。
4.10注释设计
说明准备在本程序中安排的注释，如：
1、加在模块首部的注释；
2、加在各分枝点处的注释；
3、对各变量的功能、范围、缺省条件等所加的注释；
4、对使用的逻辑所加的注释等等。
5、加在程序单元首部，说明本程序的作用
6、对程序中的变量代表的意思、范围进行注释
7、对程序中的函数或过程所起的作用进行注释
8、加在模块首部的注释
9、加在各分支点处的注释
10、对各变量的功能、范围、缺省条件等所加的注释
11、对使用的逻辑等所加的注释
4.11限制条件
说明本程序运行中所受到的限制条件。
4.12测试计划
1、发表评论的字数不能超过相应的数字，如果超过了所发表的评论将无法提交，并弹出“超过所限字数”提示窗口。
如果是则满足条件。
2、如果出现点击相应模块无法打开相应的界面，则是数据连接的原因。
如果是则满足条件
3、发表评论的内容必须满足设置的条件，否则无法正常操作
4.13尚未解决的问题
说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。
5程序1（网站后台的实现）设计说明
后台用户管理实现是本系统的重要功能之一。
本系统采用标准的三层构建。
在该任务中MODEL类库中UserInfo类主要完成对数据库中用户表中字段的定义。
DAL类库中UserSccess类主要是对用户操作的各种功能的具体实现。
BLL类库中UserLogic类则是对DAL类库中类的逻辑调用。
因此要实现后台用户管理，就要完成各类库中类的实现。
5.1程序描述
网站后台的实现
在后台管理中，管理员登录后可以对本系统进行后台的管理。
管理员能够管理现有的新闻，可以对现有的新闻进行删除、修改、浏览等操作，同时还可以发布新闻以及对新闻进行审核。
只有当管理员审核通过后腰发布的新闻才能显示在新闻浏览页面，这样可以保证新闻的合法性。
管理员还可以对新闻类别及系统用户进行增加、删除、修改等操作。
由于一条新闻可以有多条评论，因此在新闻评论管理中，管理员可以删除一条新闻的单条评论，也可以删除一条新闻的全部评论。
网站后台的实现包括界面及功能的实现。
网站后台管理的主要功能如下：
（1）现有新闻
（2）管理发布新的新闻
（3）对要发布的新闻进行审核
（4）管理新闻评论
（5）管理新闻栏目
（6）管理系统用户
网址后台的实现：
在后台管理中，管理员登录后可以对本系统进行后台的管理。
管理员能够管理现有的新闻，可以对现有的新闻进行浏览、审核、修改、删除等操作，同时还可以发布新闻以及对新闻进行审核。
网站后台的实现包括界面的实现和相关功能代码的实现。
针对系统管理员，总结出如下需求信息
（1）管理员有不同的权限，可以对栏目进行增加、删除、修改
（2）管理员可以对新闻有增加、删除、修改
（3）管理员可以对行文模板增加、删除、修改
（4）管理员可以对新闻进行审核
（5）管理员可以对用户进行管理
5.2功能
网站后台功能的设计主要为数据访问层类、业务逻辑层类以及表示层的各功能项，而这三层又都可以调用实体类。
要实现网站后台功能必须先解决好各个页面的逻辑调用关系。
a、实现表示层的页面对其他层功能的调用。
本系统在数据层实现了对新闻、评论、用户、新闻类别的基本操作。
在逻辑层完成了对这些方法的逻辑调用，同时会根据各个页面的具体情况增加适当的方法。
由于在各个功能页面中都离不开对逻辑层相应类的对象的定义和使用，因此要根据不同的页面功能定义相应的对象，调用其方法实现功能。
b、数据控件的应用。
本系统后台中需要对数据进行大量操作，除了使用Repeater控件还使用了GridView控件。
后台登录主要还是对各新闻信息和用户信息的修改、删除、添加等的操作与管理
用户登入系统后可以对新闻进行浏览，阅读，搜索留言、评论留言等操作；还可以对新闻进行审核、评论等。
每条新闻的标题被做成一个链接，用户点击它们就能跳转页面进行新闻阅读；新闻阅读页面每条新闻的详细信息将被取出，包括内容、标题等；用户能根据自己的需要搜索新闻，如可以通过新闻标题或新闻内容对新闻进行搜索这样可以快速地找到符合条件的新闻，并输出搜索结果；用户能对新闻进行被评论（允许匿名评论）。
系统管理员可以进行新闻分类管理、添加新闻、修改新闻、新闻审核和删除新闻，同时系统管理员能完成用户管理如包括系统用户管理、添加用户和更改账号。
新闻管理员拥有添加新闻和更改账号的权限。
5.3性能
说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。
5.4输人项
输入项是管理员的注册与登录。
登录时需要按要求输入符合条件的管理员名和管理员密码。
其他的模块只需通过点击就可以进入相应的界面，以及管理员对新闻的各种操作窗口的登录（修改新闻类别、修改用户信息等）
5.5输出项
输出项是指经过管理员修改后所显示出来的新闻信息及用户信息的结果。
以及管理员所需要管理的新闻管理、类别管理、用户管理和其他的操作等。
5.6算法
无特殊算法
5.7流程逻辑
用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。
5.8接口
1、该模块直接被主模块调用，通过管理员对新闻的管理、类别的管理、用户管理及其他的操作，同时进行超链接，生成相应的窗口，为管理员自己和用户提供方便。
2、该模块直接调用数据库连接模块，取得数据库连接，
5.9存储分配
根据需要，说明本程序的存储分配。
5.10注释设计
说明准备在本程序中安排的注释，如：
1、加在模块首部的注释；
2、加在各分枝点处的注释；
3、对各变量的功能、范围、缺省条件等所加的注释；
4、对使用的逻辑所加的注释等等。
5、加在程序单元首部，说明本程序的作用
6、对程序中的变量代表的意思、范围进行注释
7、对程序中的函数或过程所起的作用进行注释
8、加在模块首部的注释
9、加在各分支点处的注释
10、对各变量的功能、范围、缺省条件等所加的注释
11、对使用的逻辑等所加的注释
5.11限制条件
说明本程序运行中所受到的限制条件。
5.12测试计划
1、添加用户信息时，用户名称不能为空，如果提交空的用户名称则弹出“用户名称不能为空的字样”；
2、用户密码不能为空；
3、用户邮箱不能为空且要按照要求填写符合条件的用户邮箱；
4、正确选择用户的权限；
以上各条件若有一条不满足都不能完成用户信息的添加操作，而且还会弹出一个阻止操作的提示窗口。
5.13尚未解决的问题
说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。
升级会员 