netman 다운로드 - netman 소스코드 다운로드

소개하다

epoll/kqueue 및 리액터 모델을 기반으로 구현된 경량 고성능 TCP 네트워크 프레임워크
간단한 API, 세부사항은 프레임워크 내에서 구현되며, 단 몇 줄의 코드만으로 고성능 서버를 구축할 수 있습니다.
라우팅 구성 지원, 비즈니스 요구 사항 처리에 더 집중, 패킷 압축 해제에 대해 걱정할 필요 없음
보다 유연한 맞춤형 패킷 형식 지원
Linux/macos 지원, Windows는 docker에서 실행하세요.
TLS 지원
웹소켓 지원
미들웨어

장점

비차단 IO
맨 아래 레이어는 이벤트 루프를 기반으로 합니다. net 패키지에서는 연결을 유지하기 위해 goroutine 이 필요하지만 netman 이벤트 루프 기반으로 이를 필요로 하지 않으므로 메모리 사용량이 크게 줄어듭니다. 많은 수의 연결.
라우팅 구성에 따라 비즈니스 계층은 패킷 언패킹 구현에 신경 쓰지 않습니다.
글로벌 미들웨어, 그룹화 미들웨어
테스트 결과, Alibaba Cloud 서버(단일 머신)에서 100만 개의 연결(C1000K)이 유지되었으며, 메모리 사용량은 약 3.8GB 였습니다. 테스트 대상으로 인트라넷 환경을 선택했습니다.

설치하다

go get -u github.com/ikilobyte/netman

포장 기계

기본적으로 프레임워크에 의해 구현되는 패킷 규칙은 헤더 + MsgID + 패키지 본문입니다. 여기서包头：4Byte 는 패키지 본문의 길이를 나타내는 데 사용되며 MsgID：4Byte 는 둘 다 LittleEndian 사용합니다.
자신만의 패킷 규칙을 사용할 수도 있습니다. 서버를 구성할 때 해당 구성을 전달하기만 하면 됩니다.

TCP 서버

 package main

import (
	"fmt"
	"github.com/ikilobyte/netman/iface"
	"github.com/ikilobyte/netman/server"
	"time"
)

type Hello struct {
}

func ( h * Hello ) Do ( request iface. IRequest ) {

	// 消息内容
	body := request . GetMessage (). Bytes ()

	// 当前连接
	connect := request . GetConnect ()

	// 所有连接（包含当前连接）
	connections := request . GetConnects ()

	fmt . Println ( body , connect , connections )

	// 发送消息
	n , err := connect . Send ( 0 , [] byte ( "hello world" ))
	fmt . Printf ( "written %d err %v" , n , err )

	// 关闭连接
	connect . Close ()
}

type Hooks struct {
}

func ( h * Hooks ) OnOpen ( connect iface. IConnect ) {
	fmt . Printf ( "connect onopen %d n " , connect . GetID ())
}

func ( h * Hooks ) OnClose ( connect iface. IConnect ) {
	fmt . Printf ( "connect closed %d n " , connect . GetID ())
}

func main () {
	s := server . New (
		"0.0.0.0" ,
		6650 ,

		// 以下配置都是可选的，更多配置请看下方 `配置` 文档
		// 包体最大长度
		server . WithMaxBodyLength ( 1024 * 1024 * 100 ),

		// Hooks，同样适用于UDP，是的框架将UDP和epoll结合在了一起
		server . WithHooks ( new ( Hooks )),

		// 使用自己的封包规则
		// server.WithPacker(new(xxx))

		// 开启TLS
		//server.WithTLSConfig(&tls.Config{Certificates: nil})

		// 心跳检测（允许连接的空闲时间），需要同时配置才能生效
		server . WithHeartbeatIdleTime ( time . Hour * 5 ),
		server . WithHeartbeatCheckInterval ( time . Second * 5 ),
	)

	// 添加路由
	s . AddRouter ( 0 , new ( Hello )) // 消息ID为0的处理方法
	//s.AddRouter(1,new(xxx))

	s . Start ()
}

TCP 클라이언트

