文档

Go SDK使用说明

更新时间:

物联网平台提供Go语言的云端SDK供开发人员使用。本文介绍云端Go SDK的安装和配置,以及使用Go SDK调用云端API的示例。

安装SDK

  1. 安装Go开发环境。

    目前支持Go 1.13.0及以上版本。请访问Go官网获取。

  2. Go安装完毕后,新建系统变量GOPATH,并将其指向您的代码目录。

    了解更多GOPATH相关信息,请执行命令go help gopath

  3. 执行以下命令安装阿里云Go SDK,通过Go mod来管理项目依赖。

    重要
    • 以下命令安装的SDK版本为示例值,最新版本信息,请参见OpenAPI门户物联网平台的SDK安装方式。Go SDK的历史版本信息,请参见SDK的Code

      了解Go SDK详细信息,请访问alibabacloud-go-sdk

    • Go SDK安装路径默认为 $GOPATH/src/github.com/alibabacloud-go/iot-20180120,$GOPATH可以通过命令go env GOPATH查看。

      若Go SDK依赖包缺少,可执行命令go mod tidy拉取。

    go get github.com/alibabacloud-go/iot-20180120/v6

初始化SDK

  1. 创建对象config,存放SDK初始化信息(AccessKey IDAccessKey Secret、地域ID等)。

  2. 通过iot.NewClient(config)方法加载SDK信息,创建客户端实例,完成SDK客户端初始化。

以华东2(上海)地域及其服务接入地址为例,初始代码如下。实际场景设置中,需使用您的物联网平台服务所在地域。

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  iot20180120  "github.com/alibabacloud-go/iot-20180120/v6/client"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  "github.com/alibabacloud-go/tea/tea"
)


/**
 * 使用AK&SK初始化账号Client
 * @param accessKeyId
 * @param accessKeySecret
 * @return Client
 * @throws Exception
 */
func CreateClient (accessKeyId *string, accessKeySecret *string) (_result *iot20180120.Client, _err error) {
  config := &openapi.Config{
    // 必填,您的 AccessKey ID
    AccessKeyId: accessKeyId,
    // 必填,您的 AccessKey Secret
    AccessKeySecret: accessKeySecret,
  }
  // Endpoint 请参考 https://api.aliyun.com/product/Iot
  config.Endpoint = tea.String("iot.cn-shanghai.aliyuncs.com")
  _result = &iot20180120.Client{}
  _result, _err = iot20180120.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  // 请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID 和 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
  // 工程代码泄露可能会导致 AccessKey 泄露,并威胁账号下所有资源的安全性。以下代码示例使用环境变量获取 AccessKey 的方式进行调用,仅供参考,建议使用更安全的 STS 方式
  client, _err := CreateClient(tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")), tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")))
  if _err != nil {
    return _err
  }
  
  ......
}

参数

说明

accessKeyId

您阿里云账号的AccessKey ID。

您可在阿里云官网控制台AccessKey管理中创建或查看您的AccessKey。

accessKeySecret

您阿里云账号的AccessKey Secret

RegionId

您的物联网平台服务的地域ID,用于拼接服务接入地址,格式为:iot.${RegionId}.aliyuncs.com。

您可在物联网平台控制台左上方,查看当前服务所在地域。

地域ID的表达方法,请参见地域和可用区

SDK客户端的HTTP请求配置、代理配置、超时机制、重试机制等配置方式,请参见V2.0 Go SDK

重要

为避免将AccessKey硬编码到业务代码中带来的安全风险,可采用配置环境变量的方法管理AccessKey。

您需在本地操作系统中添加环境变量ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET,并分别写入已准备好的AccessKey ID和AccessKey Secret。

在示例代码中可以通过以下方法获取:

  • os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")

  • os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")

更多鉴权访问方式,请参见管理访问凭证

发起调用

物联网平台云端SDK为每个API封装两个类,分别命名为${API名称}+"Request"${API名称}+"Response",分别用于承载API的调用请求和调用结果。

调用步骤

  1. 已完成SDK客户端初始化。具体内容,请参见初始化SDK

  2. 创建对应API的调用请求,生成${API名称}+"Request"类对象实例request

  3. 通过对象实例request,使用request.${请求参数的名称}方法,设置API所需的请求参数值。

  4. 创建${API名称}+"Response"类的对象实例response承载响应结果:使用Client对象实例client${API名称}(request)方法,获取API对应request的响应结果,包含服务端响应的bodyheaders

物联网平台云端API,请参见API列表。有关request中请求参数说明,及response中返回参数说明,请参见对应API文档。

