mirror of
https://gitee.com/binary/weixin-java-tools.git
synced 2026-03-10 00:13:40 +08:00
🎨 #3840 小程序和公众号的多租户starter添加多租户共享模式以优化资源使用
This commit is contained in:
@@ -4,6 +4,7 @@ import com.binarywang.spring.starter.wxjava.miniapp.properties.WxMaMultiProperti
|
||||
import com.binarywang.spring.starter.wxjava.miniapp.properties.WxMaSingleProperties;
|
||||
import com.binarywang.spring.starter.wxjava.miniapp.service.WxMaMultiServices;
|
||||
import com.binarywang.spring.starter.wxjava.miniapp.service.WxMaMultiServicesImpl;
|
||||
import com.binarywang.spring.starter.wxjava.miniapp.service.WxMaMultiServicesSharedImpl;
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import cn.binarywang.wx.miniapp.api.WxMaService;
|
||||
@@ -16,8 +17,10 @@ import cn.binarywang.wx.miniapp.config.impl.WxMaDefaultConfigImpl;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
|
||||
import java.util.Collection;
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
import java.util.TreeMap;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
/**
|
||||
@@ -33,9 +36,10 @@ public abstract class AbstractWxMaConfiguration {
|
||||
protected WxMaMultiServices wxMaMultiServices(WxMaMultiProperties wxMaMultiProperties) {
|
||||
Map<String, WxMaSingleProperties> appsMap = wxMaMultiProperties.getApps();
|
||||
if (appsMap == null || appsMap.isEmpty()) {
|
||||
log.warn("微信公众号应用参数未配置,通过 WxMaMultiServices#getWxMaService(\"tenantId\")获取实例将返回空");
|
||||
log.warn("微信小程序应用参数未配置,通过 WxMaMultiServices#getWxMaService(\"tenantId\")获取实例将返回空");
|
||||
return new WxMaMultiServicesImpl();
|
||||
}
|
||||
|
||||
/**
|
||||
* 校验 appId 是否唯一,避免使用 redis 缓存 token、ticket 时错乱。
|
||||
*
|
||||
@@ -49,12 +53,29 @@ public abstract class AbstractWxMaConfiguration {
|
||||
.collect(Collectors.groupingBy(c -> c.getAppId() == null ? 0 : c.getAppId(), Collectors.counting()))
|
||||
.entrySet().stream().anyMatch(e -> e.getValue() > 1);
|
||||
if (multi) {
|
||||
throw new RuntimeException("请确保微信公众号配置 appId 的唯一性");
|
||||
throw new RuntimeException("请确保微信小程序配置 appId 的唯一性");
|
||||
}
|
||||
}
|
||||
WxMaMultiServicesImpl services = new WxMaMultiServicesImpl();
|
||||
|
||||
// 根据配置选择多租户模式
|
||||
WxMaMultiProperties.MultiTenantMode mode = wxMaMultiProperties.getConfigStorage().getMultiTenantMode();
|
||||
if (mode == WxMaMultiProperties.MultiTenantMode.SHARED) {
|
||||
return createSharedMultiServices(appsMap, wxMaMultiProperties);
|
||||
} else {
|
||||
return createIsolatedMultiServices(appsMap, wxMaMultiProperties);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 创建隔离模式的多租户服务(每个租户独立 WxMaService 实例)
|
||||
*/
|
||||
private WxMaMultiServices createIsolatedMultiServices(
|
||||
Map<String, WxMaSingleProperties> appsMap,
|
||||
WxMaMultiProperties wxMaMultiProperties) {
|
||||
|
||||
WxMaMultiServicesImpl services = new WxMaMultiServicesImpl();
|
||||
Set<Map.Entry<String, WxMaSingleProperties>> entries = appsMap.entrySet();
|
||||
|
||||
for (Map.Entry<String, WxMaSingleProperties> entry : entries) {
|
||||
String tenantId = entry.getKey();
|
||||
WxMaSingleProperties wxMaSingleProperties = entry.getValue();
|
||||
@@ -64,9 +85,75 @@ public abstract class AbstractWxMaConfiguration {
|
||||
WxMaService wxMaService = this.wxMaService(storage, wxMaMultiProperties);
|
||||
services.addWxMaService(tenantId, wxMaService);
|
||||
}
|
||||
|
||||
log.info("微信小程序多租户服务初始化完成,使用隔离模式(ISOLATED),共配置 {} 个租户", appsMap.size());
|
||||
return services;
|
||||
}
|
||||
|
||||
/**
|
||||
* 创建共享模式的多租户服务(单个 WxMaService 实例管理多个配置)
|
||||
*/
|
||||
private WxMaMultiServices createSharedMultiServices(
|
||||
Map<String, WxMaSingleProperties> appsMap,
|
||||
WxMaMultiProperties wxMaMultiProperties) {
|
||||
|
||||
// 创建共享的 WxMaService 实例
|
||||
WxMaMultiProperties.ConfigStorage storage = wxMaMultiProperties.getConfigStorage();
|
||||
WxMaService sharedService = createWxMaServiceByType(storage.getHttpClientType());
|
||||
configureWxMaService(sharedService, storage);
|
||||
|
||||
// 准备所有租户的配置,使用 TreeMap 保证顺序一致性
|
||||
Map<String, WxMaConfig> configsMap = new HashMap<>();
|
||||
String defaultTenantId = new TreeMap<>(appsMap).firstKey();
|
||||
|
||||
for (Map.Entry<String, WxMaSingleProperties> entry : appsMap.entrySet()) {
|
||||
String tenantId = entry.getKey();
|
||||
WxMaSingleProperties wxMaSingleProperties = entry.getValue();
|
||||
WxMaDefaultConfigImpl config = this.wxMaConfigStorage(wxMaMultiProperties);
|
||||
this.configApp(config, wxMaSingleProperties);
|
||||
this.configHttp(config, storage);
|
||||
configsMap.put(tenantId, config);
|
||||
}
|
||||
|
||||
// 设置多配置到共享的 WxMaService
|
||||
sharedService.setMultiConfigs(configsMap, defaultTenantId);
|
||||
|
||||
log.info("微信小程序多租户服务初始化完成,使用共享模式(SHARED),共配置 {} 个租户,共享一个 HTTP 客户端", appsMap.size());
|
||||
return new WxMaMultiServicesSharedImpl(sharedService);
|
||||
}
|
||||
|
||||
/**
|
||||
* 根据类型创建 WxMaService 实例
|
||||
*/
|
||||
private WxMaService createWxMaServiceByType(WxMaMultiProperties.HttpClientType httpClientType) {
|
||||
switch (httpClientType) {
|
||||
case OK_HTTP:
|
||||
return new WxMaServiceOkHttpImpl();
|
||||
case JODD_HTTP:
|
||||
return new WxMaServiceJoddHttpImpl();
|
||||
case HTTP_CLIENT:
|
||||
return new WxMaServiceHttpClientImpl();
|
||||
default:
|
||||
return new WxMaServiceImpl();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 配置 WxMaService 的通用参数
|
||||
*/
|
||||
private void configureWxMaService(WxMaService wxMaService, WxMaMultiProperties.ConfigStorage storage) {
|
||||
int maxRetryTimes = storage.getMaxRetryTimes();
|
||||
if (maxRetryTimes < 0) {
|
||||
maxRetryTimes = 0;
|
||||
}
|
||||
int retrySleepMillis = storage.getRetrySleepMillis();
|
||||
if (retrySleepMillis < 0) {
|
||||
retrySleepMillis = 1000;
|
||||
}
|
||||
wxMaService.setRetrySleepMillis(retrySleepMillis);
|
||||
wxMaService.setMaxRetryTimes(maxRetryTimes);
|
||||
}
|
||||
|
||||
/**
|
||||
* 配置 WxMaDefaultConfigImpl
|
||||
*
|
||||
@@ -77,34 +164,9 @@ public abstract class AbstractWxMaConfiguration {
|
||||
|
||||
public WxMaService wxMaService(WxMaConfig wxMaConfig, WxMaMultiProperties wxMaMultiProperties) {
|
||||
WxMaMultiProperties.ConfigStorage storage = wxMaMultiProperties.getConfigStorage();
|
||||
WxMaMultiProperties.HttpClientType httpClientType = storage.getHttpClientType();
|
||||
WxMaService wxMaService;
|
||||
switch (httpClientType) {
|
||||
case OK_HTTP:
|
||||
wxMaService = new WxMaServiceOkHttpImpl();
|
||||
break;
|
||||
case JODD_HTTP:
|
||||
wxMaService = new WxMaServiceJoddHttpImpl();
|
||||
break;
|
||||
case HTTP_CLIENT:
|
||||
wxMaService = new WxMaServiceHttpClientImpl();
|
||||
break;
|
||||
default:
|
||||
wxMaService = new WxMaServiceImpl();
|
||||
break;
|
||||
}
|
||||
|
||||
WxMaService wxMaService = createWxMaServiceByType(storage.getHttpClientType());
|
||||
wxMaService.setWxMaConfig(wxMaConfig);
|
||||
int maxRetryTimes = storage.getMaxRetryTimes();
|
||||
if (maxRetryTimes < 0) {
|
||||
maxRetryTimes = 0;
|
||||
}
|
||||
int retrySleepMillis = storage.getRetrySleepMillis();
|
||||
if (retrySleepMillis < 0) {
|
||||
retrySleepMillis = 1000;
|
||||
}
|
||||
wxMaService.setRetrySleepMillis(retrySleepMillis);
|
||||
wxMaService.setMaxRetryTimes(maxRetryTimes);
|
||||
configureWxMaService(wxMaService, storage);
|
||||
return wxMaService;
|
||||
}
|
||||
|
||||
|
||||
@@ -116,6 +116,15 @@ public class WxMaMultiProperties implements Serializable {
|
||||
* </pre>
|
||||
*/
|
||||
private int retrySleepMillis = 1000;
|
||||
|
||||
/**
|
||||
* 多租户实现模式.
|
||||
* <ul>
|
||||
* <li>ISOLATED: 为每个租户创建独立的 WxMaService 实例(默认)</li>
|
||||
* <li>SHARED: 使用单个 WxMaService 实例管理所有租户配置,共享 HTTP 客户端</li>
|
||||
* </ul>
|
||||
*/
|
||||
private MultiTenantMode multiTenantMode = MultiTenantMode.ISOLATED;
|
||||
}
|
||||
|
||||
public enum StorageType {
|
||||
@@ -151,4 +160,19 @@ public class WxMaMultiProperties implements Serializable {
|
||||
*/
|
||||
JODD_HTTP
|
||||
}
|
||||
|
||||
public enum MultiTenantMode {
|
||||
/**
|
||||
* 隔离模式:为每个租户创建独立的 WxMaService 实例.
|
||||
* 优点:线程安全,不依赖 ThreadLocal
|
||||
* 缺点:每个租户创建独立的 HTTP 客户端,资源占用较多
|
||||
*/
|
||||
ISOLATED,
|
||||
/**
|
||||
* 共享模式:使用单个 WxMaService 实例管理所有租户配置.
|
||||
* 优点:共享 HTTP 客户端,节省资源
|
||||
* 缺点:依赖 ThreadLocal 切换配置,异步场景需注意
|
||||
*/
|
||||
SHARED
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
package com.binarywang.spring.starter.wxjava.miniapp.service;
|
||||
|
||||
import cn.binarywang.wx.miniapp.api.WxMaService;
|
||||
import lombok.RequiredArgsConstructor;
|
||||
|
||||
/**
|
||||
* 微信小程序 {@link WxMaMultiServices} 共享式实现.
|
||||
* <p>
|
||||
* 使用单个 WxMaService 实例管理多个租户配置,通过 switchover 切换租户。
|
||||
* 相比 {@link WxMaMultiServicesImpl},此实现共享 HTTP 客户端,节省资源。
|
||||
* </p>
|
||||
* <p>
|
||||
* 注意:由于使用 ThreadLocal 切换配置,在异步或多线程场景需要特别注意线程上下文切换。
|
||||
* </p>
|
||||
*
|
||||
* @author Binary Wang
|
||||
* created on 2026/1/9
|
||||
*/
|
||||
@RequiredArgsConstructor
|
||||
public class WxMaMultiServicesSharedImpl implements WxMaMultiServices {
|
||||
private final WxMaService sharedWxMaService;
|
||||
|
||||
@Override
|
||||
public WxMaService getWxMaService(String tenantId) {
|
||||
if (tenantId == null) {
|
||||
return null;
|
||||
}
|
||||
// 使用 switchover 检查配置是否存在,保持与隔离模式 API 行为一致(不存在时返回 null)
|
||||
if (!sharedWxMaService.switchover(tenantId)) {
|
||||
return null;
|
||||
}
|
||||
return sharedWxMaService;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void removeWxMaService(String tenantId) {
|
||||
if (tenantId != null) {
|
||||
sharedWxMaService.removeConfig(tenantId);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 添加租户配置到共享的 WxMaService 实例
|
||||
*
|
||||
* @param tenantId 租户 ID
|
||||
* @param wxMaService 要添加配置的 WxMaService(仅使用其配置,不使用其实例)
|
||||
*/
|
||||
public void addWxMaService(String tenantId, WxMaService wxMaService) {
|
||||
if (tenantId != null && wxMaService != null) {
|
||||
sharedWxMaService.addConfig(tenantId, wxMaService.getWxMaConfig());
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user