https://github.com/helloh2o/lucky

Lucky is a simple game/application network framework, supports protobuf, JSON message protocol, data transmission based on HTTP(S), Websocket, Socket (TCP, KCP, QUIC), and supports encryption and decryption of message packets.
https://github.com/helloh2o/lucky

go tcp websocket

Last synced: 3 months ago
JSON representation

Lucky is a simple game/application network framework, supports protobuf, JSON message protocol, data transmission based on HTTP(S), Websocket, Socket (TCP, KCP, QUIC), and supports encryption and decryption of message packets.

• Host: GitHub
• URL: https://github.com/helloh2o/lucky
• Owner: helloh2o
• License: apache-2.0
• Created: 2020-12-29T09:21:39.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2026-03-09T10:31:19.000Z (3 months ago)
• Last Synced: 2026-03-09T12:50:17.159Z (3 months ago)
• Topics: go, tcp, websocket
• Language: Go
• Homepage:
• Size: 604 KB
• Stars: 75
• Watchers: 1
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Use Lucky to create server by simple, fast, security

[**Github**](https://github.com/helloh2o/lucky) <<=>> [**Gitee**](https://gitee.com/helloh2o/lucky)

[![Go Report Card](https://goreportcard.com/badge/github.com/helloh2o/lucky)](https://goreportcard.com/report/github.com/helloh2o/lucky)

#### [English README](https://github.com/helloh2o/lucky/blob/master/README_en.md)

#### 介绍

一个简洁安全游戏/应用网络框架，支持protobuf，JSON 消息协议，基于HTTP/HTTPS,websocket或者socket(TCP,KCP,QUIC)进行数据传输, 支持对消息包加密解密。

数据包加密方式： AES128,AES192,AES256 以及Byte轻量级混淆加密。以帮助开发者朋友能高效率写出安全可靠的业务逻辑。

数据包读、写、执行逻辑处理分别在各自goroutine中, 可以对单个连接恶意发包进行限制超过ConnUndoQueueSize会被忽略，不停留在缓冲区。

使用者只需注册消息和消息对应的回调函数，在回调中处理具体逻辑。例如：

```go

    //在处理器上注册（消息码，消息体，消息执行的逻辑代码）

	Processor.RegisterHandler(code.Hello, &protobuf.Hello{}, logic.Hello)

```

#### 安装教程

go get github.com/helloh2o/lucky

#### 使用说明

Go version >= 1.20

1. 设置配置参数或保持默认

```go

lucky.SetConf(&lucky.Data{

		ConnUndoQueueSize:   100,

		ConnWriteQueueSize:  100,

		FirstPackageTimeout: 5,

		ConnReadTimeout:     30,

		ConnWriteTimeout:    5,

		MaxDataPackageSize:  2048,

		MaxHeaderLen:        1024,

	})

```

2. 请参考example下的http, tcp, websocket, kcp, 以及kcp帧同步例子

3. 帧同步部分还需要进一步完善，只是一个基础的实现

4. 聊天室例子, 源码example/chatroom

![Image text](https://raw.githubusercontent.com/helloh2o/lucky/master/examples/chatroom/demo.png)

#### 欢迎参与 :)

1. 欢迎提交PR 和 Issue

2. 开源不易，觉得不错就给个小星星✮吧

3. 该框架正在多个 DAU>10w 商业项目中使用

4. 新增utils.LazyQueue可对高频操作进行管理，如数据库写。

5. 新增utils.RkPool可对任意数据进行排序，如排行榜。

6. 新增Redis分布式锁utils.RDLockOp, 可在多进程间多协程的情景下安全操作数据

#### Etcd分布式互斥锁

```go

// 初始化ETCD锁

onProcExitRelease := etcdlock.InitDefault("localhost:2379")

// 程序异常退出时该函数释放当前进程持有的锁

_ = onProcExitRelease 

// 获得同步锁

op := "lock_user_data"

release, _ := etcdlock.D().Lock(testOpKey)

// 主动释放锁

defer release()

// 同步逻辑代码

// 安全操作

```   

#### Redis分布式同步锁

```go

// 初始化Redis

if _, err := cache.OpenRedis("redis://localhost:6379/?pwd=&db=0"); err != nil {

	panic(err)

}

// 同步操作

op := "lock_user_111_data"

// 获得同步锁

release := RDLockOpWait(op)

// 解锁!!!

defer release()

// 同步逻辑代码

// 安全操作

```

#### 快速开始

> Run as tcp server

```go

package main

import (

	"github.com/helloh2o/lucky"

	"github.com/helloh2o/lucky/examples/comm/msg/code"

	"github.com/helloh2o/lucky/examples/comm/protobuf"

	"github.com/helloh2o/lucky/log"

)

// processor is protobuf processor

var processor = lucky.NewPBProcessor()

func init() {

	//passwd := little.RandLittlePassword()

	passwd := "EyEmxIhoYUFuEc8gDTBlbN/pVOs9Nu/hLCTSjW19Oii0mKNQ9xKPoGJqu1q5Mox4zDT/+MgicJ/j5Nt2sQwK2E8rY3ORVgMUU2v2hmQBb5cP00dettGeF6wvQ36vH2CpGLX9x6RIliP8WAtZqJ0xaT7ixnxxCIr5xRZbutXl8pXqRvSa1+Z/HcuTuFHze4T1ok5A1O4Gge1n6I4ZQjgeHHSSwYs7dQI8oYWQ0MMt3rOywvsVKgUESl2cquDapXrW3PH68MoOPyk1RCe3hxvJNxB3LnLNplVLzkmbTHnZv8AJRedfUoKAJTPsAN0HVzn+XBqUvE2Dvb6nia6tZpmrsA=="

	log.Release("TCP Server password %v", passwd)

	pwd, err := lucky.ParseLittlePassword(passwd)

	if err != nil {

		panic(err)

	}

	cipher := lucky.NewLittleCipher(pwd)

	// add encrypt cipher for processor

	processor.SetEncryptor(cipher)

	// register message && callback

	processor.RegisterHandler(code.Hello, &protobuf.Hello{}, func(args ...interface{}) {

		msg := args[lucky.Msg].(*protobuf.Hello)

		log.Release("Message => from client:: %s", msg.Hello)

		conn := args[lucky.Conn].(lucky.IConnection)

		conn.WriteMsg(msg)

	})

}

func main() {

	// run server

	if s, err := lucky.NewTcpServer("localhost:2021", processor); err != nil {

		panic(err)

	} else {

		log.Fatal("%v", s.Run())

	}

}

```

> go tcp client

```go

package main

import (

	"github.com/helloh2o/lucky"

	"github.com/helloh2o/lucky/examples/comm/msg/code"

	"github.com/helloh2o/lucky/examples/comm/protobuf"

	"github.com/helloh2o/lucky/log"

	"net"

)

// processor is protobuf processor

var processor = lucky.NewPBProcessor()

func init() {

	//passwd := lucky.RandLittlePassword()

	passwd := "EyEmxIhoYUFuEc8gDTBlbN/pVOs9Nu/hLCTSjW19Oii0mKNQ9xKPoGJqu1q5Mox4zDT/+MgicJ/j5Nt2sQwK2E8rY3ORVgMUU2v2hmQBb5cP00dettGeF6wvQ36vH2CpGLX9x6RIliP8WAtZqJ0xaT7ixnxxCIr5xRZbutXl8pXqRvSa1+Z/HcuTuFHze4T1ok5A1O4Gge1n6I4ZQjgeHHSSwYs7dQI8oYWQ0MMt3rOywvsVKgUESl2cquDapXrW3PH68MoOPyk1RCe3hxvJNxB3LnLNplVLzkmbTHnZv8AJRedfUoKAJTPsAN0HVzn+XBqUvE2Dvb6nia6tZpmrsA=="

	log.Release("TCP client password %v", passwd)

	pwd, err := lucky.ParseLittlePassword(passwd)

	if err != nil {

		panic(err)

	}

	cipher := lucky.NewLittleCipher(pwd)

	// add encrypt cipher for processor

	processor.SetEncryptor(cipher)

	// register message && callback

	processor.RegisterHandler(code.Hello, &protobuf.Hello{}, func(args ...interface{}) {

		msg := args[lucky.Msg].(*protobuf.Hello)

		log.Release("Message => from server:: %s", msg.Hello)

		conn := args[lucky.Conn].(lucky.IConnection)

		_ = conn.Close()

	})

}

func main() {

	conn, err := net.Dial("tcp", "localhost:2021")

	if err != nil {

		panic(err)

	}

	ic := lucky.NewTcpConn(conn, processor)

	ic.WriteMsg(&protobuf.Hello{Hello: "hello lucky."})

	ic.ReadMsg()

}

```