手把手教你使用gomonkey落地Go AOP

引言

AOP(Aspect-Oriented Programming,面向切面编程)是一种编程范式,旨在通过将横切关注点(如日志、事务管理等)从业务逻辑中分离出来,从而提高软件的模块化能力,增强应用程序的可维护性和可复用性。

gomonkey 是笔者开源的一款 Go 语言 的打桩框架,目标是让用户在单元测试中低成本的完成打桩,从而将精力聚焦于业务功能的开发。gomonkey 接口友好,功能强大,目前已被很多项目使用,用户遍及世界多个国家。尽管gomonkey主要用于单元测试,但也非常适用于落地Go AOP编程,且不要求用户增加静态代理(Proxy模式)。

应用案例

下面我们将通过实际案例,展示如何利用gomonkey在Go语言中落地AOP编程,重点展示其原理和应用价值。

函数案例

以下是一个简单的例子,展示了如何使用gomonkey对AddRemove函数进行AOP编程:

package main

import (
    "errors"
    "fmt"

    . "github.com/agiledragon/gomonkey/v2"
)

var (
    ErrActual       = errors.New("actual")
    ErrElemExsit    = errors.New("elem already exist")
    ErrElemNotExsit = errors.New("elem not exist")
)

var slice []int

func Add(elem int) error {
    for _, v := range slice {
        if v == elem {
            fmt.Printf("Slice: Add elem: %v already exist\n", elem)
            return ErrElemExsit
        }
    }
    slice = append(slice, elem)
    fmt.Printf("Slice: Add elem: %v succ\n", elem)
    return nil
}

func Remove(elem int) error {
    found := false
    for i, v := range slice {
        if v == elem {
            if i == len(slice)-1 {
                slice = (slice)[:i]

            } else {
                slice = append((slice)[:i], (slice)[i+1:]...)
            }
            found = true
            break
        }
    }
    if !found {
        fmt.Printf("Slice: Remove elem: %v not exist\n", elem)
        return ErrElemNotExsit
    }
    fmt.Printf("Slice: Remove elem: %v succ\n", elem)
    return nil
}

func main() {
    patches := NewPatches()
    patches.ApplyFunc(Add, func(elem int) error {
        fmt.Println("Go AOP begin for Slice: Add elem: ", elem)
        patches.Origin(func() {
            _ = Add(elem)
        })
        fmt.Println("Go AOP end for Slice: Add elem: ", elem)
        return nil
    })

    patches.ApplyFunc(Remove, func(elem int) error {
        fmt.Println("Go AOP begin for Slice: Remove elem: ", elem)
        patches.Origin(func() {
            _ = Remove(elem)
        })
        fmt.Println("Go AOP end for Slice: Remove elem: ", elem)
        return nil
    })
    _ = Add(1)
    _ = Add(1)
    _ = Remove(1)
    _ = Add(1)
}

运行程序:符合预期

bogon:main zhangxiaolong$ go run -gcflags=all=-l main.go
Go AOP begin for Slice: Add elem:  1
Slice: Add elem: 1 succ
Go AOP end for Slice: Add elem:  1
Go AOP begin for Slice: Add elem:  1
Slice: Add elem: 1 already exist
Go AOP end for Slice: Add elem:  1
Go AOP begin for Slice: Remove elem:  1
Slice: Remove elem: 1 succ
Go AOP end for Slice: Remove elem:  1
Go AOP begin for Slice: Add elem:  1
Slice: Add elem: 1 succ

关键点说明:

  • 前置和后置逻辑:通过gomonkey框架,我们在AddRemove函数执行前后插入了日志打印语句。这是AOP的典型应用,允许我们在不修改原始函数代码的情况下增加额外的功能。
  • 动态打桩:使用gomonkey进行的打桩是动态的,这意味着我们可以在运行时插入或修改行为,非常灵活。
  • 价值体现:这种方式使得代码更加模块化,业务逻辑与辅助功能(如日志记录)清晰分离,增强了代码的可维护性和可测试性。

方法案例

接下来是对对象方法的AOP应用:

package main

import (
    "errors"
    "fmt"

    . "github.com/agiledragon/gomonkey/v2"
)

