devbox
笔触狂放9
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

手把手教你搭建微信聊天机器人系列（四）：多轮对话支持_微信bot 聊天机器人

作者：笔触狂放9 | 2024-06-12 13:37:49

赞

踩

微信bot 聊天机器人

上一章，我们搭建对接文心一言（ERNIE-Bot大模型）接口的微信聊天机器人，但只支持一轮对话。这一章我们加入数据持久化的逻辑，以便保持上下文，防止服务重启造成的聊天记录丢失。

数据持久化有很多方式，比较好的一种方式是使用数据库，方便扩展功能。eggjs可以使用Sequelize（ORM框架）对数据库进行操作（官网文档点这里）。我们使用目前比较流行的PostgreSQL数据库（以下简称pg）。

PostgreSQL数据库安装

 pg数据库安装文件从官网上下载，点击Download the installer

我选择版本13 x86-64（注：本人的Navicat版本比较低，安装版本16连接不上）

下载完开始安装

 pgAdmin是数据库客户端，如果你机子上已经装了Navicat，也可以不用装pgAdmin。

 

 数据文件所在路径

 

 数据库访问密码，我们设置为pg-ernic

 

 数据库服务访问端口5432

 后面一路next就行

 创建数据库ernic

我们打开Navicat，配置一下数据库连接。

连接名 localhost_pgsql（可自定义）

主机 localhost

端口5432

初始数据库postgres

用户名postgres

密码pg-ernic

配置完，点击左下角【测试连接】，如果正确就会提示连接成功。点击确定。

        双击侧边栏localhost_pgsql，可以逐个展开，我们可以看到下面已经有默认的数据库postgres，目前里面没有任何表。我们待会可以用eggjs的Sequelize（ORM框架）进行建表。

 

 egg-sequelize配置

plugin.js

我们打开config/plugin.js，增加一下插件

 plugin.js代码如下：

  1. 'use strict';
  2.  
  3. /** @type Egg.EggPlugin */
  4. module.exports = {
  5.   sequelize: {
  6.   	enable: true,
  7.   	package: 'egg-sequelize',
  8.   },
  9. };

config.default.js

config.default.js中加入数据库连接配置，还有联系上下文的配置。这里稍微扩展一下，会话接口联系上下文会导致输入的数据变多，接口计费的规则。我们要对上下文的时间做个限制，比如超过1个小时的聊天记录不再计入传参数据。

  1. config.sequelize = { //Sequelize 数据库配置
  2. 		dialect: 'postgres',
  3. 		database: 'postgres',
  4. 		host: '127.0.0.1',
  5. 		port: '5432',
  6. 		username: 'postgres',
  7. 		password: 'pg-ernic',
  8. 		timezone: '+08:00', // 数据库时间加8小时
  9. 		define: {
  10. 			freezeTableName: true, //使用自己配置的表名，避免sequelize自动将表名转换为复数
  11. 			createdAt: false, //不默认加创建时间字段：
  12. 			updatedAt: false, //不默认加修改时间字段：
  13. 		}
  14. 	};
  15.  
  16. //配置wechat
  17. config.wechat = {
  18. 		manageName: '蓝莲花', //管理员昵称 登录成功会发消息给管理员
  19. 		relaContextStatus: true, //需要联系上下文，会导致输入文字变多，接口费用增加
  20. 		relaContextHours: 1 //需要联系上下文 几个小时前的历史消息
  21. 	}

表模型的建立

从上一章，我们知道要维护两种数据的持久化，一个是access_token，一个是聊天记录。按eggjs的规范，需要创建两个对象模型定义文件。定义好模型后，项目运行起来就可以自动建表。我们在app下创建model目录，新增access_token.js和chat_record.js两个文件。

access_token.js

