食堂客户端开发架构设计v0.8.doc

食堂客户端开发设计文档刘泽宏 2011.10.07总体架构设计食堂客户端主要由服务器和客户端两部分构成，服务器用于维护食堂菜品的数据，并与食堂摄像头交互，完成手机客户端与摄像头采集的视频流适配和并发处理。u RIMO菜品客户端主要负责用户界面的呈现与交互u 菜品收集客户端主要负责菜品的采集和上传服务器主要分为5个部分：其中底层使用mysql数据库与文件系统对数据进行保存，上层数据交互使用Servlet，与Rimo菜品客户端之间采用xml定义的数据格式进行交互，后台管理页面负责对菜品的数据的管理，管理员可以通过浏览器访问后台管理页面。流媒体服务器负责对摄像头采集的数据进行缓存、编解码、定时截图以及必要的转码操作。数据库设计dish表字段名字段类型字段含义IDInt 自增菜品IDdishNameNvarchar（50）菜品名称dsihDiscriptiontext菜品简介dishIngredientstext菜品成分dishTasteInt菜品口味（酸、辣、微辣等）goodVoteNumInt好评数badVoteNumInt差评数CategoryInt分类firstUpdateDatetimestamp首次提交菜品的时间LastUpdateDatetimestamp最后更新菜品时间defaultPicIdint默认图片ID menu表字段名字段类型字段含义IDInt 自增菜单IDDatetimestamp菜单的日期Descriptiontext菜单简介menuDish 表 字段名字段类型字段含义IDInt 自增菜单IDmenuIdint菜单IDdishIdint菜品IDdishPicture表字段名字段类型字段含义IDInt 自增图片IDdishIdint菜品IDpicturePathnvarchar(500)图片路径uploadTimedate上传时间menuIdint菜单IDuploadUserIdint上传用户idsourceint来源，是来自菜单收集时的还是用户评论的user表字段名字段类型字段含义IDInt 自增用户IDImeinvarchar(20)手机imei号firstLoginTimetimestamp首次登录时间lastLoginTimetimestamp最后登录时间loginHistory表字段名字段类型字段含义IDInt 自增IDuserIdint用户IDdatetimestamp登录时间comment表字段名字段类型字段含义IDInt 自增评论IDdishIdint菜品IDmenuIdint菜单IDusernamenvarchar(50)用户名userIdint用户的IDcontenttext评论内容pictureIdint图片IDdatetimestamp评论日期typeint评论还是投诉goodVoteNumint好评数badVoteNumint差评数isDeletedBoolean是否删除userFavorite表字段名字段类型字段含义IDInt 自增IDuserIdint用户IDdishIdint菜品IDmenuIdint添加偏好时的菜单IDaddFavoriteTimetimestamp添加偏好的时间cancleFavoriteTimetimestamp取消偏好时间isValidbit是否有效group表字段名字段类型字段含义IDInt 自增IDgroupNamenvarchar(100)组名memberNumint用户数ownerIdint创建人IDcreateTimetimestamp创建时间cancleTimetimestamp取消时间isValidbit是否有效remindTimedate提醒时间remindContentnvarchar(500)提醒的内容groupMember字段名字段类型字段含义IDInt 自增IDgroupIdint组号memberNamenvarchar(20)组员姓名memberPhonenvarchar(13)组员电话号码dishVoteHistory表字段名字段类型字段含义IDInt 自增IDdishIdint菜品IdmenuIdint菜单IduserIdint用户Iddatetimestamp评论时间voteTypebit评论类型，好评还是差评commentVoteHistory表字段名字段类型字段含义IDInt 自增IDcommentIdint评论IduserIdint用户Iddatetimestamp评论时间voteTypebit评论类型，好评还是差评交互接口设计1.今日菜谱1） 菜单查询输入：日期，默认为今日 date输出：今日菜单明细（菜单的ID，图片的url，菜品ID，菜品名称，好评数，差评数，菜品分类）当dishmenuId=-1时表示无菜单数据请求服务器的参数列表： date=20110912服务器返回xml示例： fish 4 10 20 /pic 很好吃 10 2） 当前拥挤程度查询输入：无输出：拥挤程度（一个数字）服务器返回xml示例： 3） 菜品顶、踩接口输入：菜品ID，评价类型（顶，踩）输出：菜品ID，顶或踩之后的结果comment_type 1 表示好评，0表示差评，默认好评当无正确ID传入时，返回空请求服务器的参数列表： id=10001&comment_type=1服务器返回xml示例： 45 35 4） 用户登录登录统计并检查更新接口输入：imei，客户端版本输出：最新版本号，最新版本下载地址，是否强制升级(1表示强制升级，0表示非强制升级)请求服务器参数列表：imei=XXXXX&version=XXXXX服务器返回xml示例：12. 菜品明细5） 单个菜品查询输入：菜品ID id=输出：菜品详细信息（菜品名称，菜品简介，菜品成分，菜品口味（酸、辣、微辣等），好评数，差评数，分类，首次提交菜品的时间，最后更新菜品时间，卡路里(0表示低，1表示中，2表示高)，默认图片ID，默认图片的url） 请求服务器的参数列表： id=10001服务器返回xml示例： fish 很好吃 1 10 20 202011-11-232011-12-23 10000 /img/ 6） 菜品评价查询输入：菜品ID 起始评论ID数，评论数量输出：菜品评价列表（评价ID，评价名称，评价内容，评价时间，评价图片Id，评价图片url，好评数，差评数，）请求服务器的参数列表： id=10001&startId=0&count=服务器返回xml示例： 2011-12-23 7） 菜品评价提交（包含投诉建议的提交，使用同一接口）输入：菜品ID，评价内容，用户名，imei号，评价类型（是否是投诉建议）输出：菜品详细信息请求服务器参数列表：（由于评论内容可能过大，评论内容可能会有特殊字符，建议使用post请求，字段名依然采用下面这些字段）id=1001&content=XXXXXXX&username=XXXX&imei=XXXX&comment_type=18） 图片上传接口（暂时取消）输入：图片源，图片9） 投诉建议类型查询输入：无输出：投诉建议类型（饭菜类、服务类、环境类和其它类）10） 菜品评价回复(暂时取消)输入：菜品ID，评价ID，回复内容输出：菜品评价详细信息11） 历史菜单列表查询输入：时间区间或者页码输出：符合条件的所有历史菜单列表12） 食堂视频流输入：食堂摄像头ID输出：食堂摄像头视频流13） 食堂监视图片输入：食堂摄像头ID输出：食堂摄像头视频截图14） 查询饭团输入：imei号输出：饭团详细信息及成员列表imei=12312313XXX3XXXXXXXXXXXXXXX126487XXXX126487如果无该imei对应的group返回id=-115） 查询饭团成员列表输入：饭团ID输出：饭团成员列表16） 更新饭团输入：groupId，饭团邀请短语，成员删除列表，成员新增列表 Post提交groupId=1content=XXX (更新的邀请短语，可选)newMember=名字:电话号码名字:电话号码（新增的Member，可选）deleteMemeber=1:23:21（表示删除的MemberId号，可选）输出：饭团更新结果true/false17） 创建饭团输入：饭团创建所需信息(名称，成员列表，邀请短语)imei=XXXcontent=XXXXmember=名字:电话号码名字:电话号码输出：饭团创建是否成功true/false18） 删除饭团输入：饭团ID输出：饭团删除是否成功19） 更新饭团输入：饭团ID，饭团更新项输出：饭团更新后的信息20） 加班餐信息查询输入：无输出：加班餐信息列表21） 统计结果查询输入：统计类型输出：统计结果信息22） 个人菜品关注查询输入：用户ID（注册用户名或者imei）输出：用户关注菜品列表23） 添加个人关注菜品输入：菜品ID，用户ID输出：添加个人菜品信息24） 推荐菜品查询输入：无输出：推荐菜品列表25） 菜品分类查询（用于菜品收集客户端）输入：无输出：菜品分类26） 菜品口味查询（用于菜品收集客户端）输入：无输出：菜品口味27） 所有菜品查询（用于菜品收集客户端）输入：无输出：所有菜品名称列表28） 菜品上传（用于菜品收集客户端）输入