5.3. 多返回值

在Go中，一个函数可以返回多个值。我们已经在之前例子中看到，许多标准库中的函数返回2个值，一个是期望得到的返回值，另一个是函数出错时的错误信息。下面的例子会展示如何编写多返回值的函数。

下面的程序是findlinks的改进版本。修改后的findlinks可以自己发起HTTP请求，这样我们就不必再运行fetch。因为HTTP请求和解析操作可能会失败，因此findlinks声明了2个返回值：链接列表和错误信息。一般而言，HTML的解析器可以处理HTML页面的错误结点，构造出HTML页面结构，所以解析HTML很少失败。这意味着如果findlinks函数失败了，很可能是由于I/O的错误导致的。

gopl.io/ch5/findlinks2

  1. func main() {
  2.     for _, url := range os.Args[1:] {
  3.         links, err := findLinks(url)
  4.         if err != nil {
  5.             fmt.Fprintf(os.Stderr, "findlinks2: %v\n", err)
  6.             continue
  7.         }
  8.         for _, link := range links {
  9.             fmt.Println(link)
  10.         }
  11.     }
  12. }
  14. // findLinks performs an HTTP GET request for url, parses the
  15. // response as HTML, and extracts and returns the links.
  16. func findLinks(url string) ([]string, error) {
  17.     resp, err := http.Get(url)
  18.     if err != nil {
  19.         return nil, err
  20.     }
  21.     if resp.StatusCode != http.StatusOK {
  22.         resp.Body.Close()
  23.         return nil, fmt.Errorf("getting %s: %s", url, resp.Status)
  24.     }
  25.     doc, err := html.Parse(resp.Body)
  26.     resp.Body.Close()
  27.     if err != nil {
  28.         return nil, fmt.Errorf("parsing %s as HTML: %v", url, err)
  29.     }
  30.     return visit(nil, doc), nil
  31. }

在findlinks中，有4处return语句，每一处return都返回了一组值。前三处return，将http和html包中的错误信息传递给findlinks的调用者。第一处return直接返回错误信息，其他两处通过fmt.Errorf（§7.8）输出详细的错误信息。如果findlinks成功结束，最后的return语句将一组解析获得的连接返回给用户。

在findlinks中，我们必须确保resp.Body被关闭，释放网络资源。虽然Go的垃圾回收机制会回收不被使用的内存，但是这不包括操作系统层面的资源，比如打开的文件、网络连接。因此我们必须显式的释放这些资源。

调用多返回值函数时，返回给调用者的是一组值，调用者必须显式的将这些值分配给变量:

  1. links, err := findLinks(url)

如果某个值不被使用，可以将其分配给blank identifier:

  1. links, _ := findLinks(url) // errors ignored

一个函数内部可以将另一个有多返回值的函数调用作为返回值，下面的例子展示了与findLinks有相同功能的函数，两者的区别在于下面的例子先输出参数：

  1. func findLinksLog(url string) ([]string, error) {
  2.     log.Printf("findLinks %s", url)
  3.     return findLinks(url)
  4. }

当你调用接受多参数的函数时，可以将一个返回多参数的函数调用作为该函数的参数。虽然这很少出现在实际生产代码中，但这个特性在debug时很方便，我们只需要一条语句就可以输出所有的返回值。下面的代码是等价的：

  1. log.Println(findLinks(url))
  2. links, err := findLinks(url)
  3. log.Println(links, err)

准确的变量名可以传达函数返回值的含义。尤其在返回值的类型都相同时，就像下面这样：

  1. func Size(rect image.Rectangle) (width, height int)
  2. func Split(path string) (dir, file string)
  3. func HourMinSec(t time.Time) (hour, minute, second int)

虽然良好的命名很重要，但你也不必为每一个返回值都取一个适当的名字。比如，按照惯例，函数的最后一个bool类型的返回值表示函数是否运行成功，error类型的返回值代表函数的错误信息，对于这些类似的惯例，我们不必思考合适的命名，它们都无需解释。

如果一个函数所有的返回值都有显式的变量名，那么该函数的return语句可以省略操作数。这称之为bare return。

  1. // CountWordsAndImages does an HTTP GET request for the HTML
  2. // document url and returns the number of words and images in it.
  3. func CountWordsAndImages(url string) (words, images int, err error) {
  4.     resp, err := http.Get(url)
  5.     if err != nil {
  6.         return
  7.     }
  8.     doc, err := html.Parse(resp.Body)
  9.     resp.Body.Close()
  10.     if err != nil {
  11.         err = fmt.Errorf("parsing HTML: %s", err)
  12.         return
  13.     }
  14.     words, images = countWordsAndImages(doc)
  15.     return
  16. }
  17. func countWordsAndImages(n *html.Node) (words, images int) { /* ... */ }

按照返回值列表的次序，返回所有的返回值，在上面的例子中，每一个return语句等价于：

  1. return words, images, err

当一个函数有多处return语句以及许多返回值时，bare return 可以减少代码的重复，但是使得代码难以被理解。举个例子，如果你没有仔细的审查代码，很难发现前2处return等价于 return 0,0,err（Go会将返回值 words和images在函数体的开始处，根据它们的类型，将其初始化为0），最后一处return等价于 return words, image, nil。基于以上原因，不宜过度使用bare return。

练习 5.5： 实现countWordsAndImages。（参考练习4.9如何分词）

练习 5.6： 修改gopl.io/ch3/surface（§3.2）中的corner函数，将返回值命名，并使用bare return。