refactor: unexport logger

benchmarks_test.go

@@ -86,7 +86,7 @@ func Benchmark_DefaultPacker_Unpack(b *testing.B) {
 }
 
 func beforeBench(b *testing.B) {
-	Log = &mutedLogger{}
+	_log = &mutedLogger{}
 	b.ReportAllocs()
 	b.ResetTimer()
 }

internal/examples/tcp/custom_packet/server/main.go

@@ -19,7 +19,7 @@ func init() {
 }
 
 func main() {
-	easytcp.Log = log
+	easytcp._log = log
 
 	s := easytcp.NewServer(&easytcp.ServerOption{
 		// specify codec and packer

logger.go

@@ -1,33 +1,23 @@
-//go:build go1.16
-// +build go1.16
-
 package easytcp
 
 import (
 	"fmt"
 	"io"
 	"log"
-	"os"
 )
 
 var _ Logger = &DefaultLogger{}
 
-// Log is the instance of Logger interface.
-var Log Logger = newMuteLogger()
+// _log is the instance of Logger interface.
+var _log Logger = newDiscardLogger()
 
 // Logger is the generic interface for log recording.
 type Logger interface {
 	Errorf(format string, args ...interface{})
 	Tracef(format string, args ...interface{})
 }
 
-func newLogger() *DefaultLogger {
-	return &DefaultLogger{
-		rawLogger: log.New(os.Stdout, "easytcp ", log.Ldate|log.Ltime|log.Lmicroseconds|log.Lmsgprefix),
-	}
-}
-
-func newMuteLogger() *DefaultLogger {
+func newDiscardLogger() *DefaultLogger {
 	return &DefaultLogger{
 		rawLogger: log.New(io.Discard, "easytcp", log.LstdFlags),
 	}
@@ -49,7 +39,12 @@ func (d *DefaultLogger) Tracef(format string, args ...interface{}) {
 	d.rawLogger.Printf("[TRACE] %s", fmt.Sprintf(format, args...))
 }
 
+// Log returns the package logger.
+func Log() Logger {
+	return _log
+}
+
 // SetLogger sets the package logger.
 func SetLogger(lg Logger) {
-	Log = lg
+	_log = lg
 }

logger_test.go

@@ -2,9 +2,17 @@ package easytcp
 
 import (
 	"github.com/stretchr/testify/assert"
+	"log"
+	"os"
 	"testing"
 )
 
+func newLogger() *DefaultLogger {
+	return &DefaultLogger{
+		rawLogger: log.New(os.Stdout, "easytcp ", log.Ldate|log.Ltime|log.Lmicroseconds|log.Lmsgprefix),
+	}
+}
+
 func TestDefaultLogger_Errorf(t *testing.T) {
 	lg := newLogger()
 	lg.Errorf("err: %s", "some error")
@@ -18,5 +26,5 @@ func TestDefaultLogger_Tracef(t *testing.T) {
 func TestSetLogger(t *testing.T) {
 	lg := &mutedLogger{}
 	SetLogger(lg)
-	assert.Equal(t, Log, lg)
+	assert.Equal(t, Log(), lg)
 }

server.go

@@ -119,14 +119,14 @@ func (s *Server) acceptLoop() error {
 	close(s.accepting)
 	for {
 		if s.isStopped() {
-			Log.Tracef("server accept loop stopped")
+			_log.Tracef("server accept loop stopped")
 			return ErrServerStopped
 		}
 
 		conn, err := s.Listener.Accept()
 		if err != nil {
 			if s.isStopped() {
-				Log.Tracef("server accept loop stopped")
+				_log.Tracef("server accept loop stopped")
 				return ErrServerStopped
 			}
 			return fmt.Errorf("accept err: %s", err)

session.go

@@ -150,17 +150,17 @@ func (s *session) readInbound(router *Router, timeout time.Duration) {
 		}
 		if timeout > 0 {
 			if err := s.conn.SetReadDeadline(time.Now().Add(timeout)); err != nil {
-				Log.Errorf("session %s set read deadline err: %s", s.id, err)
+				_log.Errorf("session %s set read deadline err: %s", s.id, err)
 				break
 			}
 		}
 		reqMsg, err := s.packer.Unpack(s.conn)
 		if err != nil {
 			logMsg := fmt.Sprintf("session %s unpack inbound packet err: %s", s.id, err)
 			if err == io.EOF {
-				Log.Tracef(logMsg)
+				_log.Tracef(logMsg)
 			} else {
-				Log.Errorf(logMsg)
+				_log.Errorf(logMsg)
 			}
 			break
 		}
@@ -174,7 +174,7 @@ func (s *session) readInbound(router *Router, timeout time.Duration) {
 			s.handleReq(router, reqMsg)
 		}
 	}
-	Log.Tracef("session %s readInbound exit because of error", s.id)
+	_log.Tracef("session %s readInbound exit because of error", s.id)
 	s.Close()
 }
 
@@ -198,7 +198,7 @@ func (s *session) writeOutbound(writeTimeout time.Duration) {
 
 		outboundBytes, err := s.packResponse(ctx)
 		if err != nil {
-			Log.Errorf("session %s pack outbound message err: %s", s.id, err)
+			_log.Errorf("session %s pack outbound message err: %s", s.id, err)
 			continue
 		}
 		if outboundBytes == nil {
@@ -207,18 +207,18 @@ func (s *session) writeOutbound(writeTimeout time.Duration) {
 
 		if writeTimeout > 0 {
 			if err := s.conn.SetWriteDeadline(time.Now().Add(writeTimeout)); err != nil {
-				Log.Errorf("session %s set write deadline err: %s", s.id, err)
+				_log.Errorf("session %s set write deadline err: %s", s.id, err)
 				break
 			}
 		}
 
 		if _, err := s.conn.Write(outboundBytes); err != nil {
-			Log.Errorf("session %s conn write err: %s", s.id, err)
+			_log.Errorf("session %s conn write err: %s", s.id, err)
 			break
 		}
 	}
 	s.Close()
-	Log.Tracef("session %s writeOutbound exit because of error", s.id)
+	_log.Tracef("session %s writeOutbound exit because of error", s.id)
 }
 
 func (s *session) packResponse(ctx Context) ([]byte, error) {