# NettyChat

**Repository Path**: chinasoft_ohos/NettyChat

## Basic Information

- **Project Name**: NettyChat
- **Description**: 一个好用的即时通讯库
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 2
- **Created**: 2021-05-26
- **Last Updated**: 2022-09-06

## Categories & Tags

**Categories**: harmonyos-network

**Tags**: None

## README

# NettyChat

#### 项目介绍

- 项目名称：NettyChat
- 所属系列：openHarmony的第三方组件适配移植
- 功能：实现了即时聊天功能
- 项目移植状态：100%，移植完成即时聊天功能。
- 调用差异：无
- 开发版本：sdk6，DevEco Studio 2.2 Beta1
- 基线版本：master分支

#### 效果演示

![输入图片说明](https://gitee.com/chinasoft_ohos/NettyChat/raw/master/img/main.gif "main.gif")

#### 安装教程

1.在项目根目录下的build.gradle文件中，
 ```
allprojects {
    repositories {
        maven {
            url 'https://s01.oss.sonatype.org/content/repositories/releases/'
        }
    }
}
 ```

2.在entry模块的build.gradle文件中，
 ```
 dependencies {
    implementation ('com.gitee.chinasoft_ohos:NettyChat:1.0.0@jar')
    implementation ('com.google.protobuf:protobuf-java:3.5.0')
    ......  
 }
 ```

3.将下载的netty-tcp-4.1.33-1.0.jar文件（位于： ```https://gitee.com/chinasoft_ohos/NettyChat/releases ``` ）导入到工程目录"entry->libs"下面

在sdk6，DevEco Studio 2.2 Beta1下项目可直接运行
如无法运行，删除项目.gradle,.idea,build,gradle,build.gradle文件，
并依据自己的版本创建新项目，将新项目的对应文件复制到根目录下

#### 使用说明

1.自定义IMSEventListener，实现OnEventListener，重写对应的方法配置参数

2.自定义IMSConnectStatusListener，实现IMSConnectStatusCallback，重现对应的方法监听ims连接状态

3.调用IMSClientInterface.init(Vector<String> serverUrlList, OnEventListener listener, IMSConnectStatusCallback callback)方法，把服务器地址列表、IMSEventListener、IMSConnectStatusListener三个参数传入即可

4.发送消息：调用IMSClientInterface.sendMsg(MessageProtobuf.Msg msg)即可发送

5.接收消息：收到消息会回调IMSEventListener.dispatchMsg(MessageProtobuf.Msg msg)方法。

#### 测试信息

CodeCheck代码测试无异常

CloudTest代码测试无异常

病毒安全检测通过

当前版本demo功能与原组件基本无差异

#### 版本迭代

- 1.0.0

#### 版权和许可信息
 ```
    Copyright 2019, chenshichao       
    
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at 
    
       http://www.apache.org/licenses/LICENSE-2.0 
    
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
 ```