代码如下：

  1. 'use strict';
  2.  
  3. module.exports = app => {
  4. 	const Sequelize = app.Sequelize;
  5. 	const moment = require('moment');
  6.  
  7. 	const AccessToken = app.model.define('access_token', {
  8. 		id: {
  9. 			type: Sequelize.INTEGER,
  10. 			primaryKey: true,
  11. 			autoIncrement: true
  12. 		},
  13. 		access_token: {
  14. 			type: Sequelize.STRING(200),
  15. 			comment: ''
  16. 		},
  17. 		created_at: {
  18. 			type: Sequelize.DATE,
  19. 			allowNull: true,
  20. 			defaultValue: Sequelize.NOW,
  21. 			get() {
  22. 				return moment(this.getDataValue('created_at')).format('YYYY-MM-DD HH:mm:ss');
  23. 			},
  24. 		},
  25. 		updated_at: {
  26. 			type: Sequelize.DATE,
  27. 			allowNull: true,
  28. 			defaultValue: Sequelize.NOW,
  29. 			get() {
  30. 				return moment(this.getDataValue('updated_at')).format('YYYY-MM-DD HH:mm:ss');
  31. 			},
  32. 		},
  33. 	}, {
  34. 		comment: 'AccessToken表'
  35. 	});
  36.  
  37. 	return AccessToken;
  38. };

这里简单介绍一下access_token模型的字段。 

access_token字段用于记录access_token数据。

updated_at字段用于记录access_token更新时间。

后续我们可以根据updated_at字段值来判断是否超过有效期。

 chat_record.js

代码如下：

  1. 'use strict';
  2.  
  3. module.exports = app => {
  4. 	const Sequelize = app.Sequelize;
  5. 	const moment = require('moment');
  6.  
  7. 	const ChatRecord = app.model.define('chat_record', {
  8. 		id: {
  9. 			type: Sequelize.INTEGER,
  10. 			primaryKey: true,
  11. 			autoIncrement: true
  12. 		},
  13. 		room_id: {
  14. 			type: Sequelize.STRING(100),
  15. 			comment: '群聊id'
  16. 		},
  17. 		talker_id: {
  18. 			type: Sequelize.STRING(100),
  19. 			comment: '对话者id'
  20. 		},
  21. 		talker_name: {
  22. 			type: Sequelize.STRING(100),
  23. 			comment: '对话者昵称'
  24. 		},
  25. 		send_content: {
  26. 			type: Sequelize.TEXT,
  27. 			comment: '发送文字'
  28. 		},
  29. 		receive_content: {
  30. 			type: Sequelize.TEXT,
  31. 			comment: '接收文字'
  32. 		},
  33. 		status: {
  34. 			type: Sequelize.BOOLEAN,
  35. 			comment: '是否可用',
  36. 			defaultValue: true
  37. 		},
  38. 		created_at: {
  39. 			type: Sequelize.DATE,
  40. 			allowNull: true,
  41. 			defaultValue: Sequelize.NOW,
  42. 			get() {
  43. 				return moment(this.getDataValue('created_at')).format('YYYY-MM-DD HH:mm:ss');
  44. 			},
  45. 		},
  46. 		updated_at: {
  47. 			type: Sequelize.DATE,
  48. 			allowNull: true,
  49. 			defaultValue: Sequelize.NOW,
  50. 			get() {
  51. 				return moment(this.getDataValue('updated_at')).format('YYYY-MM-DD HH:mm:ss');
  52. 			},
  53. 		},
  54. 		deleted_at: {
  55. 			type: Sequelize.DATE,
  56. 			allowNull: true,
  57. 			get() {
  58. 				return moment(this.getDataValue('deleted_at')).format('YYYY-MM-DD HH:mm:ss');
  59. 			},
  60. 		},
  61. 	}, {
  62. 		comment: '对话记录表'
  63. 	});
  64.  
  65. 	return ChatRecord;
  66. };

这里简单介绍一下聊天记录模型的字段。微信聊天有两种场景：

1、私聊

我们需要记录用户的对话者id，以便区分聊天记录。

2、群聊

我们需要同时记录群聊id和对话者id，以便区分聊天记录。 

app.js的调整

