WOIM——一个基于Netty、SpingBoot开发的分布式、嵌入式、组件化、高度自定义、高可扩展的Java即时通讯(IM)框架

本文主要是介绍WOIM——一个基于Netty、SpingBoot开发的分布式、嵌入式、组件化、高度自定义、高可扩展的Java即时通讯(IM)框架,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

WOIM

Introduction

WOIM是一个基于Netty、SpingBoot开发的分布式嵌入式组件化高度自定义高可扩展的Java即时通讯框架,可以轻松嵌入你自己的用户系统,以提供即时通讯服务,同时也可作为消息推送系统,成为连接双端的桥梁。

Features
  1. 分布式

    支持分布式集群部署,单机无法满足用户量需求时可水平扩展。

  2. 嵌入式

    只需实现自己的连接鉴权逻辑,便可非侵入式地嵌入已有的用户系统。

  3. 组件化

    从连接管理到消息处理通道再到业务逻辑都是可拆卸、组装的。

  4. 高度自定义

    非侵入式,支持二次开发和功能集成,对于内置默认的各个组件以及业务逻辑可进行替换及自定义开发,你可以通过WOIM搭建最适合你自己的即时通讯服务。

  5. 高可扩展

    内置了序列化和反序列化逻辑,真正的消息类型自定义,配置了相应的处理逻辑后,你便可以向客户端推送任何自定义的消息类型,包括但不限于私聊、群聊消息、系统推送。

  6. 完善的IM功能

    内置了私聊、群聊、离线消息、会话管理等一系列功能(出于对隐私的尊重,没有内置漫游消息的功能,但支持二次开发实现),支持多种消息类型的扩展,文字、语音、图片、文件,支持多端登录。

  7. 同端口,多协议,热插拔

    支持多种传输协议,默认使用protobuf、websocket,支持自定义协议扩展,同端口下可多协议切换,协议热插拔。

