简介

上一篇文章介绍了mergo库的使用,mergo是用来给结构体或map赋值的。mergo有一个明显的不足——它只能处理相同类型的结构!如果类型不同,即使字段名和类型完全相同,mergo也无能为力。今天我们要介绍的copier库就能处理不同类型之间的赋值。除此之外,copier还能:

  • 调用同名方法为字段赋值;
  • 以源对象字段为参数调用目标对象的方法,从而为目标对象赋值(当然也可以做其它的任何事情);
  • 将切片赋值给切片(可以是不同类型哦);
  • 将结构体追加到切片中。

感谢@thinkgos推荐。

顺带一提,作者是国人jinzhu大佬,如果你想找一个 Go 语言的 ORM 库,gorm你值得拥有!

快速使用

先安装:

  1. $ go get github.com/jinzhu/copier

后使用:

  1. package main
  2. import (
  3. "fmt"
  4. "github.com/jinzhu/copier"
  5. )
  6. type User struct {
  7. Name string
  8. Age int
  9. }
  10. type Employee struct {
  11. Name string
  12. Age int
  13. Role string
  14. }
  15. func main() {
  16. user := User{Name: "dj", Age: 18}
  17. employee := Employee{}
  18. copier.Copy(&employee, &user)
  19. fmt.Printf("%#v\n", employee)
  20. }

很好理解,就是将user对象中的字段赋值到employee的同名字段中。如果目标对象中没有同名的字段,则该字段被忽略。

高级特性

方法赋值

目标对象中的一些字段,源对象中没有,但是源对象有同名的方法。这时Copy会调用这个方法,将返回值赋值给目标对象中的字段:

  1. type User struct {
  2. Name string
  3. Age int
  4. }
  5. func (u *User) DoubleAge() int {
  6. return 2 * u.Age
  7. }
  8. type Employee struct {
  9. Name string
  10. DoubleAge int
  11. Role string
  12. }
  13. func main() {
  14. user := User{Name: "dj", Age: 18}
  15. employee := Employee{}
  16. copier.Copy(&employee, &user)
  17. fmt.Printf("%#v\n", employee)
  18. }

我们给User添加一个DoubleAge方法。Employee结构有字段DoubleAgeUser中没有,但是User有一个同名的方法,这时Copy调用userDoubleAge方法为employeeDoubleAge赋值,得到 36。

调用目标方法

有时候源对象中的某个字段没有出现在目标对象中,但是目标对象有一个同名的方法,方法接受一个同类型的参数,这时Copy会以源对象的这个字段作为参数调用目标对象的该方法:

  1. type User struct {
  2. Name string
  3. Age int
  4. Role string
  5. }
  6. type Employee struct {
  7. Name string
  8. Age int
  9. SuperRole string
  10. }
  11. func (e *Employee) Role(role string) {
  12. e.SuperRole = "Super" + role
  13. }
  14. func main() {
  15. user := User{Name: "dj", Age: 18, Role: "Admin"}
  16. employee := Employee{}
  17. copier.Copy(&employee, &user)
  18. fmt.Printf("%#v\n", employee)
  19. }

我们给Employee添加了一个Role方法,User的字段Role没有出现在Employee中,但是Employee有一个同名方法。Copy函数内部会以user对象的Role字段为参数调用employeeRole方法。最终,我们的employee对象的SuperRole值变为SuperAdmin。实际上,这个方法中可以执行任何操作,不一定是赋值。

切片赋值

使用一个切片来为另一个切片赋值。如果类型相同,那好办,直接append就行。如果类型不同呢?copier就派上大用场了:

  1. type User struct {
  2. Name string
  3. Age int
  4. }
  5. type Employee struct {
  6. Name string
  7. Age int
  8. Role string
  9. }
  10. func main() {
  11. users := []User{
  12. {Name: "dj", Age: 18},
  13. {Name: "dj2", Age: 18},
  14. }
  15. employees := []Employee{}
  16. copier.Copy(&employees, &users)
  17. fmt.Printf("%#v\n", employees)
  18. }

这个实际上就是将源切片中每个元素分别赋值到目标切片中。

将结构赋值到切片

这个不难,实际上就是根据源对象生成一个和目标切片类型相符合的对象,然后append到目标切片中:

  1. type User struct {
  2. Name string
  3. Age int
  4. }
  5. type Employee struct {
  6. Name string
  7. Age int
  8. Role string
  9. }
  10. func main() {
  11. user := User{Name: "dj", Age: 18}
  12. employees := []Employee{}
  13. copier.Copy(&employees, &user)
  14. fmt.Printf("%#v\n", employees)
  15. }

上面代码中,Copy先通过user生成一个Employee对象,然后append到切片employees中。

汇总

最后将所有的特性汇总在一个例子中,其实就是Copier的 GitHub 仓库首页的例子:

  1. type User struct {
  2. Name string
  3. Age int
  4. Role string
  5. }
  6. func (u *User) DoubleAge() int {
  7. return u.Age * 2
  8. }
  9. type Employee struct {
  10. Name string
  11. Age int
  12. SuperRole string
  13. }
  14. func (e *Employee) Role(role string) {
  15. e.SuperRole = "Super" + role
  16. }
  17. func main() {
  18. var (
  19. user = User{Name: "dj", Age: 18}
  20. users = []User{
  21. {Name: "dj", Age: 18, Role: "Admin"},
  22. {Name: "dj2", Age: 18, Role: "Dev"},
  23. }
  24. employee = Employee{}
  25. employees = []Employee{}
  26. )
  27. copier.Copy(&employee, &user)
  28. fmt.Printf("%#v\n", employee)
  29. copier.Copy(&employees, &user)
  30. fmt.Printf("%#v\n", employees)
  31. // employees = []Employee{}
  32. copier.Copy(&employees, &users)
  33. fmt.Printf("%#v\n", employees)
  34. }

上面例子中,我故意把employees = []Employee{}这一行注释掉,最后输出的employees是 3 个元素,能更清楚的看出切片到切片是append的,目标切片原来的元素还是保留的。

总结

copier库的代码量很小,用了不到 200 行的代码就实现了如此实用的一个功能,非常值得一看!

大家如果发现好玩、好用的 Go 语言库,欢迎到 Go 每日一库 GitHub 上提交 issue😄

参考

  1. copier GitHub:https://github.com/jinzhu/copier
  2. Go 每日一库 GitHub:https://github.com/go-quiz/go-daily-lib