更新 'readme.md'

readme.md

@@ -17,15 +17,22 @@
数据库设计是将消息按通道分开：系统消息，个人消息及群消息。
- msg_system: 系统消息，通过系统端发出去的消息存储在此表
- msg_p2p: 私信，通过私信端发出去的消息存储在此表
- msg_group: 群消息，通过群消息端发出去的消息存储在此表
- msg_statistic: 消息统计，当有系统，个人或群消息的时候，除了在上述三个记录数据外，还会在表中插入相关的消息统计，如：接收人有多少条未读消息，最后消息时间，内容或群ID等
- msg_push: 消息推送，当消息需要推送到设备的时候，先将消息记录在此表中，再用个推服务推送到目标设备
- system_messages: 系统消息，通过系统端发出去的消息存储在此表
- p2p_messages: 私信，通过私信端发出去的消息存储在此表
- group_messages: 群消息，通过群消息端发出去的消息存储在此表
- muc_messages:muc患者咨询消息，通过咨询发送出去的消息存储在此表
- app_status: 消息推送获取应用状态的表，当消息需要推送到设备的时候，先从此表获取客户端信息，再用个推服务推送到目标设备
- participants：会话成员表，所有的会话成员创建都创建到此表中
- sessions：所有的消息对话的主体对象，会话表，记录所有会话记录，根据type和business_type来区分对应的信息type=1 muc模式，type=2 p2p模式，type=3  group模式 type = 0 系统会话
- topics：所有的咨询(包括名医咨询都存储在此表中)关联会话信息，每个会话跟议题是一对多的关系。议题的消息根据会话类型不同分别存储在p2p_messages(会话类型type = 2)和muc_messages(会话类型type = 1)
## 运行
对Windows环境，可以预先安装Node.js。对Linux环境，代码包中包含Node.js程序，第一次部署需要使用chmod为此增加执行权限`chmod +x node`，之后通过以下命令启动消息服务器：
对Windows环境，可以预先安装Node.js。对Linux环境，代码包中包含Node.js程序，第一次部署需要使用chmod为此增加执行权限：
    chmod +x node
    
之后通过以下命令启动消息服务器：
    node app.armour.js
@@ -56,14 +63,6 @@ IM_PROFILE值将决定应用加载的配置文件，配置文件位于src/resour
未完工
### 依赖注入
使用bearcat库。
### Promise库
使用bluebird库。
## 开发SDK
IM提供了开发SDK，一个JS脚本。客户端可以通过引用此脚本或将此脚本打包到资源中。此外，脚本使用jQuery作为基础环境，因此客户端需要预先引用jQuery脚本。客户端通过以下链接引用SDK文件
@@ -72,7 +71,7 @@ IM提供了开发SDK，一个JS脚本。客户端可以通过引用此脚本或
## 工程结构
- 消息流: 首先要明白即时消息的流程，有助于理解整个过程。
- 消息流: 首先要明白即时消息的流程，有助于理解整个过程。医生端的IM仅关注医生部分，即下图中蓝色标注的内容。
![IM活动图](./doc/images/activity.png)
@@ -83,10 +82,6 @@ IM提供了开发SDK，一个JS脚本。客户端可以通过引用此脚本或
- REST API相关的放在endpoints
- 与页面相关的放在controllers
### 模型与控制层之间的交互
控制层提供两种类型的API：含有回调与不含回调。不含回调的API通过事件向外发送消息，用于与controller之间的交互。含回调的API通过回调与其他API交互，用于模型之间的交互。
### 消息发送
	实时与延时
@@ -106,56 +101,130 @@ Node.js支持同步与异步调用，也导致了异常错误处理与众不同
REST API遵循REST最佳实践，规范命名URL中的每个部分。注意POST请求是将数据作为请求体发送。下文中的host:port分别表示服务所在的主机地址及端口。
1 发送系统消息
    POST http://host:port/api/v1/chats/sm
    
