Go语言的函数可以一次返回多个结果。这就为我们温和地报告错误提供了语言级别的支持。实际上,这也是Go语言中处理错误的惯用法之一。我们先来回顾前一小节的例子:
func readFile(path string) ([]byte, error) { file, err := os.Open(path) if err != nil { return nil, err } defer file.Close() return ioutil.ReadAll(file) }
函数readFile
有两个结果声明。第二个结果声明的类型是error
。error
是Go语言内置的一个接口类型。它的声明是这样的:
type error interface { Error() string }
显然,只要一个类型的方法集合包含了名为Error
、无参数声明且仅声明了一个string
类型的结果的方法,就相当于实现了error
接口。os.Open
函数的第二个结果值就的类型就是这样的。我们把它赋给了变量err
。也许你已经意识到,在Go语言中,函数与其调用方之间温和地传递错误的方法即是如此。
在调用了os.Open
函数并取得其结果之后,我们判断err
是否为nil
。如果答案是肯定的,那么就直接把该错误(这里由err
代表)返回给调用方。这条if
语句实际上是一条卫述语句。这样的语句会检查流程中的某个步骤是否存在异常,并在必要时中止流程并报告给上层的程序(这里是调用方)。在Go语言的标准库以及很多第三方库中,我们经常可以看到这样的代码。我们也建议大家在自己的程序中善用这样的卫述语句。
现在我们把目光聚焦到readFile
函数中的最后一条语句上。这是一条return
语句。它把对ioutil.ReadAll
函数的调用的结果直接作为readFile
函数的结果返回了。实际上,ioutil.ReadAll
函数的结果声明列表与readFile
的结果声明列表是一致的。也就是说,它们声明的结果的数量、类型和顺序都是相同的。因此,我们才能够做这种返回结果上的“嫁接”。这又是一个Go语言编码中的惯用法。
好了,在知晓怎样在传递错误之后,让我们来看看怎样创造错误。没错,在很多时候,我们需要创造出错误(即error
类型的值)并把它传递给上层程序。这很简单。只需调用标准库代码包errors
的New
函数即可。例如,我们只要在readFile
函数的开始处加入下面这段代码就可以更快的在参数值无效时告知调用方:
if path == "" { return nil, errors.New("The parameter is invalid!") }
errors.New
是一个很常用的函数。在Go语言标准库的代码包中有很多由此函数创建出来的错误值,比如os.ErrPermission
、io.EOF
等变量的值。我们可以很方便地用操作符==
来判断一个error
类型的值与这些变量的值是否相等,从而来确定错误的具体类别。就拿io.EOF
来说,它代表了一个信号。该信号用于通知数据读取方已无更多数据可读。我们在得到这样一个错误的时候不应该把它看成一个真正的错误,而应该只去结束相应的读取操作。请看下面的示例:
br := bufio.NewReader(file) var buf bytes.Buffer for { ba, isPrefix, err := br.ReadLine() if err != nil { if err == io.EOF { break } fmt.Printf("Error: %s\n", err) break } buf.Write(ba) if !isPrefix { buf.WriteByte('\n') } }
可以看到,这段代码使用到了前面示例中的变量file
。它的功能是把file
代表的文件中的所有内容都读取到一个缓冲器(由变量buf
代表)中。请注意,该示例中的第6~8行代码。如果判定err
代表的错误值等于io.EOF
的值(即它们是同一个值),那么我们只需退出当前的循环以使读取操作结束即可。
总之,只要能够善用error
接口、errors.New
函数和比较操作符==
,我们就可以玩儿转Go语言中的一般错误处理。
命令源码文件index.go的功能是读取自己的内容。这其中用到了readFile
函数。请注意,我把这个函数中的最后一条语句替换成了return read(file)
。你现在的任务是,结合本节“知识要点”中的最后一段代码编写出一个完整的read
函数,使得该文件可以正确地被运行,并在标准输出打印出index.go文件的内容。
该文件中的导入语句中已列出了所有可能会用到的标准库代码包。在Go语言官方的文档网站上可以查到其中各种程序实体的用法。
注意:由于本编程课件中无法模拟真实的程序运行环境,所以它读取index.go文件的操作是不会成功的。请你把index.go中的代码(包括你写的read
函数)复制到一台Linux或Mac机器上再加以运行。
package main import ( "bufio" "bytes" "fmt" "io" "os" "path/filepath" ) func readFile(path string) ([]byte, error) { parentPath, err := os.Getwd() if err != nil { return nil, err } fullPath := filepath.Join(parentPath, path) file, err := os.Open(fullPath) if err != nil { return nil, err } defer file.Close() return read(file) } func main() { path := "index.go" ba, err := readFile(path) if err != nil { fmt.Printf("Error: %s\n", err) } fmt.Printf("The content of '%s':\n%s\n", path, ba) }