NettySocketioServer

该程序由java语言编写，基于netty-socketio开源项目和Redis，旨在实现WebSocket的服务端功能。

---

Author:wangnamu

E-mail:wangstin@sina.com

---

Requirements

• JDK 1.8 or later

Getting Started

适用范围

Web系统与手机APP之间的通讯，每个账户支持一台PC设备和一台手机设备同时在线

登录账户工作原理（详见代码）

1. 生成唯一的设备标识DeviceToken
2. socket connect 成功回调中进行登录
3. 传入userInfo信息
4. 检查是否存在其它设备登录（判定标识为每个账户支持一台PC设备和一台手机设备同时在线），如存在则返回登录失败信息
5. 服务端存入用户信息
6. 服务端踢掉与当前登录设备类型相同的已连接的其它设备
7. 被踢掉的客户端收到通知

How To Use

• 去Redis官网下载并安装Redis

• 运行redis server

• 编译程序并导出可执行jar包

• 编写配置文件 config.properties

• 打开控制台，cd到jar包目录下

• 运行命令： java -jar socket.jar 'ip' 'port' 'config.properties 绝对路径'

   config.properties文件：
   
   redisConfigPath=xxx          #redis-config.json文件绝对路径
   p12FilePath=xxx              #.p12文件绝对路径（供IOS推送使用）
   p12Password=xxx              #.p12密码（供IOS推送使用）
   p12ISProduction=true/false   #.p12测试／正式通道（供IOS推送使用）
   

Example

Javascript

<script src="https://cdnjs.cloudflare.com/ajax/libs/socket.io/1.7.3/socket.io.min.js"></script>

var socket = io.connect('http://xxx.xxx.xxx.xxx:xxxx');

//连接
socket.on('connect',function () {
    login();
 });

//登录
function login() {
    var userInfo = {};  //详见UserInfo类
    socket.emit('login', jsonObject, function (data) {
        console.log(data);  //data详见Response类
    });
}

//被踢下线
socket.on('kickoff', function (data) {
    console.log(data);  //data详见Response类
});

//收到消息
socket.on('news', function (data, ackServerCallback) {
     console.log(data);  //data详见Message类
     if (ackServerCallback) {
        ackServerCallback('success');
     }
});

//断线
socket.on('disconnect', function () {
});

Java Model

• Message

// 主键
private String SID;
// 发送人ID
private String SenderID;
// 发送人设备编号
private String SenderDeviceToken;
// 接收人ID
private HashSet<String> ReceiverIDs;
// 标题
private String Title;
// 内容
private String Body;
// 时间
private long Time;
// 消息类型(文字、图片、文件、链接、音频、视频、表情等)
private String MessageType;
// 提醒
private Boolean IsAlert;
// 针对ios10和androidN的快捷回复功能，Category字段表示快捷方式分类
private String Category = "custom";
// 自定义内容类型
private String OthersType;
// 自定义内容
private Object Others;

• UserInfo

// 主键
private String SID;
// 用户名
private String UserName;
// 真实姓名
private String NickName;
// 最近一次登录时间
private long LoginTime;
// 设备证书
private String DeviceToken;
// 设备类型
private String DeviceType;
// 检查登录状态
private Boolean CheckStatus = false;

• Response

//是否成功
private Boolean IsSuccess;
//信息
private String Message;

分布式

本程序支持分布式，client与server通过redis的发布订阅进行通信，结构如下：

#	#	#
client1	client2	client3
>>>>>>>>>>	>>>>>redis<<<<<	<<<<<<<<<<
socketioServer1	socketioServer2	socketioServer3

Nginx

e.g. 两台服务器，分别为192.168.1.100、192.168.1.101，4个socketioServer，运行在不同的服务器上，端口号分别为3001、3002、3003、3004，对外ip为192.168.1.100、端口为3000

nginx.conf 配置中加入

upstream socket_io_nodes {
   server 192.168.1.100:3001;
   server 192.168.1.100:3002;
   server 192.168.1.101:3003;
   server 192.168.1.101:3004;
}

server {
   listen  3000;
   server_name 192.168.1.100;
   location / {
         proxy_set_header Upgrade $http_upgrade;
         proxy_set_header Connection "upgrade";
         proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
         proxy_set_header Host $host;
         proxy_http_version 1.1;
         proxy_pass http://socket_io_nodes;
   }
}

注意*：使用nginx构建负载均衡，client端io的transports要使用websocket

var socket = io.connect('http://192.168.1.100:3000', {transports: ['websocket']});

如transports使用polling,nginx中的upstream应加入ip_hash

upstream socket_io_nodes {
   ip_hash;
   server 192.168.1.100:3001;
   server 192.168.1.100:3002;
   server 192.168.1.101:3003;
   server 192.168.1.101:3004;
}

Redis

为了提升系统的可用性，Redis结构建议为主从模式+哨兵模式，详见Redis

e.g. Redis1个master（192.168.1.100:6379），2个slave（192.168.1.100:6380、192.168.1.100:6381），1个sentinal（192.168.1.100:26379）

redis-sentinal.conf主要配置（详见Redis）

port 26379
dir "/private/tmp"
protected-mode no

sentinel monitor mymaster 192.168.1.100 6379 1
sentinel down-after-milliseconds mymaster 5000
sentinel parallel-syncs mymaster 1
sentinel failover-timeout mymaster 15000

redis-config.json主要配置（详见redisson）

{
    "sentinelServersConfig": {
        ...
        "sentinelAddresses": [
            "redis://192.168.1.100:26379"
        ],
        "masterName": "mymaster",
         ...
    },
    ...
}

Dependencies

Name	Address
netty-socketio	https://github.com/mrniko/netty-socketio
redisson	https://github.com/redisson/redisson
java-apns	https://github.com/notnoop/java-apns
gson	https://github.com/google/gson
slf4j	https://www.slf4j.org/

---