Golang 常见设计模式——装饰模式详细讲解

JSON 2022-04-01 14:50:35 3499

想必只要是熟悉   Python   的同学对装饰模式一定不会陌生,这类   Python   从语法上原生支持的装饰器,大大提高了装饰模式在   Python   中的应用。尽管   Go   语言中装饰模式没有   Python   中应用的那么广泛,但是它也有其独到的地方。接下来就一起看下装饰模式在   Go   语言中的应用。

简单装饰器

我们通过一个简单的例子来看一下装饰器的简单应用,首先编写一个 hello 函数:

package main

import "fmt"

func hello() {
    fmt.Println("Hello World!")
}

func main() {
    hello()
}

完成上面代码后,执行会输出“Hello World!”。接下来通过以下方式,在打印“Hello World!”前后各加一行日志:

package main

import "fmt"

func hello() {
    fmt.Println("before")
    fmt.Println("Hello World!")
    fmt.Println("after")
}

func main() {
    hello()
}

代码执行后输出:

before
Hello World!
after

当然我们可以选择一个更好的实现方式,即单独编写一个专门用来打印日志的 logger 函数,示例如下:

package main

import "fmt"

func logger(f func()) func() {
    return func() {
        fmt.Println("before")
        f()
        fmt.Println("after")
    }
}

func hello() {
    fmt.Println("Hello World!")
}

func main() {
    hello := logger(hello)
    hello()
}

可以看到 logger 函数接收并返回了一个函数,且参数和返回值的函数签名同 hello 一样。然后我们在原来调用 hello()的位置进行如下修改:

hello := logger(hello)
hello()

这样我们通过 logger 函数对 hello 函数的包装,更加优雅的实现了给 hello 函数增加日志的功能。执行后的打印结果仍为:

before
Hello World!
after

其实 logger 函数也就是我们在   Python   中经常使用的装饰器,因为 logger 函数不仅可以用于 hello,还可以用于其他任何与 hello 函数有着同样签名的函数。

当然如果想使用   Python   中装饰器的写法,我们可以这样做:

package main

import "fmt"

func logger(f func()) func() {
    return func() {
        fmt.Println("before")
        f()
        fmt.Println("after")
    }
}

// 给 hello 函数打上 logger 装饰器
@logger
func hello() {
    fmt.Println("Hello World!")
}

func main() {
    // hello 函数调用方式不变
    hello()
}

但很遗憾,上面的程序无法通过编译。因为   Go   语言目前还没有像   Python   语言一样从语法层面提供对装饰器语法糖的支持。

装饰器实现中间件

尽管 Go 语言中装饰器的写法不如 Python 语言精简,但它被广泛运用于 Web 开发场景的中间件组件中。比如 Gin Web 框架的如下代码,只要使用过就肯定会觉得熟悉:

package main

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

func main() {
    r := gin.New()

    // 使用中间件
    r.Use(gin.Logger(), gin.Recovery())

    r.GET("/ping", func(c *gin.Context) {
        c.JSON(200, gin.H{
            "message": "pong",
        })
    })
    _ = r.Run(":8888")
}

如示例中使用 gin.Logger() 增加日志,使用 gin.Recovery() 来处理 panic 异常一样,在 Gin 框架中可以通过 r.Use(middlewares...) 的方式给路由增加非常多的中间件,来方便我们拦截路由处理函数,并在其前后分别做一些处理逻辑。

而 Gin 框架的中间件正是使用装饰模式来实现的。下面我们借用 Go 语言自带的 http 库进行一个简单模拟。这是一个简单的 Web Server 程序,其监听 8888 端口,当访问 /hello 路由时会进入 handleHello 函数逻辑:

package main

import (
    "fmt"
    "net/http"
)

func loggerMiddleware(f http.HandlerFunc) http.HandlerFunc {
    return func(w http.ResponseWriter, r *http.Request) {
        fmt.Println("before")
        f(w, r)
        fmt.Println("after")
    }
}

func authMiddleware(f http.HandlerFunc) http.HandlerFunc {
    return func(w http.ResponseWriter, r *http.Request) {
        if token := r.Header.Get("token"); token != "fake_token" {
            _, _ = w.Write([]byte("unauthorized\n"))
            return
        }
        f(w, r)
    }
}

func handleHello(w http.ResponseWriter, r *http.Request) {
    fmt.Println("handle hello")
    _, _ = w.Write([]byte("Hello World!\n"))
}

func main() {
    http.HandleFunc("/hello", authMiddleware(loggerMiddleware(handleHello)))
    fmt.Println(http.ListenAndServe(":8888", nil))
}

我们分别使用 loggerMiddleware、authMiddleware 函数对 handleHello 进行了包装,使其支持打印访问日志和认证校验功能。如果我们还需要加入其他中间件拦截功能,可以通过这种方式进行无限包装。

