refactor(cmd/web): 统一终端输出

issue9 · Nov 22, 2023 · 9a8deb4 · 9a8deb4
1 parent 8809148
commit 9a8deb4
Show file tree

Hide file tree

Showing 9 changed files with 68 additions and 43 deletions.
diff --git a/cmd/web/locale/locale.go b/cmd/web/locale/locale.go
@@ -18,9 +18,10 @@ import (
 	"github.com/issue9/localeutil/message/extract"
 	"github.com/issue9/localeutil/message/serialize"
 	"github.com/issue9/web"
-	"github.com/issue9/web/logs"
 	"golang.org/x/text/language"
 	"gopkg.in/yaml.v3"
+
+	"github.com/issue9/web/cmd/web/termlog"
 )
 
 const (
@@ -49,14 +50,7 @@ func Init(opt *cmdopt.CmdOpt, p *localeutil.Printer) {
 		funcs := fs.String("func", defaultFuncs, funcs.LocaleString(p))
 		skip := fs.Bool("m", true, skipMod.LocaleString(p))
 
-		log, err := logs.New(nil, &logs.Options{
-			Levels:  logs.AllLevels(),
-			Handler: logs.NewTermHandler(os.Stdout, nil),
-			Created: logs.NanoLayout,
-		})
-		if err != nil {
-			panic(err)
-		}
+		log := termlog.New(p, os.Stdout)
 
 		return func(io.Writer) error {
 			u, ext, err := GetMarshalByExt(*f)

diff --git a/cmd/web/locale/update/update.go b/cmd/web/locale/update/update.go
@@ -15,10 +15,10 @@ import (
 	"github.com/issue9/localeutil/message"
 	"github.com/issue9/localeutil/message/serialize"
 	"github.com/issue9/web"
-	"github.com/issue9/web/logs"
 	"gopkg.in/yaml.v3"
 
 	"github.com/issue9/web/cmd/web/locale"
+	"github.com/issue9/web/cmd/web/termlog"
 )
 
 const (
@@ -38,14 +38,7 @@ func Init(opt *cmdopt.CmdOpt, p *localeutil.Printer) {
 		dest := fs.String("dest", "", destUsage.LocaleString(p))
 
 		return func(io.Writer) error {
-			log, err := logs.New(nil, &logs.Options{
-				Levels:  logs.AllLevels(),
-				Handler: logs.NewTermHandler(os.Stdout, nil),
-				Created: logs.NanoLayout,
-			})
-			if err != nil {
-				panic(err)
-			}
+			log := termlog.New(p, os.Stdout)
 
 			srcMsg, err := getSrc(*src)
 			if err != nil {

diff --git a/cmd/web/restdoc/restdoc.go b/cmd/web/restdoc/restdoc.go
@@ -17,11 +17,11 @@ import (
 	"github.com/issue9/localeutil"
 	"github.com/issue9/source"
 	"github.com/issue9/web"
-	"github.com/issue9/web/logs"
 	"golang.org/x/mod/modfile"
 
 	"github.com/issue9/web/cmd/web/restdoc/logger"
 	"github.com/issue9/web/cmd/web/restdoc/parser"
+	"github.com/issue9/web/cmd/web/termlog"
 )
 
 const (
@@ -48,14 +48,7 @@ func Init(opt *cmdopt.CmdOpt, p *localeutil.Printer) {
 
 		return func(io.Writer) error {
 			ctx := context.Background()
-			ls, err := logs.New(p, &logs.Options{
-				Levels:  logs.AllLevels(),
-				Handler: logs.NewTermHandler(os.Stdout, nil),
-				Created: logs.NanoLayout,
-			})
-			if err != nil {
-				return err
-			}
+			ls := termlog.New(p, os.Stdout)
 
 			var tags []string
 			if *t != "" {

diff --git a/cmd/web/termlog/termlog.go b/cmd/web/termlog/termlog.go
@@ -0,0 +1,27 @@
+// SPDX-License-Identifier: MIT
+
+// Package termlog 统一的终端日志类型
+package termlog
+
+import (
+	"io"
+
+	"github.com/issue9/localeutil"
+	"github.com/issue9/web/logs"
+)
+
+// New 声明用于终端输出的日志
+//
+// 如果初始化时出错，则会直接 Panic。
+func New(p *localeutil.Printer, out io.Writer) logs.Logs {
+	log, err := logs.New(p, &logs.Options{
+		Levels:  logs.AllLevels(),
+		Handler: logs.NewTermHandler(out, nil),
+		Created: logs.NanoLayout,
+	})
+	if err != nil {
+		panic(err)
+	}
+
+	return log
+}
diff --git a/cmd/web/termlog/termlog_test.go b/cmd/web/termlog/termlog_test.go
@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: MIT
+
+package termlog
+
+import (
+	"os"
+	"testing"
+
+	"github.com/issue9/assert/v3"
+	"golang.org/x/text/language"
+	"golang.org/x/text/message"
+)
+
+func TestNew(t *testing.T) {
+	a := assert.New(t, false)
+	a.NotNil(New(nil, os.Stdout))
+	a.NotNil(New(message.NewPrinter(language.SimplifiedChinese), os.Stdout))
+}
diff --git a/cmd/web/watch/watch.go b/cmd/web/watch/watch.go
@@ -43,7 +43,7 @@ func Init(opt *cmdopt.CmdOpt, p *localeutil.Printer) {
 			watch.App:    web.StringPhrase("watch.app").LocaleString(p),
 		}
 
-		return func(w io.Writer) error {
+		return func(io.Writer) error {
 			f, err := time.ParseDuration(*freq)
 			if err != nil {
 				return err

diff --git a/server/bench_test.go b/server/bench_test.go
@@ -50,9 +50,9 @@ func BenchmarkHTTPServer_Serve(b *testing.B) {
 		a := assert.New(b, false)
 		for i := 0; i < b.N; i++ {
 			r := servertest.Get(a, "http://localhost:8080/path").
-				Header("Content-type", header.BuildContentType("application/json", "gbk")).
-				Header("accept", "application/json").
-				Header("accept-charset", "gbk;q=1,gb18080;q=0.1").
+				Header(header.ContentType, header.BuildContentType("application/json", "gbk")).
+				Header(header.Accept, "application/json").
+				Header(header.AcceptCharset, "gbk;q=1,gb18080;q=0.1").
 				Request()
 			resp, err := http.DefaultClient.Do(r)
 			a.NotError(err).NotNil(resp)
@@ -66,10 +66,10 @@ func BenchmarkHTTPServer_Serve(b *testing.B) {
 		a := assert.New(b, false)
 		for i := 0; i < b.N; i++ {
 			r := servertest.Get(a, "http://localhost:8080/path").
-				Header("Content-type", header.BuildContentType("application/json", "gbk")).
-				Header("accept", "application/json").
-				Header("accept-charset", "gbk;q=1,gb18080;q=0.1").
-				Header("accept-encoding", "gzip").
+				Header(header.ContentType, header.BuildContentType("application/json", "gbk")).
+				Header(header.Accept, "application/json").
+				Header(header.AcceptCharset, "gbk;q=1,gb18080;q=0.1").
+				Header(header.AcceptEncoding, "gzip").
 				Request()
 			resp, err := http.DefaultClient.Do(r)
 			a.NotError(err).NotNil(resp)
@@ -83,8 +83,8 @@ func BenchmarkHTTPServer_Serve(b *testing.B) {
 		a := assert.New(b, false)
 		for i := 0; i < b.N; i++ {
 			r := servertest.Get(a, "http://localhost:8080/path").
-				Header("Content-type", header.BuildContentType("application/json", header.UTF8Name)).
-				Header("accept", "application/json").
+				Header(header.ContentType, header.BuildContentType("application/json", header.UTF8Name)).
+				Header(header.Accept, "application/json").
 				Request()
 			resp, err := http.DefaultClient.Do(r)
 			a.NotError(err).NotNil(resp)

diff --git a/server/router_test.go b/server/router_test.go
@@ -49,11 +49,11 @@ func TestServer_Routers(t *testing.T) {
 
 	r1.Prefix("/p1").Delete("/path", buildHandler(http.StatusCreated))
 	servertest.Delete(a, "http://localhost:8080/p1/path").
-		Header("Accept", "application/json;v=2").
+		Header(header.Accept, "application/json;v=2").
 		Do(nil).
 		Status(http.StatusCreated)
 	servertest.NewRequest(a, http.MethodOptions, "http://localhost:8080/p1/path").
-		Header("Accept", "application/json;v=2").
+		Header(header.Accept, "application/json;v=2").
 		Do(nil).Status(http.StatusOK)
 
 	r2 := srv.GetRouter("ver")
@@ -65,7 +65,7 @@ func TestServer_Routers(t *testing.T) {
 	srv.RemoveRouter("ver")
 	a.Equal(0, len(srv.Routers()))
 	servertest.Delete(a, "http://localhost:8080/p1/path").
-		Header("Accept", "application/json;v=2").
+		Header(header.Accept, "application/json;v=2").
 		Do(nil).
 		Status(http.StatusNotFound)
 }
@@ -94,15 +94,15 @@ func TestMiddleware(t *testing.T) {
 	defer srv.Close(500 * time.Millisecond)
 
 	servertest.Get(a, "http://localhost:8080/p1/path").
-		Header("accept", "application/json").
+		Header(header.Accept, "application/json").
 		Do(nil).
 		Status(http.StatusCreated).
 		Header("h", "p1p2-b1b2-").
 		StringBody("201")
 	a.Equal(count, 1)
 
 	servertest.Get(a, "http://localhost:8080/path").
-		Header("accept", "application/json").
+		Header(header.Accept, "application/json").
 		Do(nil).
 		Status(http.StatusCreated).
 		Header("h", "b1b2-").

diff --git a/web.go b/web.go
@@ -25,7 +25,7 @@ import (
 )
 
 // Version 当前框架的版本
-const Version = "0.86.0"
+const Version = "0.86.2"
 
 // 服务的几种状态
 const (