# yorick_socket

**Repository Path**: akiraaaaff/yorick_socket

## Basic Information

- **Project Name**: yorick_socket
- **Description**: 基于Netty的轻量级Socket和WebSocket框架
- **Primary Language**: Java
- **License**: 0BSD
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 5
- **Created**: 2025-08-23
- **Last Updated**: 2025-08-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# yorick_socket

#### 介绍
一套基于Netty的轻量级Socket和WebSocket框架，可用于搭建聊天服务器和游戏同步服务器

#### 软件架构
一套轻量级的Socket，WebSocket框架，基于Netty，没有集成任何JavaEE的第三方框架，便于二次开发和集成到其他项目或者作为微服务单独运行，
使用谷歌的ProtoBuf作为传输消息体，RPC框架使用的是谷歌开源的GRPC，通过反射实现消息ID和逻辑实现类注册机制


#### 安装教程

1.  修改位于resources/netty.properties 里面的端口和启动信息
2.  启动位于com/yorick/netty下的NettyLauncher里的Main方法

#### 使用说明

1. 新的消息ID需要注册，在NettyLauncher里面有个processRegisterMessage方法，需要自己注册 register.registerMessage(消息ID,实现类名字);
2. 实现类必须放在com.yorick.logic.service下面，因为Java注册消息的时候会反射这个Package下面的实体类
3. NettyLauncher里面的Main方法实例化了一个Timer类，所以如果需要定时服务，能够直接使用该Timer创建定时服务（比如心跳机制）
4. 自定义的消息传输协议，前两个byte作为消息长度，接着4个Byte作为消息ID，最后是消息体(msg_length|msg_id|msg_body)

#### 参与贡献

1.  Yorick