关于java:使用-SaToken-解决-WebSocket-握手身份认证

5次阅读

共计 7890 个字符，预计需要花费 20 分钟才能阅读完成。

相比于 Http 的单项通信形式，WebSocket 能够从服务器向浏览器被动推送音讯，这一个性能够帮忙咱们实现诸如订单音讯推送、IM 实时聊天等一些特定业务。

然而 WebSocket 自身对“身份认证”并没有提供间接的反对，对客户端的连贯默认是“来者不拒”，所以认证受权这个事，得咱们本人入手。

Sa-Token 是一个 java 权限认证框架，次要解决登录认证、权限认证、单点登录、OAuth2、微服务网关鉴权等一系列权限相干问题。
GitHub 开源地址：https://github.com/dromara/sa-token

上面咱们介绍一下如何在 WebSocket 中集成 Sa-Token 身份认证，保障连贯的安全性。

咱们将顺次介绍目前最常见的两种集成 WebSocket 形式：

Java 原生版：javax.websocket.Session
Spring 封装版：WebSocketSession

废话不多说，间接开搞：

1、首先是引入 pom.xml 依赖

<!-- SpringBoot 依赖 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

<!-- WebScoket 依赖 -->
<dependency>  
    <groupId>org.springframework.boot</groupId>  
    <artifactId>spring-boot-starter-websocket</artifactId>  
</dependency>

<!-- Sa-Token 权限认证, 在线文档：http://sa-token.dev33.cn/ -->
<dependency>
    <groupId>cn.dev33</groupId>
    <artifactId>sa-token-spring-boot-starter</artifactId>
    <version>1.29.0</version>
</dependency>

2、登录接口，用于获取会话 token

/**
 * 登录测试 
 */
@RestController
@RequestMapping("/acc/")
public class LoginController {

    // 测试登录  ---- http://localhost:8081/acc/doLogin?name=zhang&pwd=123456
    @RequestMapping("doLogin")
    public SaResult doLogin(String name, String pwd) {
        // 此处仅作模仿示例，实在我的项目须要从数据库中查问数据进行比对 
        if("zhang".equals(name) && "123456".equals(pwd)) {StpUtil.login(10001);
            return SaResult.ok("登录胜利").set("token", StpUtil.getTokenValue());
        }
        return SaResult.error("登录失败");
    }

    // ... 
    
}

3、WebSocket 连贯解决

@Component
@ServerEndpoint("/ws-connect/{satoken}")
public class WebSocketConnect {

    /**
     * 固定前缀 
     */
    private static final String USER_ID = "user_id_";
    
     /** 
      * 寄存 Session 汇合，不便推送音讯（javax.websocket.Session）*/
    private static ConcurrentHashMap<String, Session> sessionMap = new ConcurrentHashMap<>();
    
    // 监听：连贯胜利
    @OnOpen
    public void onOpen(Session session, @PathParam("satoken") String satoken) throws IOException {
        
        // 依据 token 获取对应的 userId 
        Object loginId = StpUtil.getLoginIdByToken(satoken);
        if(loginId == null) {session.close();
            throw new SaTokenException("连贯失败，有效 Token：" + satoken);
        }
        
        // put 到汇合，不便后续操作 
        long userId = SaFoxUtil.getValueByType(loginId, long.class);
        sessionMap.put(USER_ID + userId, session);
        
        // 给个提醒 
        String tips = "Web-Socket 连贯胜利，sid=" + session.getId() + "，userId=" + userId;
        System.out.println(tips);
        sendMessage(session, tips);
    }

    // 监听: 连贯敞开
    @OnClose
    public void onClose(Session session) {System.out.println("连贯敞开，sid=" + session.getId());
        for (String key : sessionMap.keySet()) {if(sessionMap.get(key).getId().equals(session.getId())) {sessionMap.remove(key);
            }
        }
    }
    
    // 监听：收到客户端发送的音讯 
    @OnMessage
    public void onMessage(Session session, String message) {System.out.println("sid 为：" + session.getId() + "，发来：" + message);
    }
    
    // 监听：产生异样 
    @OnError
    public void onError(Session session, Throwable error) {System.out.println("sid 为：" + session.getId() + "，产生谬误");
        error.printStackTrace();}
    
