front

README

front

这是一个简单的http/https/ws/wss均衡负载、故障转移路由/代理，通过定时刷新配置不中断地：

• 动态后端
• 路径继承
• 自定权重
• 故障转移
• 自定义头

支持嵌入到其他项目中/独立运行

配置为json数组格式[]，下面为数组中的其中一个{}，注意此级不会动态增加/移除

• addr: string 监听端口 例：0.0.0.0:8081
• matchRule: string 匹配规则 prefix：当未匹配到时，返回最近的/匹配， all：当未匹配到时，返回404
• copyBlocks: int 转发的块数量，默认1000
• tls: {} 启用tls
  • pub: string 公钥pem路径
  • key: string 私钥pem路径
• routes: [] 路由, 可以动态增加/删除
  • path: string 路径
  • splicing: int 当客户端支持cookie时，将会固定使用后端多少秒
  • pathAdd: bool 将客户端访问的路径附加在path上 例：/api/req => /ws => /ws/api/req
  • matchHeader: [] 将会在back前匹配，匹配客户端请求头，只有都匹配才使用此路由, 可以动态增加/删除
    • key: string 要匹配的header名
    • matchExp: string 要匹配的正则式
    • value: string 要匹配的值
  • reqHeader: [] 将会附加到每个backs前，请求后端时，请求头处理器, 可以动态增加/删除
    • action: string 可选check、replace、add、del、set。
    • key: string 具体处理哪个头
    • matchExp: string check时，如不匹配将结束请求。replace时结合value进行替换
    • value: string check时，如不匹配将结束请求。replace时结合matchExp进行替换。add时将附加值。set时将覆盖值。
  • resHeader: [] 将会附加到每个backs前，返回后端的响应时，请求头处理器, 可以动态增加/删除
    • action: string 可选check、add、del、set。
    • key: string 具体处理哪个头
    • matchExp: string check时，如不匹配将结束请求。replace时结合value进行替换
    • value: string check时，如不匹配将结束请求。replace时结合matchExp进行替换。add时将附加值。set时将覆盖值。
  • backs: [] 后端, 可以动态增加/删除
    • name: string 后端名称，将在日志中显示
    • to: string 后端地址，例"s://www.baidu.com"，会根据客户端自动添加http or ws在地址前
    • weight: int 权重，按routes中的全部back的权重比分配，当权重变为0时，将停止新请求的进入
    • errBanSec: int 当后端错误时（指连接失败，不指后端错误响应），将会禁用若干秒
    • matchHeader: [] 匹配客户端请求头，只有都匹配才使用此后端, 可以动态增加/删除
      • key: string 要匹配的header名
      • matchExp: string 要匹配的正则式
      • value: string 要匹配的值
    • reqHeader: [] 将会附加到每个backs前，请求后端时，请求头处理器, 可以动态增加/删除
      • action: string 可选check、replace、add、del、set。
      • key: string 具体处理哪个头
      • matchExp: string check时，如不匹配将结束请求。replace时结合value进行替换
      • value: string check时，如不匹配将结束请求。replace时结合matchExp进行替换。add时将附加值。set时将覆盖值。
    • resHeader: [] 将会附加到每个backs前，返回后端的响应时，请求头处理器, 可以动态增加/删除
      • action: string 可选check、add、del、set。
      • key: string 具体处理哪个头
      • matchExp: string check时，如不匹配将结束请求。replace时结合value进行替换
      • value: string check时，如不匹配将结束请求。replace时结合matchExp进行替换。add时将附加值。set时将覆盖值。

Documentation

Index

• Variables
• func DialContext(ctx context.Context, urlStr string, requestHeader http.Header) (net.Conn, *http.Response, error)
• func LoadPeriod(ctx context.Context, buf []byte, configF File, configS *[]Config, ...) error
• func Matched(matchHeader []Header, r *http.Request) bool
• func MatchedOne(matchHeader Header, value string) bool
• func Test(ctx context.Context, port int, logger Logger)
• func Upgrade(w http.ResponseWriter, r *http.Request, responseHeader http.Header) (net.Conn, error)
• type Back
  • func (t *Back) Disable()
  • func (t *Back) Id() string
  • func (t *Back) IsLive() bool
