Teams Bot如何解析和发送 at 用户

之前有好些看博客的开发者问我有什么较好的方法来解析 at 信息。用户在channel里发消息给 bot 的时候，通常需要 at bot的名字，当然在消息文字中可能还会 at 其他用户，比如 bot的名字是 MyBot，那 bot 收到的 Activity 里的 Text 值类似于：

<at>MyBot</at> 请帮我查看一下 <at>Tom</at> 的明天有空时间。

可以看到 Teams 使用了 at tag 来把用户 at 的信息包含起来。

看到这里，大家可能会想，这个简单啊，可以分析一下字符串，把 <at> 的内容find到，然后在找到结束的 tag </at> 。但是如果你仔细想想，怎么写循环，也不简单把，至少需要 5 到 10 行的c#代码，可能大家还会想到使用正则表达式，对，正则会简单一些，但是你要快速的写出这个正则表达式也不是特别简单的事情。

另外，我们还需要考虑一些转义的字符，是不是瞬间觉得也不简单了。

解析 at 信息

好在 bot 的 sdk 给我们提供了一个简单的方法。

protected override async Task OnMessageActivityAsync(ITurnContext<IMessageActivity> turnContext, CancellationToken cancellationToken)
{
    Mention[] mentions = turnContext.Activity.GetMentions();
    if(mentions != null)
    {
        foreach (var mention in mentions)
        {
            ...
        }
    }
}

GetMentions 是一个 Activity 的扩展方法，里面具体的实现可以到 sdk 的源代码里找到。这个方法会返回一个 Mention 的数组

public class Mention
{
    ...
    public ChannelAccount Mentioned { get; set; }
    ...
}

public class ChannelAccount
{
    ...
    public string Name { get; set; }
    ...
}

从上面的代码可以看到，我可以通过 Mentioned 的 Name 来获取被 at 的对象的名字。

var name = mention.Mentioned.Name

发送 at 信息

除了解析，sdk 当然也提供了发送 at 信息的方法，如下：

protected override async Task OnMessageActivityAsync(ITurnContext<IMessageActivity> turnContext, CancellationToken cancellationToken)
{
    var mention = new Mention
    {
        Mentioned = turnContext.Activity.From,
        Text = $"<at>{XmlConvert.EncodeName(turnContext.Activity.From.Name)}</at>",
    };

    var replyActivity = MessageFactory.Text($"Hello {mention.Text}.");
    replyActivity.Entities = new List<Entity> { mention };

    await turnContext.SendActivityAsync(replyActivity, cancellationToken);
}

从上面的额代码里可以看到，发送 at 信息并不是很简单，还是需要我们自己来组建一个 Mention 的对象，然后把这个对象放如到回复的 activity 的 Entities 属性里。

特别需要注意的一点是：需要 at 的人的名字，需要做 xml encode，来确保不会因为 name 里有特殊的字符，而导致整个text不合法。

看到这里，大家是不是对 at 的机制有了进一步的深入理解？ :)

Written on October 14, 2021