基于Node+wechaty实现团队工作日报系统机器人

背景

我们日常每天都需要写日报,用来汇报今日工作内容和明日工作计划。日报内容维护在wiki里面。团队TL每天会去wiki上收集工作内容；在发送到公司大群。但是每天会有小伙伴会忘记写。导致 TL没办法收集今日内容。很是苦恼。还有每次编写都需要去wiki挨个复制每个人的。工作效率很低；

思考

之前也了解过wechaty，就想着是否可以做一个每天快下班提醒团队小伙伴，维护下工作日报。以及团队TL便捷获取团队所有日报的系统。不需要一个个复制；

项目地址

github:https://github.com/zzhoouxin/wechaty-bot

基础依赖

wechaty --微信操作
node-schedule --定时任务
superagent --接口请求
cheerio -- 抓取数据
qrcode-terminal --终端显示二维码

功能

定时提醒组内小伙伴填写工作日报以及发送工作日报到工作群
根据关键字自动发送日报内容
后续功能...(等待和小组人员讨论)

项目成果

日常提醒

日常提醒
定时发送日报

定时发送日报
根据关键字发送日报内容

image.png

实现过程

1.项目结构

image.png

bot 存放wechaty每个状态的回调函数
schecdule 定时任务-获取日报并发送
config 基本配置-链接、群号等
tool 封装基础请求、公共方法
index.js 启动入口

2.核心代码

1.index.js -- wechaty启动入口

const {Wechaty} = require('wechaty')
const {PuppetPadplus} = require("wechaty-puppet-padplus");
const config = require('./config')
const onScan = require('./bot/onScan')
const onLogin = require('./bot/onLogin')
const onMessage = require('./bot/onMessage')
const onLogout = require('./bot/onLogout')

const bot = new Wechaty({
    puppet: new PuppetPadplus({
        token: config.TOKEN
    }),
    name: "小艾"
});
bot
    .on('scan', onScan)
    .on('login', onLogin(bot))
    .on('logout', onLogout)
    .on('message', onMessage(bot))
    .start()
    .then(() => console.log('开始登陆微信'))
    .catch(e => console.error(e))

这边使用的是wechaty-puppet-padplus基于ipad协议进行开发的；scan login logout message这些是Wechaty的基础回调事件。

2.config 基础文件配置`这里面都是自己基于自己业务的参数-如果您也是用confluence wiki 那可以参考下`

// 配置文件
module.exports = {
  // 每个人对应页面的ID
  ALL_USER_LIST: [
    { id: 27169291, name: '小人头'},
  ],
  WITHDRAWA_DATE: '00 50 17 * * *', //定时任务事件
  COLLOECT_DATE:'10 30 09 * * *', // 定时任务事件
  WIKI_URL: 'http://wiki.xxxxx.com/pages/viewpage.action?pageId=', //wiki内容地址
  TOKEN: 'puppet_padplus_xxxxx',//token
  ROOM: '22186778457@chatroom',//需要发送的群号
  KEYWORDs:['本组','全部']
};

image.png

里面的wiki_url 是我们自己平常填写日报的wiki地址。如果您使用其他方式-那就具体情况具体分析

3.定时任务提醒

在登录后启动定时任务
这边我们就使用到了- node-schedule 这个node库当然可以配置他的启动时间。可以查看官网详细说明。

3.1首页我们在wechaty的onlogin事件里面加入定时任务

const dailyRemind = require('../schedule/dailyRemind')
const collectContent = require('../schedule/collectContent')
/**
 * 扫码登录
 * @param qrcode
 * @param status
 */
module.exports = bot => {
    return async function onLogin() {
        await dailyRemind(bot);//日常提醒
        await collectContent(bot);//所有汇总
    }
}

3.2创建一个定时提醒的任务

通过bot.Room.find(id)找到需要提醒的群
在使用announce创建群公告 @所有人即可做到提醒

const schedule = require('./index');
const config = require('../config');
const utils = require('../tool/utils')
module.exports =async  function dailyRemind(bot) {
    schedule.setSchedule(config.WITHDRAWA_DATE, async () => {
        if(!utils.judgeIsJob()){ //周末的话，不做提醒
           return false;
        }
       try {
           //提醒组内人发送日报
           const searchRoom = await bot.Room.find({ id: config.ROOM});
           await searchRoom.announce("快下班了~大佬们可以更新一下日报啦~/:@)")
       } catch (e) {
           console.log("error:",e.message);
       }
   });
}

4.根据关键字。发送日报内容

上图中机器人会自动提示，需要回复什么关键字。当然这一步是我们自己配置的。在config.js里面有关键字配置属性。直接看代码
机器人自动回复-就需要在message事件里面处理啦-message的官方文档

// 监听对话
const { Message } = require('wechaty');
const config = require('../config');
module.exports = (bot) => {
  return async function onMessage(msg) {
    const contact = msg.from(); // 发消息人
    const content = msg.text(); //消息内容
    const room = msg.room(); //是否是群消息
    if (msg.self()) {
      return;
    }
    //如果是文本消息
    if (msg.type() == Message.Type.Text) {
      // await textJ(bot);
      if (room) {
        console.log('room===>', room);
        // 如果是群消息
        const topic = await room.topic();
        console.log(
          `群名: ${topic} 发消息人: ${contact.name()} 内容: ${content}`
        );
      } else {
        let info = `日报查询仅支持2种，回复【】内文字即可查询~\n`;
        config.KEYWORDs.map((v) => {
          info += '【' + v + '】' + '\n';
        });
        msg.say(info);
      }
    }
  };
};

5.获取自己需要的信息

上文中提交到我们有日报填写的地址
以及 superagent 、cheerio 2个依赖库-主要用到请求我们日报地址并且获取所需要的内容

wiki基础页面结构

这个是我们wiki文档的项目结构-我们首先需求通过superagent请求访问该页面-并且通过cheero获取内容。当然这2个依赖库使用。建议先熟悉一下官方文档。下文代码做了一些兼容--

async function collectUserContent() {
  let str = '';
  for (let user of config.ALL_USER_LIST) {
    const url = `${config.WIKI_URL}${user.id}`;
    const res = await fetch(url);
    let $ = cheerio.load(res.text);
    // const data = $('.wiki-content .p1').text();
    str += `\n ${user.name} \n`;
    $('.wiki-content p').each(function (i, e) {
      let text = $(e).text();
      if (text !== '\xa0') {
        str += ` ${text} \n`;
      }
    });
    $('.wiki-content .p1pkss0x').each(function (i, e) {
      let html = $(e).children();
      if (html.length === 0) {
        let text = $(e).text();
        if (text !== '\xa0') {
          str += ` ${text} \n`;
        }
      }
    });
 
   $('.wiki-content .pd7nslm').each(function (i, e) {
      let html = $(e).children();
      if (html.length === 1) {
        let text = $(e).text();
        if (text !== '\xa0') {
          str += ` ${text} \n`;
        }
      }
    });
  }
  return str;
}

获取到自己需要的内容，依旧可以通过room.say发送出去;
至此我们一个简单的日报收集的系统机器人简单的实现了。

总结

相信很多公司都有发送日报的要求。以上代码实现也是依赖了自己所需业务场景进行实现。通过wechaty改变了我们传统的工作流程。大大的提高了工作效率。避免很多重复行为。当然还有更多好玩有趣的功能区可以加入。希望自己可以和团队进行沟通，提高我们流程。大家可以参考以上流程。