TARS WebSocket

1. 设置与连接

  TARS 中包含 WebSocket 通讯服务，如需要使用 WebSocket 服务请先点击 [参数设置] - [WebSocket服务]，确认 WebSocket 消息服务 已勾选，模块文件名中设置 WebSocket 服务路径。

  按照上述设置完成后，假设TARS监听的HTTP服务端口为 8809，则使用的WebSocket路径的格式如下：

ws://localhost:8809/message

2. 运用

  使用WebSocket 客户端连接至 TARS 的服务端后，可使用以下方法来运行相关操作：

2.1. 注册会话

  连接至WebSocket服务器后，需注册会话才可使用 TARS 的WebSocket 通讯功能。注册会话的格式如下：

{"action":"login","sid":"test"}

  向WebSocket服务器发送上述指令后，客户端会话注册完成，使用的WS会话ID为 test。

2.2. 发送字符串消息

  向其它连接的客户端发送字符串消息，使用以下格式进行发送。

{"action":"msg","sid":"{SID}","text":"{TEXT}"}

{SID} 为目标客户端的注册会话ID，{TEXT} 为发送的文本信息。

2.3. 执行数据库查询(SQL)

  在 TARS 中设置了数据库连接与预设 SQL 后，可利用 TARS 来执行 SQL 查询。发送的格式内容如下：

直接发送 SQL 语句：在 WebSocket 消息中可直接发送 SQL 语句来执行查询。示例如下(包含参数用法)：

{
  "action": "execsql",
  "db_name": "demo",
  "sql": "Insert Into Table_Test(FCode,FName) values(:F1,:F2)",
  "params": [
    {
      "name": "F1",
      "value": "003"
    },
    {
      "name": "F2",
      "value": "f37"
    }
  ]
}

使用预设 SQL 执行查询：如在预设 SQL 管理中设置了查询信息，可发送需查询的预设 SQL 来执行查询。创建一个名称为 SQLTEST 的预设 SQL，查询语句示例如下(包含参数用法)：

Insert Into Table_Test(FCode,FName) values(:F1,:F2)

  呼叫 WebSocket 执行数据库查询的文本示例如下，其中的 db_name 需指定预设SQL 所在的数据库名称，默认为 tars。

 {
  "action": "execsql",
  "db_name": "tars",
  "sql_command_id": "SQLTEST",
  "params": [
    {
      "name": "F1",
      "value": "043"
    },
    {
      "name": "F2",
      "value": "d23"
    }
  ]
}