websocket-基于springboot的簡單實(shí)現(xiàn)

1.新建一個(gè)springboot工程,添加一個(gè)maven依賴

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

文件目錄結(jié)構(gòu)如下:


image.png

2. 創(chuàng)建websocket服務(wù)端類

MoneyServer.java

/**
 * @author Page
 * @date 2019-07-02 10:00
 * @description websocket 服務(wù)
 */

@Component
@Slf4j
@ServerEndpoint(value = "/money/{userId}", decoders = {
        MessageDecoder.class,}, encoders = {MessageEncoder.class,}, configurator = MoneyRepayConfig.class)
public class MoneyServer {
    private static final Map<String, Session> SESSION_MAP = new HashMap<>();

    @OnOpen
    public void connect(Session session, @PathParam("userId") String userId) {
        // 將session按照房間名來存儲(chǔ),將各個(gè)房間的用戶隔離
        SESSION_MAP.put(userId, session);
        log.info("websocket成功連接!");
    }

    @OnMessage
    public void repay(RepayReq req, Session session) {
        SESSION_MAP.put(req.getUserId(), session);
        log.info("{}正在還錢:{} 元", req.getName(), req.getMoneyNum());
    }

    public void send(RepayResultRes res) throws IOException, EncodeException {
        if (SESSION_MAP.get(res.getUserId()) == null) {
            log.info("沒有找到連接,消息無法推送");
            return;
        }
        SESSION_MAP.get(res.getUserId()).getBasicRemote().sendObject(res);
        log.info("{}成功還錢:{} 元翰苫,userId:{},還錢結(jié)果:{}", res.getName(),
                res.getMoneyNum(), res.getUserId(), res.isRepayResult()?"還成功" :"失敗了");
    }
}

這里我還添加了一個(gè)自定義的解碼器和一個(gè)編碼器,用于解析java對(duì)象和前端傳來的字符串,以及一個(gè)自定義的websocket配置類.不過在這個(gè)配置類里邊目前什么都沒有做.
MessageDecoder.java

@Slf4j
public class MessageDecoder implements Decoder.Text<RepayReq> {
 
    @Override
    public RepayReq decode(String s) {
        log.info("primal string" + s);
        RepayReq repayReq = null;
        try {
            repayReq = JSONObject.parseObject(s, RepayReq.class);
        } catch (Exception ex) {
            log.error(ex.getMessage());
        }
        return repayReq;
    }
 
    @Override
    public boolean willDecode(String s) {
          
        return (s != null);
    }
 
    @Override
    public void init(EndpointConfig endpointConfig) {
        // do nothing.
    }
 
    @Override
    public void destroy() {
        // do nothing.
    }
}

MessageEncoder.java

@Slf4j
public class MessageEncoder implements Encoder.Text<RepayResultRes> {

    @Override
    public String encode(RepayResultRes object) {

        String s = null;
        try {

            s = JSONObject.toJSONString(object);
            log.info("primal: " + object.toString());

        } catch (Exception ex) {
            log.error(ex.getMessage());
        }
        return s;
    }

    @Override
    public void init(EndpointConfig endpointConfig) {
        // do nothing.
    }

    @Override
    public void destroy() {
        // do nothing.
    }
}

MoneyRepayConfig.java

/**
 * @author Page
 * @date 2019-07-05 17:00
 * @description
 */
@Slf4j
public class MoneyRepayConfig extends ServerEndpointConfig.Configurator{
    @Override
    public boolean checkOrigin(String originHeaderValue) {
        log.info("1=========originHeaderValue====={}", originHeaderValue);
        return true;
    }

    @Override
    public <T> T getEndpointInstance(Class<T> clazz) throws InstantiationException {
        log.info("2========{}========={}==",clazz, super.getEndpointInstance(clazz));
        return super.getEndpointInstance(clazz);
    }

    @Override
    public String getNegotiatedSubprotocol(List<String> supported, List<String> requested) {
        log.info("3========{}====={}======{}", supported, requested, super.getNegotiatedSubprotocol(supported, requested));
        return super.getNegotiatedSubprotocol(supported, requested);
    }

