UP | HOME

Map-Reduce

Table of Contents

在本篇文章中，学习一下函数式编程的中非常重要的Map、Reduce、Filter的三种操作，这三种操作可以非常方便灵活地进行一些数据处理

程序中大多数情况下都是在到倒腾数据，尤其对于一些需要统计的业务场景，Map/Reduce/Filter是非常通用的玩法

基本示例

Map

下面的程序代码中，写了两个Map函数，这两个函数需要两个参数：

  • 一个是字符串数组 []string ，说明需要处理的数据一个字符串
  • 另一个是一个函数 func(s string) string 或 func(s string) int
func MapStrToStr(arr []string, fn func(s string) string) []string {
        var newArray = []string{}
        for _, it := range arr {
                newArray = append(newArray, fn(it))
        }
        return newArray
}

func MapStrToInt(arr []string, fn func(s string) int) []int {
        var newArray = []int{}
        for _, it := range arr {
                newArray = append(newArray, fn(it))
        }
        return newArray
}

整个Map函数运行逻辑都很相似：
1. 函数体都是在遍历第一个参数的数组
2. 调用第二个参数的函数
3. 把其值组合成另一个数组返回

于是可以这样使用这两个函数： 

var list = []string{"Hao", "Chen", "MegaEase"}
x := MapStrToStr(list, func(s string) string {
    return strings.ToUpper(s)
})

fmt.Printf("%v\n", x) //["HAO", "CHEN", "MEGAEASE"]

y := MapStrToInt(list, func(s string) int {
    return len(s)
})

fmt.Printf("%v\n", y) //[3, 4, 8]

可以看到，给第一个 MapStrToStr() 传了函数做的是 转大写，于是出来的数组就成了全大写的

给MapStrToInt() 传的是算其长度，所以出来的数组是每个字符串的长度。

Reduce & Filter

再来看一下Reduce和Filter的函数是什么样的： 

func Reduce(arr []string, fn func(s string) int) int {
        sum := 0
        for _, it := range arr {
                sum += fn(it)
        }
        return sum
}

var list = []string{"Hao", "Chen", "MegaEase"}

x := Reduce(list, func(s string) int {
        return len(s)
})

fmt.Printf("%v\n", x) // 15

func Filter(arr []int, fn func(n int) bool) []int {
        var newArray = []int{}
        for _, it := range arr {
                if fn(it) {
                        newArray = append(newArray, it)
                }
        }
        return newArray
}

var intset = []int{1, 2, 3, 4, 5, 6, 7, 8, 9, 10}
out := Filter(intset, func(n int) bool {
        return n%2 == 1
})
fmt.Printf("%v\n", out)

out = Filter(intset, func(n int) bool {
        return n > 5
})

fmt.Printf("%v\n", out)

业务示例

通过上面的一些示例，可能有一些明白，Map/Reduce/Filter只是一种控制逻辑，真正的业务逻辑是在传给他们的数据和那个函数来定义的

这是一个很经典的“业务逻辑”和“控制逻辑”分离解耦的编程模式

下面来看一个有业务意义的代码，来让大家强化理解一下什么叫“控制逻辑”与”业务逻辑“分离

员工信息

首先，有一个员工对象，以及一些数据： 

type Employee struct {
        Name     string
        Age      int
        Vacation int
        Salary   int
}
var list = []Employee{
        {"Hao", 44, 0, 8000},
        {"Bob", 34, 10, 5000},
        {"Alice", 23, 5, 9000},
        {"Jack", 26, 0, 4000},
        {"Tom", 48, 9, 7500},
        {"Marry", 29, 0, 6000},
        {"Mike", 32, 8, 4000},
}

相关的Reduce/Fitler函数

然后有如下的几个函数： 

func EmployeeCountIf(list []Employee, fn func(e *Employee) bool) int {
        count := 0
        for i, _ := range list {
                if fn(&list[i]) {
                        count += 1
                }
        }
        return count
}

func EmployeeFilterIn(list []Employee, fn func(e *Employee) bool) []Employee {
        var newList []Employee
        for i, _ := range list {
                if fn(&list[i]) {
                        newList = append(newList, list[i])
                }
        }
        return newList
}

