web -【在线聊天】

1.WebSocket：

1.1 什么是WebSocket：

WebSocket是HTML5开始提供的一种在单个TCP连接上进行双工通讯的协议。

WebSocket 使得客户端与服务器之间得数据交换变得简单，允许服务器端主动向客户端推送数据。在WebSocket API中，浏览器与服务器只需要一次握手，再者之间就直接创建持久性得连接，并进行双向数据运输。

它最大得特点就是，服务器可以主动向客户端推送信息。客户端也可以主动向服务器发送信息，是真正得双向平等对话，属于服务器推送技术得一种。

Http与WebSocket的区别：

最主要的是：webSocket服务器端可以主动给客户端推送消息

其他特点包括：较少得控制开销，更强的实时性，保持连接状态，更好的二进制支持，可以支持扩展，更好的压缩效果。

1.2 为什么需要WebSocket

        举例来说，我们想了解今天的天气，只能是客户端向服务器发出请求，服务器返回查询结果。HTTP 协议做不到服务器主动向客户端推送信息。
        现在，很多网站为了实现推送技术，所用的技术都是Ajax轮询。轮询是在特定的的时间间隔(如每1秒)，由浏览器对服务器发出HTTP请求，然后由服务器返回最新的数据给客户端的浏览器。这种传统的模式带来很明显的缺点，即浏览器需要不断的向服务器发出请求，然而HTTP请求可能包含较长的头部，其中真正有效的数据可能只是很小的一部分，显然这样会浪费很多的带宽等资源。
        而比较新的技术去做轮询的效果是Comet。这种技术虽然可以双向通信，但依然需要反复发出请求。而且在 Comet中，普遍采用的长链接，也会消耗服务器资源。
        HTML5 定义的WebSocket 协议，能更好的节省服务器资源和带宽，并且能够更实时地进行通讯。

2.WebSocket实现聊天功能：

pom文件所需依赖：

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

WebSocket 配置类：

package com.nice.server.config;import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.nice.server.config.security.component.JwtTokenUtil;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import org.springframework.messaging.Message;
import org.springframework.messaging.MessageChannel;
import org.springframework.messaging.simp.config.ChannelRegistration;
import org.springframework.messaging.simp.config.MessageBrokerRegistry;
import org.springframework.messaging.simp.stomp.StompCommand;
import org.springframework.messaging.simp.stomp.StompHeaderAccessor;
import org.springframework.messaging.support.ChannelInterceptor;
import org.springframework.messaging.support.MessageHeaderAccessor;
import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker;
import org.springframework.web.socket.config.annotation.StompEndpointRegistry;
import org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer;import javax.annotation.Resource;/*** webSocket配置类*/
@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {@Value("${jwt.tokenHead}")//private String tokenHead;@Resourceprivate JwtTokenUtil jwtTokenUtil;@Resourceprivate UserDetailsService userDetailsService;/*** 添加这个Endpoint,这样在网页可以通过websocket连接上服务* 也就是我们配置websocket的服务地址，并且可以指定是否使用socketJS* @param registry*/@Override   //这是是让前端连接我们public void registerStompEndpoints(StompEndpointRegistry registry) {/*** 1.将ws/ep路径注册为stomp的端点，用户连接了这个端点就可以进行websocket通讯，支持socketJS* 2.setAllowedOrigins("*"): 允许跨域* 3.withSockJS():支持socketJS访问*/registry.addEndpoint("/ws/ep").setAllowedOrigins("*").withSockJS();}/*** 输入通道参数配置* @param registration*/@Overridepublic void configureClientInboundChannel(ChannelRegistration registration) {registration.interceptors(new ChannelInterceptor() {@Overridepublic Message<?> preSend(Message<?> message, MessageChannel channel) {StompHeaderAccessor accessor = MessageHeaderAccessor.getAccessor(message, StompHeaderAccessor.class);//判断是否为连接，如果是，需要获取token，并且设置用户对象if (StompCommand.CONNECT.equals(accessor.getCommand())){String token = accessor.getFirstNativeHeader("Auth-Token"); //Auth-Token 为前端传给我们的if (!StringUtils.isEmpty(token)){String authToken = token.substring(tokenHead.length());String username = jwtTokenUtil.getUserNameFromToken(authToken);//token中存在用户名if (!StringUtils.isEmpty(username)){//登录UserDetails userDetails = userDetailsService.loadUserByUsername(username);//验证token是否有效，重新设置用户对象if (jwtTokenUtil.validateToken(authToken,userDetails)){UsernamePasswordAuthenticationToken authenticationToken =new UsernamePasswordAuthenticationToken(userDetails, null,userDetails.getAuthorities());SecurityContextHolder.getContext().setAuthentication(authenticationToken);accessor.setUser(authenticationToken);//}}}}return message;}});}/*** 配置消息代理* @param registry*/@Override   //这个是主动推送消息,/queue 让前端有地方接收public void configureMessageBroker(MessageBrokerRegistry registry) {//配置代理域，可以配置多个，配置代理目的地前缀为/queue，可以在配置域上向客户端推送消息registry.enableSimpleBroker("/queue");}
}

定义一个消息类：

package com.nice.server.pojo;import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.Accessors;import java.time.LocalDateTime;/*** 消息*/
@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
public class ChatMsg {private String from;private String to;private String content;private LocalDateTime date;private String formNickName;}

webSocketController:

package com.nice.server.controller;import com.nice.server.pojo.Admin;
import com.nice.server.pojo.ChatMsg;
import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.messaging.simp.SimpMessagingTemplate;
import org.springframework.security.core.Authentication;
import org.springframework.stereotype.Controller;import javax.annotation.Resource;
import java.time.LocalDateTime;/*** websocket*/
@Controller//
public class WsController {@Resourceprivate SimpMessagingTemplate simpMessagingTemplate;@MessageMapping("/ws/chat")public void handleMsg(Authentication authentication, ChatMsg chatMsg){Admin admin = (Admin) authentication.getPrincipal();chatMsg.setFrom(admin.getUsername());chatMsg.setFormNickName(admin.getName());chatMsg.setDate(LocalDateTime.now());simpMessagingTemplate.convertAndSendToUser(chatMsg.getTo(),"/queue/chat",chatMsg);}}

在线聊天：

设置端口，允许跨域

package com.nice.server.controller;import com.nice.server.pojo.Admin;
import com.nice.server.service.IAdminService;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;import javax.annotation.Resource;
import java.util.List;/*** 在线聊天*/
@RestController
@RequestMapping("/chat")
public class ChatController {@Resourceprivate IAdminService adminService;@ApiOperation(value = "获取所有操作员")@GetMapping("/admin")public List<Admin> getAllAdmins(String keywords){return adminService.getAllAdmins(keywords);}}

效果：