我们需要有个方法app.model.sync来维护model对应的表

  1. module.exports = app => {
  2. 	app.beforeStart(async () => {
  3. 		// 应用会等待这个函数执行完成才启动
  4. 		console.log("==app beforeStart==");
  5. 		await app.model.sync({ //Sequelize 模型配置
  6. 			// force: true, //  默认false 为不覆盖 true会删除表再创建(如果有生产业务数据非常危险，不建议打开);
  7. 			alter: true // 默认true可以 添加或删除字段;
  8. 		});
  9. 	});
  10.  
  11. 	app.ready(async () => {
  12. 		console.log("==app ready==");
  13. 		let ctx = app.createAnonymousContext();
  14. 		await ctx.service.ernie.checkAccessToken(); //检查AccessToken
  15. 		await ctx.service.wechat.startBot(); //初始化BOT
  16. 	})
  17.  
  18. 	app.beforeClose(async () => {
  19. 		console.log("==app beforeClose==");
  20. 	})
  21. };

我们将access_token的维护交给一个定时任务，每天执行一次，当到了29天的时候，刷新一下数据。定时任务需要在app下新增目录schedule，新增task.js文件。

定时任务task.js

  task.js代码如下：

  1. module.exports = {
  2. 	schedule: {
  3. 		interval: '1d', // 1 天间隔
  4. 		type: 'all', // 指定所有的 worker 都需要执行
  5. 		immediate: false, //是否项目启动就执行一次定时任务
  6. 	},
  7. 	async task(ctx) { //函数名task不能改
  8. 		await ctx.service.ernie.checkAccessToken(); //检查AccessToken
  9. 	},
  10. };

service的调整

ernie.js

ernie.js需要一个方法checkAccessToken，用于检查access_token的有效性，全部代码如下：

  1. const {
  2. 	Service
  3. } = require('egg');
  4.  
  5. const moment = require('moment');
  6.  
  7. class ErnieService extends Service {
  8. 	async getAccessToken() {
  9. 		console.log('===================ErnieService getAccessToken=====================');
  10. 		let ctx = this.ctx;
  11.  
  12. 		try {
  13. 			const res = await ctx.curl(
  14. 				`https://aip.baidubce.com/oauth/2.0/token?grant_type=client_credentials&client_id=${ctx.app.config.ernie.client_id}&client_secret=${ctx.app.config.ernie.client_secret}`, {
  15. 					method: 'GET',
  16. 					rejectUnauthorized: false,
  17. 					data: {},
  18. 					headers: {},
  19. 					timeout: 30000,
  20. 					contentType: 'json',
  21. 					dataType: 'json',
  22. 				})
  23. 			console.log(res)
  24.  
  25. 			if (res.data.access_token) {
  26. 				console.log('access_token', ctx.app.config.ernie.access_token)
  27. 				return res.data.access_token;
  28. 			}
  29.  
  30. 		} catch (error) {
  31. 			console.log(error)
  32. 		}
  33. 		return null;
  34. 	}
  35. 	
  36. 	async sendMsg(msg) {
  37. 		console.log('===================ErnieService sendMsg=====================');
  38. 		console.log(JSON.stringify(msg));
  39. 		let ctx = this.ctx;
  40. 		try {
  41. 			const res = await ctx.curl(
  42. 				`https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/completions?access_token=${ctx.app.config.ernie.access_token}`, {
  43. 					method: 'POST',
  44. 					rejectUnauthorized: false,
  45. 					data: {
  46. 						"messages": msg
  47. 					},
  48. 					timeout: 30000,
  49. 					contentType: 'json',
  50. 					dataType: 'json',
  51. 				})
  52. 			console.log(res)
  53. 	
  54. 			if (res.data) {
  55. 				return res.data;
  56. 			}
  57. 			return null;
  58. 		} catch (error) {
  59. 			console.log(error)
  60. 			return null;
  61. 		}
  62. 	}
  63. 	
  64. 	async checkAccessToken() {
  65. 		console.log('===================ErnieService checkAccessToken=====================');
  66. 		let ctx = this.ctx;
  67. 		const query = {};
  68. 		const accessToken = await ctx.model.AccessToken.findOne(query);
  69. 		if (accessToken) {
  70. 			console.log('accessToken', accessToken.access_token, accessToken.updated_at);
  71. 	
  72. 			if (moment(new Date()).diff(moment(accessToken.updated_at), 'days') >= ctx.app.config.ernie.expire_day -
  73. 				1) { //提前一天刷新
  74. 				console.log('accessToken已失效，重新获取中')
  75. 				const accessTokenStr = await ctx.service.ernie.getAccessToken();
  76. 				if (accessTokenStr) {
  77. 					await accessToken.update({
  78. 						accessToken: accessTokenStr,
  79. 						updated_at: moment().format('YYYY-MM-DD HH:mm:ss')
  80. 					});
  81. 					ctx.app.config.ernie.access_token = accessTokenStr;
  82. 					console.log('accessToken更新成功');
  83. 				} else {
  84. 					console.log('accessToken获取失败');
  85. 				}
  86. 			} else {
  87. 				ctx.app.config.ernie.access_token = accessToken.access_token;
  88. 				console.log('accessToken在有效期内');
  89. 			}
  90. 		} else {
  91. 			console.log('accessToken不存在');
  92. 			const accessTokenStr = await ctx.service.ernie.getAccessToken();
  93. 			if (accessTokenStr) {
  94. 				const queryData = await ctx.model.AccessToken.create({
  95. 					access_token: accessTokenStr
  96. 				});
  97. 				ctx.app.config.ernie.access_token = accessTokenStr;
  98. 				console.log('accessToken更新成功');
  99. 			} else {
  100. 				console.log('accessToken获取失败');
  101. 			}
  102. 		}
  103. 	}
  104. }
  105.  
  106. module.exports = ErnieService;