이 프레임워크는 client 의도적으로 캡슐화하지 않습니다. 다양한 언어의 tcp client 연결될 수 있습니다. 아래 go 는 단지 사용 방법을 보여주기 위한 것입니다. 생산환경!

 package main

import (
	"fmt"
	"github.com/ikilobyte/netman/util"
	"io"
	"log"
	"net"
)

func main () {
	conn , err := net . Dial ( "tcp" , "127.0.0.1:6565" )
	if err != nil {
		log . Panicln ( err )
	}

	// 使用默认的消息封包实现，当然你也可以自行实现
	packer := util . NewDataPacker ()
	body , err := packer . Pack ( 0 , [] byte ( "hello world" ))
	if err != nil {
		log . Panicln ( err )
	}

	// 发送消息
	_ , err = conn . Write ( body )
	if err != nil {
		log . Panicln ( err )
	}

	// 读取消息
	head := make ([] byte , 8 )
	_ , err = io . ReadFull ( conn , head )
	if err != nil {
		log . Panicln ( err )
	}

	// 使用packer解析出message
	message , err := packer . UnPack ( head )
	if err != nil {
		log . Panicln ( err )
	}

	// 根据消息长度读取包体
	buff := make ([] byte , message . Len ())
	n , err := conn . Read ( buff )
	if err != nil {
		log . Panicln ( err )
	}
	fmt . Printf ( "recv %s n " , buff [: n ])
	conn . Close ()
}

UDP

사용 방법은 tcp와 동일합니다. udp와 epoll 결합하여 udp의 높은 동시성을 달성하도록 프레임워크 레이어를 적용했습니다.

서버 예
클라이언트 예

웹소켓

섬기는 사람
crossbario/autobahn-testsuite 테스트 케이스가 사용되었으며 직접 테스트할 수 있습니다.

 package main

import (
	"fmt"
	"github.com/ikilobyte/netman/iface"
	"github.com/ikilobyte/netman/server"
)

type Handler struct {}

// Open 连接建立时
func ( h * Handler ) Open ( connect iface. IConnect ) {

	// 获取query参数
	query := connect . GetQueryStringParam ()

	// 客户端连接的url应该设置为：ws://ip:port/path?key=value&token=xxx
	// 支持任意path，如：ws://ip:port/x/y/z/a/b/c?key=value&token=xxx
	if query . Get ( "token" ) != "xxx" {
		connect . Close ()
		return
	}

	fmt . Println ( "onopen" , connect . GetID ())
}

// Message 消息到来时
func ( h * Handler ) Message ( request iface. IRequest ) {

	// 消息
	message := request . GetMessage ()

	// 当前连接
	connect := request . GetConnect ()

	// 判断是什么消息类型
	if message . IsText () {
		// 发送文本消息
		fmt . Println ( connect . Text ( message . Bytes ()))
	} else {
		// 发送二进制消息
		fmt . Println ( connect . Binary ( message . Bytes ()))
	}
}

// Close 连接关闭时
func ( h * Handler ) Close ( connect iface. IConnect ) {
	fmt . Println ( "onclose" , connect . GetID ())
}

func main () {
	s := server . Websocket (
		"0.0.0.0" ,
		6565 ,
		new ( Handler ), // websocket事件回调处理
	)  
	s . Start ()
}

고객
Javascript의 new Websocket 과 같이 각 언어의 Websocket 클라이언트 라이브러리를 사용할 수 있습니다.
client.html

미들웨어

全局中间件및分组中间件로 정의할 수 있습니다. 현재 웹소켓은全局中间件
미들웨어를 구성한 후 수신된 각 메시지는 먼저 미들웨어를 통과한 다음 해당 메시지 콜백 기능에 도달합니다.
미들웨어 실행순서,全局中间件->分组中间件
미들웨어는 실행을 조기에 종료할 수 있습니다.

미들웨어 정의

 // 用作全局中间件
