goutils

README

goutils

Go Utils

常用功能放在goutils包 大的模块功能放在子包内

go mod tidy
go mod download

go get -u github.com/BurntSushi/toml
go get -u go.mongodb.org/mongo-driver

go list -m -json all

git tag -ln
git tag -a v0.0.7 -m "goutils-v0.0.7"
git push origin --tags

License

This project is under MIT License. See the LICENSE file for the full license text.

Documentation

Index

• Constants
• Variables
• func CurrentProcessName() (string, error)
• func DebugPrintInfo(v reflect.Value)
• func DeepCopy(dst, src interface{}) error
• func DefaultDataDir(dirs ...string) string
• func EmptyDir(dir string) bool
• func EnsureDir(dir string, mode os.FileMode) error
• func Exit(s string)
• func FileExist(path string) bool
• func FileNotExist(path string) bool
• func GetCurrentPath() string
• func HomeDir() string
• func If(condition bool, trueVal, falseVal interface{}) interface{}
• func Inject(obj interface{}, key string, val interface{}) error
• func IsStartLower(s string) bool
• func IsStartUpper(s string) bool
• func LockPIDFile(pidfile string) error
• func Mac() string
• func MergeSliceByte(ss ...[]byte) []byte
• func MustWriteFile(filePath string, contents []byte, mode os.FileMode)
• func NonEmptyDir(dir string) bool
• func ReverseByte(arr []byte) []byte
• func Rootify(path string, roots ...string) string
• func StartLower(s string) string
• func StartUpper(s string) string
• func TimeParse(value string) (time.Time, error)
• func TimeParseInLocation(value string) (time.Time, error)
• func TimeParseToUTC(value string) (time.Time, error)
• func TrapSignal(cb func())
• func URLJoin(urls ...string) string
• func UUID() (string, error)
• func UnlockPIDFile(pidfile string) error
• func WindowsAppData() string
• func WriteFile(filePath string, contents []byte, mode os.FileMode) error
• func WritePIDFile(filepath string) error
• type DiskSize
  • func (s DiskSize) String() string
• type FileLock
  • func NewFileLock(dir string) *FileLock
  • func (l *FileLock) Lock() error
  • func (l *FileLock) Unlock() error
• type Message
  • func NewErrorMessage(err error) *Message
  • func NewMessage(code int, msg string, datas ...interface{}) *Message
  • func NewSuccessMessage(datas ...interface{}) *Message

Constants

const (
	B = 1
	K = 1024 * B
	M = 1024 * K
	G = 1024 * M
	T = 1024 * G
	P = 1024 * T
	E = 1024 * P
)

const URLSeparator = '/'

Variables

var (
	Validate                   = validator.Validate
	RegisterCustomValidateType = validator.RegisterCustomValidateType
)

var DefaultTimeFormart = "2006-01-02 15:04:05"

var Fmt = fmt.Sprintf

Fmt shorthand, XXX DEPRECATED

Functions

func CurrentProcessName

func CurrentProcessName() (string, error)

func DebugPrintInfo

func DebugPrintInfo(v reflect.Value)

func DeepCopy

func DeepCopy(dst, src interface{}) error

深拷贝

func DefaultDataDir

func DefaultDataDir(dirs ...string) string

DefaultDataDir is the default data directory

func EmptyDir

func EmptyDir(dir string) bool

空目录

func EnsureDir

func EnsureDir(dir string, mode os.FileMode) error

确保完整路径

func Exit

func Exit(s string)

exit app

func FileExist

func FileExist(path string) bool

file and folder

func FileNotExist

func FileNotExist(path string) bool

file and folder

func GetCurrentPath

func GetCurrentPath() string

返回当前可执行文件的路径 os.Getwd() 返回当前的 work dir 工作目录

func HomeDir

func HomeDir() string

func If

func If(condition bool, trueVal, falseVal interface{}) interface{}

实现三元表达式的功能

func Inject

func Inject(obj interface{}, key string, val interface{}) error

反射注入(struct 结构体)

func IsStartLower

func IsStartLower(s string) bool

是否首字母小写

func IsStartUpper

func IsStartUpper(s string) bool

是否首字母大写

func LockPIDFile

func LockPIDFile(pidfile string) error

func Mac

func Mac() string

获取本机第一个不为空的MAC地址

func MergeSliceByte

func MergeSliceByte(ss ...[]byte) []byte

func MustWriteFile

func MustWriteFile(filePath string, contents []byte, mode os.FileMode)

func NonEmptyDir

func NonEmptyDir(dir string) bool

非空目录

func ReverseByte

func ReverseByte(arr []byte) []byte

func Rootify

func Rootify(path string, roots ...string) string

helper function to make dir creation independent of root dir

func StartLower

func StartLower(s string) string

首字母小写

func StartUpper

func StartUpper(s string) string

首字母大写

func TimeParse

func TimeParse(value string) (time.Time, error)

func TimeParseInLocation

func TimeParseInLocation(value string) (time.Time, error)

func TimeParseToUTC

func TimeParseToUTC(value string) (time.Time, error)

func TrapSignal

func TrapSignal(cb func())

TrapSignal catches the SIGTERM and executes cb function. After that it exits with code 1.

func URLJoin

func URLJoin(urls ...string) string

func UUID

func UUID() (string, error)

func UnlockPIDFile

func UnlockPIDFile(pidfile string) error

func WindowsAppData

func WindowsAppData() string

func WriteFile

func WriteFile(filePath string, contents []byte, mode os.FileMode) error

func WritePIDFile

func WritePIDFile(filepath string) error

Types

type DiskSize

type DiskSize uint64

func (DiskSize) String

func (s DiskSize) String() string

type FileLock

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

func NewFileLock

func NewFileLock(dir string) *FileLock

func (*FileLock) Lock

func (l *FileLock) Lock() error

func (*FileLock) Unlock

func (l *FileLock) Unlock() error

type Message

type Message struct {
	Code int         `json:"code"`           //状态码
	Msg  string      `json:"msg,omitempty"`  //消息
	Data interface{} `json:"data,omitempty"` //结果数据
}

func NewErrorMessage

func NewErrorMessage(err error) *Message

func NewMessage

func NewMessage(code int, msg string, datas ...interface{}) *Message

func NewSuccessMessage

func NewSuccessMessage(datas ...interface{}) *Message