Spring Boot使用Netty SocketIO实现WebIM功能

Stella981
• 阅读 1020

Netty SocketIO是一个 Java 语言版本的 Socket.IO 服务器的实现,基于 Netty 框架开发,使用简单,功能强大。

在Spring Boot中包含了对Netty SocketIO的支持,只需要简单配置即可加入。

第一步:增加Netty SocketIO的依赖。

<dependency>  
    <groupId>com.corundumstudio.socketio</groupId>  
    <artifactId>netty-socketio</artifactId>  
    <version>1.7.11</version>  
</dependency>

第二步:在Application中增加启动项

package com.ukefu;

import javax.servlet.MultipartConfigElement;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.embedded.ConfigurableEmbeddedServletContainer;
import org.springframework.boot.context.embedded.EmbeddedServletContainerCustomizer;
import org.springframework.boot.context.embedded.ErrorPage;
import org.springframework.boot.context.embedded.MultipartConfigFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
import org.springframework.http.HttpStatus;

import com.corundumstudio.socketio.AuthorizationListener;
import com.corundumstudio.socketio.Configuration;
import com.corundumstudio.socketio.HandshakeData;
import com.corundumstudio.socketio.SocketConfig;
import com.corundumstudio.socketio.SocketIOServer;
import com.corundumstudio.socketio.annotation.SpringAnnotationScanner;
import com.ukefu.core.UKDataContext;

@EnableAutoConfiguration
@SpringBootApplication
@EnableJpaRepositories("com.ukefu.service.repository")
public class Application {
    
    @Value("${uk.im.server.host}")  
    private String host;  
  
    @Value("${uk.im.server.port}")  
    private Integer port; 
    
    @Bean  
    public SocketIOServer socketIOServer()   
    {  

        Configuration config = new Configuration();
//        config.setHostname("localhost");
        config.setPort(port);
        config.setSocketConfig(new SocketConfig());
//        config.setOrigin("http://im.ukewo.com");
        
        config.setWorkerThreads(100);
//        config.setStoreFactory(new HazelcastStoreFactory());
        config.setAuthorizationListener(new AuthorizationListener() {
            
            public boolean isAuthorized(HandshakeData data) {
                return true;
            }
        });
        
        SocketIOServer server  = new SocketIOServer(config);
        server.addNamespace(UKDataContext.NameSpaceEnum.IM.toString()) ;
        server.addNamespace(UKDataContext.NameSpaceEnum.AGENT.toString()) ;
        return server;  
    }  
    
    @Bean   
    public MultipartConfigElement multipartConfigElement() {   
            MultipartConfigFactory factory = new MultipartConfigFactory();  
            factory.setMaxFileSize("50MB"); //KB,MB  
            factory.setMaxRequestSize("100MB");   
            return factory.createMultipartConfig();   
    }   
      
    @Bean
    public EmbeddedServletContainerCustomizer containerCustomizer() {

        return new EmbeddedServletContainerCustomizer() {
            @Override
            public void customize(ConfigurableEmbeddedServletContainer container) {

                ErrorPage error = new ErrorPage("/error.html");

                container.addErrorPages(error);
            }
        };
    }
    
    @Bean  
    public SpringAnnotationScanner springAnnotationScanner(SocketIOServer socketServer) {  
        return new SpringAnnotationScanner(socketServer);  
    }  

    public static void main(String[] args) {
        UKDataContext.setApplicationContext(SpringApplication.run(Application.class, args));
    }

}

第三步:配置Netty Server相关代码

package com.ukefu.util.server;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

import com.corundumstudio.socketio.SocketIOServer;
import com.ukefu.core.UKDataContext;
import com.ukefu.util.server.handler.AgentEventHandler;
import com.ukefu.util.server.handler.IMEventHandler;
  
@Component  
public class ServerRunner implements CommandLineRunner {  
    private final SocketIOServer server;  
    
    private IMEventHandler imEventHandler ;
    
    private AgentEventHandler agentEventHandler ;
    
    @Autowired  
    public ServerRunner(SocketIOServer server , IMEventHandler imEventHandler , AgentEventHandler agentEventHandler) {  
        this.server = server;  
        this.imEventHandler = imEventHandler ;
        this.agentEventHandler = agentEventHandler ;
    }  
  
    public void run(String... args) throws Exception { 
        server.getNamespace(UKDataContext.NameSpaceEnum.IM.toString()).addListeners(imEventHandler);
        server.getNamespace(UKDataContext.NameSpaceEnum.AGENT.toString()).addListeners(agentEventHandler);
        server.start();  
    }  
}  

第四步:配置消息处理的代码

package com.ukefu.util.server.handler;

import java.net.InetSocketAddress;

import org.apache.commons.lang.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import com.corundumstudio.socketio.AckRequest;
import com.corundumstudio.socketio.SocketIOClient;
import com.corundumstudio.socketio.SocketIOServer;
import com.corundumstudio.socketio.annotation.OnConnect;
import com.corundumstudio.socketio.annotation.OnDisconnect;
import com.corundumstudio.socketio.annotation.OnEvent;
import com.ukefu.util.server.message.AgentStatusMessage;
import com.ukefu.util.server.message.ChatMessage;
import com.ukefu.util.server.message.NewRequestMessage;
  
