DreamSlave.Wecom 1.3.1

企业微信相关方法封装

使用说明

本仓库目前为预览版，无任何使用保障，仅在部分项目中引用尚未发现任何问题，请勿用于生产环境

已实现的功能

• 企业微信Token
• 企业微信Js-ticket
• 企业微信加密回调解析
• 企业微信加密回调响应（仅限文本）
• 企业微信回调接口
• 获取企业授权用户登录身份
• 获取企业用户敏感身份信息
• 获取企业Web登录的用户信息
• 企业微信机器人（消息推送）
• 企业微信发送应用消息（文本、图片、文件、图文、视频、语音、卡片等）

Token/Ticket处理方式

当cfg.AutoRefresh = true;时，将在后台启动BackgroundService服务并在每60分钟自动刷新一次

使用教程->企业微信回调/鉴权

该库提供了两种的注入方式方便使用者调用

可从Nuget中下载此库

单一实例注入

builder.Services.AddWecomService(cfg =>
{
    cfg.CorpID = "企业微信Id";
    cfg.CorpSecret = "Secret";
    cfg.AgentId = 1000001;
    cfg.Token = "";
    cfg.EncodingAesKey = "";
    cfg.AutoRefresh = true;
});

多实例注入（类似于IHttpClientFactory）

builder.Services.AddWecomService("名称",cfg =>
{
    cfg.CorpID = "企业微信Id";
    cfg.CorpSecret = "Secret";
    cfg.AgentId = 1000001;
    cfg.Token = "";
    cfg.EncodingAesKey = "";
    cfg.AutoRefresh = true;
});

在不同的实例注入下，使用方法有着本质的区别请注意

如果是单一实例，则直接注入IWecomOAuth2Service和IWecomCallBackService即可

private readonly ILogger<WecomController> _logger;
private readonly IWecomOAuth2Service _wecomOauth2Service;
private readonly IWecomCallBackService _wecomCallBackService;
public WecomController(ILogger<WecomController> logger,
     IWecomOAuth2Service wecomOAuth2Service,
     IWecomCallBackService wecomCallBackService)
 {
     _logger = logger;
     _wecomCallBackService = wecomCallBackService;
     _wecomOauth2Service = wecomOAuth2Service;
 }

如果是多实例注入，则需要注入IWecomFactory然后获取指定名称的Service

private readonly ILogger<WecomController> _logger;
private readonly IWecomOAuth2Service _wecomTokenService;
private readonly IWecomFactory _wecomFactory;
private readonly IWecomCallBackService _wecomCallBackService;
private readonly IWecomCallBackService _addressCallBackService;
public WecomController(ILogger<WecomController> logger,
    IWecomFactory wecomFactory)
{
    _logger = logger;
    _wecomFactory = wecomFactory;
    _wecomCallBackService = _wecomFactory.GetCallback("oauth2");
    _wecomTokenService = _wecomFactory.GetOAuth2("oauth2");
    _addressCallBackService = _wecomFactory.GetCallback("adress");
}

企业微信回调WebApi示例

/// <summary>
/// 企业微信签名回调
/// </summary>
/// <param name="callback"></param>
/// <returns></returns>
[HttpGet("/api/wecom/callback")]
public IActionResult GetCallBack([FromQuery] Callback callback)
{
    var flag = _wecomCallBackService.CheckSignature(callback);
    if (!flag)
    {
        return Content("签名不符合验证!", "text/plain", System.Text.Encoding.UTF8);
    }

    var data = _wecomCallBackService.DecryptEchostr(callback);
    return Content(data, "text/plain", Encoding.UTF8);
}


[HttpPost("/api/wecom/callback")]
public async Task<IActionResult> PostCallBack([FromQuery] Callback callback)
{
    using var reader = new StreamReader(Request.Body);
    var payload = await reader.ReadToEndAsync();
    var data = _wecomCallBackService.DecryptCallBackData(payload);
    _logger.LogInformation("消息内容：{0}", data);
	//这里的data需要自行处理
    return Content(await _oauthExec.HandleMessageAsync(data), "text/plain", System.Text.Encoding.UTF8);
}

这里的_oauthExec需要进行注入，如果是单实例注入则直接注入WecomCommandExecService即可

为了方便测试，下面放两个使用示例，只需要按照下面的写法进行编写即可，库会自动扫描（反射）处理

text内容

public class DeveloperHandler
{
    [WecomTextCommand("id")]
    public async Task<string> HandleOpenIdCommandAsync(IServiceProvider serviceProvider, MessageReceive messageReceive)
    {
        return await Task.FromResult("您好,您的企业微信Id为：" + messageReceive.fromUserName);
    }
}

event内容

public class EventHandler
{
    [WecomEventCommand("enter_agent")]
    public async Task<string> OnEnterAgent(IServiceProvider provider, MessageReceive message)
    {
        return await Task.FromResult($"您进入了{message.AgentId}");
    }


    [WecomEventCommand("location")]
    public async Task<string> OnLocationEvent(IServiceProvider provider, MessageReceive message)
    {
        return await Task.FromResult($"您的位置是{message.Latitude}/{message.Longitude} {message.Precision}");
    }


    [WecomEventCommand("view")]
    public async Task<string> OnViewEvent(IServiceProvider provider, MessageReceive message)
    {
        return await Task.FromResult($"您点击了<a href='{message.EventKey}'>菜单</a>");
    }

    [WecomEventCommand("click")]
    public async Task <string> OnClickEvent(IServiceProvider provider, MessageReceive message)
    {
        return await Task.FromResult($"您点击了菜单 {message.EventKey}");
    }


    [WecomEventCommand("view_miniprogram")]
    public async Task<string> OnViewMiniprogramEvent(IServiceProvider provider, MessageReceive message)
    {
        return await Task.FromResult($"您点击了小程序 {message.EventKey}");
    }


    [WecomEventCommand("scancode_push")]
    public async Task<string> OnScanCodePushEvent(IServiceProvider provider, MessageReceive message)
    {
        return await Task.FromResult($"您扫码了 {message.ScanCodeInfo.ScanResult}");
    }

    [WecomEventCommand("scancode_waitmsg")]
    public async Task<string> OnScanCodeWaitMsgEvent(IServiceProvider provider, MessageReceive message)
    {
        return await Task.FromResult($"您扫码了 {message.ScanCodeInfo.ScanResult}");
    }



    [WecomEventCommand("change_contact")]
    public async Task<string> OnChangeContactEvent(IServiceProvider provider, MessageReceive message)
    {   
        return await Task.FromResult($"通讯录变更事件 {message.ChangeType}");
    }


    [WecomEventCommand("batch_job_result")]
    public async Task<string> OnBatchJobResultEvent(IServiceProvider provider, MessageReceive message)
    {
        return await Task.FromResult($"批量任务结果 {message.BatchJob.JobId} {message.BatchJob.JobType}");
    }
}

使用教程-机器人推送

在Program.cs中添加下列代码，可以添加多个机器人只需要修改name即可

builder.Services.AddWecomBot("运维机器人", "3297fdf1-baf5-4da7-b6ca-68bfa7f65af4");

然后在接口或者实现的服务中进行下列操作

private readonly IWecomBotService _wecomBotService;
public WecomController(ILogger<WecomController> logger,
    [FromKeyedServices("运维机器人")] IWecomBotService wecomBotService)
{
    _logger = logger;
    _wecomBotService = wecomBotService;
}

最后调用方法即可

var flag = await _wecomBotService.SendTextMessageToBotAsync(keyword);