    @Override
    public List<Extension> getNegotiatedExtensions(List<Extension> installed, List<Extension> requested) {
        log.info("4======{}====={}======{}", installed, requested, super.getNegotiatedExtensions(installed, requested));
        return super.getNegotiatedExtensions(installed, requested);
    }

    @Override
    public void modifyHandshake(ServerEndpointConfig sec, HandshakeRequest request, HandshakeResponse response) {
        log.info("5======{}======{}======{}", sec, request, response);
        super.modifyHandshake(sec, request, response);
    }
}

ServerEndpointConfig 里有幾個(gè)可以重寫的方法,通過這些方法可以獲取websocket的信息以及對(duì)連接的一些信息進(jìn)行修改等.

3. 創(chuàng)建WebSocketConfig

通過這個(gè)配置類對(duì)websocket服務(wù)進(jìn)行發(fā)布

@Configuration
@ServletComponentScan
public class WebSocketConfig extends WsSci {
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

4.創(chuàng)建controller

這里我還創(chuàng)建了一個(gè)控制器類,用于模擬服務(wù)器的響應(yīng),發(fā)送消息通知客戶端.
RepaySuccessController.java

/**
 * @author Page
 * @Date: 2019-07-02 10:36
 * @Description:
 */

@Controller
@RequestMapping("/money")
public class RepaySuccessController {
    @Resource
    MoneyServer moneyServer;

    @PostMapping("/repaySuccess")
    public void repaySuccess(RepayResultRes req) throws IOException, EncodeException {
        moneyServer.send(req);
    }
}

工程代碼已經(jīng)放在我的github倉庫,有需要的可以下載

地址:歡迎參觀
更多關(guān)于websocket的內(nèi)容,可以參考官方文檔:
https://docs.oracle.com/javaee/7/api/javax/websocket/server/package-summary.html

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市扁凛,隨后出現(xiàn)的幾起案子令漂,更是在濱河造成了極大的恐慌,老刑警劉巖纬朝,帶你破解...
    沈念sama閱讀 217,406評(píng)論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異隅茎,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)绸硕,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,732評(píng)論 3 393
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來咬崔,“玉大人郎仆,你說我怎么就攤上這事铆农『锇迹” “怎么了郊霎?”我有些...
    開封第一講書人閱讀 163,711評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵书劝,是天一觀的道長进倍。 經(jīng)常有香客問我,道長购对,這世上最難降的妖魔是什么猾昆? 我笑而不...
    開封第一講書人閱讀 58,380評(píng)論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮骡苞,結(jié)果婚禮上垂蜗,老公的妹妹穿的比我還像新娘片部。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,432評(píng)論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著褒墨,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上拆又,一...
    開封第一講書人閱讀 51,301評(píng)論 1 301
  • 那天涣雕,我揣著相機(jī)與錄音侄非,去河邊找鬼叠赦。 笑死,一個(gè)胖子當(dāng)著我的面吹牛借笙,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播鸟整,決...
    沈念sama閱讀 40,145評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼嘱支,長吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼汛聚!你這毒婦竟也來了风罩?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,008評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤竿报,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后箕宙,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體爆安,經(jīng)...
    沈念sama閱讀 45,443評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡慷吊,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,649評(píng)論 3 334
  • 正文 我和宋清朗相戀三年抖韩,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了程帕。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片止喷。...
    茶點(diǎn)故事閱讀 39,795評(píng)論 1 347
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡嗜傅,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情趁曼,我是刑警寧澤奢驯,帶...
    沈念sama閱讀 35,501評(píng)論 5 345
  • 正文 年R本政府宣布,位于F島的核電站勃救,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏治力。R本人自食惡果不足惜蒙秒,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,119評(píng)論 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望宵统。 院中可真熱鬧晕讲,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,731評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至净捅,卻和暖如春疑枯,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背蛔六。 一陣腳步聲響...
    開封第一講書人閱讀 32,865評(píng)論 1 269
  • 我被黑心中介騙來泰國打工荆永, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人国章。 一個(gè)月前我還...
    沈念sama閱讀 47,899評(píng)論 2 370
  • 正文 我出身青樓具钥,卻偏偏與公主長得像,于是被迫代替她去往敵國和親液兽。 傳聞我的和親對(duì)象是個(gè)殘疾皇子骂删,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,724評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容