开源项目 him-netty 使用教程

开源项目 him-netty 使用教程

him-netty 开源的H5即时聊天系统 spring-boot + netty + protobuf + vue ~ 项目地址: https://gitcode.com/gh_mirrors/hi/him-netty

1. 项目介绍

him-netty 是一个开源的 H5 即时聊天系统，基于 Spring Boot、Netty、Protobuf 和 Vue 构建。该项目旨在提供一个高性能、可扩展的即时聊天解决方案，适用于移动端和 PC 端。him-netty 支持单聊、群聊、客户端心跳、断开重连、异地登录通知下线等功能，并且具备离线消息处理能力。

2. 项目快速启动

2.1 环境准备

在开始之前，请确保您的开发环境满足以下要求：

• Git
• JDK 8
• Maven 3.6.1
• MySQL

2.2 下载项目

首先，使用 Git 克隆项目到本地：

git clone https://github.com/lmxdawn/him-netty.git
cd him-netty

2.3 数据库配置

创建一个名为 him 的数据库，并将项目根目录下的 scripts 文件夹中的 him.sql 导入到数据库中：

CREATE DATABASE him;
USE him;
SOURCE scripts/him.sql;

2.4 项目打包与运行

使用 Maven 打包项目：

mvn -Dmaven.test.skip=true clean package

打包完成后，运行项目：

java -jar him-api/target/him-api-0.0.1-SNAPSHOT.jar

如果需要指定环境配置，可以使用 --spring.profiles.active=pro 参数，默认环境为 dev。

2.5 前端配置

启动前端项目 him-vue，访问 http://localhost:8080 即可进入聊天系统。

3. 应用案例和最佳实践

3.1 单聊与群聊

him-netty 支持单聊和群聊功能，用户可以通过系统生成的二维码添加好友或加入群组。系统通过 Protobuf 进行消息编解码，确保消息的高效传输。

3.2 客户端心跳与断开重连

为了保持客户端与服务器的连接稳定，him-netty 实现了客户端心跳机制。当客户端断开连接时，系统会自动尝试重连，确保用户不会因为网络波动而失去连接。

3.3 异地登录通知

当用户在其他设备上登录时，系统会通知当前设备的用户，并将其下线，确保账号安全。

4. 典型生态项目

4.1 Spring Boot

him-netty 基于 Spring Boot 框架，利用其强大的依赖注入和自动配置功能，简化了项目的开发和部署。

4.2 Netty

Netty 是一个高性能的网络通信框架，him-netty 使用 Netty 作为底层通信框架，确保了系统的高并发处理能力。

4.3 Protobuf

Protobuf 是一种高效的序列化协议，him-netty 使用 Protobuf 进行消息的编解码，减少了网络传输的数据量，提高了系统的性能。

4.4 Vue

前端使用 Vue 框架，提供了良好的用户交互体验。通过 Vue 的组件化开发，使得前端代码更加模块化和易于维护。

通过以上模块的介绍，您可以快速了解并启动 him-netty 项目，并根据实际需求进行定制和扩展。

him-netty 开源的H5即时聊天系统 spring-boot + netty + protobuf + vue ~ 项目地址: https://gitcode.com/gh_mirrors/hi/him-netty