# bbs

**Repository Path**: scudream/bbs

## Basic Information

- **Project Name**: bbs
- **Description**: No description available
- **Primary Language**: Java
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-06-07
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# BBS论坛项目
## members
- 彭文俊
- 郑健希
- 唐品
- 陈治中
- 孟中原

# 函数设计
##	用户端
这部分将介绍论坛用户要使用的几个主要页面以及每个页面所需要的功能。
###	通用功能
功能：
1、	登陆注册弹窗
2、	注销
3、	友情链接
4、	个人主页链接
5、	所有板块列表及跳转
6、	创作文章（跳转到文章创作页面）
函数设计：
1、	登陆注册
a)	参数：用户名、密码等信息
b)	返回值：int值判断是否成功（1：成功，其他：失败）、相关用户信息将被传至session
2、	注销
a)	参数：用户名
b)	返回值：int值判断是否成功（1：成功，0：失败）、相关用户信息会从session中删除
3、	获取友情链接
a)	参数：无
b)	返回值：友情链接列表
4、	获取所有板块列表
a)	参数：无
b)	返回值：板块列表
###	主页
功能：
1、	显示热门文章（帖子）登陆后显示关注板块的热门文章或者好友热门文章
函数设计：
1、	获取热门文章
a)	参数：页数（根据页数加载热门文章列表）
b)	返回值：热门文章列表（8-10个一页）
###	板块页面
功能：
1、	显示板块下文章列表
2、	根据不同数据排序文章
3、	创作文章
4、	关注作者
5、	关注板块
6、	收藏文章
7、	搜索功能（暂定）
函数设计：
1、	获取全部文章列表
a)	参数：板块id
b)	返回值：该板块下的所有文章列表
2、	关注作者
a)	参数：作者id，用户id
b)	返回值：boolean
3、	收藏文章
a)	参数：文章id，用户id
b)	返回值：boolean
4、	关注板块
a)	参数：板块id，用户id
b)	返回值：boolean
5、	搜索文章
a)	参数：文章的作者，标题模糊查询，时间限定等
b)	返回值：符合条件的文章列表
###	文章页面
功能：
1、	显示文章内容
2、	收藏文章
3、	关注作者
4、	举报文章
5、	评论文章
函数设计：
1、	获取文章内容
a)	参数：文章id
b)	返回值：文章内容，包含关注数作者等信息
2、	举报文章
a)	参数：文章id，用户id
b)	返回值：boolean
3、	评论文章
a)	参数：文章id，用户id，评论内容
b)	返回值：boolean或者页面跳转
###	个人信息主页
功能：
1、	显示个人信息
2、	显示个人文章
3、	显示个人回复
4、	显示收藏订阅的文章、作者、板块，并给链接
5、	编辑个人信息
函数设计：
1、	就显示上面的一堆，分成多个函数给还是一个函数给全都行
a)	参数：用户id
b)	返回值：包含上述信息的json数据或者列表
2、	提交更改的个人信息
a)	参数：用户id、更改的个人信息（包括头像）
b)	返回值：boolean
###	文章编写
功能：
1、	文章提交
2、	获取所有板块列表
函数设计：
1、	文章提交
a)	参数：用户id、题目、分类（板块）内容、图片或者视频（以后可能）
b)	返回值：boolean

##	管理端
###	通用功能
功能：
1、	登录、注销
2、	五个页面之间自由跳转（菜单栏）
###	仪表盘
功能（均可裁剪）：
1、	显示用户总数并提供跳转
2、	显示访问总数并提供跳转
3、	显示板块总数并提供跳转
4、	显示文章总数并提供跳转
5、	用户简略排行榜
6、	新用户信息
7、	访问数量统计
函数设计：
1、	返回1-4功能所需的数字
a)	参数：无
b)	返回值：包含四个总数的数组
2、	返回发文章最多的前五个用户
a)	参数：无
b)	返回值：五个用户的列表，信息包含最后更新时间、姓名、id、邮箱、文章数目
3、	返回新注册用户x人
a)	参数：无
b)	返回值：返回列表 

