koa-oicq开发文档

前言：koa-oicq是基于takayama-lily所开发用于方便开发者的框架。正如项目名称一样，本框架是模仿koa所开发的。

使用：npm install koa-oicq or yarn add koa-oicq

快速使用例子：

const KoaOicq = require('koa-oicq');
const { createEvent } = require('koa-oicq');

const client = new KoaOicq();
const app = createEvent('message');
client.use(app);

// 必须调用next才会调转到下一个中间件，原理同koa
app.use(async (ctx, next) => {
  console.log(1);
  await ctx.reply('1')

  await next()

  console.log(2);
  await ctx.reply('2')
});

app.use(async (ctx, next) => {
  console.log(3);
  await ctx.reply('3')

  await next()
  console.log(4);

  await ctx.reply('4')
});

app.use(async (ctx, next) => {
  console.log(5);
  await ctx.reply('5')

  await next()

  console.log(6);
  await ctx.reply('6')
});
// 打印顺序 135642

// on支持监听原生oicq所有事件
client.on('message.private', (event, bot) => {
  console.log(bot); // 当前登录qqbot对象，可调用所有api
  event.reply('私聊消息')
})

// 调用后会在data目录下生成二维码，登录QQ扫码，控制台回车即可登录
client.listen(2770315275);

ctx（当前消息的上下文对象）

ctx.event原生oicq事件对象

ctx.bot当前客户端机器人对象（用有原生bot的所有api）

ctx.sender消息发送者，同ctx.event.sender

ctx.msg消息构成对象（数组），同ctx.event

ctx.rowMsg原生消息（字符串），同ctx.event

ctx.reply当前事件对象回复函数，同ctx.event

ctx.groupId如果为群消息则为群id，同ctx.event

ctx.groupName如果为群消息则为群id，同ctx.event

ctx.userId发送者id，同ctx.event

ctx.msgId消息id（可用于撤回消息等）,同ctx.event

ctx.botId当前bot的id，同ctx.event

ctx.primaryType当前一级事件类型

原生监听事件on（新增error | end 事件）

就相当于原生的on，只不过回调多了一个bot对象

中间件开发（不用局限于自带的条件型中间件）

中间件支持同步和异步模式，传入一个函数，会传参ctx，next

中间件支持传入一个函数, 或者一个带有apply函数的对象（注意：该apply函数返回的是一个回调函数，而不是把apply作为回调函数）

自带中间件 （message、request、notice）

system事件，我们推荐使用原生oicq监测

const KoaOicq = require('koa-oicq');
const { createEvent } = require('koa-oicq');

const client = new KoaOicq();
// 创建专门监听notice的子中间件
const not = createEvent('notice');
not.use(async (ctx, next) => {
  console.log('notice');
  await next();
})

client.use(not);

client.listen('qq')

// request同理

当然你可以自定义条件性子中间件（满足一定条件才会走该子中间件的所有中间件）

const KoaOicq = require('koa-oicq');

const app = new KoaOicq();
const { customEvent } = KoaOicq;

const custom = customEvent((ctx) => {
  // 如果消息为ctx才会调用下面的中间件
  if (ctx.rowMsg === 'ts') return true;
  else return false;
});

custom.use(async (ctx, next) => {
  console.log('我被调用了~~~');
  await next();
})

client.use(custom);

client.listen('qq')

错误捕获

koa-oicq不仅支持全局错误捕获，同时也支持子中间件的错误捕获

const KoaOicq = require('koa-oicq');
const { createEvent } = require('koa-oicq');

const client = new KoaOicq();
const app = createEvent('message');
// 加载子中间件
client.use(app);
// 全局中间件错误监听
client.on('error', (err, ctx, next) => {

});
// 子中间件错误监听
app.on('error', (err, ctx, next)=>{
    
});

client.listen('qq')

生命周期

目前只支持每个事件对象完成所有中间件轮询后的生命周期回调

const KoaOicq = require('koa-oicq');

const client = new KoaOicq();

client.on('end', (ctx)=>{
    console.log('结束了')
})

client.listen('qq')

后序：如果设计到不懂的api请去oicq查看文档，欢迎大家给一些建议，本人在校大二彩笔一枚，哈哈哈