docs: 提供微信公众平台模块的示例项目

2025-09-20 18:48:10 +08:00 · 2021-07-27 18:37:11 +08:00
parent 0fd94ea541
commit b62867de8d
18 changed files with 616 additions and 7 deletions
--- a/samples/SKIT.FlurlHttpClient.Wechat.Api.Sample_Net5/Controllers/WechatNotifyController.cs
+++ b/samples/SKIT.FlurlHttpClient.Wechat.Api.Sample_Net5/Controllers/WechatNotifyController.cs
@@ -0,0 +1,68 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
+using SKIT.FlurlHttpClient.Wechat.Security;
+
+namespace SKIT.FlurlHttpClient.Wechat.Api.Sample_Net5.Controllers
+{
+    [ApiController]
+    [Route("notify")]
+    public class WechatNotifyController : ControllerBase
+    {
+        private readonly ILogger _logger;
+
+        private readonly Options.WechatOptions _wechatOptions;
+
+        public WechatNotifyController(
+            ILoggerFactory loggerFactory,
+            IOptions<Options.WechatOptions> wechatOptions)
+        {
+            _logger = loggerFactory.CreateLogger(GetType());
+            _wechatOptions = wechatOptions.Value;
+        }
+
+        [HttpGet]
+        [Route("message-push")]
+        public IActionResult VerifyMessage(
+            [FromQuery(Name = "app_id")] string? appId,
+            [FromQuery(Name = "signature")] string? signature,
+            [FromQuery(Name = "timestamp")] string? timestamp,
+            [FromQuery(Name = "nonce")] string? nonce,
+            [FromQuery(Name = "echostr")] string? echoString)
+        {
+            // 验证服务器推送
+            // 文档：https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Access_Overview.html
+
+            var wechatAccount = _wechatOptions.Accounts?.FirstOrDefault(e => e.AppId == appId);
+            if (wechatAccount == null)
+                return Content("fail");
+
+            ISet<string> set = new SortedSet<string>() { _wechatOptions.CallbackToken, timestamp!, nonce! };
+            string sign = SHA1Utility.Hash(string.Concat(set));
+            if (!string.Equals(sign, signature, StringComparison.InvariantCultureIgnoreCase))
+                return Content("fail");
+
+            return Content(echoString);
+        }
+
+        [HttpPost]
+        [Route("message-push")]
+        public async Task<IActionResult> ReceiveMessage()
+        {
+            // 接收服务器推送
+            // 文档：https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/message-push.html
+
+            using var reader = new StreamReader(Request.Body, Encoding.UTF8);
+            string content = await reader.ReadToEndAsync();
+            _logger.LogInformation("接收到微信推送的数据：{0}", content);
+
+            return Content("success");
+        }
+    }
+}
--- a/samples/SKIT.FlurlHttpClient.Wechat.Api.Sample_Net5/Controllers/WechatUserController.cs
+++ b/samples/SKIT.FlurlHttpClient.Wechat.Api.Sample_Net5/Controllers/WechatUserController.cs
@@ -0,0 +1,59 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
+using SKIT.FlurlHttpClient.Wechat.Api;
+using SKIT.FlurlHttpClient.Wechat.Api.Models;
+
+namespace SKIT.FlurlHttpClient.Wechat.Api.Sample_Net5.Controllers
+{
+    [ApiController]
+    [Route("user")]
+    public class WechatUserController : ControllerBase
+    {
+        private readonly ILogger _logger;
+
+        private readonly Services.Repositories.IWechatAccessTokenEntityRepository _wechatAccessTokenEntityRepository;
+
+        private readonly Services.HttpClients.IWechatApiHttpClientFactory _wechatApiHttpClientFactory;
+
+        public WechatUserController(
+            ILoggerFactory loggerFactory,
+            Services.Repositories.IWechatAccessTokenEntityRepository wechatAccessTokenEntityRepository,
+            Services.HttpClients.IWechatApiHttpClientFactory wechatApiHttpClientFactory)
+        {
+            _logger = loggerFactory.CreateLogger(GetType());
+            _wechatAccessTokenEntityRepository = wechatAccessTokenEntityRepository;
+            _wechatApiHttpClientFactory = wechatApiHttpClientFactory;
+        }
+
+        [HttpGet]
+        [Route("info")]
+        public async Task<IActionResult> GetUserInfoByOpenId(
+            [FromQuery(Name = "app_id")] string appId,
+            [FromQuery(Name = "open_id")] string openId)
+        {
+            // 获取用户基本信息
+            // 文档：https://developers.weixin.qq.com/doc/offiaccount/User_Management/Get_users_basic_information_UnionID.html#UinonId
+
+            var entity = _wechatAccessTokenEntityRepository.FirstOrDefault(e => e.AppId == appId);
+            var client = _wechatApiHttpClientFactory.Create(appId);
+            var request = new CgibinUserInfoRequest() { AccessToken = entity?.AccessToken, OpenId = openId };
+            var response = await client.ExecuteCgibinUserInfoAsync(request, HttpContext.RequestAborted);
+            if (!response.IsSuccessful())
+            {
+                _logger.LogWarning(
+                    "获取用户基本信息失败（状态码：{0}，错误代码：{1}，错误描述：{2}）。",
+                    response.RawStatus, response.ErrorCode, response.ErrorMessage
+                );
+            }
+
+            return new JsonResult(response);
+        }
+    }
+}