Skip to main content

3. 开发机器人服务

在本章节中,将会介绍如何用 Java 开发一个聊天机器人服务,实现基本的介绍和发送消息能力。

本教程的完整代码可以在 GitHub 仓库中获取,你也可以跳过本文中构建步骤,直接从 GitHub 中 clone 相关代码。

创建 Java 模块

参考 Spring Quickstart Guide 创建一个空的 Spring 工程。 推荐新手采用本教程相同的配置,点此链接进入 spring intializr,本教程相关的参数已经通过 URL 参数自动携带过去。

本教程使用的主要参数包括:

  • Project:Maven
  • Language:Java
  • Spring Boot:2.7.15
  • Java:8

进入页面后,点击 GENERATE 按钮后会下载生成好 Spring 工程文件,解压缩后可以完成 Java 模块创建。

温馨提示

如果你需要在已有的 Java 工程中开发钉钉聊天机器人,可以跳过这一步。

安装依赖

一、在 pom.xml 中添加依赖项(本文档中版本号仅用于示例,强烈推荐采用最新版本

pom.xml
<!-- ... -->
<dependencies>
<!-- ... -->
<dependency>
<groupId>com.dingtalk.open</groupId>
<artifactId>dingtalk-stream</artifactId>
<version>1.2.0</version>
</dependency>
<!-- ... -->
</dependencies>
<!-- ... -->

二、在命令行中 pom.xml 所在目录执行 mvn clean package 命令获得最新依赖项,或者在 IDE 中执行相关动作。

开发机器人服务

一、在 ./src/main/resources/application.properties 中添加应用凭据的配置:

./src/main/resources/application.properties
dingtalk.app.client-id=put-your-client-id-here
dingtalk.app.client-secret=put-your-client-secret-here
注意事项

务必将以上命令中"put-your-client-id-here"和"put-your-client-secret-here"替换成实际的值后再运行,否则无法成功建立连接。Client ID 和 Client Secret 可以通过步骤二: 创建应用文档获取。

二、在 com.example.botechotext 包下面创建 BotEchoTextConsumer 类,用于处理来自的 IM 消息推送:

BotEchoTextConsumer.java
package com.example.botechotext;

import com.dingtalk.open.app.api.callback.OpenDingTalkCallbackListener;
import com.dingtalk.open.app.api.chatbot.BotReplier;
import com.dingtalk.open.app.api.models.bot.ChatbotMessage;
import org.springframework.stereotype.Component;

import java.io.IOException;

@Component
public class BotEchoTextConsumer implements OpenDingTalkCallbackListener<ChatbotMessage, Void> {

@Override
public Void execute(ChatbotMessage message) {
String response = String.format("echo received message: [%s]", message.getText().getContent().trim());
try {
BotReplier.fromWebhook(message.getSessionWebhook()).replyText(response);
} catch (IOException e) {
throw new RuntimeException(e);
}
return null;
}
}

三、在 com.example.botechotext 包下面创建 BotEchoTextListener 类,用于创建 IM 消息的监听:

BotEchoTextListener.java
package com.example.botechotext;

import com.dingtalk.open.app.api.OpenDingTalkClient;
import com.dingtalk.open.app.api.OpenDingTalkStreamClientBuilder;
import com.dingtalk.open.app.api.callback.DingTalkStreamTopics;
import com.dingtalk.open.app.api.security.AuthClientCredential;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;

@Component
public class BotEchoTextListener {
@Value("${dingtalk.app.client-id}")
private String clientId;

@Value("${dingtalk.app.client-secret}")
private String clientSecret;

private final BotEchoTextConsumer botEchoTextConsumer;

@Autowired
public BotEchoTextListener(BotEchoTextConsumer botEchoTextConsumer) {
this.botEchoTextConsumer = botEchoTextConsumer;
}

@PostConstruct
public void init() throws Exception {
// init stream client
OpenDingTalkClient client = OpenDingTalkStreamClientBuilder
.custom()
.credential(new AuthClientCredential(clientId, clientSecret))
.registerCallbackListener(DingTalkStreamTopics.BOT_MESSAGE_TOPIC, botEchoTextConsumer)
.build();
client.start();
}
}

以上代码实现了这些能力:

  1. 通过命令行参数读取 Client ID 和 Client Secret 选项
  2. 通过 Client ID 和 Client Secret 创建 Stream Client
  3. 在 Stream Client 中注册机器人消息回调方法,实现消息接收能力
  4. 在消息回调方法中,简单 echo 机器人消息回去,实现消息发送(回复)能力

运行机器人服务

在 IDE 中运行 BotEchoTextApplication.java 中 main 函数,当看到这样的日志输出时候表示运行成功 [DingTalk] connection is established, connectionId=...

至此,你已成功完成机器人服务开发和部署。接下来可以体验自己开发的机器人服务了。

注意事项

务必将以上命令中"put-your-client-id-here"和"put-your-client-secret-here"替换成实际的值后再运行,否则无法成功建立连接。Client ID 和 Client Secret 可以通过步骤二: 创建机器人应用文档获取。

至此,你已成功完成机器人服务开发和部署。接下来可以体验自己开发的机器人服务了。

相关链接