WeChatMiniProgService Class

提供微信小程序扫码服务的抽象基类。

Definition

Namespace: QuickAdmin.Service.Auth
Assembly: QuickAdmin.Net (in QuickAdmin.Net.dll) Version: 1.1.6
C#
[NotUseDI]
public abstract class WeChatMiniProgService : IWeChatMiniProgService
Inheritance
object    WeChatMiniProgService
Implements
IWeChatMiniProgService

Remarks

继承类需要重写 AppIdAppSecretTheHttpClient,然后在应用启动时以单例模式注册后即可使用。
此基类内已实现 AccessToken 获取、扫码绑定账户和扫码登录相关逻辑。AccessToken 以及二维码数据均被存储于缓存中,可在继承类重写相关方法更改存储方式。

Constructors

WeChatMiniProgServiceInitializes a new instance of the WeChatMiniProgService class

Properties

Protected Properties

AccessTokenTimeoutSeconds 微信 AccessToken 有效期,单位:秒。
AppId 小程序 AppId。
AppSecret 小程序 AppSecret。
authService 认证服务。
cache 缓存服务。用来缓存二维码数据。
exService 异常日志服务。
fsql 获取本服务要操作的数据库数据所用的 IFreeSql 实例。
QRCodeFailedBase64ImageString 二维码生成失败时返回给浏览器的一个图片。
QRCodeTimeoutSeconds 二维码有效期,单位:秒。
TheHttpClient 调用微信 API 时使用的 HttpClient
userService 用户实体服务。

Methods

Public Methods

CheckQRCode 检查二维码。供小程序端在用户扫码时调用。
GetUnlimitedQRCodeImage 获取二维码图片(调用微信 getUnlimitedQRCode API)。供浏览器端调用。
QRCodeAuth 确认授权。供小程序端在用户确认授权后调用。
QRCodeCancel 取消二维码。供小程序端在用户取消授权后,或浏览器端失效该二维码时调用。
RefreshQRCodeStatus 刷新二维码状态。供浏览器端轮询二维码状态时调用。

Protected Methods

CreateAccessToken 调用微信 getAccessToken API 获取 AccessToken。
CreateCheckQRCodeOutput 用来在检查二维码时,创建要返回给小程序端的数据。
CreateUnlimitedQRCodeApiParams 依据扫码目的创建对应调用参数。
GetAccessToken 获取 AccessToken。
GetQRCodeDataFromCache 从缓存中获取指定二维码数据。
GetUserIdByOpenId 获取指定 openId 对应的用户 Id。
NewQRCodeDataAndSaveToCache 依据扫码目的创建并记录二维码数据。
NewScene 用来生成 scene 值的方法。
OnQRCodeAuthed 用户确认授权后在浏览器端执行的后续逻辑。
OnQRCodeAuthing 用户在小程序端确认授权后执行的方法。
OnQRCodeCanceling 将二维码置为失效状态的方法。
ProcessQRCodeImageObtainedFromAPI 处理从微信 API 取得的二维码图片。
RemoveQRCodeDataFromCache 从缓存中移除该二维码数据。
UpdateQRCodeData 更新指定二维码数据。

See Also