SpringCloud— 微信小程序授權登錄增加多租戶配置

作者：AI全棧程序猿 2023-07-28 22:14:51

現在我們需要結合Weixin-Java-Miniapp的多租戶實現整合到我們的框架中，使多租戶可通過系統配置界面來新增多租戶小程序。

GitEgg框架集成weixin-java-miniapp工具包以實現微信小程序相關接口調用功能，weixin-java-miniapp底層支持多租戶擴展。每個小程序都有唯一的appid，weixin-java-miniapp的多租戶實現并不是以租戶標識TenantId來區分的，而是在接口調用時，傳入appid，動態切換ThreadLocal的appid來實現多租戶的。并且其多個微信小程序的配置，都是在配置yml文件中的，在實際業務運營過程中，如果需要新增多租戶小程序就修改配置文件顯然是不合適的。

現在我們需要結合weixin-java-miniapp的多租戶實現整合到我們的框架中，使多租戶可通過系統配置界面來新增多租戶小程序。前面我們講了如何集成以及如何使用weixin-java-miniapp實現微信授權登錄及賬號綁定等，現在只需要在原來的基礎上增加數據配置存儲，在服務啟動時由原先的讀取配置文件加載相應的微信小程序接口實例，修改為可以通過讀取配置文件和讀取緩存配置來生成相應的微信小程序接口實例。

一、新增微信小程序配置界面

1、微信小程序配置數據庫設計

在數據庫設計的時候，我們需要知道微信小程序授權時，哪些字段需要配置，是可選字段還是必填字段，這里我們通過weixin-java-miniapp的springboot工程配置文件可知，所需字段有：

# 公眾號配置(必填)
wx.miniapp.appid = appId
wx.miniapp.secret = @secret
wx.miniapp.token = @token
wx.miniapp.aesKey = @aesKey
wx.miniapp.msgDataFormat = @msgDataFormat                  # 消息格式，XML或者JSON.
# 存儲配置redis(可選)
# 注意: 指定redis.host值后不會使用容器注入的redis連接(JedisPool)
wx.miniapp.config-storage.type = Jedis                     # 配置類型: Memory(默認), Jedis, RedisTemplate
wx.miniapp.config-storage.key-prefix = wa                  # 相關redis前綴配置: wa(默認)
wx.miniapp.config-storage.redis.host = 127.0.0.1
wx.miniapp.config-storage.redis.port = 6379
# http客戶端配置
wx.miniapp.config-storage.http-client-type=HttpClient      # http客戶端類型: HttpClient(默認), OkHttp, JoddHttp
wx.miniapp.config-storage.http-proxy-host=
wx.miniapp.config-storage.http-proxy-port=
wx.miniapp.config-storage.http-proxy-username=
wx.miniapp.config-storage.http-proxy-password=

根據我們的設計，配置文件中需要增加租戶字段，我們需要兼容即使用配置文件來配置微信小程序，又可以使用配置界面將微信小程序配置信息配置到數據庫中，同時，增加md5字段配置，用于在讀取配置時比較配置信息是否有更改。所以，保存微信小程序配置的數據庫設計如下：

