Notification Server文档

Notification Server提供了组件间的通讯接口，现暂仅提供基础的异步发布订阅模式。
后期会加上多种通讯方式、权限控制和管理、消息审计等功能。当前版本基于RabbitMQ，但仅提供HTTP接口，不排除未来会支持AMQP接口。

发布订阅模式

HTTP发布信息

发布接口

HTTP接口：/publish/<notify scope>

• HTTP Method：POST
• notify scope：通知范围，scope间使用/分割。
• 每个scope命名格式（正则）：^[a-zA-Z]\w*$。

消息格式

消息格式使用JSON，发布方基本结构如下：

{
    "version": "ns 1.0", 
    "attrs": {
        "time": "YYYY-MM-DDTHH:MM:SS.mmmmmm", 
        "msg_id": "550e8400-e29b-41d4-a716-446655440000", 
        "sender_id": "6063d21e-5b46-11e4-b445-000c29f3465d"
    }, 
    "data": { ... }
}

字段说明（粗体为必填项，斜体为可选项）：

• version：版本号，当前为ns 1.0。
• attrs：消息属性，用于标识消息与控制消息处理。
  
  • time：使用ISO 8601时间格式，标识发送时间，缺省为服务器接收到信息的时间。
  • msg_id：消息的uuid，缺省为服务器随机分配的uuid。
  • sender_id：发送方的uuid，缺省为服务器根据ip生成（不保证每次相同）。
• data：真正的消息体，格式无明确定义，由发布和订阅方约定。

注意：不建议在attrs中添加自定义的信息。

服务器回馈信息也使用JSON，基本结构如下：

{
    "version": "ns 1.0", 
    "message": "+ok message published", 
    "attrs": {
        "time": "YYYY-MM-DDTHH:MM:SS.mmmmmm", 
        "msg_id": "550e8400-e29b-41d4-a716-446655440000", 
        "sender_id": "6063d21e-5b46-11e4-b445-000c29f3465d"
    }
}

字段说明：

• version：服务器支持的版本号，当前为ns 1.0。
• message：状态信息，包括处理状态和状态信息，两者使用空格分开。
  
  • 处理状态：成功+ok，失败为-err，未知为#unkwn。
  • 状态信息：状态信息由服务器给出，说明处理的详细信息。
• attrs：消息属性，用于标识消息与控制消息处理。
  
  • time：最终确定的消息时间。
  • msg_id：最终确定的消息uuid。
  • sender_id：最终确定的发送方uuid。

发布示例

客户端发布：

POST /publish/test_project/mysql HTTP/1.1
{
    "version": "ns 1.0", 
    "attrs": {
        "time": "2014-10-23T20:57:43.524624", 
        "sender_id": "4a30b386-d559-4a8f-9c03-cdb6e7476d03"
    }, 
    "data": {
        "event": "created_database", 
        "database": "testdb"
    }
}

服务器反馈：

{
    "version": "ns 1.0", 
    "message": "+ok message published", 
    "attrs": {
        "time": "2014-10-23T20:57:43.524624", 
        "msg_id": "9e4d1dda-475b-4c5a-927f-92b8a319c994", 
        "sender_id": "4a30b386-d559-4a8f-9c03-cdb6e7476d03"
    }
}