共计 4453 个字符,预计需要花费 12 分钟才能阅读完成。
序
本文次要钻研一下 golang 的 zap 的 buffer
buffer
zap@v1.16.0/buffer/buffer.go
package buffer // import "go.uber.org/zap/buffer"
import (
"strconv"
"time"
)
const _size = 1024 // by default, create 1 KiB buffers
// Buffer is a thin wrapper around a byte slice. It's intended to be pooled, so
// the only way to construct one is via a Pool.
type Buffer struct {bs []byte
pool Pool
}
// AppendByte writes a single byte to the Buffer.
func (b *Buffer) AppendByte(v byte) {b.bs = append(b.bs, v)
}
// AppendString writes a string to the Buffer.
func (b *Buffer) AppendString(s string) {b.bs = append(b.bs, s...)
}
// AppendInt appends an integer to the underlying buffer (assuming base 10).
func (b *Buffer) AppendInt(i int64) {b.bs = strconv.AppendInt(b.bs, i, 10)
}
// AppendTime appends the time formatted using the specified layout.
func (b *Buffer) AppendTime(t time.Time, layout string) {b.bs = t.AppendFormat(b.bs, layout)
}
// AppendUint appends an unsigned integer to the underlying buffer (assuming
// base 10).
func (b *Buffer) AppendUint(i uint64) {b.bs = strconv.AppendUint(b.bs, i, 10)
}
// AppendBool appends a bool to the underlying buffer.
func (b *Buffer) AppendBool(v bool) {b.bs = strconv.AppendBool(b.bs, v)
}
// AppendFloat appends a float to the underlying buffer. It doesn't quote NaN
// or +/- Inf.
func (b *Buffer) AppendFloat(f float64, bitSize int) {b.bs = strconv.AppendFloat(b.bs, f, 'f', -1, bitSize)
}
// Len returns the length of the underlying byte slice.
func (b *Buffer) Len() int {return len(b.bs)
}
// Cap returns the capacity of the underlying byte slice.
func (b *Buffer) Cap() int {return cap(b.bs)
}
// Bytes returns a mutable reference to the underlying byte slice.
func (b *Buffer) Bytes() []byte {return b.bs}
// String returns a string copy of the underlying byte slice.
func (b *Buffer) String() string {return string(b.bs)
}
// Reset resets the underlying byte slice. Subsequent writes re-use the slice's
// backing array.
func (b *Buffer) Reset() {b.bs = b.bs[:0]
}
// Write implements io.Writer.
func (b *Buffer) Write(bs []byte) (int, error) {b.bs = append(b.bs, bs...)
return len(bs), nil
}
// TrimNewline trims any final "\n" byte from the end of the buffer.
func (b *Buffer) TrimNewline() {if i := len(b.bs) - 1; i >= 0 {if b.bs[i] == '\n' {b.bs = b.bs[:i]
}
}
}
// Free returns the Buffer to its Pool.
//
// Callers must not retain references to the Buffer after calling Free.
func (b *Buffer) Free() {b.pool.put(b)
}
Buffer 定义了[]byte 及 Pool 属性,它提供了 AppendByte、AppendString、AppendInt、AppendTime、AppendUint、AppendBool、AppendFloat、String、Reset、Write、TrimNewline、Free 办法
pool
zap@v1.16.0/buffer/pool.go
package buffer
import "sync"
// A Pool is a type-safe wrapper around a sync.Pool.
type Pool struct {p *sync.Pool}
// NewPool constructs a new Pool.
func NewPool() Pool {
return Pool{p: &sync.Pool{New: func() interface{} {return &Buffer{bs: make([]byte, 0, _size)}
},
}}
}
// Get retrieves a Buffer from the pool, creating one if necessary.
func (p Pool) Get() *Buffer {buf := p.p.Get().(*Buffer)
buf.Reset()
buf.pool = p
return buf
}
func (p Pool) put(buf *Buffer) {p.p.Put(buf)
}
Pool 定义了
*sync.Pool
属性,其 NewPool 办法创立 sync.Pool,New 办法为创立 Buffer,_size 默认为 1024 即 1KB;其 Get 办法从 pool 获取 buffer,其 put 办法用于将 buffer 偿还到 pool;因为偿还时 buffer 可能没有 reset,所以每次 Get 的时候都会先 Reset 一下再返回
bufferpool
zap@v1.16.0/internal/bufferpool/bufferpool.go
package bufferpool
import "go.uber.org/zap/buffer"
var (_pool = buffer.NewPool()
// Get retrieves a buffer from the pool, creating one if necessary.
Get = _pool.Get
)
bufferpool 包创立了一个全局的_pool,并定义了 Get func
FullPath
zap@v1.16.0/zapcore/entry.go
func (ec EntryCaller) FullPath() string {
if !ec.Defined {return "undefined"}
buf := bufferpool.Get()
buf.AppendString(ec.File)
buf.AppendByte(':')
buf.AppendInt(int64(ec.Line))
caller := buf.String()
buf.Free()
return caller
}
FullPath 办法应用 bufferpool 来创立 caller
newJSONEncoder
zap@v1.16.0/zapcore/json_encoder.go
func newJSONEncoder(cfg EncoderConfig, spaced bool) *jsonEncoder {
return &jsonEncoder{
EncoderConfig: &cfg,
buf: bufferpool.Get(),
spaced: spaced,
}
}
newJSONEncoder 应用 bufferpool.Get()来获取 buffer,而后创立 jsonEncoder
实例
func bufferDemo() {buf := buffer.NewPool().Get()
buf.AppendByte('v')
fmt.Println(buf.String())
buf.Reset()
buf.AppendString("foo")
fmt.Println(buf.String())
buf.Reset()
buf.AppendInt(42)
fmt.Println(buf.String())
buf.Reset()
buf.AppendUint(42)
fmt.Println(buf.String())
buf.Reset()
buf.AppendBool(true)
fmt.Println(buf.String())
buf.Reset()
buf.AppendFloat(3.14, 32)
fmt.Println(buf.String())
buf.Reset()
buf.Write([]byte("foo"))
fmt.Println(buf.String())
buf.Reset()
buf.AppendTime(time.Date(2000, 1, 2, 3, 4, 5, 6, time.UTC), time.RFC3339)
fmt.Println(buf.String())
buf.Reset()
buf.Free()}
输入
v
foo
42
42
true
3.14
foo
2000-01-02T03:04:05Z
小结
Buffer 定义了 []byte 及 Pool 属性,它提供了 AppendByte、AppendString、AppendInt、AppendTime、AppendUint、AppendBool、AppendFloat、String、Reset、Write、TrimNewline、Free 办法;Pool 定义了*sync.Pool
属性,其 NewPool 办法创立 sync.Pool,New 办法为创立 Buffer,_size 默认为 1024 即 1KB;其 Get 办法从 pool 获取 buffer,其 put 办法用于将 buffer 偿还到 pool;因为偿还时 buffer 可能没有 reset,所以每次 Get 的时候都会先 Reset 一下再返回
doc
- zap