团队项目技术规格说明书---服务器
一、功能框架说明
《校淘》服务器(以下简称XTServer)是在MyEclipse上开发的基于Java EE的服务器软件，并且运行在Tomcat8.0服务器，XTServer主要使用Hibernate框架简化开发过程。
XTServer主要由以下几部分组成：
- 用户管理（注册、登录、好友、聊天等）
- 商品管理（发布、购买、搜索等）
二、数据库设计
数据库共有9个表：
| 编号 | 表名 | 描述 |
|---|---|---|
| 1 | classify | 商品分类表 |
| 2 | comment | 商品评论表 |
| 3 | home | 首页商品表 |
| 4 | message | 消息表 |
| 5 | product | 商品表 |
| 6 | reqaddfriend | 好友请求表 |
| 7 | user | 用户表 |
| 8 | userditals | 用户详情表 |
| 9 | userfriend | 好友表 |
具体的表属性如下：
-
classify
-
comment
-
home
-
message
-
product
-
reqaddfriend
-
user
-
userditals
-
userfriend
三、主要类功能说明
1. 接口类
Hibernate框架为每个数据库表生成一个接口类，使得对数据库的操作变成了对对象的操作。主要包括以下类：
| 编号 | 类名 |
|---|---|
| 1 | Classify |
| 2 | Comment |
| 3 | Home |
| 4 | Message |
| 5 | Product |
| 6 | Reqaddfriend |
| 7 | User |
| 8 | Userditals |
| 9 | Userfriend |
2. UserManage类
类名：UserManage
类说明：这个类在构造的时候需要初始化内部的User类，或者通过registUser方法初始化。
类方法：
| 编号 | 类方法名 | 类方法功能 | 返回值类型 | 返回值说明 |
|---|---|---|---|---|
| 1 | registUser | 注册用户，调用后可调用方法isExist()检测是否注册成功 |
void | 无 |
| 2 | updatePassword | 修改用户密码 | int | 0：注册成功 1：用户不存在 2：原密码错误 |
| 3 | addFriend | 添加好友 | int | 0：添加成功 1：用户不存在 |
| 4 | getFriends | 获得好友列表 | ArrayList |
好友昵称列表 |
| 5 | reqAddFriend | 请求添加好友 | int | 0：请求成功 1：请求已存在 2：被请求用户不存在 3：请求用户不存在 |
| 6 | operateAddFriend | 操作好友请求 | int | 0:删除成功 1：删除失败 |
3. MessageManage类
类名：MessageManage
类说明：这个类在构造的时候需要初始化内部的User类，用以制定某个用户的消息管理。
类方法：
| 编号 | 类方法名 | 类方法功能 | 返回值类型 | 返回值说明 |
|---|---|---|---|---|
| 1 | sendMessage | 发送消息 | int | 0：发送成功 1：指定用户不存在 2：接收消息用户不存在 |
| 2 | getMessagesJson | 获得某个用户未查看消息信息的Json数据 | String | 用户消息信息Json数据 |
4. ProductManage类
类名：ProductManage
类说明：这个类在构造的时候需要初始化内部的Product类，用以某个某个商品的管理。
类方法：
| 编号 | 类方法名 | 类方法功能 | 返回值类型 | 返回值说明 |
|---|---|---|---|---|
| 1 | ProductManage | 带商品信息的构造方法，用以添加新的商品 | 无 | 无 |
| 2 | buyProduct | 购买该商品 | int | 0：购买成功；1：用户不存在 2：该商品已经被人购买 |
| 3 | getCommentsJson | 获得该商品的评论 | String | 商品评论信息列表Json数据 |
| 4 | addComment | 为该商品添加评论 | void | 无 |
| 5 | getProductInfoJson | 获取该商品的详细信息 | String | 该商品详细信息的Json数据 |
5. Servlet类
每个独立的功能都有一个继承自Servlet的类去处理，它们都是被客户端访问的类：
| 编号 | 类名 | 功能 |
|---|---|---|
| 1 | Regist | 用户注册 |
| 2 | Login | 用户登录 |
| 3 | UdPassWord | 修改用户密码 |
| 4 | SearchUser | 搜索用户 |
| 5 | SetUserDitals | 设置用户详细信息 |
| 6 | GetUserDitals | 获取用户详细信息 |
| 7 | RequestAddFriend | 请求添加好友 |
| 8 | OperateAddFrie | 操作好友请求 |
| 9 | DeleteFriend | 删除好友 |
| 10 | SendMessage | 发送消息 |
| 11 | GetMessages | 获取消息 |
| 12 | GetProduct | 通过商品分类获取商品 |
| 13 | GetProductById | 通过商品ID获取商品信息 |
| 14 | AddProduct | 发布商品 |
| 15 | BuyProduct | 购买商品 |
| 16 | AddComment | 添加评论 |
| 17 | GetComment | 获取评论 |
四、接口说明
服务器的地址：121.xx.xx.74
端口号：8080
说明：每个独立的工功能都有一个可访问的servlet地址
