Spring Boot + Web Socket 实现扫码登录，这种方式太香了！！

水深无声 2022-10-13 12:38 139阅读 0赞

**点击关注公众号，Java干货****及时送达**![85dd5c702d4daaacd649f327bd0bfeae.png][]

最近单位又有一个新Java项目。

涉及到扫码登录。之前项目使用的是 ajax 轮询的方式。感觉太low了。

所以这次用webSocket的方式进行实现

好。废话不多说！咱们开始！！

## **一、首先咱们需要一张表** ##

这表是干啥的呢？就是记录一下谁扫码了。谁登录了。

> User\_Token表

字段如下：

*  uuid : 用于确保唯一性
 *  userId ：谁登录的
 *  loginTime ：登录时间
 *  createTime ：创建时间 用于判断是否过期
 *  state：是否二维码失效  0有效 1失效

## **二、角色都有哪些** ##

咱们还需要分析一下子。扫码登录这个业务逻辑都有哪些角色

*  android端 or 微信Web端 ：扫码
 *  PC端 ：被扫。登录
 *  服务端：掌控全局，提供接口。

## **三、接口都需要哪些？** ##

有了角色。你用大腿也能想出来接口了对不对！！

所以咱们的接口有2个！

*  生成二维码接口：生成一个二维码。二维码中有UUID。
 *  确认身份接口：确定身份以及判断是否二维码过期等

## **四、步骤** ##

那句话怎么说的来着。要把大象装冰箱一共分几步？

*  PC端打开。调用生成二维码接口 并与 服务端建立链接。链接使用uuid进行绑定
 *  微信Web端进行扫码。获取二维码中的uuid。
 *  微信Web端拿到uuid以后。显示是否登录页面。点击确定后 调用 确认身份接口。
 *  确认身份接口通过以后。服务端给PC端发送信息。完成登录。此时链接断开。

好了！分析完了这些。你们一定在想。。还有完没完啊。。不要在BB了。。赶紧贴代码吧。。

> 作者：观众老爷们。我这是在教给你们如何思考的方法呀?

那么开始贴代码吧！希望大家在看到的同时也可以自己进行思考。

## **五、疯狂贴代码** ##

[首先需要获取二维码的代码对不对！贴！][Link 1]

//获取登录二维码、放入Token
    @RequestMapping(value = "/getLoginQr" ,method = RequestMethod.GET)
    public void createCodeImg(HttpServletRequest request, HttpServletResponse response){
        response.setHeader("Pragma", "No-cache");
        response.setHeader("Cache-Control", "no-cache");
    
        response.setDateHeader("Expires", 0);
        response.setContentType("image/jpeg");
    
        try {
            //这里没啥操作 就是生成一个UUID插入 数据库的表里
            String uuid = userService.createQrImg();
            response.setHeader("uuid", uuid);
            // 这里是开源工具类 hutool里的QrCodeUtil 
            // 网址：http://hutool.mydoc.io/
            QrCodeUtil.generate(uuid, 300, 300, "jpg",response.getOutputStream());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

[有了获取二维码的接口。相对的前端需要调用。][Link 1]

> 知识点：动态加载图片流并取出header中的参数

这里使用了xmlhttp进行处理。

为什么？

因为后端返回的是一个流。

那么流中。就是放置了二维码中的uuid。这个uuid作为一次会话的标识符使用。

那么前端也需要拿到。跟后端进行webSocket链接。

这样有人扫码后。服务端才可以使用webSocket的方式通知前端。有人扫码成功了。你做你的业务吧。酱紫。

所以为了拿到请求中 header中放置的uuid 所以这样通过xmlhttp进行处理

<div class="qrCodeImg-box" id="qrImgDiv"></div>

[js][Link 1]

$(document).ready(function(){
        initQrImg();
    });
     
     
     function initQrImg(){
        $("#qrImgDiv").empty();
    
        var xmlhttp;
        xmlhttp=new XMLHttpRequest();
        xmlhttp.open("GET",getQrPath,true);
        xmlhttp.responseType = "blob";
        xmlhttp.onload = function(){
            console.log(this);
            uuid = this.getResponseHeader("uuid");
    
            if (this.status == 200) {
                var blob = this.response;
                var img = document.createElement("img");
                img.className = 'qrCodeBox-img';
                img.onload = function(e) {
                    window.URL.revokeObjectURL(img.src);
                };
                img.src = window.URL.createObjectURL(blob);
                document.getElementById("qrImgDiv").appendChild(img);
    
                initWebSocket();
            }
        }
        xmlhttp.send();
    }
    
    
    
    var path = "://localhost:8085";
    var getQrPath =  "http" + path + "/user/getLoginQr";
    var wsPath =     "ws" + path + "/websocket/";
    
    
    
    function initWebSocket(){
    
       if(typeof(WebSocket) == "undefined") {
           console.log("您的浏览器不支持WebSocket");
       }else{
           console.log("您的浏览器支持WebSocket");
           //实现化WebSocket对象，指定要连接的服务器地址与端口  建立连接
           //等同于socket = new WebSocket("ws://localhost:8083/checkcentersys/websocket/20");
           var wsPathStr = wsPath+uuid;
           socket = new WebSocket(wsPathStr);
           //打开事件
           socket.onopen = function() {
               console.log("Socket 已打开");
               //socket.send("这是来自客户端的消息" + location.href + new Date());
           };
           //获得消息事件
           socket.onmessage = function(msg) {
               console.log(msg.data);
               var data = JSON.parse(msg.data);
               if(data.code == 200){
                   alert("登录成功！");
                   //这里存放自己业务需要的数据。怎么放自己看
                   window.sessionStorage.uuid = uuid;
                   window.sessionStorage.userId = data.userId;
                   window.sessionStorage.projId = data.projId;
    
                   window.location.href = "pages/upload.html"
               }else{
                   //如果过期了，关闭连接、重置连接、刷新二维码
                   socket.close();
                   initQrImg();
               }
               //发现消息进入    开始处理前端触发逻辑
           };
           //关闭事件
           socket.onclose = function() {
               console.log("Socket已关闭");
           };
           //发生了错误事件
           socket.onerror = function() {
               alert("Socket发生了错误");
               //此时可以尝试刷新页面
           }
       }
    
    }

[好了。上面已经提到了前端如何配置webSocket。][Link 1]

## **Spring Boot中操作WebSocket** ##

Spring Boot 就不介绍了，基础教程和示例源码看这里：https://github.com/javastacks/spring-boot-best-practice

1、增加pom.xml

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

2、增加一个Bean

/**
     * WebSocket的支持
     * @return
     */
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }

[3、定义WebSocketServer][Link 1]

package com.stylefeng.guns.rest.modular.inve.websocket;
     
    /**
     * Created by jiangjiacheng on 2019/6/4.
     */
    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 cn.hutool.log.Log;
    import cn.hutool.log.LogFactory;
     
    @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--;
        }
    }

