parser

package
v0.1.0 Latest Latest
Warning

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

Go to latest
Published: Jan 20, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package parser 提供了数据解析功能。 支持从本地文件和远程 API 解析用户数据,并提供多种数据合并策略。

Package parser 提供了数据解析功能。 支持从本地文件和远程 API 解析用户数据,并提供多种数据合并策略。

Package parser 提供了数据解析功能。 支持从本地文件和远程 API 解析用户数据,并提供多种数据合并策略。

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func FromFile

func FromFile(rulesFile string) (rules []define.AllowListUser)

FromFile 从本地文件读取用户规则列表。

该函数从指定的 JSON 文件中读取用户数据,支持以下特性: - 自动处理文件不存在的情况(返回空列表) - 自动处理文件读取错误(记录警告日志) - 自动处理 JSON 解析错误(记录警告日志)

参数:

  • rulesFile: 规则文件的路径,应为有效的 JSON 文件路径

返回:

  • []define.AllowListUser: 解析后的用户列表,如果文件不存在或解析失败则返回空列表

副作用:

  • 会记录警告和错误日志
  • 如果文件存在但读取失败,会记录错误日志
  • 如果 JSON 解析失败,会记录警告日志

func FromRemoteConfig

func FromRemoteConfig(ctx context.Context, url, authorizationHeader string) ([]define.AllowListUser, error)

FromRemoteConfig 从远程配置获取用户列表(支持 context)

该函数从远程 URL 获取 JSON 格式的用户配置数据,支持以下特性: - 上下文控制:支持超时和取消操作 - 自动重试:使用 doRequestWithRetry 实现自动重试机制 - 认证支持:可选的 Authorization 请求头

参数:

  • ctx: 上下文,用于取消请求和超时控制
  • url: 远程配置的 URL 地址
  • authorizationHeader: 可选的 Authorization 请求头值,为空时不添加

返回:

  • []define.AllowListUser: 成功时返回解析后的用户列表
  • error: 失败时返回错误,可能的原因包括:请求初始化失败、网络错误、HTTP 状态码错误、JSON 解析失败

副作用:

  • 会记录错误和警告日志
  • 会设置请求头(Content-Type、Cache-Control、Authorization)

func GetRules

func GetRules(ctx context.Context, rulesFile, configURL, authorizationHeader, appMode string) (result []define.AllowListUser)

GetRules 根据模式获取规则(支持 context)

该函数是规则获取的统一入口,根据不同的模式(appMode)选择不同的数据获取和合并策略。 支持的模式包括:

  • DEFAULT/REMOTE_FIRST: 远程优先,本地补充
  • ONLY_REMOTE: 仅使用远程规则
  • ONLY_LOCAL: 仅使用本地规则
  • LOCAL_FIRST: 本地优先,远程补充
  • REMOTE_FIRST_ALLOW_REMOTE_FAILED: 远程优先,允许远程失败时继续
  • LOCAL_FIRST_ALLOW_REMOTE_FAILED: 本地优先,允许远程失败时继续

参数:

  • ctx: 上下文,用于取消请求和超时控制
  • rulesFile: 本地规则文件路径
  • configUrl: 远程配置 URL
  • authorizationHeader: 远程请求的 Authorization 头
  • appMode: 应用模式,决定数据获取策略

返回:

  • []define.AllowListUser: 合并后的用户列表,按添加顺序排列

副作用:

  • 会记录调试和警告日志
  • 可能进行网络请求(根据模式)
  • 可能读取本地文件(根据模式)

func InitHTTPClient

func InitHTTPClient(timeout, maxIdleConns int, insecureTLS bool)

InitHTTPClient 初始化 HTTP 客户端(使用配置)

Types

This section is empty.

Jump to

Keyboard shortcuts

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