###	用户管理
功能：
1、	查看指定页数用户信息
2、	删除用户
3、	禁言用户
函数设计：
1、	返回指定页数的10-15条信息
a)	参数：页数
b)	返回值：10-15条信息列表
2、	删除指定用户
a)	参数：用户id、管理员id
b)	返回值：boolean
3、	禁言指定用户
a)	参数：用户id、管理员id
b)	返回值：boolean
###	文章管理模块
功能：
1、	显示所有文章(标题、作者、时间、审核状态)
2、	查看文章内容
3、	审核指定文章
4、	删除指定文章
5、	置顶指定文章（最多3个）
函数设计：
1、	获取所有文章信息列表
a)	参数：无
b)	返回值：所有文章列表
2、	查看指定文章
a)	参数：文章id
b)	返回值：文章内容作者等（可以有页面跳转）
3、	审核指定文章
a)	参数：文章id、通过或者不通过、管理员id
b)	返回值：boolean
4、	删除文章
a)	参数：文章id、管理员id
b)	返回值：boolean
5、	置顶文章
a)	参数：文章id、管理员id
b)	返回值：boolean
###	板块管理
功能：
1、	查看所有板块信息
2、	创建板块
3、	修改板块名字
4、	删除板块
函数设计：
1、	获取所有板块信息
a)	参数：无
b)	返回值所有板块列表，包括板块名字，文章数、最后活跃时间
2、	创建板块
a)	参数：管理员id、板块名字
b)	返回值：boolean
3、	修改板块
a)	参数：板块id、管理员id、更改的名字
b)	返回值：boolean
4、	删除板块
a)	参数：板块id、管理员id
b)	返回值：boolean
###	访问记录
功能：
1、	返回所有访问记录信息
函数设计：
1、	返回所有访问信息
a)	参数：无
b)	返回值：访问信息列表：ip、用户、时间等


# 接口函数

## 版块相关(只涉及正确访问)  BlockController

### getBlockList
#### 功能：获取所有版块信息 不分页
#### 请求参数：null（不传参）
#### 返回参数：{"code":200,"msg":"","count":已有版块数,"data":Block的列表}

### getBlockListByPage
#### 功能：分页获取版块信息
#### 请求参数：null（模糊搜索还没有做，使用搜索时应传入 b_title）
#### 返回参数：{"code":200,"msg":"","count":已有版块数,"data":Block的列表}

### getBlockNum
#### 功能：获取版块数
#### 请求参数：null
#### 返回参数：{"code":200,"msg":"","count":已有版块数}

### addBlock
#### 功能：新增版块
#### 请求参数：b_title b_description(可为空)
#### 返回参数：{"code":200,"msg":""}

### removeBlockById
#### 功能：删除版块
#### 请求参数：b_id(session获取？暂定)
#### 返回参数：{"code":200,"msg":""}

### redactBlock
#### 功能：修改版块信息（版块名称或描述）
#### 请求参数：b_id、b_title、b_description(除了b_id其余均可为空)
#### 返回参数：{"code":200,"msg":""}

### getTopicNum
#### 功能：获取当前版块贴子数
#### 请求参数：b_id
#### 返回参数：{"code":200,"msg":"","count":该版块贴子数}


## 版主相关（版主删改等） ModeratorController

### getModeratorList
#### 功能：获取所有版主信息
#### 请求参数：u_id或b_id(都为空时返回所有版主，u_id不为空时返回该用户管理的版块，b_id不为空时返回该版块的版主id)
#### 返回参数：{"code":200,"msg":"","data":Moderator的列表}

### addModerator
#### 功能：新增版主
#### 请求参数：u_id b_id（相互对应）  不能为空 必须存在（暂时还没有做校验）
#### 返回参数：{"code":200,"msg":"",}

### removeModerator
#### 功能：删除版主
#### 请求参数：u_id b_id（相互对应）
#### 返回参数：{"code":200,"msg":""}

### getModeratorNum
#### 功能：返回版主总数
#### 请求参数：无
#### 返回参数：{"code":200,"msg":"","count":count(版主数量)}

## 帖子相关 TopicController

### getTopicList
#### 功能：获取帖子列表 不分页
#### 请求参数：b_id u_id (均可为空)
#### 返回参数：{"code":200,"msg":""，"data":相应帖子列表}

### getTopicListByPage
#### 功能：分页获取帖子列表
#### 请求参数：b_id(同getTopicList)
#### 返回参数：{"code":200,"msg":""，"data":相应帖子列表}

### getTopicCommentList
#### 功能：返回该贴以及其评论
#### 请求参数：t_id
#### 返回参数：{"code":200,"msg":"","data":该贴详细信息以及所属评论，结构同TopicDao.xml中的resultMap}

### getEliteTopicListByPage
#### 功能：分页获取精华帖
#### 请求参数：b_id(同getTopicList)
#### 返回参数：{"code":200,"msg":""，"data":相应帖子列表}

### getMyTopicList（暂时还没有测试，应该没问题）
#### 功能：获取我发的帖子
#### 请求参数：t_author_id
#### 返回参数：{"code":200,"msg":""，"data":相应帖子列表}


### getMyTopicListByPage
#### 功能：分页获取我发的帖子
#### 请求参数：t_author_id
#### 返回参数：{"code":200,"msg":""，"data":相应帖子列表}

### getMyCollectionTopicList
#### 功能：分页获取我的收藏贴（暂时还没有测试，应该没问题）
#### 请求参数：t_author_id
#### 返回参数：{"code":200,"msg":""，"data":相应帖子列表}


### getMyCollectionTopicListByPage
#### 功能：分页获取我的收藏贴
#### 请求参数：t_author_id
#### 返回参数：{"code":200,"msg":""，"data":相应帖子列表}

### getCommentNum
#### 功能：获取帖子回复数
#### 请求参数：t_id
#### 返回参数：{"code":200,"msg":"","commentNum":当前帖子评论数}

### postTopic
#### 功能：发帖
#### 请求参数：t_title t_author_id t_type(是否投票贴，暂时还没有做) b_id(所属版块id)  均不为空
#### 返回参数：{"code":200,"msg":""}

### redactTopic
#### 功能：修改帖子
#### 请求参数：t_title b_id t_id
#### 返回参数：{"code":200,"msg":""}

### getPostMostUser
#### 功能：获取返回发布文章数目最多的10名用户
#### 请求参数：null
#### 返回参数：{"code":200,"msg":"","data":用户列表(暂时只返回u_id,u_name,topic_num)}

### removeTopicById
#### 功能：删除帖子
#### 请求参数：t_id
#### 返回参数：{"code":200,"msg":""}

### recoverTopicById
#### 功能：恢复删除帖子
#### 请求参数：t_id
#### 返回参数：{"code":200,"msg":""}

### setTopTopicById
#### 功能：置顶帖子
#### 请求参数：t_id
#### 返回参数：{"code":200,"msg":""}

### removeTopTopicById
#### 功能：取消置顶
#### 请求参数：t_id
#### 返回参数：{"code":200,"msg":""}

### setEliteTopicById
#### 功能：设置精华帖
#### 请求参数：t_id
#### 返回参数：{"code":200,"msg":""}

### removeEliteTopicById
#### 功能：取消精华贴
#### 请求参数：t_id
#### 返回参数：{"code":200,"msg":""}

### closeTopicById
#### 功能：关闭帖子评论权限（不能评论）
#### 请求参数：t_id
#### 返回参数：{"code":200,"msg":""}

### reopenTopicById
#### 功能：打开帖子评论权限
#### 请求参数：t_id
#### 返回参数：{"code":200,"msg":""}

### informTopic
#### 功能：举报帖子
#### 请求参数：report_content,report_author_id,report_t_id (暂时没有做检查，不能为空)
#### 返回参数：{"code":200,"msg":""}

### collectTopic
#### 功能：收藏帖子
#### 请求参数：u_id t_id
#### 返回参数：{"code":200,"msg":""}

### deleteCollectionTopic
#### 功能：取消收藏
#### 请求参数：u_id t_id
#### 返回参数：{"code":200,"msg":""}


## 评论相关 CommentController

### postComment
#### 功能：发表评论
#### 请求参数：c_content,u_id,t_id,
#### 返回参数：{"code":200,"msg":""}

### redactComment
#### 功能：修改评论
#### 请求参数：c_content c_id
#### 返回参数：{"code":200,"msg":""}

### removeComment
#### 功能：删除评论
#### 请求参数：c_id
#### 返回参数：{"code":200,"msg":""}

### getCommentList
#### 功能：获取评论列表
#### 请求参数：t_id
#### 返回参数：{"code":200,"msg":"","data":相应评论列表}

### getMyComment
#### 功能：获取我的评论
#### 请求参数：u_id
#### 返回参数：{"code":200,"msg":"","data":相应评论列表}

### getMyCommentByPage
#### 功能：分页获取我的评论（传参问题暂时没有解决，用一下上面的不分页吧）
#### 请求参数：u_id
#### 返回参数：{"code":200,"msg":"","data":相应评论列表}

## 公告相关（添加、获取、删除公告等）（类名：NoticeController）

### getNotice
#### 功能：获取论坛内所有公告
#### 请求参数：无参数
#### 返回参数：{"code":200,"msg":"","data":Notice的列表}

### getNoticeDetail
#### 功能：获取一个公告
#### 请求参数：HttpServletRequest request，其中应包含"notice_id"字段
#### 返回参数：{"code":200,"msg":"","data":Notice类}

