WebSocket初接觸

玉獅子發表於2019-04-24
Web

產生背景

因為HTTP 協議是一種無狀態的、無連線的、單向的應用層協議。只能由客戶端發起請求，服務端相應請求，無法實現服務端主動向客戶端傳送訊息。 HTTP解決上述問題是採用輪詢或Comet機制，這樣會帶來或多或少的問題，如頻繁的傳送請求會給服務請帶來極大壓力。

概述

WebSocket是一種基於TCP的新型網路協議，通過一個套接字實現了伺服器和瀏覽器之間的全雙工通訊，也就是允許服務端傳送資訊到客戶端。使用場景如彈幕等。Spring4.0為WebSocket通訊提供了支援。

WebSocket請求格式

GET ws:    //請求地址以ws：開頭
Host: 
Upgrade: websocket  //表明連線轉化為WebSocket連線
Connection: Upgrade //表明連線轉化為WebSocket連線
Origin:
Sec-WebSocket-Key: //標識連線
Sec-WebSocket-Version: //指定協議版本
複製程式碼

WebSocket響應格式

HTTP/1.1 101 Switching Protocols  //表明HTTP協議即將被更改
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Accept: server-random-string
複製程式碼

程式清單

  • 匯入依賴
    <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
    </dependency>
複製程式碼
  • 注入 ServerEndpointExporter
@Configuration
public class WebSocketConfig {
       @Bean
       public ServerEndpointExporter serverEndpointExporter() {
           return new ServerEndpointExporter();
       }
}
複製程式碼
  • 服務端頁面
@ServerEndpoint("/websocket/{sid}")
@Component
public class WebSocketServer {
	
	static Log log=LogFactory.get(WebSocketServer.class);
    //靜態變數，用來記錄當前線上連線數。應該把它設計成執行緒安全的。
    private static int onlineCount = 0;

    //concurrent包的執行緒安全Set，用來存放每個客戶端對應的MyWebSocket物件。
    private static CopyOnWriteArraySet<WebSocketServer> webSocketSet = new CopyOnWriteArraySet<WebSocketServer>();

    //與某個客戶端的連線會話，需要通過它來給客戶端傳送資料
    private Session session;

    //接收sid
    private String sid="";
    /**
     * 連線建立成功呼叫的方法*/
    @OnOpen
    public void onOpen(Session session,@PathParam("sid") String sid) {
        this.session = session;
        webSocketSet.add(this);     //加入set中
        addOnlineCount();           //線上數加1
        log.info("有新視窗開始監聽:"+sid+",當前線上人數為" + getOnlineCount());
        this.sid=sid;
        try {
        	 sendMessage("連線成功");
        } catch (IOException e) {
            log.error("websocket IO異常");
        }
    }

    /**
     * 連線關閉呼叫的方法
     */
    @OnClose
    public void onClose() {
        webSocketSet.remove(this);  //從set中刪除
        subOnlineCount();           //線上數減1
        log.info("有一連線關閉！當前線上人數為" + getOnlineCount());
    }

    /**
     * 收到客戶端訊息後呼叫的方法
     *
     * @param message 客戶端傳送過來的訊息*/
    @OnMessage
    public void onMessage(String message, Session session) {
    	log.info("收到來自視窗"+sid+"的資訊:"+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,@PathParam("sid") String sid) throws IOException {
    	log.info("推送訊息到視窗"+sid+"，推送內容:"+message);
        for (WebSocketServer item : webSocketSet) {
            try {
            	//這裡可以設定只推送給這個sid的，為null則全部推送
            	if(sid==null) {
            		item.sendMessage(message);
            	}else if(item.sid.equals(sid)){
            		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--;
    }
}
複製程式碼
  • 訊息推送
@Controller
@RequestMapping("/checkcenter")
public class CheckCenterController {

	//頁面請求
	@GetMapping("/socket/{cid}")
	public ModelAndView socket(@PathVariable String cid) {
		ModelAndView mav=new ModelAndView("/socket");
		mav.addObject("cid", cid);
		return mav;
	}
	//推送資料介面
	@ResponseBody
	@RequestMapping("/socket/push/{cid}")
	public ApiReturnObject pushToWeb(@PathVariable String cid,String message) {  
		try {
			WebSocketServer.sendInfo(message,cid);
		} catch (IOException e) {
			e.printStackTrace();
			return ApiReturnUtil.error(cid+"#"+e.getMessage());
		}  
		return ApiReturnUtil.success(cid);
	} 
} 
複製程式碼

程式碼參考：blog.csdn.net/moshowgame/…

相關文章