DevExtreme DataGrid WebSocket 协议

DevExtreme Data Grid 来自 DevExpress，是一款功能强大的 JavaScript 数据表格。其中一个特色功能是局部更新，允许在不刷新整个页面的情况下更新表格中的某条记录。此类更新通常通过 WebSocket 协议接收。

sgcWebSockets 库可与 DevExtreme Data Grid 结合使用，实现实时更新表格而不损失性能。

推送 API

DevExtreme 使用推送 API 在收到新修改时更新表格。服务器通常通过 WebSocket 协议将数据传送给客户端，然后将修改推送到表格中。

store.push([{ type: "insert", data: data }]); // if a new object is created
store.push([{ type: "update", data: data, key: key }]); // if an existing object is changed
store.push([{ type: "remove", key: key }]); // if an object is removed

以下示例演示了如何将 sgcWebSockets 数据集协议与 DevExtreme 推送 API 结合使用。这是一个向所有已连接客户端提供实时股票报价的 WebSocket 服务器。

    // ... create a new websocket connection using dataset protocol
    var ws = new sgcws_dataset("ws://127.0.0.1:5413");
    // ... when the client connects to websocket server
	ws.on('open', function(evt){
	    // first request all quotes
		ws.subscribe_all();
	    // create the grid configuration
        $("#gridContainer").dxDataGrid({
            dataSource: store,
            showBorders: true,
            repaintChangesOnly: true,
            highlightChanges: true,
            columns: [
			{dataField: "Id"},
			{dataField: "Symbol"},
			{
                dataField: "Open",
                dataType: "number",
                format: "#0.####"
            },
			{
                dataField: "High",
                dataType: "number",
                format: "#0.####"
            },
			{
                dataField: "Low",
                dataType: "number",
                format: "#0.####"
            },
			{
                dataField: "Last",
                dataType: "number",
                format: "#0.####"
            }]
        });
	});
	// ... synchronization starts
    ws.on('sgcbeforesynchronize', function(evt) {
		vSync = true;
	});
	// ... synchronization ends
    ws.on('sgcaftersynchronize', function(evt) {
		vSync = false;
	});
	// ... record update is received
	// ... create a new JSON object with stock data information
	// ... call push method to update the grid
    ws.on('sgcdataset', function(evt){
	  var id = evt.dataset["ID"];
	  var symbol = evt.dataset["NAME"];
	  var open = evt.dataset["OPEN"].replace(',', '.');
	  var high = evt.dataset["HIGH"].replace(',', '.');
	  var low = evt.dataset["LOW"].replace(',', '.');
	  var last = evt.dataset["LAST"].replace(',', '.');
	  var change = evt.dataset["CHANGE"].replace(',', '.');
	  var quote = JSON.parse("{\"Id\":" + id + ", \"Symbol\":\"" + symbol + "\", \"Open\": " + open + ", \"High\": " + high + ", \"Low\": " + low + ", \"Last\": " + last + ", \"Change\": " + change + "}");
	  if (vSync == true)
	  {
	    store.push([{ type: "insert", key: quote.Id, data: quote, index: -1 }]);
	  }
	  else
	  {
	    store.push([{ type: "update", key: quote.Id, data: quote}]);
	  }
	});

以下提供 DevExtreme Data Grid + sgcWebSockets 的 Windows 编译演示，可供下载。