调整代码结构

FUTURE.md

@@ -18,7 +18,8 @@
 * [x] 完善示例代码
 * [x] 增加属性解析器适配功能
 * [x] 优化 handler 和 writer 设计
-* [ ] 增加一个可读性高的 handler 实现
+* [x] 增加一个可读性高的 handler 实现
+* [ ] MixHandler 转义处理
 * [ ] 提高单元测试覆盖率到 70%
 * [ ] 进一步提高单元测试覆盖率到 80%
 

_examples/file.go

@@ -16,7 +16,7 @@ package main
 
 import (
 	"github.com/FishGoddess/logit"
-	"github.com/FishGoddess/logit/rotate"
+	"github.com/FishGoddess/logit/core/rotate"
 )
 
 func main() {

_examples/handler.go

@@ -19,6 +19,7 @@ import (
 	"log/slog"
 
 	"github.com/FishGoddess/logit"
+	"github.com/FishGoddess/logit/core/handler"
 )
 
 func main() {
@@ -31,12 +32,12 @@ func main() {
 	logger = logit.NewLogger(logit.WithJsonHandler())
 	logger.Info("using json handler")
 
-	// Or you want to use customized handlers, try RegisterHandler.
+	// Or you want to use customized handlers, try Register.
 	newHandler := func(w io.Writer, opts *slog.HandlerOptions) slog.Handler {
 		return slog.NewTextHandler(w, opts)
 	}
 
-	if err := logit.RegisterHandler("demo", newHandler); err != nil {
+	if err := handler.Register("demo", newHandler); err != nil {
 		panic(err)
 	}
 

_examples/option.go

@@ -34,7 +34,7 @@ func main() {
 
 	// Change logger handler:
 	logit.WithHandler("xxx")
-	logit.WithStandardHandler()
+	logit.WithMixHandler()
 	logit.WithTextHandler()
 	logit.WithJsonHandler()
 

_examples/performance_test.go

@@ -59,7 +59,7 @@ BenchmarkLogrusFile-2                     174944              6491 ns/op
 func BenchmarkLogitLogger(b *testing.B) {
 	logger := logit.NewLogger(
 		logit.WithInfoLevel(),
-		logit.WithStandardHandler(),
+		logit.WithMixHandler(),
 		logit.WithWriter(io.Discard),
 	)
 
@@ -107,7 +107,7 @@ func BenchmarkLogitLoggerJsonHandler(b *testing.B) {
 func BenchmarkLogitLoggerPrint(b *testing.B) {
 	logger := logit.NewLogger(
 		logit.WithInfoLevel(),
-		logit.WithStandardHandler(),
+		logit.WithMixHandler(),
 		logit.WithWriter(io.Discard),
 	)
 
@@ -226,7 +226,7 @@ func BenchmarkLogitFile(b *testing.B) {
 
 	logger := logit.NewLogger(
 		logit.WithInfoLevel(),
-		logit.WithStandardHandler(),
+		logit.WithMixHandler(),
 		logit.WithFile(path),
 	)
 
@@ -244,7 +244,7 @@ func BenchmarkLogitFileWithBuffer(b *testing.B) {
 
 	logger := logit.NewLogger(
 		logit.WithInfoLevel(),
-		logit.WithStandardHandler(),
+		logit.WithMixHandler(),
 		logit.WithFile(path),
 		logit.WithBuffer(65536),
 	)
@@ -265,7 +265,7 @@ func BenchmarkLogitFileWithBatch(b *testing.B) {
 
 	logger := logit.NewLogger(
 		logit.WithInfoLevel(),
-		logit.WithStandardHandler(),
+		logit.WithMixHandler(),
 		logit.WithFile(path),
 		logit.WithBatch(64),
 	)

config.go

@@ -19,6 +19,8 @@ import (
 	"log/slog"
 	"os"
 	"time"
+
+	"github.com/FishGoddess/logit/core/handler"
 )
 
 type nilSyncer struct{}
@@ -55,7 +57,7 @@ func newDefaultConfig() *config {
 
 	conf := &config{
 		level:       slog.LevelDebug,
-		handler:     handlerStandard,
+		handler:     handler.Mix,
 		newWriter:   newWriter,
 		wrapWriter:  nil,
 		replaceAttr: nil,
@@ -102,7 +104,7 @@ func (c *config) newHandlerOptions() *slog.HandlerOptions {
 }
 
 func (c *config) newHandler() (slog.Handler, Syncer, io.Closer, error) {
-	newHandler, err := getHandlerFunc(c.handler)
+	newHandler, err := handler.Get(c.handler)
 	if err != nil {
 		return nil, nil, nil, err
 	}

config_test.go

@@ -20,6 +20,8 @@ import (
 	"log/slog"
 	"os"
 	"testing"
+
+	"github.com/FishGoddess/logit/core/handler"
 )
 
 type testConfigHandler struct {
@@ -58,7 +60,7 @@ func TestConfigNewHandlerOptions(t *testing.T) {
 func TestConfigNewHandler(t *testing.T) {
 	handlerName := t.Name()
 
-	RegisterHandler(handlerName, func(w io.Writer, opts *slog.HandlerOptions) slog.Handler {
+	handler.Register(handlerName, func(w io.Writer, opts *slog.HandlerOptions) slog.Handler {
 		return &testConfigHandler{
 			w:    w,
 			opts: *opts,

buffer.go → core/handler/buffer.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package logit
+package handler
 
 import (
 	"sync"

buffer_test.go → core/handler/buffer_test.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package logit
+package handler
 
 import (
 	"testing"

handler.go → core/handler/handler.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package logit
+package handler
 
 import (
 	"fmt"
@@ -22,20 +22,20 @@ import (
 )
 
 const (
-	handlerStandard = "standard"
-	handlerText     = "text"
-	handlerJson     = "json"
+	Mix  = "mix"
+	Text = "text"
+	Json = "json"
 )
 
 var (
-	newHandlers = map[string]HandlerFunc{
-		handlerStandard: func(w io.Writer, opts *slog.HandlerOptions) slog.Handler {
-			return NewStandardHandler(w, opts)
+	newHandlers = map[string]NewHandlerFunc{
+		Mix: func(w io.Writer, opts *slog.HandlerOptions) slog.Handler {
+			return NewMixHandler(w, opts)
 		},
-		handlerText: func(w io.Writer, opts *slog.HandlerOptions) slog.Handler {
+		Text: func(w io.Writer, opts *slog.HandlerOptions) slog.Handler {
 			return slog.NewTextHandler(w, opts)
 		},
-		handlerJson: func(w io.Writer, opts *slog.HandlerOptions) slog.Handler {
+		Json: func(w io.Writer, opts *slog.HandlerOptions) slog.Handler {
 			return slog.NewJSONHandler(w, opts)
 		},
 	}
@@ -45,23 +45,23 @@ var (
 	newHandlersLock sync.RWMutex
 )
 
-// HandlerFunc is a function for creating slog.Handler with w and opts.
-type HandlerFunc func(w io.Writer, opts *slog.HandlerOptions) slog.Handler
+// NewHandlerFunc is a function for creating slog.Handler with w and opts.
+type NewHandlerFunc func(w io.Writer, opts *slog.HandlerOptions) slog.Handler
 
-// getHandlerFunc gets new handler func with name and returns an error if failed.
-func getHandlerFunc(name string) (HandlerFunc, error) {
+// Get gets new handler func with name and returns an error if failed.
+func Get(name string) (NewHandlerFunc, error) {
 	newHandlersLock.RLock()
 	defer newHandlersLock.RUnlock()
 
 	if newHandler, ok := newHandlers[name]; ok {
 		return newHandler, nil
 	}
 
-	return nil, fmt.Errorf("logit: handler %s unknown", name)
+	return nil, fmt.Errorf("logit: handler %s not found", name)
 }
 
-// RegisterHandler registers newHandler with name to logit.
-func RegisterHandler(name string, newHandler HandlerFunc) error {
+// Register registers newHandler with name.
+func Register(name string, newHandler NewHandlerFunc) error {
 	newHandlersLock.Lock()
 	defer newHandlersLock.Unlock()
 

handler_test.go → core/handler/handler_test.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package logit
+package handler
 
 import (
 	"fmt"
@@ -30,7 +30,7 @@ func TestGetHandlerFunc(t *testing.T) {
 	handler := t.Name()
 	newHandlers[handler] = newHandler
 
-	got, err := getHandlerFunc(handler)
+	got, err := Get(handler)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -40,18 +40,18 @@ func TestGetHandlerFunc(t *testing.T) {
 	}
 }
 
-// go test -v -cover -count=1 -test.cpu=1 -run=^TestRegisterHandler$
-func TestRegisterHandler(t *testing.T) {
+// go test -v -cover -count=1 -test.cpu=1 -run=^TestRegister$
+func TestRegister(t *testing.T) {
 	for name := range newHandlers {
-		if err := RegisterHandler(name, nil); err == nil {
+		if err := Register(name, nil); err == nil {
 			t.Fatal("register an existed handler func should be failed")
 		}
 	}
 
 	handler := t.Name()
 	newHandler := func(w io.Writer, opts *slog.HandlerOptions) slog.Handler { return nil }
 
-	if err := RegisterHandler(handler, newHandler); err != nil {
+	if err := Register(handler, newHandler); err != nil {
 		t.Fatal(err)
 	}