    // ---------
    
    // 向指定客户端推送音讯 
    public static void sendMessage(Session session, String message) {
        try {System.out.println("向 sid 为：" + session.getId() + "，发送：" + message);
            session.getBasicRemote().sendText(message);
        } catch (IOException e) {throw new RuntimeException(e);
        }
    }
    
    // 向指定用户推送音讯 
    public static void sendMessage(long userId, String message) {Session session = sessionMap.get(USER_ID + userId);
        if(session != null) {sendMessage(session, message);
        }
    }
    
}

4、WebSocket 配置

/**
 * 开启 WebSocket 反对
 */
@Configuration  
public class WebSocketConfig { 
    
    @Bean  
    public ServerEndpointExporter serverEndpointExporter() {return new ServerEndpointExporter();  
    }
    
}

5、启动类

@SpringBootApplication
public class SaTokenWebSocketApplication {public static void main(String[] args) {SpringApplication.run(SaTokenWebSocketApplication.class, args); 
    }
    
}

搭建结束，启动我的项目

6、测试

1、首先咱们拜访登录接口，拿到会话 token

http://localhost:8081/acc/doLogin?name=zhang&pwd=123456

如图所示：

2、而后咱们轻易找一个 WebSocket 在线测试页面进行连贯
，例如：https://www.bejson.com/httputil/websocket/

连贯地址：

ws://localhost:8081/ws-connect/302ee2f8-60aa-42aa-8ecb-eeae5ba57015

如图所示：

3、如果咱们输出一个谬误的 token，会怎么呢？

能够看到，连贯会被立刻断开！

1、同上：首先是引入 pom.xml 依赖

<!-- SpringBoot 依赖 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

<!-- WebScoket 依赖 -->
<dependency>  
    <groupId>org.springframework.boot</groupId>  
    <artifactId>spring-boot-starter-websocket</artifactId>  
</dependency>

<!-- Sa-Token 权限认证, 在线文档：http://sa-token.dev33.cn/ -->
<dependency>
    <groupId>cn.dev33</groupId>
    <artifactId>sa-token-spring-boot-starter</artifactId>
    <version>1.29.0</version>
</dependency>

2、登录接口，用于获取会话 token

/**
 * 登录测试 
 */
@RestController
@RequestMapping("/acc/")
public class LoginController {

    // 测试登录  ---- http://localhost:8081/acc/doLogin?name=zhang&pwd=123456
    @RequestMapping("doLogin")
    public SaResult doLogin(String name, String pwd) {
        // 此处仅作模仿示例，实在我的项目须要从数据库中查问数据进行比对 
        if("zhang".equals(name) && "123456".equals(pwd)) {StpUtil.login(10001);
            return SaResult.ok("登录胜利").set("token", StpUtil.getTokenValue());
        }
        return SaResult.error("登录失败");
    }

    // ... 
    
}

3、WebSocket 连贯解决

/**
 * 解决 WebSocket 连贯 
 */
public class MyWebSocketHandler extends TextWebSocketHandler {

    /**
     * 固定前缀 
     */
    private static final String USER_ID = "user_id_";
    
    /**
     * 寄存 Session 汇合，不便推送音讯
     */
    private static ConcurrentHashMap<String, WebSocketSession> webSocketSessionMaps = new ConcurrentHashMap<>();

    // 监听：连贯开启 
    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {

        // put 到汇合，不便后续操作 
        String userId = session.getAttributes().get("userId").toString();
        webSocketSessionMaps.put(USER_ID + userId, session);
        

        // 给个提醒 
        String tips = "Web-Socket 连贯胜利，sid=" + session.getId() + "，userId=" + userId;
        System.out.println(tips);
        sendMessage(session, tips);
    }
    
    // 监听：连贯敞开 
    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        // 从汇合移除 
        String userId = session.getAttributes().get("userId").toString();
        webSocketSessionMaps.remove(USER_ID + userId);
        