func EmployeeSumIf(list []Employee, fn func(e *Employee) int) int {
        var sum = 0
        for i, _ := range list {
                sum += fn(&list[i])
        }
        return sum
}

简单说明一下：

  • EmployeeConutIf 和 EmployeeSumIf 分别用于统满足某个条件的个数或总数。它们都是Filter + Reduce的语义
  • EmployeeFilterIn 就是按某种条件过虑。就是Fitler的语义

各种自定义的统计示例

现在就可以有如下的代码：

  • 统计有多少员工大于40岁
old := EmployeeCountIf(list, func(e *Employee) bool {
        return e.Age > 40
})

fmt.Printf("old people: %d\n", old) //old people: 2
  • 统计有多少员工薪水大于6000
high_pay := EmployeeCountIf(list, func(e *Employee) bool {
        return e.Salary >= 6000
})
fmt.Printf("High Salary people: %d\n", high_pay) //High Salary people: 4
  • 列出有没有休假的员工
no_vacation := EmployeeFilterIn(list, func(e *Employee) bool {
        return e.Vacation == 0
})
fmt.Printf("People no vacation: %v\n", no_vacation) //People no vacation: [{Hao 44 0 8000} {Jack 26 0 4000} {Marry 29 0 6000}]
  • 统计所有员工的薪资总和
total_pay := EmployeeSumIf(list, func(e *Employee) int {
        return e.Salary
})

fmt.Printf("Total Salary: %d\n", total_pay) //Total Salary: 43500
  • 统计30岁以下员工的薪资总和
younger_pay := EmployeeSumIf(list, func(e *Employee) int {
    if e.Age < 30 {
        return e.Salary
    } 
    return 0
})

fmt.Printf("Younger Salary: %d\n", younger_pay) // Younger Salary: 19000

泛型Map-Reduce

上面的Map-Reduce都因为要处理数据的类型不同而需要写出不同版本的Map-Reduce，虽然他们的代码看上去是很类似的。所以，这里就要带出来泛型编程了 

Go开发团队技术负责人Russ Cox在golang-dev上的mail确认了Go泛型(type parameter)将在Go 1.18版本落地，即2022.2月份

简单版 Generic Map

目前的Go语言的泛型只能用 interface{} + reflect 来完成：

  • interface{}： 可以理解为C中的 void* ，Java中的 Object
  • reflect：Go的 反射机制包 ，用于在运行时检查类型

先来看一下一个非常简单 不作任何类型检查 的 泛型的 Map函数： 

func Map(data interface{}, fn interface{}) []interface{} {
        vfn := reflect.ValueOf(fn)
        vdata := reflect.ValueOf(data)
        result := make([]interface{}, vdata.Len())

        for i := 0; i < vdata.Len(); i++ {
                result[i] = vfn.Call([]reflect.Value{vdata.Index(i)})[0].Interface()
        }
        return result
}

上面的代码中，

  • 通过 reflect.ValueOf() 来获得 interface{} 的值：
    • 一个是数据 vdata
    • 另一个是函数 vfn
  • 通过 vfn.Call() 方法来 调用函数
  • 通过 []refelct.Value{vdata.Index(i)} 来 获得数据
Go语言中的反射的语法还是有点令人费解的，但是简单看一下手册还是能够读懂的

现在对于不同类型的数据可以使用相同逻辑的Map()代码： 

square := func(x int) int {
        return x * x
}
nums := []int{1, 2, 3, 4}

squared_arr := Map(nums,square)
fmt.Println(squared_arr) //[1 4 9 16]

upcase := func(s string) string {
        return strings.ToUpper(s)
}

strs := []string{"Hao", "Chen", "MegaEase"}
upstrs := Map(strs, upcase);
fmt.Println(upstrs) //[HAO CHEN MEGAEASE]

但是因为反射是运行时的事，所以，如果类型什么出问题的话，就会有运行时的错误。比如： 

x := Map(5, 5)
fmt.Println(x)