wechat.js

wechat.js需要对聊天记录进行读取和存储，用于保持上下文，全部代码如下：

  1. const {
  2. 	Service
  3. } = require('egg');
  4.  
  5.  
  6. const {
  7. 	WechatyBuilder,
  8. 	ScanStatus
  9. } = require("wechaty");
  10. const qrcode = require("qrcode-terminal");
  11. const Sequelize = require('sequelize');
  12. const Op = Sequelize.Op;
  13.  
  14. let ctx;
  15. let wechaty;
  16. let startStatus = false;
  17.  
  18. const onMessage = async (message) => {
  19. 	console.log(`收到消息: ${message}`);
  20. 	const room = message.room() // 是否是群消息
  21. 	if (!room || await message.mentionSelf()) { //如果是私聊或者群聊@我
  22. 		if (message.type() === wechaty.Message.Type.Text) {
  23. 			const sendContent = await message.text();
  24. 			if (sendContent) {
  25. 				try {
  26. 					let room_id = '';
  27. 					if (room) { //如果是群聊
  28. 						room_id = room.id;
  29. 						console.log(`room_id: ${room_id}`);
  30. 					}
  31.  
  32. 					const talker = message.talker();
  33. 					const talker_id = talker.id;
  34. 					const talker_name = talker.name();
  35. 					console.log(`talker_id: ${talker_id}`);
  36. 					console.log(`${talker_name}: ${sendContent}`);
  37.  
  38. 					let msgRecord = [];
  39.  
  40. 					if (ctx.app.config.wechat.relaContextStatus) { //需要联系上下文
  41. 						let query = {
  42. 							where: {
  43. 								created_at: {
  44. 									[Op.gte]: Sequelize.literal(
  45. 										`NOW() - (INTERVAL '${ctx.app.config.wechat.relaContextHours} HOUR')`
  46. 									),
  47. 								},
  48. 								status: true
  49. 							},
  50. 							attributes: {
  51. 								exclude: ['deleted_at', 'status']
  52. 							}
  53. 						};
  54. 						if (room_id) {
  55. 							query.where.room_id = room_id;
  56. 						} else {
  57. 							query.where.talker_id = talker_id;
  58. 						}
  59. 						const queryData = await ctx.model.ChatRecord.findAll(query);
  60.  
  61. 						for (let i of queryData) {
  62. 							msgRecord.push({
  63. 								"role": "user",
  64. 								"content": i.send_content
  65. 							});
  66. 							msgRecord.push({
  67. 								"role": "assistant",
  68. 								"content": i.receive_content
  69. 							});
  70. 						}
  71. 					}
  72.  
  73. 					msgRecord.push({
  74. 						"role": "user",
  75. 						"content": sendContent
  76. 					});
  77. 					let res = await ctx.service.ernie.sendMsg(msgRecord);
  78. 					if (res) {
  79. 						if (res.error_code) {
  80. 							message.say(JSON.stringify(res));
  81. 							console.log(`报错: ${JSON.stringify(res)}`);
  82. 						} else {
  83. 							if (res.result) {
  84. 								message.say(res.result);
  85. 								console.log(`回复: ${res.result}`);
  86. 								const chatRecord = await ctx.model.ChatRecord.create({
  87. 									room_id,
  88. 									talker_id,
  89. 									talker_name,
  90. 									send_content: sendContent,
  91. 									receive_content: res.result
  92. 								});
  93. 							}
  94. 						}
  95. 					}
  96. 				} catch (error) {
  97. 					console.log(error);
  98. 					message.say(JSON.stringify(error));
  99. 				}
  100. 			}
  101. 		}
  102. 	}
  103. };
  104.  
  105. const onLogout = (user) => {
  106. 	console.log(`用户 ${user} 退出成功`);
  107. };
  108. const onLogin = async (user) => {
  109. 	console.log(`用户 ${user} 登录成功`);
  110. 	
  111. 	const contact = await wechaty.Contact.find({
  112. 		name: ctx.app.config.wechat.manageName
  113. 	})
  114. 	if (contact) {
  115. 		await contact.say('微信机器人服务初始化完毕!')
  116. 	} else {
  117. 		console.error('未找到管理员微信')
  118. 	}
  119. };
  120. const onError = console.error;
  121. const onScan = (code, status) => {
  122. 	// status: 2代表链接等待调用，3代表链接已打开，这个链接实际上是提供一个登录的二维码供扫描
  123. 	if (status === ScanStatus.Waiting) {
  124. 		// status: 2代表等待，3代表扫码完成
  125. 		qrcode.generate(code, {
  126. 			small: true
  127. 		}, console.log)
  128. 	}
  129. };
  130.  
  131. class WechatService extends Service {
  132. 	async startBot() {
  133. 		console.log('===================WechatService startBot=====================');
  134. 		ctx = this.ctx;
  135. 		if (startStatus && wechaty) {
  136. 			if (wechaty.isLoggedIn) {
  137. 				await wechaty.logout();
  138. 			}
  139. 			await wechaty.stop();
  140. 			startStatus = false;
  141. 			wechaty = null;
  142. 		}
  143. 		wechaty = await WechatyBuilder.build();
  144. 		wechaty
  145. 			.on("scan", onScan)
  146. 			.on("login", onLogin)
  147. 			.on("logout", onLogout)
  148. 			.on("error", onError)
  149. 			.on("message", onMessage);
  150. 		await wechaty.start();
  151. 		startStatus = true;
  152. 	}
  153. }
  154.  
  155. module.exports = WechatService;

最后，我们要安装一下组件

  1. npm i -s egg-sequelize
  2. npm i -s pg
  3. npm i -s pg-hstore

然后我们启动项目，微信扫码登录后，管理员会立即收到机器人发的消息（前提是已经加过机器人为好友，并且昵称为config.wechat.manageName中设置的内容）。然后就可以连续对话了。

        至此，本系列主体功能都已经结束了。看看后续如果还有什么内容，我会继续补充。 

        本章完整代码在这里下载。运行前请配置好config/config.default.js里面config.ernie下的client_id和client_secret配置项。 微信登录二维码如有显示问题请参看第二章-微信登录二维码问题处理。

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/笔触狂放9/article/detail/708292
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号