Quick Start
  • 初始化数据库表格

    • 方法一:配置文件中配置

      默认为NONE模式,不进行数据库的初始化,可选模式有NEW(删除旧表,创建新表),SAFE(不存在则创建)模式

      woi:woim:db-initialization-mode: SAFE
      
    • 方法二:执行sql脚本

      执行提供的sql脚本

  • 依赖引入

    本项目暂未上传至中央仓库,可clone后安装到本地maven仓库

    服务端

    maven

        <dependency><groupId>zone.czh</groupId><artifactId>woi-woim</artifactId><version>1.0.0</version></dependency>
    

    客户端

    maven

        <dependency><groupId>zone.czh</groupId><artifactId>woi-woim-client</artifactId><version>1.0.0</version></dependency>
    

    gradle

        implementation 'zone.czh:woi-woim-client:1.0.0'
    
  • 使用及开发

    详见example模块

    服务端

    • 快速开发
    1. 注解开启WOIM

      @SpringBootApplication
      @EnableWOIM //todo enable woim
      public class WoiWOIMExampleApplication {public static void main(String[] args) {SpringApplication.run(WoiWOIMExampleApplication.class, args);}
      }
      
    2. 实现WOIMConfigurator

      //or implements WOIMConfigurator
      @Component
      public class ExampleConfigurator extends DefaultWOIMConfigurator{@Overridepublic WOIMVerifier getChannelVerifier() {//todo 配置自己的连接授权方法,适配自己的用户系统return null;}
      }
      
    • 集群
    1. 编写配置文件

      woi:woim:server-addr: 127.0.0.1:8080,127.0.0.1:8081,127.0.0.1:8082
      

客户端

  • 快速开发

    //init client
    WOIMClient client = new WOIMClient.Builder().setInetHost("127.0.0.1").setPort(6666).setEventListener(new CustomEventListener()).setConfigurator(new CustomConfigurator()).build();
    //auth
    client.authSafely("token",null,null);
    //send message
    client.push(new PrivateMsg());
    //the customized message you pushed must be serializable!!!
    
Document

暂无详细文档,可参考example模块

Screenshot

安卓端

(自己写的一个基于本框架开发的安卓端app,条件合适时可以考虑开源)

image image image image image image image image image image

Web端

woim-client-ts(sdk):

github
gitee

image

桌面端

暂时没做图形界面的桌面端

image
Contacts

Email:

woimail@163.com

woi.cmail@gmail.com

这篇关于WOIM——一个基于Netty、SpingBoot开发的分布式、嵌入式、组件化、高度自定义、高可扩展的Java即时通讯(IM)框架的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/471156

相关文章

SpringBoot UserAgentUtils获取用户浏览器的用法

《SpringBootUserAgentUtils获取用户浏览器的用法》UserAgentUtils是于处理用户代理(User-Agent)字符串的工具类,一般用于解析和处理浏览器、操作系统以及设备... 目录介绍效果图依赖封装客户端工具封装IP工具实体类获取设备信息入库介绍UserAgentUtils

Spring 中的循环引用问题解决方法

《Spring中的循环引用问题解决方法》:本文主要介绍Spring中的循环引用问题解决方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录什么是循环引用?循环依赖三级缓存解决循环依赖二级缓存三级缓存本章来聊聊Spring 中的循环引用问题该如何解决。这里聊

Java学习手册之Filter和Listener使用方法

《Java学习手册之Filter和Listener使用方法》:本文主要介绍Java学习手册之Filter和Listener使用方法的相关资料,Filter是一种拦截器,可以在请求到达Servl... 目录一、Filter(过滤器)1. Filter 的工作原理2. Filter 的配置与使用二、Listen

Spring Boot中JSON数值溢出问题从报错到优雅解决办法

《SpringBoot中JSON数值溢出问题从报错到优雅解决办法》:本文主要介绍SpringBoot中JSON数值溢出问题从报错到优雅的解决办法,通过修改字段类型为Long、添加全局异常处理和... 目录一、问题背景:为什么我的接口突然报错了?二、为什么会发生这个错误?1. Java 数据类型的“容量”限制

Java对象转换的实现方式汇总

《Java对象转换的实现方式汇总》:本文主要介绍Java对象转换的多种实现方式,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录Java对象转换的多种实现方式1. 手动映射(Manual Mapping)2. Builder模式3. 工具类辅助映

SpringBoot请求参数接收控制指南分享

《SpringBoot请求参数接收控制指南分享》:本文主要介绍SpringBoot请求参数接收控制指南,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Spring Boot 请求参数接收控制指南1. 概述2. 有注解时参数接收方式对比3. 无注解时接收参数默认位置

Go语言开发实现查询IP信息的MCP服务器

《Go语言开发实现查询IP信息的MCP服务器》随着MCP的快速普及和广泛应用,MCP服务器也层出不穷,本文将详细介绍如何在Go语言中使用go-mcp库来开发一个查询IP信息的MCP... 目录前言mcp-ip-geo 服务器目录结构说明查询 IP 信息功能实现工具实现工具管理查询单个 IP 信息工具的实现服

SpringBoot基于配置实现短信服务策略的动态切换

《SpringBoot基于配置实现短信服务策略的动态切换》这篇文章主要为大家详细介绍了SpringBoot在接入多个短信服务商(如阿里云、腾讯云、华为云)后,如何根据配置或环境切换使用不同的服务商,需... 目录目标功能示例配置(application.yml)配置类绑定短信发送策略接口示例:阿里云 & 腾

SpringBoot项目中报错The field screenShot exceeds its maximum permitted size of 1048576 bytes.的问题及解决

《SpringBoot项目中报错ThefieldscreenShotexceedsitsmaximumpermittedsizeof1048576bytes.的问题及解决》这篇文章... 目录项目场景问题描述原因分析解决方案总结项目场景javascript提示:项目相关背景:项目场景:基于Spring

Spring Boot 整合 SSE的高级实践(Server-Sent Events)

《SpringBoot整合SSE的高级实践(Server-SentEvents)》SSE(Server-SentEvents)是一种基于HTTP协议的单向通信机制,允许服务器向浏览器持续发送实... 目录1、简述2、Spring Boot 中的SSE实现2.1 添加依赖2.2 实现后端接口2.3 配置超时时