@Component  
public class IMEventHandler extends EventHandler    
{  
      
    @Autowired  
    public IMEventHandler(SocketIOServer server)   
    {  
        super(server) ;
    }  
    
    @OnConnect  
    public void onConnect(SocketIOClient client)  
    {  
        System.out.println(client.getSessionId());
    }  
      
    //添加@OnDisconnect事件,客户端断开连接时调用,刷新客户端信息  
    @OnDisconnect  
    public void onDisconnect(SocketIOClient client)  
    {  
        System.out.println(client.getSessionId());
    }  
      
    //消息接收入口,网站有新用户接入对话  
    @OnEvent(value = "new")  
    public void onEvent(SocketIOClient client, AckRequest request, NewRequestMessage data)   
    {
        try {
            String user = client.getHandshakeData().getSingleUrlParam("userid") ;
            String orgi = client.getHandshakeData().getSingleUrlParam("orgi") ;
            String session = client.getHandshakeData().getSingleUrlParam("session") ;
            String appid = client.getHandshakeData().getSingleUrlParam("appid") ;
            if(!StringUtils.isBlank(session)){
                session = session.replaceAll("-", "") ;
            }
            
            if(!StringUtils.isBlank(user)){
                /**
                 * 用户进入到对话连接 , 排队用户请求 , 如果返回失败,表示当前坐席全忙,用户进入排队状态,当前提示信息 显示 当前排队的队列位置,不可进行对话,用户发送的消息作为留言处理
                 */
                InetSocketAddress address = (InetSocketAddress) client.getRemoteAddress()  ;
//                NewRequestMessage newRequestMessage = OnlineUserUtils.newRequestMessage(user, orgi , session , appid , address.getHostString() , client.getHandshakeData().getSingleUrlParam("osname") , client.getHandshakeData().getSingleUrlParam("browser")) ;
//                /**
//                 * 加入到 缓存列表
//                 */
//                NettyClients.getInstance().putIMEventClient(user, client);
//                
//                if(newRequestMessage!=null && !StringUtils.isBlank(newRequestMessage.getMessage())){
//                    MessageOutContent outMessage = new MessageOutContent() ;
//                    outMessage.setMessage(newRequestMessage.getMessage());
//                    outMessage.setMessageType(UKDataContext.MessageTypeEnum.MESSAGE.toString());
//                    outMessage.setCalltype(UKDataContext.CallTypeEnum.IN.toString());
//                    
//                    client.sendEvent(UKDataContext.MessageTypeEnum.STATUS.toString(), outMessage);
//                }
            }
        } catch (Exception e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }  
    
  //消息接收入口,坐席状态更新  
    @OnEvent(value = "agentstatus")  
    public void onEvent(SocketIOClient client, AckRequest request, AgentStatusMessage data)   
    {
        System.out.println(data.getMessage());
    } 
    
    //消息接收入口,收发消息,用户向坐席发送消息和 坐席向用户发送消息  
    @OnEvent(value = "message")  
    public void onEvent(SocketIOClient client, AckRequest request, ChatMessage data)   
    {
        System.out.println(data.getMessage());
    } 
}  

第五步:完成配置。

以上所有代码在优客服中找到。

点赞
收藏
评论区
推荐文章
blmius blmius
3年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
待兔 待兔
5个月前
手写Java HashMap源码
HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22
Jacquelyn38 Jacquelyn38
3年前
2020年前端实用代码段,为你的工作保驾护航
有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
Wesley13 Wesley13
3年前
mysql设置时区
mysql设置时区mysql\_query("SETtime\_zone'8:00'")ordie('时区设置失败,请联系管理员!');中国在东8区所以加8方法二:selectcount(user\_id)asdevice,CONVERT\_TZ(FROM\_UNIXTIME(reg\_time),'08:00','0
Wesley13 Wesley13
3年前
00:Java简单了解
浅谈Java之概述Java是SUN(StanfordUniversityNetwork),斯坦福大学网络公司)1995年推出的一门高级编程语言。Java是一种面向Internet的编程语言。随着Java技术在web方面的不断成熟,已经成为Web应用程序的首选开发语言。Java是简单易学,完全面向对象,安全可靠,与平台无关的编程语言。
Stella981 Stella981
3年前
Django中Admin中的一些参数配置
设置在列表中显示的字段,id为django模型默认的主键list_display('id','name','sex','profession','email','qq','phone','status','create_time')设置在列表可编辑字段list_editable
Wesley13 Wesley13
3年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
为什么mysql不推荐使用雪花ID作为主键
作者:毛辰飞背景在mysql中设计表的时候,mysql官方推荐不要使用uuid或者不连续不重复的雪花id(long形且唯一),而是推荐连续自增的主键id,官方的推荐是auto_increment,那么为什么不建议采用uuid,使用uuid究
Python进阶者 Python进阶者
11个月前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这