参数格式
    {
        to: "Rose",
        title: "System Message",
        summary: "You have new job",
        contentType: "1",
        content: "The patient has been followed in the scheduler, please make new follow plan as soon as possible."
    Application: {
        Base: '/api/v2/application',  
        BadgeNo: '/badge_no' //获取角标
    },
    Users: {
        Base: '/api/v2/users',
        Login: '/login',  //用户登录
        Logout: '/logout', //用户登出
        User: '/:user_id', //获取用户信息
        UserStatus: '/:user_id/status',//用户状态
        UserConsultTime:'/:user_id/consult/time'//用户咨询时间
    },
    Sessions: {
        Base: '/api/v2/sessions',
        Session: '/:session_id/session',
        SessionSticky: '/:session_id/sticky',                           // 会话置顶，置顶使用PUT，取消置顶使用DELETE
        SessionStatus: '/:session_id/status',                           //更新状态
        RecentSessions: '/recent',                                      // 最近会话，使用类型过滤出'患者'或'医生'会话
        Topics: '/:topic_id/topics',
        Topic: '/topics/:topic_id',                          // 议题，指定ID的议题将返回其信息
        TopicEnded: '/:session_id/topics/:topic_id/ended',              // 议题是否已结束，若top_id为current，则检查最后一个议题的状态
        TopicList:'/topics',
        TopicReplyCount:"/topics/count/reply",
        TopicMessages:'/topic/:topic_id/messages',
        Messages: '/:session_id/messages',                             // 会话消息
        MessagesByTopic: '/:session_id/topics/:topic_id/messages',      // 议题消息
        Message: '/:session_id/messages/:message_id',                   // 单条消息
        SessionsUnreadMessageCount: '/unread_message_count',            // 所有会话的未读消息数
        SessionUnreadMessageCount: '/:session_id/unread_message_count', // 指定会话的未读消息数
        SessionUnreadMessages: '/:session_id/messages/unread',           // 会话未读消息
        ParticipantUpdate:'/:session_id/participant/update',//更新成员=删除旧成员，新增新成员
        Participants: '/:session_id/participants',                      // 会话所有成员
        ParticipantsAvatar: '/:session_id/participants/avatars',        // 会话所有成员头像
        Participant: '/:session_id/participants/:participant_id',       // 会话单个成员
        ParticipantAvatar: '/:session_id/participants/:participant_id/avatars'  // 会话单个成员头像
    }
### 业务分析
2 发送P2P消息
    GET http://192.168.131.115:3000/api/v1/chats/pm
    **消息类型**：
    
        muc_messsges,p2p_messages,group_messages,system_messages表对应的type字段
            0、系统消息
            1、文本消息
            2、图片消息
            3、语音消息
            4、文章消息
            5、跳转消息
            6、议题开始
            7、议题结束
            8、转发的消息
            9、转发的图片
            10、议题结束发送的消息
            11、预留
            12、小视频消息
            13、预留
            
    **会话类型** 
    
        sessions的type字段
            a、type =1 消息保存muc_messsges、患者的三师、家庭咨询会话
            
            b、type=2 消息保存p2p_messages、患者的名医咨询，医生间的p2p、名医咨询会话
            
            c、type =3 消息保存group_messages、行政团队聊天会话
            
            d、type =0 消息保存system_messages 系统聊天会话
            
        sessions的business_type字段
        
            a、business_type =1 此会话不包含患者
            
            b、business_type =2 此会话包含患者
            
        sessions的status字段
        
            **此字段只针对议题的会话有效**
            
                标示当前会话是否有活跃的议题
                
    **议题相关**
    
        议题的ID就是wlyy库的wlyy_consult 的code字段可以关联wlyy_consult_team 查询对应的咨询行政团队信息，和签约医生信息，及咨询医生信息
        
        目前有wlyy_consults的视图做关联，可根据实际业务逻辑拓展相关字段。
        
        议题topics status及type字段讲解
        
            status =0 reply = 0 新增的咨询
            
            status = 0 reply =1 医生已经回复的咨询
            
            status = 10 reply = 0 医生未回复就结束掉的咨询，PS:目前统计要求这部分数据不纳入未回复的咨询，请知悉
            
            status = 10 reply = 1 医生已经回复，且已经结束的咨询    
            
### Web Socket
参数格式
Web Socket提供页面内长连接，并且能够通过Web Socket收发消息。
    {
        from: 发送人ID,
        to: 接收人ID,
        contentType: 内容类型，1为普通文本，2为图片，3为语音，4为超链接,
        content: "消息内容"
    }
    
3 发送群消息
Web Socket 客户端类型包含患者、医生
           
Web Socket 客户端登录需带上对应的会话ID用作于区分推送对象
    POST http://192.168.131.115:3000/api/v1/chats/gm
Web Socket 客户端在线在推送消息的时候会更新用户的活跃时间用作于消息统计
参数格式
### 微信相关模板消息 目前只有咨询回复的模板消息回复是在IM内发送微信模板
    {
        from: 发送人ID,
        at: at对象ID,
        group: 组ID,
        groupType: 组类别
        contentType: 内容类型，1为普通文本，2为图片，3为语音，4为超链接,
        content: "消息内容"
    }
    
4 获取消息
微信模板消息:结合Web Socket 当用户的sockt的连接不存在，则通过微信模板推送给予患者信息提醒，由于患者咨询只能存在一个，所以在推送的时候没有添加会话是否同一个的校验。后期出现多个需增加客户端的会话ID是否相同做校验。
    GET http://192.168.131.115:3000/api/v1/chats/pm?user_id=xxx
### 相关问题排查处理SQL及处理思路
 
参数：
    
- user_id: 用户ID
### Web Socket
Web Socket提供页面内长连接，并且能够通过Web Socket收发消息。