上面的代码可以编译通过，但是在运行时就出问题： 

panic: reflect: call of reflect.Value.Len on int Value

goroutine 1 [running]:
reflect.Value.Len(0x4a6240, 0x4dcda0, 0x82, 0x4708fc)
        /usr/local/go/src/reflect/value.go:1163 +0x185
main.Map(0x4a6240, 0x4dcda0, 0x4a6240, 0x4dcda8, 0x1, 0x14, 0x0)
        /home/klose/Documents/programming/html/klose911.github.io/src/go/go-patterns/src/map_reduce/simple_generic_map.go:12 +0x16b
main.main()
        /home/klose/Documents/programming/html/klose911.github.io/src/go/go-patterns/src/map_reduce/simple_generic_map.go:36 +0x25c
exit status 2

健壮版的Generic Map

因此如果要写一个健壮的程序，对于这种用interface{} 的“过度泛型”，就需要自己来做类型检查

下面是一个有类型检查的Map代码： 

func Transform(slice, function interface{}) interface{} {
        return transform(slice, function, false)
}

func TransformInPlace(slice, function interface{}) interface{} {
        return transform(slice, function, true)
}

func transform(slice, function interface{}, inPlace bool) interface{} {

        //check the `slice` type is Slice
        sliceInType := reflect.ValueOf(slice)
        if sliceInType.Kind() != reflect.Slice {
                panic("transform: not slice")
        }

        //check the function signature
        fn := reflect.ValueOf(function)
        elemType := sliceInType.Type().Elem()
        if !verifyFuncSignature(fn, elemType, nil) {
                panic("trasform: function must be of type func(" + sliceInType.Type().Elem().String() + ") outputElemType")
        }

        sliceOutType := sliceInType
        if !inPlace {
                sliceOutType = reflect.MakeSlice(reflect.SliceOf(fn.Type().Out(0)), sliceInType.Len(), sliceInType.Len())
        }

        for i := 0; i < sliceInType.Len(); i++ {
                sliceOutType.Index(i).Set(fn.Call([]reflect.Value{sliceInType.Index(i)})[0])
        }
        return sliceOutType.Interface()

}

func verifyFuncSignature(fn reflect.Value, types ...reflect.Type) bool {

        //Check it is a funciton
        if fn.Kind() != reflect.Func {
                return false
        }

        // NumIn() - returns a function type's input parameter count.
        // NumOut() - returns a function type's output parameter count.
        if (fn.Type().NumIn() != len(types)-1) || (fn.Type().NumOut() != 1) {
                return false
        }

        // In() - returns the type of a function type's i'th input parameter.
        for i := 0; i < len(types)-1; i++ {
                if fn.Type().In(i) != types[i] {
                        return false
                }
        }

        // Out() - returns the type of a function type's i'th output parameter.
        outType := types[len(types)-1]
        if outType != nil && fn.Type().Out(0) != outType {
                return false
        }
        return true
}

上面的代码一下子就复杂起来了，可见，复杂的代码都是在处理异常的地方

下面列几个代码中的要点：

  • 代码中没有使用Map函数，因为和数据结构和关键有含义冲突的问题，所以使用 Transform ，这个来源于 C++ STL库中的命名
  • 有两个版本的函数
    • 一个是返回一个全新的数组: Transform()
    • 一个是“就地完成”: TransformInPlace()
  • 在 主函数 中，用 Kind() 方法 检查 了 数据类型 是不是 Slice ， 函数类型 是不是 Func
  • 检查 函数的 参数 和 返回类型 是通过 verifyFuncSignature() 来完成的，其中：
    • NumIn(): 用来检查函数的“入参”
    • NumOut() 用来检查函数的“返回值”
  • 如果需要新生成一个Slice，会使用 reflect.MakeSlice() 来完成

有了上面的这段代码，就很可以很开心的使用了：

  • 可以用于字符串数组
list := []string{"1", "2", "3", "4", "5", "6"}
result := Transform(list, func(a string) string{
        return a +a +a
}) //{"111","222","333","444","555","666"}
  • 可以用于整形数组
