OA系统设计说明文档格式.docx
- 文档编号:21191647
- 上传时间:2023-01-28
- 格式:DOCX
- 页数:14
- 大小:350.17KB
OA系统设计说明文档格式.docx
《OA系统设计说明文档格式.docx》由会员分享,可在线阅读,更多相关《OA系统设计说明文档格式.docx(14页珍藏版)》请在冰豆网上搜索。
1.实用:
满足用户现实需要,解决实际问题,做细核心功能。
2.易用:
使用方便,各项功能一目了然。
满足用户的使用习惯,易使用、易维护、易升级。
实现“傻瓜〞式的操作,将实施、培训本钱和周期降到最低。
3.简洁:
页面简洁,功能简洁,每一个元素都有存在的意义。
4.稳定:
从底层数据库到功能层经过严格测试,能在不同的硬件环境中长期平稳运行。
1.1.4.功能说明
OA是辅助办公的软件,使用OA与不使用OA相比照的好处是:
可以用计算机管理所有的数据,并可以方便的实现统计与报表的功能。
提高办公效率。
〔实现信息化〕。
以下是一个OA系统的全部功能列表:
说明:
不是所有的OA都有全部的功能,而是根据需求确定的。
1.2.项目实现说明
1.2.1.软件开发的步骤说明
需求确认—概要设计—详细设计—编码—单元测试—集成测试—系统测试—维护。
单元测试是由程序员自己来完成,最终受益的也是程序员自己。
可以这么说,程序员有责任编写功能代码,同时也就有责任为自己的代码编写单元测试。
执行单元测试,就是为了证明这段代码的行为和我们期望的一致。
集成测试,也叫组装测试或联合测试。
在单元测试的根底上,将所有模块按照设计要求〔如根据结构图〕组装成为子系统或系统,进展集成测试。
实践说明,一些模块虽然能够单独地工作,但并不能保证连接起来也能正常的工作。
程序在某些局部反映不出来的问题,在全局上很可能暴露出来,影响功能的实现。
系统测试是将已经确认的软件、计算机硬件、外设、网络等其他元素结合在一起,进展信息系统的各种组装测试和确认测试,其目的是通过与系统的需求相比拟,发现所开发的系统与用户需求不符或矛盾的地方,从而提出更加完善的方案。
1.2.2.在项目开发中,我们处于什么位置,要做哪些事情?
1.2.3.在课堂上,我们要完成哪些功能,具体需什么?
模块
功能
说明
组织与用户管理
岗位管理
部门管理
用户管理
系统权限
初始化权限
分配权限
验证权限
网上交流--论坛
版块管理
看帖、发帖、回帖
文章管理
审批流转〔工作流〕
表单模板管理
审批流程管理
审批流转
表单查询
按列出的顺序实现功能。
效果以静态页面为准〔需求〕。
按静态页面做
1.3.ItcastOA的整体设计
1.3.1.分层
一、JavaEE的三层架构
二、关于分层的说明
1,上面调用下面,即View调用Service,Service调用Dao。
2,层与层之间用接口。
除定义的接口外,不能使用其它层的特有类或接口。
3,使用实体作为DTO〔DataTransferObject,数据传输对象〕
要做到任一层换掉后,其他层不受影响。
我们在此项目中使用两层:
View+Service即在Service中直接操作Hibernate.Session。
因为如果使用三层,在Service中就会有一局部方法只是直接调用DAO中的方法。
一般情况下只有在多个数据源的场合下适合引入DAO层。
三、有关分层的几个问题
1,一定要分层吗?
不一定。
假设公司要求你写一个可以给指定员工发送短信的小程序,用于开会通知与自动发送生日祝福短信。
这个程序很小,没有多少行代码,而且不变,这时不分层可以吗?
完全可以呀。
但我们在写程序时,还是要分层的,分层的程序结构清晰,可维护性高。
2,一定要3层吗?
分3层是推荐的,而不是必须的,应根据自己的具体情况进展安排。
我们如果使用3层的结构,用起来就麻烦,因为在Service中会有一局部方法只是直接调用Dao中的方法,而Dao中的方法只是调用Session完成某操作。
此时分2层更好,即在Service中可直接操作Session,以简化结构。
其实Hibernate已经可以支持多种数据库。
3,一定要使用接口吗?
以前就有同学问我:
“在设计程序时确定的技术在开发完成后一般不会更换的,实现类一般也不会更换,这种情况还用接口吗,一般的小项目是不是可以不使用接口?
〞。
是的,如果不会变〔一般也不会变〕,这是完全可以的。
我们所学习的框架、技术都是解决问题的推荐方案,而不是必须要用的。
遇到问题后优先使用成熟的技术与方案,以防止很多潜在的问题,防止走不必要的弯路。
1.3.2.所用框架、技术
编号
工具
版本
1.
Struts2
2.1.8.1
2.
Hibernate
3.6.0
实现持久化操作
3.
Spring
2.5
4.
PM
4.4
工作流支持
5.
Junit
4
单元测试
6.
jQuery
1.4
1.3.3.开发环境
操作系统
WindowsXP
开发工具
MyEclipse8.6
Eclipse
数据库
MySql5.0.22
Web容器
Tomcat6.0
浏览器
IE6
1,推荐使用MyEclipse,这样出现工具问题可以一起解决。
当然也可以使用自已熟悉的工具,如Eclipse、NetBeans、IntelliJidea。
现在的重点是代码实现,不是工具。
应使用有效的工具。
2,要注意使用的MySql与JDBC驱动的版本要兼容。
3,显示的技术〔js,css〕有兼容的问题,写出的代码可能在某些浏览器中不能正常运行,这就需要在写代码时多使用JS框架,让框架帮我们解决兼容的问题。
1.3.4.代码规
1,命名:
使用驼峰命名法。
a)类、接口:
每个单词的首字母大写。
例:
MyDateConverter
b)变量、方法:
第一个单词的首字母小写,其他单词的首字母都大写。
myDateConverter
c)常量:
全部字母都大写,单词之间使用’_’隔开。
例,DEFAULT_PAGE_SIZE
2,使用有意义的名称,慎用缩写。
3,注释:
在代码中参加适当的注释:
说明步骤,与说明非简单逻辑。
4,空行:
在代码中参加适当的空行,就像写文章时要分段一样〔增强可读性〕。
5,要格式化代码、一个java文件中的代码不要过多、一个方法中的代码不要过多。
总之,要保证代码的有效、清晰、简洁〔→可读〕。
1,有效:
这是第一目标,代码要是可以解决问题的。
2,清晰:
在有效的前提下,让代码结构与思路清晰。
3,简洁:
代码与逻辑应尽量的简单,不要是给别人讲别人都听不明白。
1.3.5.约定
1,工程中所有的文件都采用utf-8编码。
所有的页面都是使用utf-8编码,这样方便解决表单容的乱码问题。
乱码一般情况下是乱用编码产生的。
2,实体的主键属性的类型使用Long型。
1.3.6.项目计划
知识点
预计时间
1.搭建环境+根底功能
a)Dao设计
1.Struts根底
2.Hibernate根底
1天
2.组织用户管理
a)岗位管理
b)部门管理
c)用户管理
1.一般的实体设计
2.实体映射〔映射文件〕
3.增删改查功能
4.树状显示
5.使用jQuery.validate进展表单验证
2天
3.系统权限
a)创立权限
b)分配权限
c)使用权限
1.jQuery的一般使用
2.权限控制方案
4.论坛
a)论坛管理
b)论坛根本功能
c)文章管理
1.分页
2.在线编辑器FCKeditor
3天
5.PM+审批流转
a)工作流框架PM
b)审批流转功能
1.工作流框架PM
2.工作流的一般应用
4天
2.准备环境
2.1.创立数据库,要注意编码
1,使用MySql数据库。
2,创立数据库时,要注意编码要支持中文。
3,建表语句如下:
createdatabaseitcastoadefaultcharactersetutf8;
showcreatedatabaseitcastoa;
需要先运行Mysql的配置向导,把编码配为GBK或UTF8。
如果配成UTF8,在mysql命令行客户端中就有乱码,所以最好用GBK。
2.2.新建Web工程并进展配置
2.2.1.配置工具
2.2.1.1.配置快捷键
1,把ContentAssist设为Alt+/
2,把WordCompletion设为Alt+.
3,其他常用快捷键说明:
Alt+/
ContentAssist代码提示
Ctrl+T
显示类的继承结构
Ctrl+O
列出类中的成员〔成员变量、方法等〕
Ctrl+/
注释/取消注释
Ctrl+Shift+O
导入要使用的包、并去除不使用的包
Ctrl+Shift+F
格式化当前文件中的代码/格式化选中的代码
Ctrl+Alt+Up
复制当前行到下面
Ctrl+Alt+Down
复制当前行到上面
Ctrl+D
删除当前行/删除选中文本占的所有行
Shift+Enter
相当于按End后再按Enter
Alt+Left
Alt+Right
Ctrl+Shift+X
变为大写
Ctrl+Shift+Y
变为小写
2.2.1.2.配置文件的默认编码
1,设置工程的默认编码为UTF-8。
2,配置JSP的默认编码为utf-8
2.2.1.3.配置格式化的代码样式
1,使用Ctrl+Shift+F可以格式化代码。
2,在Window→Preferences→Java→CodeStyle→Formatter中可以设置代码样式。
要把Java代码与注释的行宽设为130。
〔其他使用默认样式〕
3,搜索XMLSources,修改xml的行宽为130。
〔不考虑打印的情况〕
2.2.1.4.MyEclipse工具使用说明
1,导入工程时可以直接选择一个zip文档:
File→Import→ExistingProjectsintoWorkspace-->
Selectarchivefile。
2,工程改名后,发果发布到Tomcat下,对应的应用的名称不一定改变。
这个名称是在MyEclipse→Web中的WebContext-root中配置的。
新建一个WebProject,并设置工程的编码为UTF-8。
2.2.2.添加框架环境
1,不要引用外面的Jar包,应全部拷贝到工程中。
2.2.3.配置数据库
修改Hibernate.cfg.xml中的数据库连接信息。
<
!
--显示sql语句-->
propertyname="
show_sql"
>
true<
/property>
--自动更新表结构-->
hbm2ddl.auto"
update<
2.3.工程中的资源分类〔目录与包结构〕
2.3.1.目录结构
源码文件夹
src项目源代码
conf配置文件
test单元测试
WebRoot文件夹下
scriptJavaScript脚本文件
styleCSS样式文件
WEB-INF/jspjsp页面文件〔再创立子文件夹分类存放〕
2.3.2.包结构
使用三层:
显示层〔View〕,业务层〔Service〕,数据访问层〔Dao〕
〔局部〕
包名
cn.itcast.oa.domain
实体〔Domain〕
cn.itcast.oa.dao
Dao接口
cn.itcast.oa.dao.impl
Dao的实现类
cn.itcast.oa.service
Service接口
cn.itcast.oa.service.impl
Service的实现类
cn.itcast.oa.struts2.action
Struts的Action
cn.itcast.oa.util
一些工具类
cn.itcast.oa.cfg
cn.itcast.oa.filter
View显示Jsp+JSTL+Struts+jQuery
Service业务逻辑PM
Dao数据访问Hibernate
3.根底功能
3.1.设计BaseDao接口与BaseDaoImpl类
每个实体都应有一个对应的Dao,他封装了对这个实体的数据库操作。
例
实体Dao接口实现类
========================================================
User-->
UserDao-->
UserDaoImpl
Role-->
RoleDao-->
RoleDaoImpl
Department-->
DepartmentDao-->
DepartmentDaoImpl
Article-->
ArticleDao-->
ArticleDaoImpl
...
4,实体的Dao接口要继承BaseDao接口。
5,Dao的实现类要继承DaoImplBase类。
6,也可以不继承指定的接口或类,这样就要自己写相应的方法。
7,TgetById(Longid)与List<
T>
getByIdList(Long[]idList)不要合并为ListgetById(Long...ids),因为获取一个对象时也是返回List,不方便。
获取BaseDao的类型参数T的Class
问题:
1,有了DaoBase与DaoImplBase,还要用UserDao、RoleDao吗?
答:
要用。
因为UserDao或RoleDao中的方法可以分为有公有的方法与特有的方法两局部。
公有的方法是通过继承BaseDao得到的,特有的方法要写在自己里面〔BaseDao中是没有的〕。
2,UserDaoImpl已经继承了BaseDaoImpl,就不实现UserDao可以吗?
不可以。
否那么UserDaouserDao=newUserDaoImpl();
就不成立。
使用反射获取类型参数的真实类型的代码如下:
publicDaoBaseImpl(){
Typetype=this.getClass().getGenericSuperclass();
ParameterizedTypept=(ParameterizedType)type;
this.clazz=(Class<
)pt.getActualTypeArguments()[0];
}
1,使用Session时,不要自己创立,也不要管理事务,直接调用getSession()即可。
2,暂时不实现getSession()方法,在后面的事务管理中实现:
protectedSessiongetSession(){thrownewUnsupportedOperationException();
}
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- OA 系统 设计 说明