CREATE TABLE `t_wechat_miniapp`  (
  `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主鍵',
  `tenant_id` bigint(20) NOT NULL DEFAULT 0 COMMENT '租戶id',
  `miniapp_name` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '微信小程序名稱',
  `appid` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '微信小程序appid',
  `secret` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '微信小程序secret',
  `token` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '微信小程序token',
  `aes_key` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '微信小程序aesKey',
  `msg_data_format` varchar(10) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '消息格式，XML或者JSON',
  `storage_type` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '配置類型: Memory(默認), Jedis, RedisTemplate',
  `key_prefix` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '相關redis前綴配置: wa(默認)',
  `redis_host` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT 'Redis服務器地址',
  `redis_port` int(11) NULL DEFAULT NULL COMMENT 'Redis服務器端口',
  `http_client_type` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT 'http客戶端類型: HttpClient(默認), OkHttp, JoddHttp',
  `http_proxy_host` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT 'http_proxy_host',
  `http_proxy_port` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT 'http_proxy_port',
  `http_proxy_username` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT 'http_proxy_username',
  `http_proxy_password` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT 'http_proxy_password',
  `status` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL DEFAULT '1' COMMENT '狀態 1有效 0禁用',
  `md5` varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT 'MD5',
  `comments` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '描述',
  `create_time` datetime(0) NULL DEFAULT NULL COMMENT '創建時間',
  `creator` bigint(20) NULL DEFAULT NULL COMMENT '創建者',
  `update_time` datetime(0) NULL DEFAULT NULL COMMENT '更新時間',
  `operator` bigint(20) NULL DEFAULT NULL COMMENT '更新者',
  `del_flag` tinyint(2) NOT NULL DEFAULT 0 COMMENT '是否刪除',
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 1 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci COMMENT = '微信小程序配置' ROW_FORMAT = DYNAMIC;

2、通過代碼生成器生成微信小程序配置的增刪查改代碼

通過代碼生成器根據新設計的表進行CRUD代碼生成，詳細步驟不再贅述，前面有詳細講解如何根據數據庫表設計生成前后端代碼。只是這里需要增加業務邏輯處理，以及更新到緩存配置。

新增時，將配置信息添加到Redis，并且需要根據系統是否開啟多租戶來判斷生成緩存key

/**
    * 創建微信小程序配置
    * @param miniapp
    * @return
    */
    @Override
    public boolean createMiniapp(CreateMiniappDTO miniapp) {
        Miniapp miniappEntity = BeanCopierUtils.copyByClass(miniapp, Miniapp.class);
        try {
            String miniappEntityStr = JsonUtils.objToJson(miniappEntity);
            miniappEntity.setMd5(SecureUtil.md5(miniappEntityStr));
        } catch (Exception e) {
            log.error("創建微信小程序配置時，md5加密失敗:{}", e);
            throw new BusinessException("創建微信小程序配置時，md5加密失敗:" + e);
        }
        boolean result = this.save(miniappEntity);
        if (result)
        {
            // 更新到緩存
            Miniapp miniappEntityLocal = this.getById(miniappEntity.getId());
            MiniappDTO miniappDTO = BeanCopierUtils.copyByClass(miniappEntityLocal, MiniappDTO.class);
            this.addOrUpdateMiniappCache(miniappDTO);
        }
        return result;
    }

編輯時，需要更新Redis配置信息，因為會有key也同時修改的情況，所以，需要先刪除舊的配置信息，再新增新的配置信息

/**
    * 更新微信小程序配置
    * @param miniapp
    * @return
    */
    @Override
    public boolean updateMiniapp(UpdateMiniappDTO miniapp) {
        Miniapp miniappEntity = BeanCopierUtils.copyByClass(miniapp, Miniapp.class);
        Miniapp miniappEntityOld = this.getById(miniappEntity.getId());
        try {
            String miniappEntityStr = JsonUtils.objToJson(miniappEntity);
            miniappEntity.setMd5(SecureUtil.md5(miniappEntityStr));
        } catch (Exception e) {
            log.error("創建微信小程序配置時，md5加密失敗:{}", e);
            throw new BusinessException("創建微信小程序配置時，md5加密失敗:" + e);
        }
        boolean result = this.updateById(miniappEntity);
        if (result)
        {
            // 把舊的刪掉
            MiniappDTO miniappDTOOld = BeanCopierUtils.copyByClass(miniappEntityOld, MiniappDTO.class);
            this.deleteMiniappCache(miniappDTOOld);
            // 更新到緩存
            Miniapp miniappEntityLocal = this.getById(miniappEntity.getId());
            MiniappDTO miniappDTO = BeanCopierUtils.copyByClass(miniappEntityLocal, MiniappDTO.class);
            this.addOrUpdateMiniappCache(miniappDTO);
        }
        return result;
    }

刪除時，直接根據條件生成緩存key，然后進行刪除即可

/**
    * 刪除微信小程序配置
    * @param miniappId
    * @return
    */
    @Override
    public boolean deleteMiniapp(Long miniappId) {
        // 從緩存刪除
        Miniapp miniappEntity = this.getById(miniappId);
        MiniappDTO miniappDTO = BeanCopierUtils.copyByClass(miniappEntity, MiniappDTO.class);
        this.deleteMiniappCache(miniappDTO);
        // 從數據庫中刪除
        boolean result = this.removeById(miniappId);
        return result;
    }

新增/更新緩存的公共方法

private void addOrUpdateMiniappCache(MiniappDTO miniappDTO) {
        try {

            String redisKey = MiniappConstant.WX_MINIAPP_CONFIG_KEY;
            if (enable) {
                redisKey = MiniappConstant.WX_MINIAPP_TENANT_CONFIG_KEY + miniappDTO.getAppid();
            }
            redisTemplate.opsForHash().put(redisKey, miniappDTO.getTenantId().toString(), JsonUtils.objToJson(miniappDTO));

            // wxMaService增加config
            this.addConfig(miniappDTO);

        } catch (Exception e) {
            log.error("初始化微信小程序配置失敗：{}" , e);
        }
    }

刪除緩存的公共方法

private void deleteMiniappCache(MiniappDTO miniappDTO) {
        try {

            String redisKey = MiniappConstant.WX_MINIAPP_CONFIG_KEY;
            if (enable) {
                redisKey = MiniappConstant.WX_MINIAPP_TENANT_CONFIG_KEY + miniappDTO.getAppid();
            }
            redisTemplate.opsForHash().delete(redisKey, miniappDTO.getTenantId().toString(), JsonUtils.objToJson(miniappDTO));
            // wxMaService刪除config
            this.removeConfig(miniappDTO);
        } catch (Exception e) {
            log.error("初始化微信小程序配置失敗：{}" , e);
        }
    }

3、修改相關配置文件，使微信小程序配置既支持配置文件又支持數據庫配置

新增GitEggWxMaRedissonConfigImpl類繼承自WxMaRedissonConfigImpl，增加我們需要的租戶配置字段：configKey、tenantId、md5。

/**
 * @author GitEgg
 * @date 2023/7/21
 */
public class GitEggWxMaRedissonConfigImpl extends WxMaRedissonConfigImpl {

    protected String configKey;

    protected String tenantId;

    protected String md5;

    public GitEggWxMaRedissonConfigImpl(@NonNull RedissonClient redissonClient, String keyPrefix) {
        super(redissonClient, keyPrefix);
    }

    public GitEggWxMaRedissonConfigImpl(@NonNull RedissonClient redissonClient) {
        super(redissonClient);
    }
......
}

修改WxMaProperties類，增加我們需要的字段tenantId，因為configKey和md5是系統生成的，只有動態可配置時才會用到這幾個字段去判斷，這里如果是配置文件配置，修改后生效必須重啟系統，所以這里不需要這幾個字段。

@Data
@ConfigurationProperties(prefix = "wx.miniapp")
public class WxMaProperties {

    private List<Config> configs;

    @Data
    public static class Config {

        /**
         * 租戶
         */
        private Long tenantId;

        /**
         * 設置微信小程序的appid
         */
        private String appid;

        /**
         * 設置微信小程序的Secret
         */
        private String secret;

        /**
         * 設置微信小程序消息服務器配置的token
         */
        private String token;

        /**
         * 設置微信小程序消息服務器配置的EncodingAESKey
         */
        private String aesKey;

        /**
         * 消息格式，XML或者JSON
         */
        private String msgDataFormat;
    }

}

修改WxMaConfiguration類，我們使用自己定義的緩存方式和Config類進行相關操作,這里的緩存我們使用Redisson。

@Bean
    public WxMaService wxMaService() {
        List<WxMaProperties.Config> configs = this.properties.getConfigs();
        //已添加緩存配置，如果配置文件沒有，那么在緩存新增時，仍然可以setConfigs
//        if (configs == null) {
//            throw new WxRuntimeException("大哥，拜托先看下項目首頁的說明（readme文件），添加下相關配置，注意別配錯了！");
//        }
        WxMaService maService = new WxMaServiceImpl();
        if (null != configs)
        {
            maService.setMultiConfigs(
                    configs.stream()
                            .map(a -> {
//                    WxMaDefaultConfigImpl config = new WxMaDefaultConfigImpl();
//                    WxMaDefaultConfigImpl config = new WxMaRedisConfigImpl(new JedisPool());
                                GitEggWxMaRedissonConfigImpl config = new GitEggWxMaRedissonConfigImpl(redissonClient);
                                // 使用上面的配置時，需要同時引入jedis-lock的依賴，否則會報類無法找到的異常
                                config.setTenantId(null != a.getTenantId() ? a.getTenantId().toString() : AuthConstant.DEFAULT_TENANT_ID.toString());
                                config.setConfigKey(config.getTenantId() + StrPool.UNDERLINE + a.getAppid());
                                config.setAppid(a.getAppid());
                                config.setSecret(a.getSecret());
                                config.setToken(a.getToken());
                                config.setAesKey(a.getAesKey());
                                config.setMsgDataFormat(a.getMsgDataFormat());
                                return config;
                            }).collect(Collectors.toMap( GitEggWxMaRedissonConfigImpl::getConfigKey, a -> a, (o, n) -> o)));
        }
        return maService;
    }

二、服務啟動時加載微信小程序配置信息

1、新增加載方法，服務啟動時加載配置數據需要排除多租戶插件，之所以在啟動時加載配置信息到緩存，是因為配置的微服務和小程序相關功能的服務不是同一個服務，所以將緩存作為相關配置的存儲

MiniappMapper中新增initMiniappList數據庫查詢方法，一定要加@InterceptorIgnore(tenantLine = “true”)注解，表示此查詢不需要多租戶控制，在服務啟動時不區分租戶加載所有配置。

/**
     * 排除多租戶插件查詢微信配置列表
     * @param miniappDTO
     * @return
     */
    @InterceptorIgnore(tenantLine = "true")
    List<MiniappDTO> initMiniappList(@Param("miniapp") QueryMiniappDTO miniappDTO);

<!-- 不區分租戶查詢微信小程序配置信息 -->
    <select id="getMiniapp" resultType="com.gitegg.boot.extension.wx.miniapp.dto.MiniappDTO" parameterType="com.gitegg.boot.extension.wx.miniapp.dto.QueryMiniappDTO">
        SELECT
        <include refid="Base_Column_List"/>
        FROM t_wechat_miniapp
        WHERE del_flag = 0
        <if test="miniapp.miniappName != null and miniapp.miniappName != ''">
            AND miniapp_name = #{miniapp.miniappName}
        </if>
        <if test="miniapp.appid != null and miniapp.appid != ''">
            AND appid = #{miniapp.appid}
        </if>
        <if test="miniapp.secret != null and miniapp.secret != ''">
            AND secret = #{miniapp.secret}
        </if>
        <if test="miniapp.status != null and miniapp.status != ''">
            AND status = #{miniapp.status}
        </if>
        ORDER BY id DESC
    </select>

MiniappServiceImpl中新增initMiniappList接口的實現方法，緩存配置的增刪查改方法也在此類中實現，這里不再贅述，更多了解可以查看框架代碼。

/**
     * 初始化微信小程序配置表列表
     * @return
     */
    @Override
    public void initMiniappList() {
        QueryMiniappDTO miniappDTO = new QueryMiniappDTO();
        miniappDTO.setStatus(String.valueOf(GitEggConstant.ENABLE));
        // 這里初始化所有的配置，不再只初始化已啟用的配置
        List<MiniappDTO> miniappInfoList = miniappMapper.initMiniappList(miniappDTO);

        // 判斷是否開啟了租戶模式，如果開啟了，那么需要按租戶進行分類存儲
        if (enable) {
            Map<String, List<MiniappDTO>> miniappListMap =
                    miniappInfoList.stream().collect(Collectors.groupingBy(MiniappDTO::getAppid));
            miniappListMap.forEach((key, value) -> {
                String redisKey = MiniappConstant.WX_MINIAPP_TENANT_CONFIG_KEY + key;
                redisTemplate.delete(redisKey);
                addMiniapp(redisKey, value);
            });
        } else {
            redisTemplate.delete(MiniappConstant.WX_MINIAPP_CONFIG_KEY);
            addMiniapp(MiniappConstant.WX_MINIAPP_CONFIG_KEY, miniappInfoList);
        }
    }

在InitExtensionCacheRunner系統配置加載類中新增initMiniappList的調用

/**
 * 容器啟動完成加載擴展信息數據到緩存
 * @author GitEgg
 */
@Slf4j
@RequiredArgsConstructor(onConstructor_ = @Autowired)
@Component
public class InitExtensionCacheRunner implements CommandLineRunner {
    
    private final IJustAuthConfigService justAuthConfigService;
    
    private final IJustAuthSourceService justAuthSourceService;

    private final IMailChannelService mailChannelService;

    private final IMiniappService miniappService;

    @Override
    public void run(String... args) {

        log.info("InitExtensionCacheRunner running");
    
    
        // 初始化第三方登錄主配置
        justAuthConfigService.initJustAuthConfigList();

        // 初始化第三方登錄 第三方配置
        justAuthSourceService.initJustAuthSourceList();

        // 初始化郵件配置信息
        mailChannelService.initMailChannelList();

        // 初始化微信配置信息
        miniappService.initMiniappList();

    }
}

2、實現動態選擇某個租戶微信小程序接口的方法，我們需要在保證原先讀取配置文件的方式仍然可用的基礎上擴展讀取數據庫緩存配置信息，所以，在接口實現時需要充分考慮原先配置方式可用

通過appid獲取組裝后的key值，在WxMaService中存儲著默認以appid為key值的配置configMap，這里我們將key值修改為tenantId_appid的格式，作為多租戶的擴展，同時在獲取配置信息時，也需要傳入多租戶信息。
如果前端傳了租戶，那么先使用前端的租戶，如果沒有傳租戶，那么從系統中查詢租戶。
從緩存獲取配置對象，如果md5配置和系統配置不一樣，那么需要重新add。
緩存配置中沒有也需要直接返回，因為有可能是配置文件配置的。
取緩存中所有appid的配置租戶，如果存在多個租戶，那么提示錯誤，讓前端選擇租戶；如果只有一個租戶，那么返回。

/**
     * 通過appid獲取appid，忽略租戶插件
     * @param miniappId
     * @return
     */
    @Override
    public String getMiniappId(String miniappId) {
        if (enable) {
            // 如果前端傳了租戶，那么先使用前端的租戶，如果沒有傳租戶，那么從系統中查詢租戶
            String tenantId = GitEggAuthUtils.getTenantId();
            if (!StringUtils.isEmpty(tenantId))
            {
                String miniappStr = (String) redisTemplate.opsForHash().get(MiniappConstant.WX_MINIAPP_TENANT_CONFIG_KEY + miniappId, tenantId);
                if (!StringUtils.isEmpty(miniappStr))
                {
                    // 轉為系統配置對象
                    try {
                        // 從緩存獲取配置對象，如果md5配置和系統配置不一樣，那么需要重新add
                        MiniappDTO miniappDTO = JsonUtils.jsonToPojo(miniappStr, MiniappDTO.class);
                        return this.ifConfig(miniappDTO);
                    } catch (Exception e) {
                        log.error("獲取微信小程序配置時發生異常：{}", e);
                        throw new BusinessException("獲取微信小程序配置時發生異常。");
                    }
                }
                // 緩存配置中沒有也需要直接返回，因為有可能是配置文件配置的
                return tenantId + StrPool.UNDERLINE + miniappId;
            } else {
                String redisKey = MiniappConstant.WX_MINIAPP_TENANT_CONFIG_KEY + miniappId;
                // 取緩存中所有appid的配置租戶，如果存在多個租戶，那么提示錯誤，讓前端選擇租戶；如果只有一個租戶，那么返回
                List<Object> values = redisTemplate.opsForHash().values(redisKey);
                if (!CollectionUtils.isEmpty(values))
                {
                    if (values.size() > GitEggConstant.Number.ONE)
                    {
                        throw new BusinessException("此小程序配置在多個租戶下，請選擇所需要操作的租戶。");
                    }

                    String miniappConfig = (String) values.stream().findFirst().orElse(null);
                    try {
                        MiniappDTO miniappConfigDTO = JsonUtils.jsonToPojo(miniappConfig, MiniappDTO.class);
                        return this.ifConfig(miniappConfigDTO);
                    } catch (Exception e) {
                        log.error("獲取緩存小程序配置失敗:{}", e);
                        throw new BusinessException("小程序已被禁用，請聯系管理員");
                    }
                }
                else
                {
                    return AuthConstant.DEFAULT_TENANT_ID + StrPool.UNDERLINE + miniappId;
                }

            }
        } else {
            return AuthConstant.DEFAULT_TENANT_ID + StrPool.UNDERLINE + miniappId;
        }
    }

3、修改原先的切換租戶方法調用，在WxMaUserController中，將原來的wxMaService.switchover(appid)修改為我們自己的實現miniappService.switchover(appid)，其它有切換租戶調用的都改為此方法

if (!miniappService.switchover(appid)) {
            throw new IllegalArgumentException(String.format("未找到對應appid=[%s]的配置，請核實！", appid));
        }

4、微信小程序前端代碼不需要修改，還是按照前面章節的說明進行調用即可。在請求中加入appid，在請求頭中加入租戶id

import request from '@/common/utils/request'

const wechatLoginApi = {
  Login: '/extension/wx/user/'
}

export default wechatLoginApi

/**
 * 微信登錄
 * @param {Object} appId
 * @param {Object} parameter
 */
export function wechatLogin (appId, parameter) {
  return request({
    url: wechatLoginApi.Login + appId + '/login',
    method: 'get',
    params: parameter
  })
}

/**
 * 獲取微信信息
 * @param {Object} appId
 * @param {Object} parameter
 */
export function wechatInfo (appId, parameter) {
  return request({
    url: wechatLoginApi.Login + appId + '/info',
    method: 'get',
    params: parameter
  })
}

/**
 * 獲取手機號
 * @param {Object} appId
 * @param {Object} parameter
 */
export function wechatPhone (appId, parameter) {
  return request({
    url: wechatLoginApi.Login + appId + '/phone',
    method: 'get',
    params: parameter
  })
}

在修改配置時，一定需要注意權限問題，一般情況下，在不同的租戶下不允許配置相同的微信小程序，因為appid是唯一的，在發布微信小程序后，微信小程序是唯一的。當然也有特殊的情況，比如，同一個小程序作為多個租戶相同的商戶管理端，那么在此時，需要讓用戶在前端選擇輸入租戶標識以確定登錄用戶屬于哪個租戶，即多個租戶共用同一個微信小程序。

責任編輯：姜華來源：今日頭條

Spring 多租戶配置