Yamux 使用教程

Yamux 使用教程

yamuxGolang connection multiplexing library项目地址:https://gitcode.com/gh_mirrors/ya/yamux

1、项目介绍

Yamux（Yet another Multiplexer）是一个用于 Golang 的连接多路复用库。它基于一个底层连接（如 TCP 或 Unix 域套接字）来提供可靠性和顺序性，并提供面向流的多路复用。Yamux 的设计灵感来自 SPDY，但与 SPDY 不兼容。

Yamux 的主要特性包括：

• 双向流：流可以由客户端或服务器打开，适用于 NAT 穿透。
• 服务器端推送支持。
• 流量控制：避免饥饿。
• 反压：防止接收方过载。
• 保持活动：通过负载均衡器启用持久连接。
• 高效：以低开销启用数千个逻辑流。

2、项目快速启动

安装

首先，确保你已经安装了 Go 环境。然后，使用以下命令安装 Yamux：

go get github.com/hashicorp/yamux

示例代码

以下是一个简单的客户端和服务器示例代码：

客户端代码

package main

import (
	"fmt"
	"net"

	"github.com/hashicorp/yamux"
)

func main() {
	// 获取一个 TCP 连接
	conn, err := net.Dial("tcp", "localhost:8888")
	if err != nil {
		panic(err)
	}

	// 设置客户端的 Yamux 会话
	session, err := yamux.Client(conn, nil)
	if err != nil {
		panic(err)
	}

	// 打开一个新的流
	stream, err := session.Open()
	if err != nil {
		panic(err)
	}

	// 发送数据
	_, err = stream.Write([]byte("ping"))
	if err != nil {
		panic(err)
	}

	fmt.Println("数据已发送")
}

服务器代码

package main

import (
	"fmt"
	"net"

	"github.com/hashicorp/yamux"
)

func main() {
	// 监听 TCP 连接
	listener, err := net.Listen("tcp", "localhost:8888")
	if err != nil {
		panic(err)
	}

	for {
		conn, err := listener.Accept()
		if err != nil {
			panic(err)
		}

		// 设置服务器的 Yamux 会话
		session, err := yamux.Server(conn, nil)
		if err != nil {
			panic(err)
		}

		go handleSession(session)
	}
}

func handleSession(session *yamux.Session) {
	for {
		stream, err := session.Accept()
		if err != nil {
			panic(err)
		}

		go handleStream(stream)
	}
}

func handleStream(stream net.Conn) {
	buf := make([]byte, 4)
	_, err := stream.Read(buf)
	if err != nil {
		panic(err)
	}

	fmt.Println("收到数据:", string(buf))
}

3、应用案例和最佳实践

内网穿透

Yamux 可以用于实现内网穿透，允许外部网络访问内网服务。以下是一个简单的内网穿透实现示例：

服务器（内网）

package main

import (
	"fmt"
	"log"
	"net/http"
)

func main() {
	http.HandleFunc("/hello", HelloHandler)
	fmt.Println("服务器已启动，端口: 8881")
	log.Fatal(http.ListenAndServe(":8881", nil))
}

func HelloHandler(w http.ResponseWriter, r *http.Request) {
	fmt.Fprintf(w, "Hello there\n")
}

Hub（公网）

package main

import (
	"fmt"
	"log"
	"net"
	"sync"

	"github.com/hashicorp/yamux"
)

type SessionManager struct {
	sessions map[string]*yamux.Session
	mu

yamuxGolang connection multiplexing library项目地址:https://gitcode.com/gh_mirrors/ya/yamux