go 手写框架-1 路由组织

零 Golang教程评论78字数 1879阅读6分15秒阅读模式

go 手写框架-1 路由组织

前言

这可以算是一个非主流的框架,但其实它更接近于一个实践项目,而非高度封装的框架。它不像通常框架那样拥有繁多的接口和复杂的封装,而是将所有功能直接体现在代码中,使得开发者能够一目了然地理解其意义,并轻松地根据需要进行修改。

这个框架的仓库地址是goDemoX。文章源自灵鲨社区-https://www.0s52.com/bcjc/golangjc/16339.html

  • 功能齐全:包括admin用户管理、登录、权限及角色管理,且前后端功能完备。
  • 可观测性强:内置日志、追踪、指标等可观测性解决方案,方便开发者进行问题定位和性能调优。
  • 文档与测试完备:提供方便的文档交流和测试解决方案,确保代码质量。
  • 自动化管理:支持task自动化管理,包括测试、文档生成、开发及部署等流程。
  • 完善的测试代码:为了保证代码的稳定性和可维护性,该框架拥有完善的测试代码。
  • 技术栈丰富:涉及的技术栈包括gin、gorm、redis等。

这个框架几乎可以拿来即用,但由于其涉及的功能和知识点较多,我将通过一系列文章来详细介绍其实现原理和使用方法。本文将首先探讨gin代码的路由组织。文章源自灵鲨社区-https://www.0s52.com/bcjc/golangjc/16339.html

gin代码的路由组织

在web开发中,路由是任何API框架的核心。gin框架以其简洁的API和强大的中间件功能,使得路由的组织变得异常灵活和方便。文章源自灵鲨社区-https://www.0s52.com/bcjc/golangjc/16339.html

gin允许我们根据需要对路由进行分组,例如按照功能、权限或其他标准进行分组。这种分组方式不仅使代码结构更加清晰,还便于我们进行权限控制、中间件管理等操作。文章源自灵鲨社区-https://www.0s52.com/bcjc/golangjc/16339.html

下面是一个简单的示例代码,演示了如何使用gin进行路由分组:文章源自灵鲨社区-https://www.0s52.com/bcjc/golangjc/16339.html

golang

复制代码

package main

import (
    "github.com/gin-gonic/gin"
)

// 顶层路由组织
type Router struct {
    Root *gin.RouterGroup
    Jwt  *gin.RouterGroup //jwt登陆
    Auth *gin.RouterGroup //权限
}

func JwtMiddler() gin.HandlerFunc {
    return func(context *gin.Context) {

       //...jwt校验逻辑
       context.Next()
       //...
    }
}
func AuthMiddler() gin.HandlerFunc {
    return func(context *gin.Context) {

       //...权限校验逻辑
       context.Next()
       //...
    }
}

func NewRouter(g *gin.Engine) *Router {
    return &Router{
       Root: g.Group("/api"),
       Jwt:  g.Group("/api", JwtMiddler()),
       Auth: g.Group("/api", AuthMiddler()),
    }
}

type (
    IHandler interface {
       Do() error
    }
    HandlerFunc func(c *gin.Context) IHandler
)

// api Handler
type ApiHandler struct {
    ctx *gin.Context
}

func NewApiHandler(ctx *gin.Context) IHandler {
    return &ApiHandler{ctx}
}

func (this *ApiHandler) Do() error {
    this.ctx.String(200, "hello world")
    return nil
}

// 异常统一处理
func Do(f HandlerFunc) func(c *gin.Context) {
    return func(c *gin.Context) {

       if err := f(c).Do(); err != nil {
          c.JSON(400, gin.H{"error": err.Error})
       }
    }
}

func main() {
    g := gin.Default()
    router := NewRouter(g)
    router.Root.GET("/test", Do(NewApiHandler))
    g.Run(":8080")
}

这个代码首先定义了router类,所有顶级路由分组都以这个对象为基础,后期想要添加中间件或者添加新的路由分组,可以很容易实现。文章源自灵鲨社区-https://www.0s52.com/bcjc/golangjc/16339.html

业务代码为ApiHandler,实现一个Do()error接口,主要为了实现统一错误处理。文章源自灵鲨社区-https://www.0s52.com/bcjc/golangjc/16339.html

最后通过router.Root.GET("/test", Do(NewApiHandler))这句代码把handler和路由关联到一起。文章源自灵鲨社区-https://www.0s52.com/bcjc/golangjc/16339.html

这是核心代码,为了说明问题,并没有进行任何的目录结构组织。文章源自灵鲨社区-https://www.0s52.com/bcjc/golangjc/16339.html

其他

一个server服务包括什么?配置文件,日志,cli,form表单校验,统一的Response响应,方便的handler代码编写,甚至可观测性。。。。文章源自灵鲨社区-https://www.0s52.com/bcjc/golangjc/16339.html

东西不少,一点点记录下来。

零
  • 转载请务必保留本文链接:https://www.0s52.com/bcjc/golangjc/16339.html
    本社区资源仅供用于学习和交流,请勿用于商业用途
    未经允许不得进行转载/复制/分享

发表评论