启动这个 Server 来验证下装饰器:



    对结果进行简单分析可以看到,第一次请求 /hello 接口时,由于没有携带认证 token,收到了 unauthorized 响应。第二次请求时携带了 token,则得到响应“Hello World!”,并且后台程序打印如下日志:

    before
    handle hello
    after

    这说明中间件执行顺序是先由外向内进入,再由内向外返回。而这种一层一层包装处理逻辑的模型有一个非常形象且贴切的名字,洋葱模型。


    但用洋葱模型实现的中间件有一个直观的问题。相比于 Gin 框架的中间件写法,这种一层层包裹函数的写法不如 Gin 框架提供的 r.Use(middlewares...) 写法直观。

    Gin 框架源码的中间件和 handler 处理函数实际上被一起聚合到了路由节点的 handlers 属性中。其中 handlers 属性是 HandlerFunc 类型切片。对应到用 http 标准库实现的 Web Server 中,就是满足 func(ResponseWriter, *Request) 类型的 handler 切片。

    当路由接口被调用时,Gin 框架就会像流水线一样依次调用执行 handlers 切片中的所有函数,再依次返回。这种思想也有一个形象的名字,就叫作流水线(Pipeline)。


    接下来我们要做的就是将 handleHello 和两个中间件 loggerMiddleware、authMiddleware 聚合到一起,同样形成一个 Pipeline。

    package main
    
    import (
        "fmt"
        "net/http"
    )
    
    func authMiddleware(f http.HandlerFunc) http.HandlerFunc {
        return func(w http.ResponseWriter, r *http.Request) {
            if token := r.Header.Get("token"); token != "fake_token" {
                _, _ = w.Write([]byte("unauthorized\n"))
                return
            }
            f(w, r)
        }
    }
    
    func loggerMiddleware(f http.HandlerFunc) http.HandlerFunc {
        return func(w http.ResponseWriter, r *http.Request) {
            fmt.Println("before")
            f(w, r)
            fmt.Println("after")
        }
    }
    
    type handler func(http.HandlerFunc) http.HandlerFunc
    
    // 聚合 handler 和 middleware
    func pipelineHandlers(h http.HandlerFunc, hs ...handler) http.HandlerFunc {
        for i := range hs {
            h = hs[i](h)
        }
        return h
    }
    
    func handleHello(w http.ResponseWriter, r *http.Request) {
        fmt.Println("handle hello")
        _, _ = w.Write([]byte("Hello World!\n"))
    }
    
    func main() {
        http.HandleFunc("/hello", pipelineHandlers(handleHello, loggerMiddleware, authMiddleware))
        fmt.Println(http.ListenAndServe(":8888", nil))
    }

    我们借用 pipelineHandlers 函数将 handler 和 middleware 聚合到一起,实现了让这个简单的 Web Server 中间件用法跟 Gin 框架用法相似的效果。

    再次启动 Server 进行验证:



    改造成功,跟之前使用洋葱模型写法的结果如出一辙。

    简单了解了 Go 语言中如何实现装饰模式后,我们通过一个 Web Server 程序中间件,学习了装饰模式在 Go 语言中的应用。

    最后总结

    需要注意的是,尽管 Go 语言实现的装饰器有类型上的限制,不如 Python 装饰器那般通用。就像我们最终实现的 pipelineHandlers 不如 Gin 框架中间件强大,比如不能延迟调用,通过 c.Next() 控制中间件调用流等。但不能因为这样就放弃,因为 GO 语言装饰器依然有它的用武之地。

    Go 语言是静态类型语言不像 Python 那般灵活,所以在实现上要多费一点力气。希望通过这个简单的示例,相信对大家深入学习 Gin 框架有所帮助。



    版权所属:SO JSON在线解析

    原文地址:https://www.sojson.com/blog/388.html

    转载时必须以链接形式注明原始出处及本声明。

    本文主题:

    如果本文对你有帮助,那么请你赞助我,让我更有激情的写下去,帮助更多的人。

    关于作者
    一个低调而闷骚的男人。
    相关文章
    JavaScript怎么识别360浏览器?JS识别360急速模式方案,360流氓浏览器
    Maven的Mirror和Repository 的详细讲解
    Linux 安装 Redis 详细步骤讲解
    document.domain解决跨域问题,详细讲解
    Freemarker Macro,Freemarker 宏参数传递详细讲解
    SEO 之 SpringMVC redirect 301,301和302区别详细讲解
    Plupload 上传详细讲解,Plupload 多实例上传,Plupload多个上传按钮
    Bootstrap Affix 插件 高级用法详细讲解
    HttpClient 获取详细的头信息
    BlockingQueue 方法详细描述
    最新文章
    Golang 常见设计模式之单例模式 4281
    两招提升硬盘存储数据的写入效率 3553
    【程序员的实用工具推荐】 Mac 效率神器 Alfred 3008
    自媒体时代的贤内助——AI 视频云 2493
    如何处理大体积 XLSX/CSV/TXT 文件? 1845
    AI 视频云 VS 窄带高清,谁是视频时代的宠儿 1452
    Golang 常见设计模式——装饰模式详细讲解 3499
    Flink 在又拍云日志批处理中的实践 17010
    个推异常值检测和实战应用-又拍云 4446
    TCP 和 UDP协议详细讲解,优缺点分析讲解 13228
    最热文章
    苹果电脑Mac怎么恢复出厂系统?苹果系统怎么重装系统? 669898
    最新MyEclipse8.5注册码,有效期到2020年 (已经更新) 643286
    免费天气API,全国天气 JSON API接口,可以获取五天的天气预报 562943
    Jackson 时间格式化,时间注解 @JsonFormat 用法、时差问题说明 527613
    我为什么要选择RabbitMQ ,RabbitMQ简介,各种MQ选型对比 504155
    Elasticsearch教程(四) elasticsearch head 插件安装和使用 472769
    免费天气API,天气JSON API,不限次数获取十五天的天气预报 428989
    Java 信任所有SSL证书,HTTPS请求抛错,忽略证书请求完美解决 238405
    Jackson 美化输出JSON,优雅的输出JSON数据,格式化输出JSON数据... ... 219525
    谈谈斐讯路由器劫持,你用斐讯路由器,你需要知道的事情 215663
    支付扫码

    所有赞助/开支都讲公开明细,用于网站维护:赞助名单查看

    查看我的收藏

    正在加载... ...