错误处理

GO语言以error类型标识错误，BOS支持两种错误见下表：

错误类型说明
BceClientError用户操作产生的错误
BceServiceErrorBOS服务返回的错误

用户使用SDK调用BOS相关接口，除了返回所需的结果之外还会返回错误，用户可以获取相关错误进行处理。实例如下：

  1. // bosClient 为已创建的BOS Client对象
  2. bucketLocation, err := bosClient.PutBucket("test-bucket")
  3. if err != nil {
  4.     switch realErr := err.(type) {
  5.     case *bce.BceClientError:
  6.         fmt.Println("client occurs error:", realErr.Error())
  7.     case *bce.BceServiceError:
  8.         fmt.Println("service occurs error:", realErr.Error())
  9.     default:
  10.         fmt.Println("unknown error:", err)
  11.     }
  12. } else {
  13.     fmt.Println("create bucket success, bucket location:", bucketLocation)
  14. }

客户端异常

客户端异常表示客户端尝试向BOS发送请求以及数据传输时遇到的异常。例如，当发送请求时网络连接不可用时，则会返回BceClientError；当上传文件时发生IO异常时，也会抛出BceClientError。

服务端异常

当BOS服务端出现异常时，BOS服务端会返回给用户相应的错误信息，以便定位问题。常见服务端异常可参见BOS错误信息格式

SDK日志

BOS GO SDK自行实现了支持六个级别、三种输出（标准输出、标准错误、文件）、基本格式设置的日志模块，导入路径为github.com/baidubce/bce-sdk-go/util/log。输出为文件时支持设置五种日志滚动方式（不滚动、按天、按小时、按分钟、按大小），此时还需设置输出日志文件的目录。详见示例代码。

默认日志

BOS GO SDK自身使用包级别的全局日志对象，该对象默认情况下不记录日志，如果需要输出SDK相关日志需要用户自定指定输出方式和级别，详见如下示例：

  1. // import "github.com/baidubce/bce-sdk-go/util/log"
  3. // 指定输出到标准错误，输出INFO及以上级别
  4. log.SetLogHandler(log.STDERR)
  5. log.SetLogLevel(log.INFO)
  7. // 指定输出到标准错误和文件，DEBUG及以上级别，以1GB文件大小进行滚动
  8. log.SetLogHandler(log.STDERR | log.FILE)
  9. log.SetLogDir("/tmp/gosdk-log")
  10. log.SetRotateType(log.ROTATE_SIZE)
  11. log.SetRotateSize(1 << 30)
  13. // 输出到标准输出，仅输出级别和日志消息
  14. log.SetLogHandler(log.STDOUT)
  15. log.SetLogFormat([]string{log.FMT_LEVEL, log.FMT_MSG})

说明：

  • 日志默认输出级别为DEBUG
  • 如果设置为输出到文件，默认日志输出目录为/tmp，默认按小时滚动
  • 如果设置为输出到文件且按大小滚动，默认滚动大小为1GB
  • 默认的日志输出格式为：FMT_LEVEL, FMT_LTIME, FMT_LOCATION, FMT_MSG

项目使用

该日志模块无任何外部依赖，用户使用GO SDK开发项目，可以直接引用该日志模块自行在项目中使用，用户可以继续使用GO SDK使用的包级别的日志对象，也可创建新的日志对象，详见如下示例：

  1. // 直接使用包级别全局日志对象（会和GO SDK自身日志一并输出）
  2. log.SetLogHandler(log.STDERR)
  3. log.Debugf("%s", "logging message using the log package in the BOS go sdk")
  5. // 创建新的日志对象（依据自定义设置输出日志，与GO SDK日志输出分离）
  6. myLogger := log.NewLogger()
  7. myLogger.SetLogHandler(log.FILE)
  8. myLogger.SetLogDir("/home/log")
  9. myLogger.SetRotateType(log.ROTATE_SIZE)
  10. myLogger.Info("this is my own logger from the BOS go sdk")