list := []int{1, 2, 3, 4, 5, 6, 7, 8, 9}
TransformInPlace(list, func (a int) int {
        return a*3
}) //{3, 6, 9, 12, 15, 18, 21, 24, 27}
  • 可以用于结构体
var list = []Employee{
        {"Hao", 44, 0, 8000},
        {"Bob", 34, 10, 5000},
        {"Alice", 23, 5, 9000},
        {"Jack", 26, 0, 4000},
        {"Tom", 48, 9, 7500},
}

result := TransformInPlace(list, func(e Employee) Employee {
        e.Salary += 1000
        e.Age += 1
        return e
}) // // [{Hao 45 0 9000} {Bob 35 10 6000} {Alice 24 5 10000} {Jack 27 0 5000} {Tom 49 9 8500}]

健壮版的 Generic Reduce

泛型版的 Reduce 代码如下： 

func Reduce(slice, pairFunc, zero interface{}) interface{} {
        sliceInType := reflect.ValueOf(slice)
        if sliceInType.Kind() != reflect.Slice {
                panic("reduce: wrong type, not slice")
        }

        len := sliceInType.Len()
        if len == 0 {
                return zero
        } else if len == 1 {
                return sliceInType.Index(0)
        }

        elemType := sliceInType.Type().Elem()
        fn := reflect.ValueOf(pairFunc)
        if !verifyFuncSignature(fn, elemType, elemType, elemType) {
                t := elemType.String()
                panic("reduce: function must be of type func(" + t + ", " + t + ") " + t)
        }

        var ins [2]reflect.Value
        ins[0] = sliceInType.Index(0)
        ins[1] = sliceInType.Index(1)
        out := fn.Call(ins[:])[0]

        for i := 2; i < len; i++ {
                ins[0] = out
                ins[1] = sliceInType.Index(i)
                out = fn.Call(ins[:])[0]
        }
        return out.Interface()
}

健壮版的 Generic Filter

泛型版的 Filter 代码如下： 

func Filter(slice, function interface{}) interface{} {
        result, _ := filter(slice, function, false)
        return result
}

func FilterInPlace(slicePtr, function interface{}) {
        in := reflect.ValueOf(slicePtr)
        if in.Kind() != reflect.Ptr {
                panic("FilterInPlace: wrong type, " +
                        "not a pointer to slice")
        }
        _, n := filter(in.Elem().Interface(), function, true)
        in.Elem().SetLen(n)
}

var boolType = reflect.ValueOf(true).Type()

func filter(slice, function interface{}, inPlace bool) (interface{}, int) {

        sliceInType := reflect.ValueOf(slice)
        if sliceInType.Kind() != reflect.Slice {
                panic("filter: wrong type, not a slice")
        }

        fn := reflect.ValueOf(function)
        elemType := sliceInType.Type().Elem()
        if !verifyFuncSignature(fn, elemType, boolType) {
                panic("filter: function must be of type func(" + elemType.String() + ") bool")
        }

        var which []int
        for i := 0; i < sliceInType.Len(); i++ {
                if fn.Call([]reflect.Value{sliceInType.Index(i)})[0].Bool() {
                        which = append(which, i)
                }
        }

        out := sliceInType

        if !inPlace {
                out = reflect.MakeSlice(sliceInType.Type(), len(which), len(which))
        }
        for i := range which {
                out.Index(i).Set(sliceInType.Index(which[i]))
        }

        return out.Interface(), len(which)
}

1. 使用反射来做这些东西，会有一个问题，那就是代码的性能会很差。所以，上面的代码不能用于需要高性能的地方

2. 上面的代码大量的参考了 Rob Pike的版本，他的代码在 https://github.com/robpike/filter

3. 其实，在全世界范围内，有大量的程序员都在问Go语言官方什么时候在标准库中支持 Map/Reduce，Rob Pike说，这种东西难写吗？还要官方来帮你们写么？这种代码我多少年前就写过了，但是，我从来一次都没有用过，我还是喜欢用“For循环”，我觉得你最好也跟我一起用 “For循环”

Next：代码生成器

Previous：委托模式

Home：目录