func global () iface. MiddlewareFunc {
	return func ( ctx iface. IContext , next iface. Next ) interface {} {

		fmt . Println ( "前置中间件" )
		fmt . Println ( "ctx data" , ctx . GetConnect (), ctx . GetRequest (), ctx . GetMessage ())

		ctx . Set ( "key" , "value" )
		ctx . Set ( "now" , time . Now (). UnixNano ())

		// 继续往下执行
		resp := next ( ctx )

		fmt . Println ( "后置中间件" )
		return resp
	}
}

// 用作分组中间件
func space () iface. MiddlewareFunc {
	return func ( ctx iface. IContext , next iface. Next ) interface {} {
		fmt . Println ( ctx . Get ( "key" ), ctx . Get ( "now" ))
		return next ( ctx )
	}
}

미들웨어 사용

 // 全局中间件
s . Use ( global ())

// 分组，只有对应的路由才会执行
g := s . Group ( space ())
{
    g . AddRouter ( 1 , new ( xxx ))
    //g.AddRouter(2,new(xxx))
    //g.AddRouter(3,new(xxx))
}

구성

모든 구성은 Tcp（TLS） , UDP 및 Websocket 에 적용됩니다.
자세한 구성은 options.go 참조하세요.

심장 박동 감지

적용하려면 두 가지를 동시에 구성해야 합니다.

 server . New (
	"0.0.0.0" , 6565 ,
    // 表示60秒检测一次
    server . WithHeartbeatCheckInterval ( time . Second * 60 ),

    // 表示一个连接如果180秒内未向服务器发送任何数据，此连接将被强制关闭
    server . WithHeartbeatIdleTime ( time . Second * 180 ),
)

패키지 본체의 최대 길이

 server . New (
    "0.0.0.0" ,
    6565 ,

    // 0表示不限制长度
    // 这里配置的是100MB，当某条消息超过100MB时，会被拒绝处理
    server . WithMaxBodyLength ( 1024 * 1024 * 100 ),
)

TCP 연결 유지

참조: https://zh.wikipedia.org/wiki/Keepalive

 server . New (
    "0.0.0.0" ,
    6565 ,
    
    server . WithTCPKeepAlive ( time . Second * 30 ),
)

TLS

 tlsConfig := & tls. Config {
    Certificates : []tls. Certificate { ... },
}

s := server . New (
    "0.0.0.0" ,
    6565 ,

    // 传入相关配置后，即可开启TLS
    server . WithTLSConfig ( tlsConfig ),
)

맞춤형 패킷 언패킹

보다 유연한 요구 사항을 위해 패킷 압축 풀기 규칙을 사용자 정의하고 IPacker 인터페이스를 사용할 수 있습니다.
구성

 // IPacker 定义（框架内部已经定义，你只需要实现即可）
type IPacker interface {
    Pack ( msgID uint32 , data [] byte ) ([] byte , error ) // 封包
    UnPack ([] byte ) ( IMessage , error ) // 解包
    SetMaxBodyLength ( uint32 ) // 设置包体最大长度限制
    GetHeaderLength () uint32 // 获取头部长度
}

type YouPacker struct {
    // implements IPacker
    // ... 
}

server . New (
    "0.0.0.0" ,
    6565 ,
    
    // 自定义Packer
    server . server . WithPacker ( new ( YouPacker )),
)

조합하여 사용

 server . New (
    "0.0.0.0" ,
    6565 ,
    server . WithNumEventLoop ( runtime . NumCPU () * 3 ),
    server . WithHooks ( new ( Hooks )),            // hooks
    server . WithMaxBodyLength ( 0 ),             // 配置包体最大长度，默认为0（不限制大小）
    server . WithTCPKeepAlive ( time . Second * 30 ), // 设置TCPKeepAlive
    server . WithLogOutput ( os . Stdout ), // 框架运行日志保存的地方
    server . WithPacker ( new ( YouPacker )), // 可自行实现数据封包解包
    
    // 心跳检测机制，二者需要同时配置才会生效
    server . WithHeartbeatCheckInterval ( time . Second * 60 ), // 表示60秒检测一次
    server . WithHeartbeatIdleTime ( time . Second * 180 ), // 表示一个连接如果180秒内未向服务器发送任何数据，此连接将被强制关闭
    
    // 开启TLS
    server . WithTLSConfig ( tlsConfig ),
)