目次
3.4. webSocket のテスト (http://www.jsons.cn/websocket/)
1. websocket インターフェースとは
Websocket を使用して永続的な接続を確立することで、サーバーとクライアントは相互に通信でき、サーバーにデータの更新がある限り、それをアクティブにクライアントにプッシュできます。
WebSocket は、クライアントとサーバー間のデータ交換を容易にし、サーバーが積極的にデータをクライアントにプッシュできるようにします。WebSocket API では、ブラウザとサーバーはハンドシェイクを完了するだけでよく、両者の間に永続的な接続を直接作成し、双方向のデータ転送を実行できます。
WebSocket API では、ブラウザーとサーバーがハンドシェイクを行うだけで、ブラウザーとサーバーの間に高速チャネルが形成されます。データは、2 つの間で直接送信できます。
2.該当するシナリオ
ビジネス開発の過程で、いくつかの非同期処理 (wechat 支払い、Alipay 支払いの支払い通知) とアプリケーション間のメッセージ送信に遭遇します。
ビジネスが実行された後、成功した情報をフロントエンドに配信する必要があります。通常、フロント エンドはバック エンドの http/https インターフェイスを呼び出してデータを取得しますが、バック エンドが積極的にフロント エンドにメッセージをプッシュする場合は、フロント エンドとバック エンドの通信に WebSocket を使用する必要があります。
3. コード例
3.1. pom.xml 依存関係の追加
<!-- websocket-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>3.2. WebSokcet 設定クラスの作成
@Configuration
public class WebSocketConfig {
@Bean
public ServerEndpointExporter serverEndpointExporter(){
return new ServerEndpointExporter();
}
}
3.3、创建WebSokcet工具类
@ServerEndpoint(value = "/websocket")
@Component
public class WebSocketServer {
private final static Logger log = LoggerFactory.getLogger(WebSocketServer.class);
//静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
private static int onlineCount = 0;
//concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。
private static CopyOnWriteArraySet<WebSocketServer> webSocketSet = new CopyOnWriteArraySet<WebSocketServer>();
//与某个客户端的连接会话，需要通过它来给客户端发送数据
private Session session;
/**
* 连接建立成功调用的方法
*/
@OnOpen
public void onOpen(Session session) {
this.session = session;
//加入set中
webSocketSet.add(this);
//在线数加1
addOnlineCount();
log.info("有新连接加入！当前在线人数为" + getOnlineCount());
try {
MsgResponseVo userMsgResponseVo = new MsgResponseVo();
userMsgResponseVo.setMsg("SUCCESS");
WebSocketServer.sendInfo(JSON.toJSONString(userMsgResponseVo));
} catch (IOException e) {
log.error("websocket IO异常");
}
}
/**
* 连接关闭调用的方法
*/
@OnClose
public void onClose() {
//从set中删除
webSocketSet.remove(this);
//在线数减1
subOnlineCount();
log.info("有一连接关闭！当前在线人数为" + getOnlineCount());
}
/**
* 收到客户端消息后调用的方法
*
* @param message 客户端发送过来的消息
*/
@OnMessage
public void onMessage(String message, Session session) {
log.info("来自客户端的消息:" + message);
//群发消息
for (WebSocketServer item : webSocketSet) {
try {
item.sendMessage(message);
} catch (IOException e) {
e.printStackTrace();
}
}
}
/**
* @param session
* @param error
*/
@OnError
public void onError(Session session, Throwable error) {
log.error("发生错误");
error.printStackTrace();
}
public void sendMessage(String message) throws IOException {
this.session.getBasicRemote().sendText(message);
}
/**
* 群发自定义消息
*/
public static void sendInfo(String message) throws IOException {
log.info(message);
for (WebSocketServer item : webSocketSet) {
try {
item.sendMessage(message);
} catch (IOException e) {
continue;
}
}
}
public static synchronized int getOnlineCount() {
return onlineCount;
}
public static synchronized void addOnlineCount() {
WebSocketServer.onlineCount++;
}
public static synchronized void subOnlineCount() {
WebSocketServer.onlineCount--;
}
}3.3. テスト送信メッセージ インターフェイスの作成
@GetMapping("/testWebSocket")
public ApiRestResponse testWebSocket() throws IOException {
//消息体
MsgResponseVo technicianMsgResponseVo = new MsgResponseVo();
technicianMsgResponseVo.setRole("Technician");
technicianMsgResponseVo.setRoleId(1);
technicianMsgResponseVo.setMsg("您的订单已取消");
technicianMsgResponseVo.setMsgStatus("CANCEL_ORDER");
technicianMsgResponseVo.setOrderNo("test");
//发送消息
WebSocketServer.sendInfo(JSON.toJSONString(technicianMsgResponseVo));
return ApiRestResponse.success();
}
}3.4. webSocket のテスト ( http://www.jsons.cn/websocket/ )
Web サイトの ws://ip:port/webSocket ツール クラスのプレフィックスを入力します (ws://127.0.0.1:8080/websocket)
3.5. フロントエンドは WebSocket を使用してバックエンドの WebSocket アドレスを監視し、メッセージを受信した後、次の業務処理を行います。