### addNotice
#### 功能：向论坛中添加公告
#### 请求参数：HttpServletRequest request，其中应包含"notice_title"、"notice_content"两个字段
#### 返回参数：{"code":200,"msg":""}

### updateNotice
#### 功能：更改公告内容
#### 请求参数：HttpServletRequest request，其中应包含"notice_id"、"notice_title"、"notice_content"三个字段
#### 返回参数：{"code":200,"msg":""}

### deleteNotice
#### 功能：删除公告
#### 请求参数：HttpServletRequest request，其中应包含"notice_id"字段
#### 返回参数：{"code":200,"msg":""}

## 举报相关（ReportController）

### getReportList
#### 功能：获取举报的信息
#### 请求参数：无参数
#### 返回参数：{"code":200,"msg":"","data":Report列表}


## 友情链接相关（FriendlyLinkController）

### getFriendlyLink
#### 功能：获取友请链接
#### 参数：无
#### 返回值：{"code":200,"msg":"","data":FriendlyLink列表}

### addFriendlyLink
#### 功能：添加友情链接
#### 参数：HttpServletRequest request，应包含"link_name"（链接名）、"link_content"（链接内容）两个字段
#### 返回值：{"code":200,"msg":""}

### updateFriendlyLink
#### 功能：更新友情链接
#### 参数：HttpServletRequest request，其中应包含"link_id"、"link_name"、"link_content"三个字段
#### 返回值：{"code":200,"msg":""}

## 用户管理相关（AdminController）

### getAllUser
#### 功能：分页获取所有用户
#### 参数：PageInfo info，使用layUI框架自动传输
#### 返回值：{"code":200,"msg":"","count":count(User对象个数),"data":User列表}

### getUserRank
#### 功能：获取用户排行
#### 参数：无
#### 返回值：{"code":200,"msg":"","data":UserRank列表}

### getNewUser
#### 功能：获取新注册用户
#### 参数：无
#### 返回值：{"code":200,"msg":"","data":User列表}

### banUser
#### 功能：禁止用户
#### 参数：int u_id（用户id）
#### 返回值：{"code":200,"msg":""}

### changeUserType
#### 功能：改变用户类型
#### 参数：int u_id（用户id）, int u_type（新的用户类型）
#### 返回值：{"code":200,"msg":""}

### deleteUser
#### 功能：删除用户
#### 参数：int u_id（用户id）
#### 返回值：{"code":200,"msg":""}

### getUserNum
#### 功能：获取用户数量
#### 参数：无
#### 返回值：{"code":200,"msg":"","data":count}

## 用户相关

### checkLoginInfo
#### 功能：用户登录并将相关信息存入session
#### 请求参数：e_mail,pwd
#### 返回参数：成功{"code":200},失败{"code":-1}

### addLoginInfo
#### 功能：用户注册，若成功会将用户相关信息传入session
#### 请求参数：name,e_mail,pwd，gender
#### 返回参数：成功{"code":200},失败{"code":-1}

### logout
#### 功能：用户注销，消除session中存入的信息
#### 请求参数：null
#### 返回参数：成功{"code":200},失败{"code":-1}

### checkFriends
#### 功能：查看该用户关注的好友
#### 请求参数：null
#### 返回参数：成功{"code":200，"friends",userList},失败{"code":-1}

### addFriend
#### 功能：加好友
#### 请求参数：target_id
#### 返回参数：成功{"code":200},失败{"code":-1}

### deleteFriend
#### 功能：删好友
#### 请求参数：target_id
#### 返回参数：成功{"code":200},失败{"code":-1}

### modifyLoginInfo
#### 功能：修改登录信息
#### 请求参数：email, pwd
#### 返回参数：成功{"code":200},失败{"code":-1}

### modifyBasicInfo
#### 功能：修改基本信息
#### 请求参数：gender, img
#### 返回参数：成功{"code":200},失败{"code":-1}

### checkMessage
#### 功能：查看短消息
#### 请求参数：null
#### 返回参数：成功{"code":200,"messages",messages},失败{"code":-1}

### deleteMessage
#### 功能：删除短消息
#### 请求参数：null
#### 返回参数：成功{"code":200},失败{"code":-1}

### responseMessage
#### 功能：回复短消息
#### 请求参数：content， receiver_id
#### 返回参数：成功{"code":200},失败{"code":-1}

### checkUndeliveredMessage
#### 功能：查看草稿箱
#### 请求参数：null
#### 返回参数：成功{"code":200,"messages",messages},失败{"code":-1}

### sentUndeliveredMessage
#### 功能：发送草稿箱中的信件
#### 请求参数：m_id
#### 返回参数：成功{"code":200},失败{"code":-1}