HITRen

##0. 基础

• 客户端请求数据的方法，利用url来请求相应的servlet，同时需要传递相应的参数，所需参数在以下条目中悉数介绍
• servlet命名规范：每个servlet对应的java文件的文件名去掉结尾处的servlet即可，如登录需要请求LoginServlet，该servlet的名称为Login
• 参数命名：单词为复数形式的都是数组，如gnames，数组中元素的数据类型以该单词的单数形式为准，如uids，则每个元素都是uid的类型；所有id都是int型，seq也为int型，其他无特别说明的就是字符串
• 返回值：每个servlet都是返回一个json数据
  • 字段SUC是bool型，表示操作成功与否
  • INFO字符串，表示附加说明，具体每个servlet都不同
  • DATA，json格式，表示实际返回的数据

##1. 用户简单逻辑

• 登录: LoginServlet.java 客户端需要传参数email和password
• 注册: RegisterServlet.java 客户端需要传参数email和password
• 下载用户基本信息: DownloadUserInfoServlet.java 客户端需要传参数uid,seq
• 更新用户信息: UpdataUserInfoServlet.java 客户端需要传参数是一个json对象，包括用户的所有基本信息

##2. 好友关系逻辑

• 增加好友分组: AddConcernlistGroupServlet.java, 参数: uid,gname
• 重命名好友分组: RenameConcernlistGroupServlet.java,参数:uid,gname1,gname2
• 关注一个好友到分组: ConcernUserServlet.java, 参数:自己的uid,要关注的好友uid1,要放的分组gnames
• 将一些好友复制到新的分组: CopyUsersToGroupsServlet.java, 参数: uid,users,gnames
• 将一些好友从分组中删除: DeleteUsersFromGroupServlet.java, 参数: uid,users,gname
• 将一些好友从一个分组移动到另外的一些分组: MoveUsersFromGroupToGroupsServlet.java, 参数: uid,users, 当前所在分组gname,目标分组gnames
• 下载好友关系信息: DownloadRelationshipInfoServlet.java, 参数: uid, seq
• 删除关注的好友: DeleteConcernedUserServlet.java, 参数: uid, uid1
• 拉进黑名单: MoveUsersToBlacklistServlet.java, 参数: uid, users
• 从黑名单恢复: RecoverUsersFromBlacklistServlet.java, 参数: uid, users
• 删除好友分组: DeleteConcernlistGroupServlet.java, 参数: uid,gname,删除后，该分组中所有的好友都会移到default分组中

##3. 社交功能逻辑

• 发短状态: SendShortMessageServlet.java, 参数: uid, message:状态内容, auth:表示是否设置可见范围，0表示不设置，1表示设置, gnames:如果auth=1，则必须传这个字段，否则不用传
• 点赞: LikeTheMessageServlet.java, 参数: uid, mid: 被点赞的状态
• 取消点赞: CancelLikeTheMessageServlet.java, 参数： uid, mid:被取消点赞的状态
• 评论状态: CommentMessageServlet.java, 参数: uid评论者, mid: 被评论的状态, type:评论类型，0表示直接评论状态，1表示回复某人, 如果type是1，则有字段reuid表示被回复的uid,content表示回复内容
• 分享状态: ShareMessageServlet.java, 参数: uid分享者, mid被分享的状态，content分享时的描述, gnames分享给这些分组的好友看，数组为空表示分享给所有好友看
• 下载timeline:DownloadTimelineServlet.java, 参数: seqtimeline的seq
• 下载状态数据:DownloadMessagesServlet.java, 参数: mids

---

##项目构成

• 配置文件：
  • 路径： WEB-INF/conf
  • memcache.conf: memcached的配置文件，内容是部署的服务器ip和端口
  • openfire.conf: openfire服务器的配置文件，包含了服务器的基本信息，详见文件内容
• 包
  • cn.edu.hit.constant: 各种常量，主要是mongodb中的字段名
  • cn.edu.hit.dao: 和底层数据操作有关的类，包括mongodb的操作和memcached的操作
  • cn.edu.hit.kit: 工具类，包括文件路径的获取，时间的获取以及log
  • cn.edu.hit.logic: 逻辑代码，处理服务器中的各种逻辑
  • cn.edu.hit.model: 数据模型，用来表示数据
  • cn.edu.hit.openfire: 操作openfire的函数，包括在openfire中新建用户，发送推送消息等
  • cn.edu.hit.servlet.messagelogic: 社交功能中关于状态的servlet
  • cn.edu.hit.servlet.relationshiplogic: 社交模块中的好友关系处理servlet
  • cn.edu.hit.servlet.usersimplelogic: 用户登录、注册、信息修改等等