本文以调用Pub接口发布消息到Topic为例。请求参数信息,请参见Pub

重要

以下代码中iotInstanceId为实例ID。实例的详细说明,请参见实例概述

购买实例方法,请参见购买企业版实例

获取实例ID方法,请参见物联网平台实例相关问题

	pubRequest := &iot20180120.PubRequest{
		ProductKey:     tea.String("${productKey}"),
		IotInstanceId:  tea.String("${iotInstanceId}"),
		DeviceName:     tea.String("${deviceName}"),
		TopicFullName:  tea.String("/${productKey}/${deviceName}/user/get"),
		MessageContent: tea.String("eyJ0ZXN0IjoidGFzayBwdWIgYnJvYWRjYXN0In0="),
	}
	runtime := &util.RuntimeOptions{}
	tryErr := func() (_e error) {
		defer func() {
			if r := tea.Recover(recover()); r != nil {
				_e = r
			}
		}()
		resp, _err := client.PubWithOptions(pubRequest, runtime)
		if _err != nil {
			return _err
		}

		console.Log(util.ToJSONString(resp))

		return nil
	}()

完整代码示例

说明

实际场景中,请参照上文的参数说明,替换对应参数值。

// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  iot20180120  "github.com/alibabacloud-go/iot-20180120/v6/client"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  "github.com/alibabacloud-go/tea/tea"
)


/**
 * 使用AK&SK初始化账号Client
 * @param accessKeyId
 * @param accessKeySecret
 * @return Client
 * @throws Exception
 */
func CreateClient (accessKeyId *string, accessKeySecret *string) (_result *iot20180120.Client, _err error) {
  config := &openapi.Config{
    // 必填,您的 AccessKey ID
    AccessKeyId: accessKeyId,
    // 必填,您的 AccessKey Secret
    AccessKeySecret: accessKeySecret,
  }
  // Endpoint 请参考 https://api.aliyun.com/product/Iot
  config.Endpoint = tea.String("iot.cn-shanghai.aliyuncs.com")
  _result = &iot20180120.Client{}
  _result, _err = iot20180120.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  // 请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID 和 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
  // 工程代码泄露可能会导致 AccessKey 泄露,并威胁账号下所有资源的安全性。以下代码示例使用环境变量获取 AccessKey 的方式进行调用,仅供参考,建议使用更安全的 STS 方式
  client, _err := CreateClient(tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")), tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")))
  if _err != nil {
    return _err
  }

  pubRequest := &iot20180120.PubRequest{
    // 产品ProductKey。
    ProductKey: tea.String("${productKey}"),
    // 物联网平台实例ID。
    IotInstanceId: tea.String("${iotInstanceId}"),
    DeviceName: tea.String("${deviceName}"),
    // 要接收消息的设备的自定义Topic。
    TopicFullName: tea.String("/${productKey}/${deviceName}/user/get"),
    // 要发送的消息主体:{"test":"task pub broadcast"}
    MessageContent: tea.String("eyJ0ZXN0IjoidGFzayBwdWIgYnJvYWRjYXN0In0="),
  }
  runtime := &util.RuntimeOptions{}
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    // 复制代码运行请自行打印 API 的返回值
    _, _err = client.PubWithOptions(pubRequest, runtime)
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var error = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      error = _t
    } else {
      error.Message = tea.String(tryErr.Error())
    }
    // 此处仅做打印展示,请谨慎对待异常处理,在工程项目中切勿直接忽略异常。
    // 错误 message
    fmt.Println(tea.StringValue(error.Message))
    // 诊断地址
    var data interface{}
    d := json.NewDecoder(strings.NewReader(tea.StringValue(error.Data)))
    d.Decode(&data)
    if m, ok := data.(map[string]interface{}); ok {
      recommend, _ := m["Recommend"]
      fmt.Println(recommend)
    }
    _, _err = util.AssertAsString(error.Message)
    if _err != nil {
      return _err
    }
  }
  return _err
}


func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}

附录:示例代码

前往物联网平台云端SDK示例中心查看或下载API调用的示例代码。示例代码中包含Java、Python、PHP、Node.js、Go、C++和.NET等版本SDK示例。

阿里云OpenAPI开发者门户提供API在线调试工具。在API调试页面,您可以快速检索和体验调用API。系统会根据您输入的参数同步生成各语言SDK的代码示例。各语言SDK代码示例显示在页面右侧SDK示例页签下供您参考。在调用结果页签下,可查看API调用的真实请求URL和JSON格式的返回结果。

  • 本页导读 (1)
文档反馈