[这样就增加了webSocket的支持啦。][Link 1]

那么回到刚才的步骤。另外，《 [*Spring Boot 学习笔记*][Link 1]》建议看下。

1、首先PC端调用接口展示出来了二维码。

2、请求二维码中的http请求。就有uuid在 header中。直接取到uuid 作为webSocket的标识sid进行连接。

3、然后手机端使用相机拿到二维码中的uuid。使用uuid + userid 请求 扫码成功接口。

贴扫码成功接口

[Controller代码：][Link 1]

/**
     * 确认身份接口：确定身份以及判断是否二维码过期等
     * @param token
     * @param userId
     * @return
     */
    @RequestMapping(value = "/bindUserIdAndToken" ,method = RequestMethod.GET)
    @ResponseBody
    public Object bindUserIdAndToken(@RequestParam("token") String token ,
                                     @RequestParam("userId") Integer userId,
                                     @RequestParam(required = false,value = "projId") Integer projId){
    
        try {
            return new SuccessTip(userService.bindUserIdAndToken(userId,token,projId));
        } catch (Exception e) {
            e.printStackTrace();
            return new ErrorTip(500,e.getMessage());
        }
    
    }

[Service代码][Link 1]

@Override
    public String bindUserIdAndToken(Integer userId, String token,Integer projId) throws Exception {
    
        QrLoginToken qrLoginToken = new QrLoginToken();
        qrLoginToken.setToken(token);
        qrLoginToken = qrLoginTokenMapper.selectOne(qrLoginToken);
    
        if(null == qrLoginToken){
            throw  new Exception("错误的请求！");
        }
    
        Date createDate = new Date(qrLoginToken.getCreateTime().getTime() + (1000 * 60 * Constant.LOGIN_VALIDATION_TIME));
        Date nowDate = new Date();
        if(nowDate.getTime() > createDate.getTime()){//当前时间大于校验时间
    
            JSONObject jsonObject = new JSONObject();
            jsonObject.put("code",500);
            jsonObject.put("msg","二维码失效！");
            WebSocketServer.sendInfo(jsonObject.toJSONString(),token);
    
            throw  new Exception("二维码失效！");
        }
    
        qrLoginToken.setLoginTime(new Date());
        qrLoginToken.setUserId(userId);
    
        int i = qrLoginTokenMapper.updateById(qrLoginToken);
    
        JSONObject jsonObject = new JSONObject();
        jsonObject.put("code",200);
        jsonObject.put("msg","ok");
        jsonObject.put("userId",userId);
        if(ToolUtil.isNotEmpty(projId)){
            jsonObject.put("projId",projId);
        }
        WebSocketServer.sendInfo(jsonObject.toJSONString(),token);
    
        if(i > 0 ){
            return null;
        }else{
            throw  new Exception("服务器异常！");
        }
    }

