gtbox

README

• 1. 使用说明
  • 1.1. 关于测试
• 2. 使用
  • 2.1. 静态库版本
  • 2.2. 动态库版本---停止维护
• 3. 更新记录
• 4. 必要支持
• 5. 功能

1. 使用说明

• 只保留2个可运行版本，方便维护
• 尝试改动态库为静态库
• 必须安装了git
• 项目必须用go mod自动管理依赖
• 必须：go version >= 1.18

1.1. 关于测试

• go test -v -run ./...

2. 使用

2.1. 静态库版本

go get -u github.com/george012/gtbox@latest

2.2. 动态库版本---停止维护

• 在任意golang项目根目录下使用terminal执行如下命令

wget --no-check-certificate https://raw.githubusercontent.com/george012/gtbox/master/install_gtbox.sh && chmod a+x ./install_gtbox.sh && ./install_gtbox.sh

2.3. mac 编译 linux

brew install filosottile/musl-cross/musl-cross

设置如下环境变量 到 ~/.bash_profile 或者 ~/.zshrc
# Musl-cross 环境
export MUSL_CROSS_ROOT=$(brew --prefix musl-cross)
export PATH=$MUSL_CROSS_ROOT/bin:$PATH

3. 更新记录

• ChangeList

4. 必要支持

• CGO支持
• MAC安装最新版本Xcode及Command Line Tools

5. 功能

• CGO支持
• 自定义加、解密
• 简单的 SSH Client
• 简易 SCP 工具
• 简单的 HTTP Client
• 简单的 ORM 封装
• Aliyun SMS 简单处理
• 日志分片(异步日志文件管理)，
• 时间工具
• 字符串工具
• 数组工具
• 系统信息
• 超高精度Float64加、减、乘、除运算
• Bit Bytes 单位换算工具

Documentation

Index

• func SetupGTBox(projectName string, runMode RunMode, productLogDir string, ...)
• type GTAppSignalInfo
• type RunMode
  • func GetCurrentRunMode() RunMode
  • func (rm RunMode) String() string

Functions

func SetupGTBox

func SetupGTBox(projectName string, runMode RunMode, productLogDir string, logMaxSaveDays int64, logSaveType gtbox_log.GTLogSaveType, httpRequestTimeOut time.Duration)

SetupGTBox [☑]Required

en: Setup gtbox;
zh-CN: 初始化 gtbox 必须使用此方法初始化工具库,未使用此方法初始化，无法使用完整功能，亦存在兼容性问题;
@params [☑]projectName en:  ;zh-CN: 项目名称;
@params [☑]run_mode en:  ;zh-CN: 运行模式 debug|test|release;
@params [☑]logMaxSaveDays en:  ;zh-CN: 日志存储最大天数;
@params [☐]productLogDir en:  ;zh-CN: 自定义日志目录,默认为:/usr/logs/${projectName},如果传"" 即使用默认值;
@params [☑]logSaveType en:  ;zh-CN: 日志存储类型：按天切片|按小时切片 GTLogSaveTypeDays | GTLogSaveHours;
@params [☑]httpRequestTimeOut en:  ;zh-CN: 网络请求超时时间;

Types

type GTAppSignalInfo

type GTAppSignalInfo struct {
	SigCode string
	Msg     string
}

type RunMode

type RunMode int

const (
	RunModeUnknown RunMode = iota
	RunModeDebug
	RunModeRelease
	RunModeTest
)

func GetCurrentRunMode

func GetCurrentRunMode() RunMode

func (RunMode) String

func (rm RunMode) String() string