springboot集成webSocket

依賴包

<dependency>
   <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

由於新建的項目,pom中少寫了幾行配置,導致代碼中找不到ServerEndpointExporter類,pom少寫的配置:

<properties>
	<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
	<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
	<java.version>1.8</java.version>
	<maven.compiler.source>1.8</maven.compiler.source>  
       <maven.compiler.target>1.8</maven.compiler.target>  
</properties>

代碼結構

在這裏插入圖片描述

核心代碼

WebSocketConfig.java

package com.becom.qoe.wsservice.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

/**
 * 開啓WebSocket支持
 * This class is used for ...  
 * @author leiqianpeng
 * 2019年4月15日 下午4:36:22
 */
@Configuration
public class WebSocketConfig {
	@Bean  
    public ServerEndpointExporter serverEndpointExporter() {  
        return new ServerEndpointExporter();  
    } 
}

WebSocketServer.java

package com.becom.qoe.wsservice.server;

import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;

import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;

import org.springframework.stereotype.Component;

import com.alibaba.druid.support.logging.Log;
import com.alibaba.druid.support.logging.LogFactory;

@ServerEndpoint("/websocket/{sid}")
@Component
public class WebSocketServer {
	static Log log=LogFactory.getLog(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--;
    }
}

EmReturnCode.java

package com.becom.qoe.wsservice.entity;

/**
 * 接口返回代碼 枚舉
 */
public enum EmReturnCode {
    SUCCESS("成功",1),
    FAIL("失敗",-1);
    // 成員變量
    private String name;
    private int value;

    // 構造方法
    private EmReturnCode(String name, int value) {
        this.name = name;
        this.value = value;
    }

    // 普通方法
    public static String getName(int value) {
        for (EmReturnCode c : EmReturnCode.values()) {
            if (c.getValue() == value) {
                return c.name;
            }
        }
        return null;
    }

    // get set 方法
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getValue() {
        return value;
    }

    public void setValue(int value) {
        this.value = value;
    }
}

ReturnJson.java

package com.becom.qoe.wsservice.entity;

import java.io.Serializable;

public class ReturnJson implements Serializable{

	private static final long serialVersionUID = 1L;
	private String msg;
    private int retcode;
    private Object retObj;
    private boolean success;
    public final static ReturnJson Success = new ReturnJson("操作成功", EmReturnCode.SUCCESS.getValue(), null,true);
    public final static ReturnJson Faild = new ReturnJson("操作失敗", EmReturnCode.FAIL.getValue(), null,false);

    public ReturnJson(String msg, int retcode, Object retObj,boolean success) {
        super();
        this.msg = msg;
        this.retcode = retcode;
        this.retObj = retObj;
        this.success = success;
    }

    public ReturnJson(String msg, Object retObj) {
        super();
        this.msg = msg;
        this.retcode = EmReturnCode.SUCCESS.getValue();
        this.retObj = retObj;
        this.success = true;
    }

    public ReturnJson(String msg,boolean success) {
        super();
        this.msg = msg;
        this.retcode = EmReturnCode.SUCCESS.getValue();
        this.retObj = null;
        this.success = success;
    }

	public String getMsg() {
		return msg;
	}

	public int getRetcode() {
		return retcode;
	}

	public Object getRetObj() {
		return retObj;
	}

	public boolean isSuccess() {
		return success;
	}

	public static ReturnJson getSuccess() {
		return Success;
	}

	public static ReturnJson getFaild() {
		return Faild;
	}

	public void setMsg(String msg) {
		this.msg = msg;
	}

	public void setRetcode(int retcode) {
		this.retcode = retcode;
	}

	public void setRetObj(Object retObj) {
		this.retObj = retObj;
	}

	public void setSuccess(boolean success) {
		this.success = success;
	}
    
}

CheckCenterController

package com.becom.qoe.wsservice.controller;

import java.io.IOException;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.ModelAndView;

import com.becom.qoe.wsservice.entity.ReturnJson;
import com.becom.qoe.wsservice.server.WebSocketServer;


@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 ReturnJson pushToWeb(@PathVariable String cid,String message) {  
		try {
			WebSocketServer.sendInfo(message,cid);
		} catch (IOException e) {
			e.printStackTrace();
			return ReturnJson.Faild;
		}  
		return ReturnJson.Success;
	} 
}

前端代碼:

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
  </head>
  <body>
    
    <div id="app"></div>
    <!-- built files will be auto injected -->
  </body>
</html>
<script> 
var socket;  
if(typeof(WebSocket) == "undefined") {  
    console.log("您的瀏覽器不支持WebSocket");  
}else{  
    console.log("您的瀏覽器支持WebSocket");  
      //實現化WebSocket對象,指定要連接的服務器地址與端口  建立連接  
        socket = new WebSocket("ws://172.16.16.199:8771/websocket/20");  
        //socket = new WebSocket("${basePath}websocket/${cid}".replace("http","ws"));  
        //打開事件  
        socket.onopen = function() {  
            console.log("Socket 已打開");  
            //socket.send("這是來自客戶端的消息" + location.href + new Date());  
        };  
        //獲得消息事件  
        socket.onmessage = function(msg) {  
            console.log(msg.data);  
            //發現消息進入    開始處理前端觸發邏輯
        };  
        //關閉事件  
        socket.onclose = function() {  
            console.log("Socket已關閉");  
        };  
        //發生了錯誤事件  
        socket.onerror = function() {  
            alert("Socket發生了錯誤");  
            //此時可以嘗試刷新頁面
        }  
        //離開頁面時,關閉socket
        //jquery1.8中已經被廢棄,3.0中已經移除
        // $(window).unload(function(){  
        //     socket.close();  
        //});  
}
</script> 


測試

1.打開上面寫的前端頁面:
在這裏插入圖片描述
2.使用postman推送消息:
在這裏插入圖片描述
3.返回瀏覽器,可查看到瀏覽器已經接收到消息了
在這裏插入圖片描述

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章