constant

package
v1.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 28, 2026 License: MIT Imports: 0 Imported by: 0

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

View Source
const (
	ClientTypeUnspecified = iota
	// ClientTypeWebBrowser 网页端浏览器
	ClientTypeWebBrowser
	// ClientTypeMiniProgram 小程序
	ClientTypeMiniProgram
	// ClientTypeMobileApp 移动端应用
	ClientTypeMobileApp
	// ClientTypeDesktopApp 桌面端应用
	ClientTypeDesktopApp
	// ClientTypeServer 服务端
	ClientTypeServer
	// ClientTypeEmbedded 嵌入式
	ClientTypeEmbedded
)
View Source
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"
)
View Source
const (
	// XRealIp 真实ip,一般由nginx设置的
	XRealIp = "x-real-ip"
	// Authorization 用户token
	Authorization = "authorization"

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

	// AccessMethod 访问方式(http2grpc[http-gateway->grpc-gateway], grpc2grpc[grpc-gateway->grpc-service])
	AccessMethod          = HeaderPrefix + "access-method"
	AccessMethodHTTP2GRPC = "http2grpc"
	AccessMethodGRPC2GRPC = "grpc2grpc"

	// RouteMethod 路由方式(user[user-permission], service[service-permission])
	RouteMethod        = HeaderPrefix + "route-method"
	RouteMethodUser    = "user"
	RouteMethodService = "service"

	// TraceId 链路跟踪
	TraceId  = HeaderPrefix + "trace-id"
	SpanId   = HeaderPrefix + "span-id"
	ParentId = HeaderPrefix + "parent-id"

	// AppLanguage 应用语言
	AppLanguage = HeaderPrefix + "app-language"
	// AppVersion 应用版本
	AppVersion = HeaderPrefix + "app-version"

	// Session 用户session
	Session = HeaderPrefix + "session"
	// UserId 用户id
	UserId = HeaderPrefix + "user-id"
	// AppId 用户当前的应用Id
	AppId = HeaderPrefix + "app-id"
	// TenantId 用户当前应用的归属租户id
	TenantId = HeaderPrefix + "tenant-id"
	// OrgIds 用户当前应用下的组织Ids
	OrgIds = HeaderPrefix + "org-ids"
	// RoleIds 用户当前应用下的角色Ids
	RoleIds = HeaderPrefix + "role-ids"

	// SystemType 客户端系统类型
	SystemType = HeaderPrefix + "system-type"
	// SystemName 客户端系统名称
	SystemName = HeaderPrefix + "system-name"
	// SystemVersion 客户端系统版本
	SystemVersion = HeaderPrefix + "system-version"
	// ClientType 客户端类型
	ClientType = HeaderPrefix + "client-type"
	// ClientName 客户端名称
	ClientName = HeaderPrefix + "client-name"
	// ClientVersion 客户端版本
	ClientVersion = HeaderPrefix + "client-version"

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

	// InvokeServiceAuth 服务调用相关(Invoke-服务调用方信息,Target-被调用方服务信息)
	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"

	ClientIp = HeaderPrefix + "client-ip"
	SourceIp = HeaderPrefix + "source-ip"
)
View Source
const (
	RequestMethodGet = iota + 1
	RequestMethodPost
	RequestMethodPut
	RequestMethodDelete
	RequestMethodGrpc
)
View Source
const (
	RequestMethodGetString    = "GET"
	RequestMethodPostString   = "POST"
	RequestMethodPutString    = "PUT"
	RequestMethodDeleteString = "DELETE"
	RequestMethodGrpcString   = "GRPC"
)
View Source
const (
	SystemTypeUnspecified = iota
	SystemTypeWindows
	SystemTypeMacOS
	SystemTypeLinux
	SystemTypeAndroid
	SystemTypeIOS
	SystemTypeHarmony
	SystemTypeChromeOS
	SystemTypeFreeBSD
)
View Source
const (
	InvokeServiceAuthToken = "invoke-service-auth"
)
View Source
const (
	// KernelLanguage 内核开发语言
	KernelLanguage = "Golang"
)

Variables

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL