Merge pull request #12 from jacexh/release/0.2.6

Release/0.2.6
jacexh · Mar 22, 2021 · f359055 · f359055
2 parents 04c86e9 + 7a004db
commit f359055
Show file tree

Hide file tree

Showing 26 changed files with 47 additions and 43 deletions.
diff --git a/README.md b/README.md
@@ -20,6 +20,10 @@ gdp
 
 ## Change Log
 
+### 0.2.6
+
+- 参考[Project Layout](https://github.com/golang-standards/project-layout)调整项目布局
+
 ### 0.2.5
 
 - Graceful Shutdown的exit code改成0

diff --git a/types/dto/dto.go → api/dto/dto.go b/types/dto/dto.go → api/dto/dto.go
diff --git a/router/middleware/ginzap.go → api/middleware/ginzap.go b/router/middleware/ginzap.go → api/middleware/ginzap.go
@@ -5,8 +5,8 @@ import (
 	"time"
 
 	"github.com/gin-gonic/gin"
+	"{{.Module}}/internal/trace"
 	"{{.Module}}/pkg/bytespool"
-	"{{.Module}}/trace"
 	"go.uber.org/zap"
 )
 

diff --git a/router/middleware/index.go → api/middleware/index.go b/router/middleware/index.go → api/middleware/index.go
@@ -5,7 +5,7 @@ import (
 	"sync/atomic"
 
 	"github.com/gin-gonic/gin"
-	"{{.Module}}/trace"
+	"{{.Module}}/internal/trace"
 )
 
 type (

diff --git a/router/middleware/recovery.go → api/middleware/recovery.go b/router/middleware/recovery.go → api/middleware/recovery.go
@@ -9,7 +9,7 @@ import (
 	"strings"
 
 	"github.com/gin-gonic/gin"
-	"{{.Module}}/trace"
+	"{{.Module}}/internal/trace"
 	"go.uber.org/zap"
 )
 

diff --git a/router/router.go → api/server.go b/router/router.go → api/server.go
@@ -1,13 +1,13 @@
-package router
+package api
 
 import (
 	"net/http"
 
 	"github.com/gin-gonic/gin"
-	"{{.Module}}/logger"
-	"{{.Module}}/option"
-	"{{.Module}}/router/api"
-	"{{.Module}}/router/middleware"
+	"{{.Module}}/api/middleware"
+	v1 "{{.Module}}/api/v1"
+	"{{.Module}}/internal/logger"
+	"{{.Module}}/internal/option"
 )
 
 // BuildRouter 构造Router
@@ -21,9 +21,9 @@ func BuildRouter(option option.RouterOption) *gin.Engine {
 		middleware.Ginzap(logger.Logger, option.MergeLog, option.DumpResponse),
 	)
 
-	group := router.Group("/api")
+	group := router.Group("/v1")
 	{
-		group.POST("/user", api.CreateUser)
+		group.POST("/user", v1.CreateUser)
 	}
 
 	router.GET("/ping", func(c *gin.Context) {

diff --git a/router/api/api.go → api/v1/api.go b/router/api/api.go → api/v1/api.go
@@ -1,12 +1,12 @@
-package api
+package v1
 
 import (
 	"net/http"
 
 	"github.com/gin-gonic/gin"
-	"{{.Module}}/application"
-	"{{.Module}}/trace"
-	"{{.Module}}/types/dto"
+	"{{.Module}}/api/dto"
+	"{{.Module}}/internal/application"
+	"{{.Module}}/internal/trace"
 )
 
 func CreateUser(c *gin.Context) {

diff --git a/cmd/main.go b/cmd/main.go
@@ -9,12 +9,12 @@ import (
 	"syscall"
 	"time"
 
-	"{{.Module}}/application"
-	"{{.Module}}/infrastructure/persistence"
-	"{{.Module}}/logger"
-	"{{.Module}}/option"
+	"{{.Module}}/api"
+	"{{.Module}}/internal/application"
+	"{{.Module}}/internal/infrastructure/persistence"
+	"{{.Module}}/internal/logger"
+	"{{.Module}}/internal/option"
 	"{{.Module}}/pkg/infection"
-	"{{.Module}}/router"
 	"go.uber.org/zap"
 )
 
@@ -42,7 +42,7 @@ func main() {
 	application.BuildUserApplication(ur)
 
 	// 启动运行web server
-	eng := router.BuildRouter(opt.Router)
+	eng := api.BuildRouter(opt.Router)
 
 	// 服务启动
 	srv := &http.Server{

diff --git a/application/converter.go → internal/application/converter.go b/application/converter.go → internal/application/converter.go
@@ -1,8 +1,8 @@
 package application
 
 import (
-	"{{.Module}}/domain/user"
-	"{{.Module}}/types/dto"
+	"{{.Module}}/api/dto"
+	"{{.Module}}/internal/domain/user"
 )
 
 func convertUser(user *user.UserEntity) *dto.UserDTO {

diff --git a/application/handler/user.go → internal/application/handler/user.go b/application/handler/user.go → internal/application/handler/user.go
@@ -3,10 +3,10 @@ package handler
 import (
 	"context"
 
-	"{{.Module}}/domain/event"
-	"{{.Module}}/domain/user"
-	"{{.Module}}/logger"
-	"{{.Module}}/trace"
+	"{{.Module}}/internal/domain/event"
+	"{{.Module}}/internal/domain/user"
+	"{{.Module}}/internal/logger"
+	"{{.Module}}/internal/trace"
 	"go.uber.org/zap"
 )
 

diff --git a/application/user.go → internal/application/user.go b/application/user.go → internal/application/user.go
@@ -3,12 +3,12 @@ package application
 import (
 	"context"
 
-	"{{.Module}}/application/handler"
-	"{{.Module}}/domain/event"
-	"{{.Module}}/domain/user"
-	"{{.Module}}/logger"
-	"{{.Module}}/trace"
-	"{{.Module}}/types/dto"
+	"{{.Module}}/api/dto"
+	"{{.Module}}/internal/application/handler"
+	"{{.Module}}/internal/domain/event"
+	"{{.Module}}/internal/domain/user"
+	"{{.Module}}/internal/logger"
+	"{{.Module}}/internal/trace"
 	"go.uber.org/zap"
 )
 

diff --git a/domain/event/events.go → internal/domain/event/events.go b/domain/event/events.go → internal/domain/event/events.go
diff --git a/domain/event/mediator.go → internal/domain/event/mediator.go b/domain/event/mediator.go → internal/domain/event/mediator.go
@@ -3,8 +3,8 @@ package event
 import (
 	"context"
 
-	"{{.Module}}/logger"
-	"{{.Module}}/trace"
+	"{{.Module}}/internal/logger"
+	"{{.Module}}/internal/trace"
 	"go.uber.org/zap"
 )
 

diff --git a/domain/user/event.go → internal/domain/user/event.go b/domain/user/event.go → internal/domain/user/event.go
@@ -1,6 +1,6 @@
 package user
 
-import "{{.Module}}/domain/event"
+import "{{.Module}}/internal/domain/event"
 
 type (
 	EventUserCreated struct {

diff --git a/domain/user/repository.go → internal/domain/user/repository.go b/domain/user/repository.go → internal/domain/user/repository.go
diff --git a/domain/user/user.go → internal/domain/user/user.go b/domain/user/user.go → internal/domain/user/user.go
@@ -3,7 +3,7 @@ package user
 import (
 	"errors"
 
-	"{{.Module}}/domain/event"
+	"{{.Module}}/internal/domain/event"
 )
 
 type UserEntity struct {

diff --git a/types/do/do.go → internal/infrastructure/do/do.go b/types/do/do.go → internal/infrastructure/do/do.go
diff --git a/infrastructure/persistence/converter.go → ...l/infrastructure/persistence/converter.go b/infrastructure/persistence/converter.go → ...l/infrastructure/persistence/converter.go
@@ -1,8 +1,8 @@
 package persistence
 
 import (
-	"{{.Module}}/domain/user"
-	"{{.Module}}/types/do"
+	"{{.Module}}/internal/domain/user"
+	"{{.Module}}/internal/infrastructure/do"
 )
 
 func convertUser(entity *user.UserEntity) *do.UserDo {

diff --git a/infrastructure/persistence/database.go → ...al/infrastructure/persistence/database.go b/infrastructure/persistence/database.go → ...al/infrastructure/persistence/database.go
@@ -4,8 +4,8 @@ import (
 	"fmt"
 
 	_ "github.com/go-sql-driver/mysql"
-	"{{.Module}}/logger"
-	"{{.Module}}/option"
+	"{{.Module}}/internal/logger"
+	"{{.Module}}/internal/option"
 	"go.uber.org/zap"
 	"xorm.io/xorm"
 )

diff --git a/infrastructure/persistence/user.go → internal/infrastructure/persistence/user.go b/infrastructure/persistence/user.go → internal/infrastructure/persistence/user.go
@@ -3,7 +3,7 @@ package persistence
 import (
 	"context"
 
-	"{{.Module}}/domain/user"
+	"{{.Module}}/internal/domain/user"
 	"xorm.io/xorm"
 )
 

diff --git a/logger/logger.go → internal/logger/logger.go b/logger/logger.go → internal/logger/logger.go
@@ -1,7 +1,7 @@
 package logger
 
 import (
-	"{{.Module}}/option"
+	"{{.Module}}/internal/option"
 	"github.com/jacexh/goutil/zaphelper"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"

diff --git a/logger/xorm.go → internal/logger/xorm.go b/logger/xorm.go → internal/logger/xorm.go
@@ -3,7 +3,7 @@ package logger
 import (
 	"fmt"
 
-	"{{.Module}}/trace"
+	"{{.Module}}/internal/trace"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
 	"xorm.io/xorm/log"

diff --git a/option/option.go → internal/option/option.go b/option/option.go → internal/option/option.go
diff --git a/trace/context.go → internal/trace/context.go b/trace/context.go → internal/trace/context.go
diff --git a/trace/gin.go → internal/trace/gin.go b/trace/gin.go → internal/trace/gin.go
diff --git a/trace/zap.go → internal/trace/zap.go b/trace/zap.go → internal/trace/zap.go