Skip to content

Latest commit

 

History

History
132 lines (107 loc) · 7.36 KB

README.md

File metadata and controls

132 lines (107 loc) · 7.36 KB
Raw

WeChatManagement.MiniPrograms

ABP version 小程序模块 下载量 Discord online GitHub stars

Abp 小程序管理模块，提供小程序登录、用户个人信息记录、小程序微信服务器等功能，自动适应微信开放平台规则，与微信第三方平台模块轻松衔接。

Installation

  1. Install the following NuGet packages. (see how)

    • EasyAbp.WeChatManagement.MiniPrograms.Application
    • EasyAbp.WeChatManagement.MiniPrograms.Application.Contracts
    • (2选1) EasyAbp.WeChatManagement.MiniPrograms.Domain.OpenIddict
    • (2选1) EasyAbp.WeChatManagement.MiniPrograms.Domain.Ids4
    • EasyAbp.WeChatManagement.MiniPrograms.Domain.Shared
    • EasyAbp.WeChatManagement.MiniPrograms.EntityFrameworkCore
    • EasyAbp.WeChatManagement.MiniPrograms.HttpApi
    • EasyAbp.WeChatManagement.MiniPrograms.HttpApi.Client
    • (Optional) EasyAbp.WeChatManagement.MiniPrograms.MongoDB
    • (Optional) EasyAbp.WeChatManagement.MiniPrograms.Web
    • (Optional) EasyAbp.Abp.WeChat.Common.SharedCache.StackExchangeRedis (重要！如果开发/沙盒/线上均使用了相同的微信AppId，请安装此模块，使用中立缓存共享 AccessToken: #15 (comment))

  2. Add DependsOn(typeof(WeChatManagementMiniProgramsXxxModule)) attribute to configure the module dependencies. (see how)

  3. Add builder.ConfigureWeChatManagementCommon(); and builder.ConfigureWeChatManagementMiniPrograms(); to the OnModelCreating() method in MyProjectMigrationsDbContext.cs.

  4. Add EF Core migrations and update your database. See: ABP document.

  5. 在 Web/Host 项目的 appsettings.json 中增加微信登录授权服务器配置：

    {
  "WeChatManagement": {
    "MiniPrograms": {
      "AuthServer": {
        "Authority": "https://localhost:44380",
        "ClientId": "MyProjectName_WeChatMiniProgram",
        "ClientSecret": "1q2w3e*"
      }
    }
  }
}

  6. 在 OpenIddictDataSeedContributor 中增加新的客户端 Data Seed (你也可以使用 IDS4)：

    // WeChat MiniProgram
var weChatMiniProgramClientId =
    configurationSection["MyProjectName_WeChatMiniProgram:ClientId"];
if (!weChatMiniProgramClientId.IsNullOrWhiteSpace())
{
    await CreateApplicationAsync(
        name: weChatMiniProgramClientId,
        type: OpenIddictConstants.ClientTypes.Confidential,
        consentType: OpenIddictConstants.ConsentTypes.Implicit,
        displayName: "WeChat Mini-program",
        secret: configurationSection["MyProjectName_WeChatMiniProgram:ClientSecret"] ?? "1q2w3e*",
        grantTypes: new List<string>
        {
            OpenIddictConstants.GrantTypes.RefreshToken,
            WeChatMiniProgramConsts.GrantType
        },
        scopes: commonScopes
    );
}

  7. 在 OpenIddictDataSeedContributor 中找到

    if (grantType == OpenIddictConstants.GrantTypes.ClientCredentials)
{
    application.Permissions.Add(OpenIddictConstants.Permissions.GrantTypes.ClientCredentials);
}

    在下面增加

    if (grantType == WeChatMiniProgramConsts.GrantType)
{
    application.Permissions.Add($"gt:{WeChatMiniProgramConsts.GrantType}");
}

  8. 在 DbMigrator 项目的 appsettings.json 中增加：

    {
  "OpenIddict": {
    "Applications": {
      "WeChatManagementSample_WeChatMiniProgram": {
        "ClientId": "MyProjectName_WeChatMiniProgram",
        "ClientSecret": "1q2w3e*"
      }
    }
  }
}

  9. 运行 DbMigrator 项目，以创建新的授权客户端。

Usage

小程序登录

  1. 使用 /api/wechat-management/mini-programs/login/login (POST) 接口进行微信登录，留意 LoginInput 的注释说明。

  2. 使用 /api/wechat-management/mini-programs/login/refresh (POST) 接口对 AccessToken 续期。

  3. 在有需要时，使用 /api/wechat-management/mini-programs/user-info (PUT) 接口对存储的微信用户信息进行更新。(见 #20)

小程序授权 Razor 页面登录

  1. 配置用于微信登录的小程序的 Name，默认为Default，参考本模块设置。

  2. 重写登录页，在页面中插入 WeChatMiniProgramPcLoginWidget，重写方法参考 官方文档 和 本模块示例。

  3. 微信扫码后（默认配置下，会打开小程序首页），确保小程序本身已完成用户登录，小程序需要将扫码获得的 scene 作为 token 参数传入 /api/wechat-management/mini-programs/login/authorize-pc 接口。

  4. 完成上一步后，Razor 登录页将自动完成登录并跳转。

MiniProgram MiniProgramUser UserInfo PcLogin

Roadmap

  • 微信服务器
  • 旧账号关联微信登录
  • 微信授权 Razor 页面登录
  • 对接第三方平台模块
  • 单元测试