var (
    ErrActual       = errors.New("actual")
    ErrElemExsit    = errors.New("elem already exist")
    ErrElemNotExsit = errors.New("elem not exist")
)

type Slice []int

func NewSlice() Slice {
    return make(Slice, 0)
}

func (this *Slice) Add(elem int) error {
    for _, v := range *this {
        if v == elem {
            fmt.Printf("Slice: Add elem: %v already exist\n", elem)
            return ErrElemExsit
        }
    }
    *this = append(*this, elem)
    fmt.Printf("Slice: Add elem: %v succ\n", elem)
    return nil
}

func (this *Slice) Remove(elem int) error {
    found := false
    for i, v := range *this {
        if v == elem {
            if i == len(*this)-1 {
                *this = (*this)[:i]

            } else {
                *this = append((*this)[:i], (*this)[i+1:]...)
            }
            found = true
            break
        }
    }
    if !found {
        fmt.Printf("Slice: Remove elem: %v not exist\n", elem)
        return ErrElemNotExsit
    }
    fmt.Printf("Slice: Remove elem: %v succ\n", elem)
    return nil
}

func main() {
    patches := NewPatches()
    patches.ApplyFunc(NewSlice, func() Slice {
        fmt.Println("Go AOP begin for NewSlice")
        s := make(Slice, 0)
        var slice *Slice
        patches.ApplyMethodFunc(slice, "Add", func(elem int) error {
            fmt.Println("Go AOP begin for Slice: Add elem: ", elem)
            patches.Origin(func() {
                _ = s.Add(elem)
            })
            fmt.Println("Go AOP end for Slice: Add elem: ", elem)
            return nil
        })
        patches.ApplyMethodFunc(slice, "Remove", func(elem int) error {
            fmt.Println("Go AOP begin for Slice: Remove elem: ", elem)
            patches.Origin(func() {
                _ = s.Remove(elem)
            })
            fmt.Println("Go AOP end for Slice: Remove elem: ", elem)
            return nil
        })
        return s
    })

    slice := NewSlice()
    _ = slice.Add(1)
    _ = slice.Add(1)
    _ = slice.Remove(1)
    _ = slice.Add(1)
}

运行程序:符合预期

bogon:main zhangxiaolong$ go run -gcflags=all=-l main.go
Go AOP begin for NewSlice
Go AOP begin for Slice: Add elem:  1
Slice: Add elem: 1 succ
Go AOP end for Slice: Add elem:  1
Go AOP begin for Slice: Add elem:  1
Slice: Add elem: 1 already exist
Go AOP end for Slice: Add elem:  1
Go AOP begin for Slice: Remove elem:  1
Slice: Remove elem: 1 succ
Go AOP end for Slice: Remove elem:  1
Go AOP begin for Slice: Add elem:  1
Slice: Add elem: 1 succ
Go AOP end for Slice: Add elem:  1

关键点说明:

  • 封装性和灵活性:通过对Slice类型的方法进行打桩,我们在保持封装性的同时,增加了灵活性,使得可以对成员函数进行类似的前后逻辑增强。
  • 适用性:这种方法同样适用于任何需要在方法调用前后执行额外操作的场景,如权限验证和事务处理等。

总结

基于gomonkey可以无侵入且低成本的落地Go AOP编程,从而提升软件的模块化和可扩展性能力,特别适合处理那些需要在运行时动态改变行为的复杂系统。

本来通过案例手把手教你落地了函数和方法的Go AOP编程,我们不仅看到了如何实际应用gomonkey进行AOP编程,也理解了其带来的结构上的优势。这些技术可以广泛应用于日志、安全和事务管理等多个领域,极大地提高软件的可重用性和可维护性。

然而,需要强调的是,目前gomonkey的打桩是全局的,非并发安全,所以在高并发系统中应用gomonkey要非常慎重。我们在单元测试实践中,测试用例都是串行执行的,暂时规避了这个问题。从长远来看,支持并发安全是gomonkey的重要目标,我们计划后续通过协程来隔离桩函数,让用户打桩更美好!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,013评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,205评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,370评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,168评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,153评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,954评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,271评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,916评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,382评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,877评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,989评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,624评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,209评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,199评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,418评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,401评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,700评论 2 345

推荐阅读更多精彩内容