HTTP SDK

最近更新时间:2019-08-13 11:29:37

概述

腾讯云消息队列 CMQ 目前支持 Java、Python、PHP、C++ 及 C# SDK ,后续会支持更多语言。欢迎广大开发者根据 API 说明开发更多语言版本的 SDK。
由于分配资源和释放资源需要1s左右的时间,当前消息队列 SDK 在创建及删除队列/主题时会有1s 延迟,建议在程序中增加创建和删除的时间间隔保障调用成功。

注意:

  • 为了保障数据传输的安全,为您提供更加可靠的服务,腾讯云团队将在2019年1月31日23:59:59停止对主题及队列的公网 HTTP 方式的访问,建议您将公网接口请求域名改为 HTTPS。
  • 修改公网接口请求域名的方式如下:
    判断接入域名中使用的协议是否为 HTTP,如果有,将其替换为 HTTPS 即可。
    例如:endpoint=http://cmq-topic-gz.api.qcloud.com该接入方式为 HTTP 协议访问广州主题公网域名,修改为:endpoint=https://cmq-topic-gz.api.qcloud.com

下载地址

不同语言版本的 SDK 下载地址如下:

GitHub 地址

注意事项

使用 SDK 前至少要获取 SecretIdSecretKey 和 endpoint(即请求发到哪个地域,走内网还是外网)。endpoint 说明如下。

队列模型

请参照下面说明将域名中的 {$region} 替换成相应地域:

  • 外网接口请求域名:https://cmq-queue-{$region}.api.qcloud.com
  • 内网接口请求域名:http://cmq-queue-{$region}.api.tencentyun.com

主题模型

请参照下面说明将域名中的 {$region} 替换成相应地域:

  • 外网接口请求域名:https://cmq-topic-{$region}.api.qcloud.com
  • 内网接口请求域名:http://cmq-topic-{$region}.api.tencentyun.com

如果业务进程也部署在腾讯云的 CVM 子机上,强烈建议使用同地域的内网 endpoint。例如:在腾讯云北京地域的 CVM 子机,则建议您使用 http://cmq-queue-bj.api.tencentyun.com。原因如下:

  • 同地域内网时延更低。
  • 目前消息队列对于公网下行流量是要收取流量费用的,用内网可以节省这部分的费用。

说明

{$region}需用具体地域替换:gz(广州),sh(上海),bj(北京),shjr(上海金融),szjr(深圳金融),hk(中国香港),cd(成都),ca(北美),usw(美西),sg(新加坡)。公共参数中的 region 值要与域名的 region 值保持一致,如果出现不一致的情况,以域名的 region 值为准,将请求发往域名 region 所指定的地域。

Demo工程使用

准备 Demo 环境

  1. 安装 IDE
    您可以安装 IntelliJ IDEA 或者 Eclipse,本文以 IntelliJ IDEA 为例进行说明。
    请在 下载 IntelliJ IDEA Ultimate 版本,并参考 IntelliJ IDEA 说明进行安装。
  2. 下载 Demo 工程
    请在 下载 CMQ-HTTP 的 Demo 工程 到本地,解压后即可看到本地新增的 cmq-java-sdk-master 文件夹。

配置 Demo 工程

  1. 创建资源
    您需要在控制台创建所需消息队列资源,包括 CMQ 队列名、SecretID、SecretKey。
    具体创建过程请参考 队列模型快速入门主题模型快速入门
  2. 导入 Demo 工程文件
    在 IDEA 的开机界面打开文件夹。

    打开文件夹后,Demo 工程文件存于/src/main/java/com/qcloud/cmq/example文件夹下。
  3. 配置 Demo 参数
    修改文件请求地址、密钥对等。以 Producer 为例,配置如下:
    String secretId="获取的SecretID";
    String secretKey="获取的SecretKey";
    String endpoint = "https://cmq-topic-{$region}.api.qcloud.com";
    String queueName = "test";
    选择“新建队列”和“使用已有队列”:
    //创建新队列并设置属性
    QueueMeta meta = new QueueMeta();
    meta.pollingWaitSeconds = 10;
    meta.visibilityTimeout = 10;
    meta.maxMsgSize = 1048576;
    meta.msgRetentionSeconds = 345600;
    Queue queue = account.createQueue(queueName,meta);
    //使用控制台已有队列
    Queue queue = account.getQueue(queueName);
    本 Demo 使用的是当前账号已有队列,如需选择新建队列,修改 queueName 为将要创建的队列名,然后找到新建队列相关代码取消注释。
    注释代码均为常用操作,“删除”操作需谨慎使用,其他类中的配置参考 Producer 类。

运行 Demo

使用队列模型收发消息

先运行 Producer 类发送消息,再运行 Consumer 类接受消息。
发送消息代码示例:

String msg = "hello!";
String msgId = queue.sendMessage(msg);
System.out.println("==> send success! msg_id:" + msgId);

接收消息代码示例:

Message msg = queue.receiveMessage(10);

使用主题模型收发消息

运行 TopicDemo 类,主题模型请求域名参考 主题模型请求域名
发布消息示例:

String msg = "hello!";
String msgId = topic.publishMessage(msg);

处理消息示例:

String queueName = "test";
String subscriptionName = "sub-test";
String Endpoint = queueName;
String Protocol = "queue";
account.createSubscribe(topicName,subscriptionName, Endpoint, Protocol);

创建订阅者时填写一个队列,用队列处理消息。