[逻辑大概就是判断一下 token对不对][Link 1]。

如果对的话。时间是否过期。如果没有过期进行业务逻辑操作

//这句话比较关键
    WebSocketServer.sendInfo(jsonObject.toJSONString(),token);

就是通知前端已经登录成功了。并且给他业务所需要的内容。

然后前端代码接收到了。就进行业务逻辑操作就可以啦。另外，关注公众号Java技术栈，在后台回复：面试，可以获取我整理的 Java、Spring Boot 系列面试题和答案，非常齐全。

*原文链接：https://blog.csdn.net/q826qq1878/article/details/91041679*

![9dd80f4c1f9fb44fbd3e1887400e254c.gif][]

![580f2fde9abab6297a56e74debfd64e0.png][]

[![a5626a38264aaf6dde8f8929bef87b11.png][]][a5626a38264aaf6dde8f8929bef87b11.png 1]

[![8eafe5f46c78b9fcf3ad5cf41d9a7f2d.png][]][8eafe5f46c78b9fcf3ad5cf41d9a7f2d.png 1]

[![d31233fe32200e3091b94982a7d5bfbb.png][]][d31233fe32200e3091b94982a7d5bfbb.png 1]

[![7e7ed392f4aabd473445ef8755d174d6.png][]][7e7ed392f4aabd473445ef8755d174d6.png 1]

[![11922dd3b8a7a68dde116ed38103b491.png][]][11922dd3b8a7a68dde116ed38103b491.png 1]

**关注Java技术栈看更多干货**

![a7f3456809959e47c61d9746531b32cf.png][]

![31d24ba47a7b36b26671625ab46d57ab.gif][]

获取 Spring Boot 实战笔记！

[85dd5c702d4daaacd649f327bd0bfeae.png]: /images/20221005/fcea1a117c414db89c9655ff0cdf66dd.png
[Link 1]: http://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&chksm=eb50f82edc2771386229a5bb81d865eee375f8ecbec665494417beb8c933260114d67b34c3a0&idx=2&mid=2247531800&scene=21&sn=fbf496a2626d9d550c4ae95bb4f60c11#wechat_redirect
[9dd80f4c1f9fb44fbd3e1887400e254c.gif]: /images/20221005/2b3985dcf94b4a579344a227c9fcfdf7.png
[580f2fde9abab6297a56e74debfd64e0.png]: /images/20221005/ac0a76aa3e5c4eeca6be660c44fe8895.png
[a5626a38264aaf6dde8f8929bef87b11.png]: /images/20221005/4bf10e8b71314733ac426c956ef34fc2.png
[a5626a38264aaf6dde8f8929bef87b11.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247535009&scene=21&sn=5a0ac485739f9ee7be02bbe938ff0eb3#wechat_redirect
[8eafe5f46c78b9fcf3ad5cf41d9a7f2d.png]: /images/20221005/b500a773de2b4928b3cd37ed2b971753.png
[8eafe5f46c78b9fcf3ad5cf41d9a7f2d.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247534855&scene=21&sn=fdaf7ea70fca4597d3cc4e18f5ada334#wechat_redirect
[d31233fe32200e3091b94982a7d5bfbb.png]: /images/20221005/080fcb99a3ae4ef3882d24cfa2d71a2b.png
[d31233fe32200e3091b94982a7d5bfbb.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247530418&scene=21&sn=e6a0138c7c2f9a9ff6a8b4c878386211#wechat_redirect
[7e7ed392f4aabd473445ef8755d174d6.png]: /images/20221005/510ffb421f1c470fa6ce9a085e564272.png
[7e7ed392f4aabd473445ef8755d174d6.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247535062&scene=21&sn=c34b69e41525dbcb3c473c6986daa801#wechat_redirect
[11922dd3b8a7a68dde116ed38103b491.png]: /images/20221005/f3b9ae2291a54d6399005ba42ca16fc7.png
[11922dd3b8a7a68dde116ed38103b491.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247535563&scene=21&sn=b2a1de775b95890690e3295aa7e6b253#wechat_redirect
[a7f3456809959e47c61d9746531b32cf.png]: /images/20221005/414db1439c9f49ff869e0d7b542eede9.png
[31d24ba47a7b36b26671625ab46d57ab.gif]: /images/20221005/d430bfc2fdf04726ae4b27b3504b041d.png