Go

Go
- 单元测试
  - 断言
  - 模拟
  - 打桩
- 性能剖析
- 数值处理
- 字符处理
  - 字符串
  - 字符类
  - 正则表达式
  - 格式化
  - 序列化
    - JSON
- 文件系统
- 进程管理
  - 参数解析
  - 进程信息
- 时间库
- 同步库
- 网络库
- 日志库
- Web 框架
  - API 注释
- 数据库
  - MySQL

单元测试

断言

// file: unit_test.go
import (
  "testing"
  "github.com/stretchr/testify/assert"
)

func TestSomething(t *testing.T) {
}

func Fail(t TestingT, failureMessage string, msgAndArgs ...interface{}) bool
func FailNow(t TestingT, failureMessage string, msgAndArgs ...interface{}) bool

func Zero(t TestingT, i interface{}, msgAndArgs ...interface{}) bool
func Nil(t TestingT, object interface{}, msgAndArgs ...interface{}) bool
func Implements(t TestingT, interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) bool
func IsType(t TestingT, expectedType interface{}, object interface{}, msgAndArgs ...interface{}) bool
func Same(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool
func Regexp(t TestingT, rx interface{}, str interface{}, msgAndArgs ...interface{}) bool
func True(t TestingT, value bool, msgAndArgs ...interface{}) bool
func False(t TestingT, value bool, msgAndArgs ...interface{}) bool
func Positive(t TestingT, e interface{}, msgAndArgs ...interface{}) bool
func Negative(t TestingT, e interface{}, msgAndArgs ...interface{}) bool
func Equal(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool
func EqualValues(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool      // 支持可相互转换类型之间的比较
func NotEqualValues(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool      // 支持可相互转换类型之间的比较
func InEpsilon(t TestingT, expected, actual interface{}, epsilon float64, msgAndArgs ...interface{}) bool
func InEpsilonSlice(t TestingT, expected, actual interface{}, epsilon float64, msgAndArgs ...interface{}) bool
func Greater(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool
func GreaterOrEqual(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool
func Less(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool
func LessOrEqual(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool

func Len(t TestingT, object interface{}, length int, msgAndArgs ...interface{}) bool
func Empty(t TestingT, object interface{}, msgAndArgs ...interface{}) bool
func Subset(t TestingT, list, subset interface{}, msgAndArgs ...interface{}) (ok bool)
func Contains(t TestingT, s, contains interface{}, msgAndArgs ...interface{}) bool // 针对string
func ElementsMatch(t TestingT, listA, listB interface{}, msgAndArgs ...interface{}) (ok bool)
func IsIncreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool
func IsDecreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool

func DirExists(t TestingT, path string, msgAndArgs ...interface{}) bool
func FileExists(t TestingT, path string, msgAndArgs ...interface{}) bool

func Panics(t TestingT, f PanicTestFunc, msgAndArgs ...interface{}) bool
func PanicsWithError(t TestingT, errString string, f PanicTestFunc, msgAndArgs ...interface{}) bool
func PanicsWithValue(t TestingT, expected interface{}, f PanicTestFunc, msgAndArgs ...interface{}) bool

模拟

打桩

性能剖析

net/http/pprof

import _ "net/http/pprof"

http://localhost:6060/debug/pprof/

goroutine
heap
threadcreate
block
mutex
cmdline
profile
symbol
trace

runtime/pprof

import "runtime/pprof"

func StartCPUProfile(w io.Writer) error
func StopCPUProfile()

go test

go test -cpuprofile cpu.prof -memprofile mem.prof -bench .

go tool pprof

go tool pprof [binary] [binary.prof]
go tool pprof http://localhost:6060/debug/pprof/profile

pprof 界面中常用命令

topN
list Func
web

数值处理

大数

import "math/big"

func NewInt(x int64) *Int
func NewFloat(x float64) *Float
func ParseFloat(s string, base int, prec uint, mode RoundingMode) (f *Float, b int, err error)
func NewRat(a, b int64) *Rat
// 各大数类型提供各种方法来进行运算

数学库

import "math"

// 三角函数
func Cos(x float64) float64
func Sin(x float64) float64
func Sincos(x float64) (sin, cos float64)
func Tan(x float64) float64
func Acos(x float64) float64        // [-π/2, π/2]
func Asin(x float64) float64        // [0,    π]
func Atan(x float64) float64        // [-π/2, π/2]
func Atan2(y, x float64) float64    // [-π,   π]
// 双曲函数
func Cosh(x float64) float64
func Sinh(x float64) float64
func Tanh(x float64) float64
func Acosh(x float64) float64
func Asinh(x float64) float64
func Atanh(x float64) float64
// 对数函数
func Log(x float64) float64
func Log1p(x float64) float64       // ln(1+x)
func Log2(x float64) float64
func Log10(x float64) float64
// 指数函数
func Exp(x float64) float64
func Expm1(x float64) float64       // eˣ-1
func Exp2(x float64) float64
func Pow10(n int) float64
func Pow(x, y float64) float64
// 幂函数
func Sqrt(x float64) float64
func Cbrt(x float64) float64
// 其他函数
func Dim(x, y float64) float64      // max(x - y, 0)
func FMA(x, y, z float64) float64   // x * y + z
func Hypot(p, q float64) float64    // √(x² + y²)
func J0(x float64) float64
func J1(x float64) float64
func Jn(n int, x float64) float64
func Y0(x float64) float64
func Y1(x float64) float64
func Yn(n int, x float64) float64
func Erf(x float64) float64
func Erfc(x float64) float64
func Erfcinv(x float64) float64
func Erfinv(x float64) float64
func Gamma(x float64) float64
func Lgamma(x float64) (lgamma float64, sign int)
// 浮点运算
func Mod(x, y float64) float64      // 商四舍五入后计算余数
func Remainder(x, y float64) float64// 商向零取整后计算余数
func Max(x, y float64) float64      // max(x, y) 若存在NAN则返回NAN
func Min(x, y float64) float64      // min(x, y) 若存在NAN则返回NAN
// 浮点取整
func Ceil(x float64) float64        // 向上取整
func Floor(x float64) float64       // 向下取整
func Trunc(x float64) float64       // 向零取整
func Round(x float64) float64       // 远零取整（四舍五入）
func RoundToEven(x float64) float64 // 向偶取整（非四舍五入）
// 符号
func Abs(x float64) float64
func Signbit(x float64) bool
func Copysign(x, y float64) float64 // 取x的值和y的符号
// 浮点编码
func Inf(sign int) float64
func IsInf(f float64, sign int) bool
func NaN() float64
func IsNaN(f float64) (is bool)
func Modf(f float64) (int float64, frac float64)
func Frexp(f float64) (frac float64, exp int)
func Ldexp(frac float64, exp int) float64
func Logb(x float64) float64
func Ilogb(x float64) int
func Nextafter(from, to float64) (r float64)
func Nextafter32(from, to float32) (r float32)
func Float32bits(f float32) uint32
func Float32frombits(b uint32) float32
func Float64bits(f float64) uint64
func Float64frombits(b uint64) float64

随机数

import "math/rand"

func Seed(seed int64)       // 做种默认随机数生成器

func Int() int              // [0, max]
func Int31() int32
func Uint32() uint32
func Int63() int64
func Uint64() uint64
func Intn(n int) int        // [0, n)
func Int31n(n int32) int32
func Int63n(n int64) int64
func Float32() float32      // [0.0, 1.0)
func Float64() float64
func ExpFloat64() float64   // 指数分布
func NormFloat64() float64  // 正态分布

func Perm(n int) []int
func Read(p []byte) (n int, err error)
func Shuffle(n int, swap func(i, j int))    // i为索引[1, n]，j为随机数[0, i]

字符处理

字符串

import "bytes"
import "strings"

// 比较
func Compare(a, b string) int
func EqualFold(s, t string) bool    // 忽略Unicode大小写
// 查询
func Count(s, substr string) int
func Contains(s, substr string) bool
func ContainsRune(s string, r rune) bool
func ContainsAny(s, chars string) bool
func Index(s, substr string) int
func IndexByte(s string, c byte) int
func IndexRune(s string, r rune) int
func IndexFunc(s string, f func(rune) bool) int
func IndexAny(s, chars string) int
func LastIndex(s, substr string) int
func LastIndexByte(s string, c byte) int
func LastIndexAny(s, chars string) int
func LastIndexFunc(s string, f func(rune) bool) int
func HasPrefix(s, prefix string) bool
func HasSuffix(s, suffix string) bool
// 切分与连接
func Fields(s string) []string                  // 连续空白符切分
func FieldsFunc(s string, f func(rune) bool) []string
func Split(s, sep string) []string
func SplitN(s, sep string, n int) []string      // 返回切片长度最大为N
func SplitAfter(s, sep string) []string
func SplitAfterN(s, sep string, n int) []string
func Join(elems []string, sep string) string
func Repeat(s string, count int) string
// 删除
func Trim(s, cutset string) string
func TrimSpace(s string) string
func TrimFunc(s string, f func(rune) bool) string
func TrimLeft(s, cutset string) string
func TrimLeftFunc(s string, f func(rune) bool) string
func TrimRight(s, cutset string) string
func TrimRightFunc(s string, f func(rune) bool) string
func TrimPrefix(s, prefix string) string
func TrimSuffix(s, suffix string) string
// 替换
func Replace(s, old, new string, n int) string
func ReplaceAll(s, old, new string) string
func Map(mapping func(rune) rune, s string) string
func ToValidUTF8(s, replacement string) string  // 将错误的字节替换为replacement
// 大小写转换
func Title(s string) string
func ToTitle(s string) string
func ToTitleSpecial(c unicode.SpecialCase, s string) string
func ToLower(s string) string
func ToLowerSpecial(c unicode.SpecialCase, s string) string
func ToUpper(s string) string
func ToUpperSpecial(c unicode.SpecialCase, s string) string

字符类

import unicode

var Categories = map[string]*RangeTable{...}
func Is(rangeTab *RangeTable, r rune) bool
func In(r rune, ranges ...*RangeTable) bool
func IsOneOf(ranges []*RangeTable, r rune) bool

func IsDigit(r rune) bool       // ASCII数字
func IsNumber(r rune) bool      // Unicode数字
func IsLetter(r rune) bool
func IsUpper(r rune) bool
func IsLower(r rune) bool
func IsTitle(r rune) bool
func IsPunct(r rune) bool
func IsMark(r rune) bool
func IsSymbol(r rune) bool
func IsSpace(r rune) bool
func IsGraphic(r rune) bool     // 包含空白符
func IsPrint(r rune) bool       // 对于空白符仅包含ASCII space
func IsControl(r rune) bool

正则表达式

import "regexp"
// 构造Regexp
func Compile(expr string) (*Regexp, error)
func MustCompile(str string) *Regexp
func QuoteMeta(s string) string

// 查看
func (re *Regexp) String() string
func (re *Regexp) NumSubexp() int
func (re *Regexp) SubexpNames() []string
func (re *Regexp) SubexpIndex(name string) int

// 模式匹配：默认匹配到第一个就结束，搜索文本（参数）与匹配（返回）类型为byte[]，
// All      表示返回切片，元素为多次匹配
// Submatch 表示返回切片，元素为子匹配
// Index    表示用int[]代替byte[]返回
// String   表示用string代替byte[]参数与返回
// Submatch与Index结合只会使返回值增加一维而非两维
func (re *Regexp) Find(All)?(String)?(Submatch)?(Index)?
func (re *Regexp) Match(b []byte) bool // 不完全匹配
func (re *Regexp) MatchString(s string) bool
func (re *Regexp) MatchReader(r io.RuneReader) bool

// 模式替换：将src中匹配到的match按fmt替换后追加到dst中，返回新dst
func (re *Regexp) Expand(dst []byte, fmt []byte, src []byte, match []int) []byte
func (re *Regexp) ExpandString(dst []byte, fmt string, src string, match []int) []byte
func (re *Regexp) ReplaceAll(Func|Literal)?(String)?

// 切分
func (re *Regexp) Split(s string, n int) []string

格式化

import "fmt"

// 若两个操作数均非字符串，则中间添加空格
func Print(a ...interface{}) (n int, err error)
func Fprint(w io.Writer, a ...interface{}) (n int, err error)
func Sprint(a ...interface{}) string
// 始终在两操作数中间添加空格，并在末尾添加换行
func Println(a ...interface{}) (n int, err error)
func Fprintln(w io.Writer, a ...interface{}) (n int, err error)
func Sprintln(a ...interface{}) string
// 按格式化字符操作
func Printf(format string, a ...interface{}) (n int, err error)
func Fprintf(w io.Writer, format string, a ...interface{}) (n int, err error)
func Sprintf(format string, a ...interface{}) string
func Errorf(format string, a ...interface{}) error

// 忽略空白符，扫描直到参数读取完毕或EOF
func Scan(a ...interface{}) (n int, err error)
func Fscan(r io.Reader, a ...interface{}) (n int, err error)
func Sscan(str string, a ...interface{}) (n int, err error)
// 忽略空白符，扫描直到参数读取完毕或NL或EOF，若读取完毕时行尾仍有非空白符则算错误
func Scanln(a ...interface{}) (n int, err error)
func Fscanln(r io.Reader, a ...interface{}) (n int, err error)
func Sscanln(str string, a ...interface{}) (n int, err error)
// fmt中的'\n'匹配`\s*\n`，与'\n'相邻的'\s'匹配'\s*'，不与'\n'相邻的'\s'匹配`\s+`，其它字符都必须精准匹配
// 除%c外，其他操作都忽略开头空白符
func Scanf(format string, a ...interface{}) (n int, err error)
func Fscanf(r io.Reader, format string, a ...interface{}) (n int, err error)
func Sscanf(str string, format string, a ...interface{}) (n int, err error)

// +对于结构会打印其字段名，#对于结构会打印其类型与字段名
// 宽度与精度可替换为 [索引]* 从而用参数值替换
"%对齐 符号 # 0 宽度.精度 [索引] 类型"

格式	描述	支持类型
%v	打印值	all
%T	打印类型	all
%t	打印布尔值	bool
%b	打印二进制	整数、浮点数
%o	打印八进制	整数
%O	打印八进制带前缀 0o	整数
%d	打印十进制	整数
%x	打印十六进制小写字母	整数、浮点数、string
%X	打印十六进制大写字母	整数、浮点数、string
%e %E	打印科学计数法 e 或 E	浮点数
%f %F	打印定点数	浮点数
%g %G	打印智能选择	浮点数
%c	打印码点对应字符	byte、rune
%U	打印码点值	byte、rune
%s	打印字符串	string
%q	打印引用后的字符串	string
%p	打印十六进制指针值	指针

序列化

JSON

import "encoding/json"

func Unmarshal(data []byte, v interface{}) error
func Marshal(v interface{}) ([]byte, error)
func MarshalIndent(v interface{}, prefix, indent string) ([]byte, error)
func Indent(dst *bytes.Buffer, src []byte, prefix, indent string) error
func Compact(dst *bytes.Buffer, src []byte) error
func Valid(data []byte) bool
// 从JSON转换时忽略stuct中不存在的字段，默认值为零值，可以利用指针复合类型确认字段是否存在（不存在为nil）
// 若匹配字段的类型不匹配则出错
// 字段匹配忽略大小写
type Json struct {
    Bool   bool                   `json:"bool"`
    Int    int                    `json:"integer"`
    Float  float64                `json:"float"`
    String string                 `json:"string"`
    List   []string               `json:"list"`
    Obj1   map[string]interface{} `json:"obj1"`
    Obj2   NestObj                `json:"obj2"`
    Omit   Omit                   `json:"-"`
    NilPtr *string                `json:"nilPtr"`
}

文件系统

文件路径

import "path/filepath"

func VolumeName(path string) string                 // 返回卷名。Windows返回类似"C:"，其他返回""
func Dir(path string) string                        // 返回路径名(Clean)。"dir/file"=>"dir", "dir/"=>"dir"
func Base(path string) string                       // 返回文件名(Clean)。"dir/file"=>"file"
func Ext(path string) string                        // 返回扩展名。"f.go"=>".go"
func SplitList(path string) []string                // 返回分离出来的路径名，path中各路径名用冒号:分隔
func Split(path string) (dir, file string)          // 返回dir + file = path。"dir/file"=>"dir/"+"file"
func Rel(basepath, targpath string) (string, error) // 返回相对路径(Clean)
func Join(elem ...string) string                    // 返回合并路径(Clean)

func IsAbs(path string) bool
func IsPathSeparator(c uint8) bool
func FromSlash(path string) string                  // 转换从'/'(Clean)
func ToSlash(path string) string                    // 转换为'/'(Clean)
func Abs(path string) (string, error)               // 返回绝对路径(Clean)
func EvalSymlinks(path string) (string, error)      // 返回真实路径(Clean)
func Clean(path string) string                      // 返回干净路径(Clean)。去除"."与"..", "/.."=>"/", "/"=>"/", ""=>"/"

func Match(pattern, name string) (matched bool, err error)  // 仅语法上进行shell通配符匹配
func Glob(pattern string) (matches []string, err error)     // 返回当前目录下通配符匹配结果

func WalkDir(root string, fn fs.WalkDirFunc) error
type WalkDirFunc func(path string, d DirEntry, err error) error
// WalkDirFunc在打开文件前被调用，
// path路径前缀为root
// err若os.Lstat(path)出错则设置err，若一个目录的Readdirnames方法失败也设置err
// error返回SkipDir表示跳过该目录（或该文件的上级目录），返回其他non-nil则停止

文件信息

import "os"

func Stat(name string) (FileInfo, error)
func Lstat(name string) (FileInfo, error)
func IsExist(err error) bool
func IsNotExist(err error) bool
func IsPermission(err error) bool
func SameFile(fi1, fi2 FileInfo) bool

func (s FileInfo) Name() string       // base name of the file
func (s FileInfo) Size() int64        // length in bytes for regular files; system-dependent for others
func (s FileInfo) ModTime() time.Time // modification time
func (s FileInfo) IsDir() bool        // abbreviation for Mode().IsDir()
func (s FileInfo) Mode() FileMode     // file mode bits

// FileMode包含了文件类型和权限信息，可利用位运算判断
func (m FileMode) IsDir() bool
func (m FileMode) IsRegular() bool
func (m FileMode) Perm() FileMode
func (m FileMode) String() string
func (m FileMode) Type() FileMode

文件操作

import "os"

func Link(oldname, newname string) error
func Symlink(oldname, newname string) error
func Readlink(name string) (string, error)

func Mkdir(name string, perm FileMode) error
func MkdirAll(path string, perm FileMode) error
func MkdirTemp(dir, pattern string) (string, error)
func TempDir() string
func UserCacheDir() (string, error)
func UserConfigDir() (string, error)
func UserHomeDir() (string, error)

func Remove(name string) error                      // 删除普通文件或空目录
func RemoveAll(path string) error                   // 删除普通文件或目录
func Rename(oldpath, newpath string) error

func Chown(name string, uid, gid int) error
func Lchown(name string, uid, gid int) error
func Chmod(name string, mode FileMode) error
func Chtimes(name string, atime time.Time, mtime time.Time) error

输入输出

import "os"

func CreateTemp(dir, pattern string) (*File, error)                 // dir为空则默认系统临时目录，pattern中最后一个*被替换为random
func Create(name string) (*File, error)                             // 不存在则创建，存在则截断
func Open(name string) (*File, error)                               // 只读模式打开
func OpenFile(name string, flag int, perm FileMode) (*File, error)  // 手动指定打开标识(os.O_*)与默认权限
func Pipe() (r *File, w *File, err error)

func (f *File) Name() string
func (f *File) Read(b []byte) (n int, err error)
func (f *File) ReadAt(b []byte, off int64) (n int, err error)
func (f *File) Write(b []byte) (n int, err error)
func (f *File) WriteAt(b []byte, off int64) (n int, err error)
func (f *File) Seek(offset int64, whence int) (ret int64, err error)// whence(os.SEEK_*)
func (f *File) Sync() error

func ReadFile(name string) ([]byte, error)
func WriteFile(name string, data []byte, perm FileMode) error
func Truncate(name string, size int64) error

进程管理

参数解析

import "flag"

func Bool(name string, value bool, usage string) *bool
func BoolVar(p *bool, name string, value bool, usage string)
func Int(name string, value int, usage string) *int
func IntVar(p *int, name string, value int, usage string)
func Uint(name string, value uint, usage string) *uint
func UintVar(p *uint, name string, value uint, usage string)
func Float64(name string, value float64, usage string) *float64
func Float64Var(p *float64, name string, value float64, usage string)
func String(name string, value string, usage string) *string
func StringVar(p *string, name string, value string, usage string)
func Duration(name string, value time.Duration, usage string) *time.Duration
func DurationVar(p *time.Duration, name string, value time.Duration, usage string)
func Func(name, usage string, fn func(string) error)    // 如fn返回non-nil则表示解析错误
func Var(value Value, name string, usage string)
func Parse()
func Parsed() bool
func PrintDefaults()    // 手动打印参数选项提示信息到stderr

func Arg(i int) string  // 解析后剩余中第i个命令行参数
func Args() []string    // 解析后剩余的命令行参数
func NArg() int         // 解析后剩余参数个数
func NFlag() int        // 解析的选项参数个数
func Set(name, value string) error

func Visit(fn func(*Flag))      // 仅访问被设置的flag
func VisitAll(fn func(*Flag))   // 访问所有flag

type Flag struct {
    Name     string // name as it appears on command line
    Usage    string // help message
    Value    Value  // value as set
    DefValue string // default value (as text); for usage message
}

type Value interface {
    String() string
    Set(string) error
}

进程信息

import "os"

func Executable() (string, error)
func Environ() []string
func Exit(code int)
func Expand(s string, mapping func(string) string) string
func ExpandEnv(s string) string

func Getenv(key string) string
func LookupEnv(key string) (string, bool)
func Setenv(key, value string) error
func Unsetenv(key string) error
func Clearenv()
func Getwd() (dir string, err error)
func Chdir(dir string) error
func Getuid() int
func Getgid() int
func Geteuid() int
func Getegid() int
func Getgroups() ([]int, error)
func Getpid() int
func Getppid() int

func Hostname() (name string, err error)

时间库

import "time"
// 时间+时区 可唯一确定一个世界通用时，当输出时的时区改变则时间也会随之改变

// Time计算时使用monotonic clock，其他操作使用wall clock
func Now() Time
func Date(year int, month Month, day, hour, min, sec, nsec int, loc *Location) Time
func Unix(sec int64, nsec int64) Time   // 接受Unix时间戳sec*1e9+nsec
func Parse(layout, value string) (Time, error)
func ParseInLocation(layout, value string, loc *Location) (Time, error)

// RFC3339 = "2006-01-02T15:04:05-07:00"
// RFC3339Nano = "2006-01-02T15:04:05.000-07:00"
func (t *Time) Format(layout string) string
func (t *Time) Date() (year int, month Month, day int)
func (t *Time) Year() int
func (t *Time) Month() Month
func (t *Time) Day() int
func (t *Time) Weekday() Weekday
func (t *Time) YearDay() int
func (t *Time) Clock() (hour, min, sec int)
func (t *Time) Hour() int
func (t *Time) Minute() int
func (t *Time) Second() int
func (t *Time) Nanosecond() int

// Unix时间戳定义为1970-1-1 00:00:00 UTC开始所流逝的秒数，不受Time的时区影响
func (t *Time) Zone() (name string, offset int) // offset为相对UTC偏移秒数
func (t *Time) Unix() int64                     // 返回秒级Unix时间戳
func (t *Time) UnixNano() int64                 // 同上，但返回ns纳秒级版本
func (t *Time) UTC() Time                       // 转换为UTC时间
func (t *Time) Local() Time                     // 转换为Local时间
func (t *Time) Location() *Location
func (t *Time) In(loc *Location) Time

func (t *Time) Add(d Duration) Time
func (t *Time) AddDate(years int, months int, days int) Time
func (t *Time) Sub(u Time) Duration
func (t *Time) Truncate(d Duration) Time
func (t *Time) Before(u Time) bool
func (t *Time) After(u Time) bool
func (t *Time) Equal(u Time) bool
func (t *Time) IsZero() bool

type Month int
const (
    January Month = 1 + iota
    February
    March
    April
    May
    June
    July
    August
    September
    October
    November
    December
)
func (m Month) String() string

type Weekday int
const (
    Sunday Weekday = iota
    Monday
    Tuesday
    Wednesday
    Thursday
    Friday
    Saturday
)
func (d Weekday) String() string

// Duration单位为nanosecond
func ParseDuration(s string) (Duration, error)  // ns, us, ms, s, m, h
func Since(t Time) Duration
func Until(t Time) Duration
func (d Duration) Hours() float64
func (d Duration) Minutes() float64
func (d Duration) Seconds() float64
func (d Duration) Milliseconds() int64
func (d Duration) Microseconds() int64
func (d Duration) Nanoseconds() int64
func (d Duration) String() string
func (d Duration) Round(m Duration) Duration    // 向零取整
func (d Duration) Truncate(m Duration) Duration // 远零取整

func NewTicker(d Duration) *Ticker
func (t *Ticker) Reset(d Duration)
func (t *Ticker) Stop()

func AfterFunc(d Duration, f func()) *Timer
func NewTimer(d Duration) *Timer
func (t *Timer) Reset(d Duration) bool
func (t *Timer) Stop() bool

func Sleep(d Duration)

同步库

type Mutex
    func (m *Mutex) Lock()
    func (m *Mutex) Unlock()
type RWMutex
    func (rw *RWMutex) Lock()
    func (rw *RWMutex) RLock()
    func (rw *RWMutex) RLocker() Locker
    func (rw *RWMutex) RUnlock()
    func (rw *RWMutex) Unlock()
type Cond
    func NewCond(l Locker) *Cond
    func (c *Cond) Broadcast()
    func (c *Cond) Signal()
    func (c *Cond) Wait()
type Map
    func (m *Map) Delete(key interface{})
    func (m *Map) Load(key interface{}) (value interface{}, ok bool)
    func (m *Map) LoadAndDelete(key interface{}) (value interface{}, loaded bool)
    func (m *Map) LoadOrStore(key, value interface{}) (actual interface{}, loaded bool)
    func (m *Map) Range(f func(key, value interface{}) bool)
    func (m *Map) Store(key, value interface{})
type WaitGroup
    func (wg *WaitGroup) Add(delta int)
    func (wg *WaitGroup) Done()
    func (wg *WaitGroup) Wait()
type Once
    func (o *Once) Do(f func())

网络库

import "net"

func ParseIP(s string) IP
func ParseCIDR(s string) (IP, *IPNet, error)
func (n *IPNet) Contains(ip IP) bool
func (n *IPNet) Network() string
func (n *IPNet) String() string

func SplitHostPort(hostport string) (host, port string, err error)
func JoinHostPort(host, port string) string
func LookupAddr(addr string) (names []string, err error)        // 从hosts文件反查ip对应host
func LookupCNAME(host string) (cname string, err error)         // 查询host对应cname
func LookupHost(host string) (addrs []string, err error)        // 查询host对应ip
func LookupIP(host string) ([]IP, error)                        // 查询host对应ip
func LookupPort(network, service string) (port int, err error)  // 查询service对应port

// network: "tcp", "tcp4", "tcp6", "udp", "udp4", "udp6", "ip", "ip4", "ip6", "unix", "unixgram", "unixpacket"
// address: "ip:port", "host:service"
func Dial(network, address string) (Conn, error)
func Listen(network, address string) (Listener, error)

type Listener interface {
    Accept() (Conn, error)
    Close() error
    Addr() Addr
}

type Conn interface {
    Read(b []byte) (n int, err error)
    Write(b []byte) (n int, err error)
    Close() error
    LocalAddr() Addr
    RemoteAddr() Addr
    SetDeadline(t time.Time) error
    SetReadDeadline(t time.Time) error
    SetWriteDeadline(t time.Time) error
}

import "crypto/tls"

func Listen(network, laddr string, config *Config) (net.Listener, error)
func Dial(network, addr string, config *Config) (*Conn, error)
func Server(conn net.Conn, config *Config) *Conn
func Client(conn net.Conn, config *Config) *Conn
type Config struct {
    CipherSuites []uint16       // for both
    Certificates []Certificate  // for both
    InsecureSkipVerify bool     // for Client
    ServerName string           // for Client
    RootCAs *x509.CertPool      // for Client
    ClientAuth ClientAuthType   // for Server
    ClientCAs *x509.CertPool    // for Server
    KeyLogWriter io.Writer      // 用于获取PMS来抓包解密报文
}
func LoadX509KeyPair(certFile, keyFile string) (Certificate, error)
func X509KeyPair(certPEMBlock, keyPEMBlock []byte) (Certificate, error)

import "crypto/x509"

func NewCertPool() *CertPool
func SystemCertPool() (*CertPool, error)
func (s *CertPool) AddCert(cert *Certificate)
func (s *CertPool) AppendCertsFromPEM(pemCerts []byte) (ok bool)
func (s *CertPool) Subjects() [][]byte

日志库

import "github.com/sirupsen/logrus"

func init() {
    logrus.SetOutput(os.Stdout)
    logrus.SetLevel(logrus.InfoLevel)
    logrus.SetReportCaller(true)
    logrus.SetFormatter(&logrus.TextFormatter{
        // DisableLevelTruncation:    true,
        // PadLevelText:              true,
        // ForceQuote:                false,
        // DisableQuote:              false,
        // QuoteEmptyFields:          false,
        // ForceColors:               false,
        // DisableColors:             false,
        // EnvironmentOverrideColors: true, // CLICOLOR_FORCE and CLICOLOR
        // DisableTimestamp:          false,
        FullTimestamp:             true,
        TimestampFormat:           "2006-01-02 15:04:05",
        CallerPrettyfier: func(f *runtime.Frame) (function string, file string) {
            file = fmt.Sprintf("%v:%v", filepath.Base(f.File), f.Line)
            function = fmt.Sprintf("%v()", f.Function)
            return
        },
    })
}

func main() {
    log := logrus.WithFields(logrus.Fields{})
    iow := logrus.StandardLogger().Write()  // io.Writer

    log.Trace("message")
    log.Debug("message")
    log.Info("message")
    log.Warn("message")
    log.Error("message")
    log.Fatal("message")
    log.Panic("message")
}

Web 框架

API 注释

// @Summary 接口简述
// @Description 接口详情
// @Tags 标签, 支持逗号分隔列表
// @Accept 接收MIME类型
// @Produce 生成MIME类型
// @Param 参数名 参数类型 数据类型 是否必须 "注释" 可选属性(值)
// @Success 返回码 {参数类型} 数据类型 "注释"
// @Failure 返回码 {参数类型} 数据类型 "注释"
// @Router /path/to/resource [Method]

MIME 类型
- json
- mpfd
- xml
参数类型
- path
- query
- header
- body
数据类型
- bool
- int
- number
- string
- array
- object
属性
- default(*)
- enums(v1, v2)

数据库

MySQL

定义 struct/map 表示数据表

结构名 => 表名
- SnakeCase => snake_cases
- func (this *SnakeCase) TableName() string
字段名 => 列名
- SnakeCase => snake_case
- gorm:"column:name"

类型转换

Go 数据类型	SQL 数据类型
整数	整数
浮点数	浮点数
string	字符
[]byte	字节
time.Time	日期时间
string	任意 SQL 类型
struct,map	单行记录
`[]struct`,`[]map`	多行记录

标签

大多数 tag 用于创建表时使用，少部分会影响 CRUD
- gorm:"column:name"
- gorm:"type:sqltype"
- gorm:"unique"
- gorm:"not null"
- gorm:"autoIncrement"
- gorm:"default:value"
- gorm:"embedded;embeddedPrefix:prefix_"
- gorm:"<-" // allow read and write (create and update)
- gorm:"<-:create" // allow read and create
- gorm:"<-:update" // allow read and update
- gorm:"<-:false" // readonly
- gorm:"->:false;<-:create" // createonly (disabled read from db)
- gorm:"->:false;<-:update" // updateonly (disabled read from db)
- gorm:"-" // no read/write permission (ignore this field)
- gorm:"primaryKey"
- gorm:"index:idx_name,priority:1" // 构造索引 idx_member，优先级默认为 12，同优先级则根据字段先后顺序构造
- gorm:"uniqueIndex:idx_name,priority:1"

import "gorm.io/gorm"
import "gorm.io/driver/mysql"

type Model struct {
    gorm.Model      // 包含ID, CreateAt, UpdateAt, DeleteAt
}

// 连接数据库
dsn := fmt.Sprintf("%s:%s@tcp(%s:%s)/%s?charset=utf8mb4&parseTime=True&loc=Local", user, password, ip, port, db)
db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})
sqlDB.SetMaxOpenConns(0)    // open连接越多，并发量越大，性能越高，但导致数据库压力越大；推荐10-20
sqlDB.SetMaxIdleConns(2)    // idel连接越多，重新建连的可能性越低，但内存占用越高；推荐2-5
sqlDB.SetConnMaxLifetime(0) // 清理超时过期的idel连接，生命周期越长，重新建连可能性越低，但导致数据库连接过期；推荐与数据库配置相同

// 自动迁移表
db.AutoMigrate(&Model{})    // 创建或修改表模式但不会删除列，应该放在init函数里

// 接下来的SQL方法都会将上下文写入返回的新对象中，可用于拼接SQL语句

// 选择列：默认选择的列即的Model的非零字段对应列
db.Select("*")              // 显式指定所有列
db.Select("field", ...)     // 显式指定列
db.Omit("field", ...)       // 忽略指定的已选择列

// 过滤行：默认不进行行过滤
db.Where(&Model{Name:""})   // 忽略零值不用于过滤
db.Where("field = ?", val)  // gorm解析?时会自动判断数据类型
db.Where("field IN", []Model)
db.Or("")
db.Not("")

// 删除：过滤行
db.Unscoped()               // 用于查询包含软删除，用于删除则永久删除
db.Delete(&Model{})

// 插入：选择列
db.Create(&Model{})         // 主键列ID的自增值会写回Model.ID
db.Create(&[]Model{})
db.CreateInBatches(&[]Model{}, size)

// 更新：选择列，过滤行
db.UpdateColumns("field", val)  // 更新指定列
db.Updates(&Model{})            // 更新非零列
db.Save(&Model{})               // 更新所有列
result.RowsAffected             // 操作结果：更新行数
db.Expr("price * ?", num)       // 解析为原生SQL语句字符串，用于原来需要go值的地方

// 查询：选择列，过滤行
db.First(&record)           // 主键升序取第一个
db.Last(&record)            // 主键降序取第一个
db.Take(&record)            // 未指定排序取第一个（与选取的索引有关）

subQuery := db.Selete("..") // 子查询可用于Where
db.Select("field", ...)
db.Distinct("field", ...)
db.Joins("LEFT JOIN others ON records.id = others.id AND others.grade > ?", grade)
db.Where("id = ?", id)
db.Group("name, age").Having("COUNT(name) > 2")
db.Order("field1 DESC").Order("field2")
db.Limit(1).Offset(0)

db.Find(&Model{})
db.Find(&[]Model{})
db.Count(&int64{})

// 事务
tx := db.Begin()
tx.SavePoint("sp1")
tx.RollbackTo("sp1")
tx.Rollback()
tx.Commit()

// Hooks
func (u *User) BeforeCreate(tx *gorm.DB) (err error)
func (u *User) AfterCreate(tx *gorm.DB) (err error)
func (u *User) BeforeSave(tx *gorm.DB) (err error)
func (u *User) AfterSave(tx *gorm.DB) (err error)
func (u *User) BeforeUpdate(tx *gorm.DB) (err error)
func (u *User) AfterUpdate(tx *gorm.DB) (err error)
func (u *User) BeforeDelete(tx *gorm.DB) (err error)
func (u *User) AfterDelete(tx *gorm.DB) (err error)
func (u *User) AfterFind(tx *gorm.DB) (err error)

// 调试
db.Session(&Session{DryRun: true}).First(&user, 1).Statement.SQL.String()   // SQL语句

FilesExpand file tree

golib.md

Latest commit

History

golib.md

File metadata and controls

Go

单元测试

断言

模拟

打桩

性能剖析

net/http/pprof

runtime/pprof

go test

go tool pprof

数值处理

大数

数学库

随机数

字符处理

字符串

字符类

正则表达式

格式化

序列化

JSON

文件系统

文件路径

文件信息

文件操作

输入输出

进程管理

参数解析

进程信息

时间库

同步库

网络库

日志库

Web 框架

API 注释

数据库

MySQL