【更新】更新restful

This commit is contained in:
PandaGoAdmin
2022-08-03 16:00:32 +08:00
parent 2cb23c0ecf
commit 6945277fdb
48 changed files with 1234 additions and 836 deletions

View File

@@ -1,83 +1,47 @@
package initialize
import (
"fmt"
"pandax/pkg/global"
"pandax/pkg/transport"
ginSwagger "github.com/swaggo/gin-swagger"
"github.com/swaggo/gin-swagger/swaggerFiles"
devRouter "pandax/apps/develop/router"
jobRouter "pandax/apps/job/router"
logRouter "pandax/apps/log/router"
resRouter "pandax/apps/resource/router"
sysRouter "pandax/apps/system/router"
"pandax/pkg/middleware"
_ "pandax/docs"
"net/http"
"github.com/gin-gonic/gin"
)
func InitRouter() *gin.Engine {
func InitRouter() *transport.HttpServer {
// server配置
serverConfig := global.Conf.Server
gin.SetMode(serverConfig.Model)
server := transport.NewHttpServer(serverConfig.GetPort())
var router = gin.New()
router.MaxMultipartMemory = 8 << 20
// 没有路由即 404返回
router.NoRoute(func(g *gin.Context) {
g.JSON(http.StatusNotFound, gin.H{"code": 404, "msg": fmt.Sprintf("not found '%s:%s'", g.Request.Method, g.Request.URL.Path)})
})
// 设置静态资源
if staticConfs := serverConfig.Static; staticConfs != nil {
for _, scs := range *staticConfs {
router.Static(scs.RelativePath, scs.Root)
}
}
// 设置静态文件
if staticFileConfs := serverConfig.StaticFile; staticFileConfs != nil {
for _, sfs := range *staticFileConfs {
router.StaticFile(sfs.RelativePath, sfs.Filepath)
}
}
container := server.Container
// 是否允许跨域
if serverConfig.Cors {
router.Use(middleware.Cors())
container.Filter(middleware.Cors(container).Filter)
}
// 流量限制
if serverConfig.Rate.Enable {
router.Use(middleware.Rate())
container.Filter(middleware.Rate)
}
// api接口
router.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
// 设置路由组
sys := router.Group("system")
{
sysRouter.InitSysTenantRouter(sys)
sysRouter.InitSystemRouter(sys)
sysRouter.InitDeptRouter(sys)
sysRouter.InitConfigRouter(sys)
sysRouter.InitApiRouter(sys)
sysRouter.InitDictRouter(sys)
sysRouter.InitMenuRouter(sys)
sysRouter.InitRoleRouter(sys)
sysRouter.InitPostRouter(sys)
sysRouter.InitUserRouter(sys)
sysRouter.InitNoticeRouter(sys)
sysRouter.InitSysTenantRouter(container)
sysRouter.InitSystemRouter(container)
sysRouter.InitDeptRouter(container)
sysRouter.InitConfigRouter(container)
sysRouter.InitApiRouter(container)
sysRouter.InitDictRouter(container)
sysRouter.InitMenuRouter(container)
sysRouter.InitRoleRouter(container)
sysRouter.InitPostRouter(container)
sysRouter.InitUserRouter(container)
sysRouter.InitNoticeRouter(container)
}
// 任务
job := router.Group("job")
/*// 任务
{
jobRouter.InitJobRouter(job)
jobRouter.InitJobRouter()
}
//日志系统
log := router.Group("log")
@@ -95,6 +59,9 @@ func InitRouter() *gin.Engine {
{
resRouter.InitResOssRouter(res)
resRouter.InitResEmailsRouter(res)
}
return router
}*/
// api接口
middleware.SwaggerConfig(container)
//http.Handle("/apidocs/", http.StripPrefix("/apidocs/", http.FileServer(http.Dir("/Users/emicklei/Projects/swagger-ui/dist"))))
return server
}

View File

@@ -1,27 +1,17 @@
package middleware
import (
"net/http"
"github.com/gin-gonic/gin"
"github.com/emicklei/go-restful/v3"
)
// 处理跨域请求,支持options访问
func Cors() gin.HandlerFunc {
return func(c *gin.Context) {
method := c.Request.Method
origin := c.Request.Header.Get("Origin")
c.Header("Access-Control-Allow-Origin", origin)
c.Header("Access-Control-Allow-Headers", "Content-Type,AccessToken,X-CSRF-Token, Authorization, Token,X-Token,X-User-Id")
c.Header("Access-Control-Allow-Methods", "POST, GET, OPTIONS,DELETE,PUT")
c.Header("Access-Control-Expose-Headers", "Content-Length, Access-Control-Allow-Origin, Access-Control-Allow-Headers, Content-Type")
c.Header("Access-Control-Allow-Credentials", "true")
func Cors(wsContainer *restful.Container) restful.CrossOriginResourceSharing {
cors := restful.CrossOriginResourceSharing{
ExposeHeaders: []string{"Content-Length", "Access-Control-Allow-Origin", "Access-Control-Allow-Headers", "Content-Type"},
AllowedHeaders: []string{"Content-Type", "AccessToken", "X-CSRF-Token", "Authorization", "Token", "X-Token", "X-User-Id"},
AllowedMethods: []string{"POST", "GET", "OPTIONS", "DELETE", "PUT"},
CookiesAllowed: false,
Container: wsContainer}
// 放行所有OPTIONS方法
if method == "OPTIONS" {
c.AbortWithStatus(http.StatusNoContent)
}
// 处理请求
c.Next()
}
return cors
}

View File

@@ -9,7 +9,7 @@ import (
)
func OperationHandler(rc *restfulx.ReqCtx) error {
c := rc.GinCtx
c := rc.Request
// 请求操作不做记录
if c.Request.Method == http.MethodGet || rc.LoginAccount == nil {
return nil
@@ -23,8 +23,8 @@ func OperationHandler(rc *restfulx.ReqCtx) error {
Method: c.Request.Method,
OperName: rc.LoginAccount.UserName,
OperUrl: c.Request.URL.Path,
OperIp: c.ClientIP(),
OperLocation: utils.GetRealAddressByIP(c.ClientIP()),
OperIp: c.Request.RemoteAddr,
OperLocation: utils.GetRealAddressByIP(c.Request.RemoteAddr),
OperParam: "",
Status: "0",
}

View File

@@ -2,7 +2,7 @@ package middleware
import (
"github.com/didip/tollbooth"
"github.com/gin-gonic/gin"
"github.com/emicklei/go-restful/v3"
"pandax/pkg/global"
)
@@ -12,17 +12,14 @@ import (
* @Date 2022/1/19 8:28
**/
//限流中间件
func Rate() gin.HandlerFunc {
//Rate 限流中间件
func Rate(req *restful.Request, resp *restful.Response, chain *restful.FilterChain) {
lmt := tollbooth.NewLimiter(global.Conf.Server.Rate.RateNum, nil)
lmt.SetMessage("已经超出接口请求限制,稍后再试.")
return func(c *gin.Context) {
httpError := tollbooth.LimitByRequest(lmt, c.Writer, c.Request)
if httpError != nil {
c.Data(httpError.StatusCode, lmt.GetMessageContentType(), []byte(httpError.Message))
c.Abort()
} else {
c.Next()
}
httpError := tollbooth.LimitByRequest(lmt, resp, req.Request)
if httpError != nil {
resp.WriteErrorString(httpError.StatusCode, httpError.Message)
return
}
chain.ProcessFilter(req, resp)
}

44
pkg/middleware/swagger.go Normal file
View File

@@ -0,0 +1,44 @@
package middleware
import (
restfulspec "github.com/emicklei/go-restful-openapi/v2"
"github.com/emicklei/go-restful/v3"
"github.com/go-openapi/spec"
)
/**
* @Description
* @Author 熊猫
* @Date 2022/8/3 9:16
**/
func SwaggerConfig(wsContainer *restful.Container) {
config := restfulspec.Config{
WebServices: wsContainer.RegisteredWebServices(),
APIPath: "/apidocs.json",
PostBuildSwaggerObjectHandler: enrichSwaggerObject}
wsContainer.Add(restfulspec.NewOpenAPIService(config))
}
func enrichSwaggerObject(swo *spec.Swagger) {
swo.Info = &spec.Info{
InfoProps: spec.InfoProps{
Title: "Pandax API",
Description: "Restful Api",
Contact: &spec.ContactInfo{
ContactInfoProps: spec.ContactInfoProps{
Name: "PandaX",
Email: "PandaX@doe.rp",
URL: "https://github.com/XM-GO/PandaX",
},
},
License: &spec.License{
LicenseProps: spec.LicenseProps{
Name: "MIT",
URL: "https://github.com/XM-GO/PandaX",
},
},
Version: "1.0.0",
},
}
}

View File

@@ -0,0 +1,48 @@
package transport
import (
"context"
"fmt"
"google.golang.org/grpc"
"net"
"pandax/pkg/global"
)
type GrpcServer struct {
Addr string
srv *grpc.Server
}
func NewServer(addr string) *GrpcServer {
return &GrpcServer{
Addr: addr,
srv: grpc.NewServer(),
}
}
func (s *GrpcServer) GetServe() *grpc.Server {
return s.srv
}
func (s *GrpcServer) Type() Type {
return TypeGRPC
}
func (s *GrpcServer) Start(ctx context.Context) error {
l, err := net.Listen("tcp", s.Addr)
if err != nil {
return fmt.Errorf("error listen addr: %w", err)
}
global.Log.Debugf("GRPC Server listen: %s", s.Addr)
go func() {
if err := s.srv.Serve(l); err != nil {
global.Log.Errorf("error http serve: %s", err)
}
}()
return nil
}
func (s *GrpcServer) Stop(ctx context.Context) error {
s.srv.Stop()
return nil
}

View File

@@ -0,0 +1,59 @@
package transport
import (
"context"
"github.com/XM-GO/PandaKit/logger"
"github.com/emicklei/go-restful/v3"
"net/http"
"pandax/pkg/global"
)
type HttpServer struct {
Addr string
srv *http.Server
Container *restful.Container
}
func NewHttpServer(addr string) *HttpServer {
c := restful.NewContainer()
c.EnableContentEncoding(true)
restful.TraceLogger(&httpLog{})
restful.SetLogger(&httpLog{})
return &HttpServer{
Addr: addr,
Container: c,
srv: &http.Server{
Addr: addr,
Handler: c,
},
}
}
func (s *HttpServer) Type() Type {
return TypeHTTP
}
func (s *HttpServer) Start(ctx context.Context) error {
global.Log.Debugf("HTTP Server listen: %s", s.Addr)
go func() {
if err := s.srv.ListenAndServe(); err != nil {
global.Log.Errorf("error http serve: %s", err)
}
}()
return nil
}
func (s *HttpServer) Stop(ctx context.Context) error {
return s.srv.Shutdown(ctx)
}
type httpLog struct{}
func (t *httpLog) Print(v ...any) {
logger.Log.Debug(v...)
}
func (t *httpLog) Printf(format string, v ...any) {
logger.Log.Debugf(format, v...)
}

View File

@@ -0,0 +1,19 @@
package transport
import (
"context"
)
type Type string
const (
TypeHTTP Type = "HTTP"
TypeGRPC Type = "GRPC"
)
// Server is transport server.
type Server interface {
Type() Type
Start(context.Context) error
Stop(context.Context) error
}