constant

README

Constant

constant 包定义了微服务通信中通用的 HTTP Header / gRPC Metadata Key。

常用常量

这些常量主要用于 gRPC Metadata 或 HTTP Header 中传递上下文信息。

身份与追踪

• TraceId：全链路追踪 ID（ff-trace-id）
• Session：会话标识（ff-session）
• Authorization：认证令牌（authorization）
• UserId：用户 ID（ff-user-id）
• AppId：应用 ID（ff-app-id）
• TenantId：租户 ID（ff-tenant-id）
• ClientIp：客户端 IP（ff-client-ip）
• XRealIp：反向代理透传真实 IP（x-real-ip）

客户端信息

• SystemName / SystemVersion：系统名称与版本
• ClientName / ClientVersion：客户端名称与版本
• SystemType / ClientType：系统/客户端类型
• DeviceFormFactor：设备形态
• AppVersion / AppLanguage：应用版本 / 语言

使用示例

import "github.com/fireflycore/go-micro/constant"

// 从 gRPC metadata 获取 TraceId
md, _ := metadata.FromIncomingContext(ctx)
traceId := md.Get(constant.TraceId)

Documentation

Overview

Package constant 定义微服务通用 header/metadata key。

Index

• Constants

Constants

const (
	// DefaultNamespace 默认命名空间
	DefaultNamespace = "firefly"
	// DefaultNetworkSN 默认网卡命名
	DefaultNetworkSN = "firefly-main-network"
	// DefaultExternalNetworkAddress 默认外网地址
	DefaultExternalNetworkAddress = "127.0.0.1"
	// DefaultMaxRetry 默认重试次数
	DefaultMaxRetry = 3
	// DefaultTTL 默认心跳间隔
	DefaultTTL = 10
	// DefaultVersion 默认版本号
	DefaultVersion = "v0.0.1"
)

const (
	XRealIp           = "x-real-ip"
	Authorization     = "authorization"
	AuthorizationType = "authorization-type"

	// HeaderPrefix Firefly系统自定义头部（统一前缀）
	HeaderPrefix = "x-firefly-"

	AppLanguage = HeaderPrefix + "app-language"
	AppVersion  = HeaderPrefix + "app-version"

	TraceId  = HeaderPrefix + "trace-id"
	Session  = HeaderPrefix + "session"
	UserId   = HeaderPrefix + "user-id"
	AppId    = HeaderPrefix + "app-id"
	TenantId = HeaderPrefix + "tenant-id"
	ClientIp = HeaderPrefix + "client-ip"
	RoleIds  = HeaderPrefix + "role-ids"
	OrgIds   = HeaderPrefix + "org-ids"

	SystemName       = HeaderPrefix + "system-name"
	ClientName       = HeaderPrefix + "client-name"
	SystemType       = HeaderPrefix + "system-type"
	ClientType       = HeaderPrefix + "client-type"
	DeviceFormFactor = HeaderPrefix + "device-form-factor"
	SystemVersion    = HeaderPrefix + "system-version"
	ClientVersion    = HeaderPrefix + "client-version"

	// GatewayAuth 网关认证
	GatewayAuth = HeaderPrefix + "gateway-auth"

	InvokeServiceAuth     = HeaderPrefix + "invoke-service-auth"
	InvokeServiceAppId    = HeaderPrefix + "invoke-service-app-id"
	InvokeServiceEndpoint = HeaderPrefix + "invoke-service-endpoint"
	TargetServiceAppId    = HeaderPrefix + "target-service-app-id"
	TargetServiceEndpoint = HeaderPrefix + "target-service-endpoint"
)

const (
	InvokeServiceAuthToken = "invoke-service-auth"
)

const (
	// KernelLanguage 内核开发语言
	KernelLanguage = "Golang"
)