更新了一下版本,精简了一些代码,然后写了一个用户手册,尽量写的正规一点哈哈哈
已经上传至Github:点击这里下载
ACM周总结管理系统 V1.1 用户手册
一、引言
1.1 编写目的
编写这份用户手册,是为了向用户介绍“ACM周总结管理系统”的使用方法。
1.2 背景
a. 软件系统名称:“ACM周总结管理系统”;
b. 任务提出者、开发者:郑为中。
c. 首批用户:元培ACM实验室的师生。
1.3 定义
表现层(springMVC):Controller层。Controller层负责具体的业务模块流程的控制。
业务层(Spring):Service层。Service层主要负责业务模块的逻辑应用设计。
持久层(Mybatis):Dao层(mapper)。DAO层主要是做数据持久层的工作,负责与数据库进行联络的一些任务都封装在此。
1.4 参考资料
a. 蔡老师布置的寒假作业,要求大三学生开发一个带数据库的网站;
b. 《ACM周总结管理系统 V1.0》;
二、 用途
2.1 功能
a:新增周总结(所有用户)
B:查看已上传的周总结(所有用户)
C:删除上传的周总结(所有用户)
D:查看项目介绍和相关联系方式(所有用户)
2.2 性能
2.2.1精度
a:用户ID ,系统自动生成,int类型,理论最多可存在约21E个用户。
b:用户名称,字符串类型,0到100个字符,默认为NULL。
c:用户密码,字符串类型,0到100个字符,默认为NULL。
d:周总结ID:系统自动生成,int类型,理论最多可存在约21E篇周总结,且总大小不超过1024KB。
e:周总结作者,是对应“用户名称”的外键,字符串类型,0到100个字符,默认为NULL。
f:周总结周数,即标题,字符串类型,0到100个字符,默认为NULL。
g:周总结正文,TEXT类型,无字符上限,无默认值。
h:周总结日期,用于记录周总结的发布日期,字符串类型,0到100个字符,默认为NULL。
i:周总结发布状态,用于记录周总结是否发布成功,正常发布为1,int整型,默认为NULL。
j:周总结删除状态,用于记录是否被移动到回收站,正常为0,移到回收站为1,int整型,默认为NULL。
2.2.2时间特性
加载登入界面约1秒;登入跳转时间约1秒;查看子页面时间约1秒。
2.2.3灵活性
本系统仅支持Web运行,使用IntelliJ IDEA 2019.3打开本项目,配置mysql和Tomcat后可运行。
2.3 安全保密
本软件在注册用户时,使用验证码机制。后续还将开放邀请码注册机制,保护用户的数据安全。
三、 运行环境
3.1 硬设备
最低配置要求:
CPU 1.5G+ GHz多核处理器/2.0+GHz单核处理器
内存 2G +
显卡 支持OpenGL 1.4以上
硬盘 至少80M剩余空间
3.2 支持软件
a: 操作系统 Windows 10 X64
b: JDK 11
c: mysql 5.5.28
d: maven 3.6.3
e: tomcat 8.0.9
f: IDE IntelliJ IDEA 2019.3
g: 数据库名称 test
3.3 数据结构
用户类:
1. // 用户ID 2. private int a_id; 3. 4. // 用户名 5. private String a_name; 6. 7. // 密码 8. private String a_password;
总结类:
1. // 总结编号 2. private int s_id; 3. 4. // 总结作者 5. private String s_author; 6. 7. // 总结简介 8. private String s_intro; 9. 10. // 总结内容 11. private String s_content; 12. 13. // 总结创建日期 14. private String s_date; 15. 16. // 总结发表 --> 0:未发表 1:未发表 17. private int s_publish; 18. 19. // 总结状态 --> 0:存在 1:已删除 20. private int s_status;
四、 使用过程
4.1 安装与初始化
a:使用IntelliJ IDEA 2019.3 打开本项目
b:配置Deployment,移除旧的,添加新的
c:配置Tomcat本地目录和JDK版本
d:运行后进入登入界面,输入账号密码,点击登入
e:进入主页
4.2 输入
用户所需要保存上传的周总结。
4.2.1输入数据的现实背景
用户在学习或者工作中,自我总结的内容。
4.2.2输入格式
见2.2.1节精度。
4.2.3输入举例
周数:第六学期第一周
周总结内容:本周是第六学期的第一周,这是我的周总结。
4.3 输出对每项输出作出说明
4.3.1输出数据的现实背景
在网页中显示上传的周总结,方便用户查看总结。
4.3.2输出格式
网页。
4.3.3输出举例