        // 给个提醒 
        String tips = "Web-Socket 连贯敞开，sid=" + session.getId() + "，userId=" + userId;
        System.out.println(tips);
    }

    // 收到音讯 
    @Override
    public void handleTextMessage(WebSocketSession session, TextMessage message) throws IOException {System.out.println("sid 为：" + session.getId() + "，发来：" + message);
    }

    // ----------- 
    
    // 向指定客户端推送音讯 
     public static void sendMessage(WebSocketSession session, String message) {
         try {System.out.println("向 sid 为：" + session.getId() + "，发送：" + message);
             session.sendMessage(new TextMessage(message));
         } catch (IOException e) {throw new RuntimeException(e);
         }
     }
     
     // 向指定用户推送音讯 
     public static void sendMessage(long userId, String message) {WebSocketSession session = webSocketSessionMaps.get(USER_ID + userId);
        if(session != null) {sendMessage(session, message);
        }
     }
    
}

4、WebSocket 前置拦截器

/**
 * WebSocket 握手的前置拦截器 
 */
public class WebSocketInterceptor implements HandshakeInterceptor {// 握手之前触发 (return true 才会握手胜利)
    @Override
    public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler handler,
            Map<String, Object> attr) {System.out.println("---- 握手之前触发" + StpUtil.getTokenValue());
        
        // 未登录状况下回绝握手 
        if(StpUtil.isLogin() == false) {System.out.println("---- 未受权客户端，连贯失败");
            return false;
        }
        
        // 标记 userId，握手胜利 
        attr.put("userId", StpUtil.getLoginIdAsLong());
        return true;
    }

    // 握手之后触发 
    @Override
    public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,
            Exception exception) {System.out.println("---- 握手之后触发");
    }
    
}

5、WebSocket 配置

/**
 * WebSocket 相干配置 
 */
@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
    
    // 注册 WebSocket 处理器 
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry webSocketHandlerRegistry) {
        webSocketHandlerRegistry
                // WebSocket 连贯处理器 
                .addHandler(new MyWebSocketHandler(), "/ws-connect")
                // WebSocket 拦截器 
                .addInterceptors(new WebSocketInterceptor())
                // 容许跨域 
                .setAllowedOrigins("*");
    }

}

6、启动类

/**
 * Sa-Token 整合 WebSocket 鉴权示例 
 */
@SpringBootApplication
public class SaTokenWebSocketSpringApplication {public static void main(String[] args) {SpringApplication.run(SaTokenWebSocketSpringApplication.class, args); 
    }
    
}

启动我的项目，开始测试

7、测试

1、首先拜访登录接口，拿到会话 token

http://localhost:8081/acc/doLogin?name=zhang&pwd=123456

如图所示：

2、而后关上 WebSocket 在线测试页面进行连贯
，例如：https://www.bejson.com/httputil/websocket/

连贯地址：

ws://localhost:8081/ws-connect?satoken=fe6e7dbd-38b8-4de2-ae05-cda7e36bf2f7

如图所示：

注：这里采纳 url 传递 Token 是因为在第三方测试页面上这样比拟不便，实在我的项目中能够从 Cookie、Header 参数、url 参数三种形式任选其一传递会话令牌，成果等同

3、如果输出一个谬误的 Token

连贯失败！

以上代码曾经上传 git，示例地址：
码云：sa-token-demo-websocket

Gitee 地址：https://gitee.com/dromara/sa-token
GitHub 地址：https://github.com/dromara/sa-token
Sa-Token 官网：https://sa-token.dev33.cn/

正文完

java

发表至： java

2022-02-14

0

并发和Readcopy-updateRCU

关于java:App融合深度链接和携带参数安装实例分析

关于java:如何用-Nginx-代理-MySQL-连接并限制可访问-IP

Java8新特性时间日期库DateTime-API及示例

关于ssl证书:利用openssl自制ca证书以及ssl证书

关于java:使用-SaToken-解决-WebSocket-握手身份认证

前言

两种集成形式

形式一：Java 原生版 javax.websocket.Session

1、首先是引入 pom.xml 依赖

2、登录接口，用于获取会话 token

3、WebSocket 连贯解决

4、WebSocket 配置

5、启动类

6、测试

形式二：Spring 封装版：WebSocketSession

1、同上：首先是引入 pom.xml 依赖

2、登录接口，用于获取会话 token

3、WebSocket 连贯解决

4、WebSocket 前置拦截器

5、WebSocket 配置

6、启动类

7、测试

示例地址

参考资料

站内搜索