README_CH.md

IM

IM 是一个轻量级的即时通信服务端。提供客户端jar包，方便集成二次开发。

功能

• 单聊：文字/文件
• 已发送/已送达/已读回执
• 支持集成ldap
• 支持集成第三方登录系统
• 方便水平扩展
• 提供客户端jar包

快速上手

准备工作

使用docker快速启动 IM 服务。

# detect if the docker environment is avaliable.
docker -v

# clone the repository
git clone git@github.com:yuanrw/IM.git

启动服务

cd IM/docker
docker-compose up

容器内有demo程序，自动启动多个客户端并且随机发送消息，启动成功后输出如下日志:

......
2019-08-11 17:29:13.451 client-samples - [Olive] get a msg: 357980857883037697 has been read
2019-08-11 17:29:13.452 client-samples - [yuanrw] get a msg: 357980857887232002 has been read
2019-08-11 17:29:13.452 client-samples - [xianyy] get a msg: 357980857887232001 has been read
2019-08-11 17:29:13.452 client-samples - [Adela] get a msg: 357980857874649089 has been read
2019-08-11 17:29:13.452 client-samples - [Bella] get a msg: 357980857874649090 has been read
2019-08-11 17:29:13.452 client-samples - [Tom] get a msg: 357980857887232000 has been read



sentMsg: 51, readMsg: 51, hasSentAck: 51, hasDeliveredAck: 51, hasReadAck: 51, hasException: 0



2019-08-11 17:29:15.114 client-samples - [Bella]get a msg: 357980866275840002 has been sent
2019-08-11 17:29:15.114 client-samples - [Adela]get a msg: 357980866275840000 has been sent
2019-08-11 17:29:15.114 client-samples - [Cynthia]get a msg: 357980866275840003 has been sent
......

分布式部署

mvn clean package -DskipTests

在/target目录下生成 $SERVICE_NAME-$VERSION-bin.zip

环境

• java 8+
• mysql 5.7+
• rabbitmq
• redis

启动

按照如下顺序启动服务: rest-web --> transfer -->connector

启动rest-web的步骤如下,transfer和connector类似.

rest-web

1. 解压

unzip rest-web-$VERSION-bin.zip
cd rest-web-$VERSION

2. 修改配置文件

server.port=8082

# 日志目录
log.path=

# jdbc配置
spring.datasource.url=
......

# redis配置
spring.redis.host=
......

# rabbitmq配置
spring.rabbitmq.host=
......

3. 执行rest.sql初始化库表

4. 启动服务

java -jar rest-web-$VERSION.jar --spring.config.location=application.properties

transfer

java -jar -Dconfig=transfer.properties transfer-$VERSION.jar

connector

java -jar -Dconfig=connector.properties connector-$VERSION.jar

Nginx配置

所有的服务都能够水平扩展，客户端和connector服务端需要保持长连接。 nginx可以如下配置:

stream {
	upstream backend {
        # connector services port
        server 127.0.0.1:9081         max_fails=3 fail_timeout=30s;
        server 127.0.0.1:19081			max_fails=3 fail_timeout=30s;
	}

    server {
        # to keep a persistent connection
        listen 9999 so_keepalive=on;
        proxy_timeout 1d;
        proxy_pass backend;
    }
}

Login

IM含有一个非常简单的登录系统，可以直接使用。
也支持以下两种登录方式。

ldap

这里使用open ldap来登录。
修改配置文件application.properties

spi.user.impl.class=com.yrw.im.rest.web.spi.impl.LdapUserSpiImpl

# the following config should be replace with your own config
spring.ldap.base=dc=example,dc=org
# admin
spring.ldap.username=cn=admin,dc=example,dc=org
spring.ldap.password=admin
spring.ldap.urls=ldap://127.0.0.1:389
# user filter，use the filter to search user when login in
spring.ldap.searchFilter=
# search base eg. ou=dev
ldap.searchBase=
# user objectClass
ldap.mapping.objectClass=inetOrgPerson
ldap.mapping.loginId=uid
ldap.mapping.userDisplayName=gecos
ldap.mapping.email=mail

java -jar rest-web-$VERSION.jar --spring.config.location=application.properties

自己的登录系统

1. 需要实现com.yrw.im.rest.spi.UserSpi中的接口

public interface UserSpi<T extends UserBase> {

    /**
     * get user by username and password, return user(id can not be null)
     * if username and password are right, else return null.
     * <p>
     * be sure that your password has been properly encrypted
     *
     * @param username
     * @param pwd
     * @return
     */
    T getUser(String username, String pwd);

    /**
     * get user by id, if id not exist then return null.
     *
     * @param id
     * @return
     */
    T getById(String id);
}

2. 修改配置文件application.properties

# 你的实现类的全限定类名
spi.user.impl.class=

3. 打包

mvn clean package -DskipTests

使用客户端jar包

一个使用样例:

MyClient.java