• type Config
  • func (t *Config) Run(ctx context.Context, logger Logger)
  • func (t *Config) SwapSign(add func(*Route), del func(*Route), logger Logger)
• type File
• type HandshakeError
  • func (t HandshakeError) Error() string
• type Header
• type Logger
• type Route
  • func (t *Route) FiliterBackByRequest(r *http.Request) []*Back
  • func (t *Route) SwapSign(add func(*Back), del func(*Back), logger Logger)

Variables

var (
	ErrRedirect        = errors.New("ErrRedirect")
	ErrNoHttp          = errors.New("ErrNoHttp")
	ErrNoWs            = errors.New("ErrNoWs")
	ErrCopy            = errors.New("ErrCopy")
	ErrReqCreFail      = errors.New("ErrReqCreFail")
	ErrReqDoFail       = errors.New("ErrReqDoFail")
	ErrResDoFail       = errors.New("ErrResDoFail")
	ErrHeaderCheckFail = errors.New("ErrHeaderCheckFail")
)

Functions

func DialContext

func DialContext(ctx context.Context, urlStr string, requestHeader http.Header) (net.Conn, *http.Response, error)

func LoadPeriod

func LoadPeriod(ctx context.Context, buf []byte, configF File, configS *[]Config, logger Logger) error

加载

func Matched

func Matched(matchHeader []Header, r *http.Request) bool

func MatchedOne

func MatchedOne(matchHeader Header, value string) bool

func Test

func Test(ctx context.Context, port int, logger Logger)

测试

func Upgrade

func Upgrade(w http.ResponseWriter, r *http.Request, responseHeader http.Header) (net.Conn, error)

Types

type Back

type Back struct {
	Name      string `json:"name"`
	To        string `json:"to"`
	Weight    int    `json:"weight"`
	ErrBanSec int    `json:"errBanSec"`

	Splicing    int      `json:"-"`
	PathAdd     bool     `json:"-"`
	MatchHeader []Header `json:"matchHeader"`
	ReqHeader   []Header `json:"reqHeader"`
	ResHeader   []Header `json:"resHeader"`
	// contains filtered or unexported fields
}

func (*Back) Disable

func (t *Back) Disable()

func (*Back) Id

func (t *Back) Id() string

func (*Back) IsLive

func (t *Back) IsLive() bool

type Config

type Config struct {
	Addr string `json:"addr"`
	TLS  struct {
		Pub string `json:"pub"`
		Key string `json:"key"`
	} `json:"tls"`
	MatchRule  string               `json:"matchRule"`
	CopyBlocks int                  `json:"copyBlocks"`
	BlocksI    pslice.BlocksI[byte] `json:"-"`

	Routes []Route `json:"routes"`
	// contains filtered or unexported fields
}

func (*Config) Run

func (t *Config) Run(ctx context.Context, logger Logger)

func (*Config) SwapSign

func (t *Config) SwapSign(add func(*Route), del func(*Route), logger Logger)

type File

type File interface {
	Read(data []byte) (int, error)
}

type HandshakeError

type HandshakeError struct {
	// contains filtered or unexported fields
}

func (HandshakeError) Error

func (t HandshakeError) Error() string

type Header

type Header struct {
	Action   string `json:"action"`
	Key      string `json:"key"`
	MatchExp string `json:"matchExp"`
	Value    string `json:"value"`
}

type Logger

type Logger interface {
	Error(msg string, args ...any)
	Debug(msg string, args ...any)
	Info(msg string, args ...any)
	Warn(msg string, args ...any)
}

type Route

type Route struct {
	Path string `json:"path"`

	Splicing    int      `json:"splicing"`
	PathAdd     bool     `json:"pathAdd"`
	MatchHeader []Header `json:"matchHeader"`
	ReqHeader   []Header `json:"reqHeader"`
	ResHeader   []Header `json:"resHeader"`

	Backs []Back `json:"backs"`
	// contains filtered or unexported fields
}

func (*Route) FiliterBackByRequest

func (t *Route) FiliterBackByRequest(r *http.Request) []*Back

func (*Route) SwapSign

func (t *Route) SwapSign(add func(*Back), del func(*Back), logger Logger)