public class WxMaDefaultConfigImpl extends Object implements WxMaConfig
| 限定符和类型 | 字段和说明 |
|---|---|
protected Lock |
accessTokenLock |
protected String |
appid |
protected Lock |
cardApiTicketLock |
protected Lock |
jsapiTicketLock |
protected String |
originalId
小程序原始ID
|
protected File |
tmpDirFile
临时文件目录.
|
protected String |
token |
CLOUD_RUN_API_HOST_URL, DEFAULT_API_HOST_URL| 构造器和说明 |
|---|
WxMaDefaultConfigImpl() |
| 限定符和类型 | 方法和说明 |
|---|---|
boolean |
autoRefreshToken()
是否在 token 失效时自动刷新
|
void |
enableUpdateAccessTokenBefore(boolean enableUpdateAccessTokenBefore)
可临时关闭更新token回调,主要用于其他介质初始化数据时,可不进行回调
|
void |
expireAccessToken()
强制将 access_token 标记为已过期
|
void |
expireCardApiTicket()
强制将卡券 api_ticket 标记为已过期
|
void |
expireJsapiTicket()
强制将 jsapi_ticket 标记为已过期
|
protected long |
expiresAheadInMillis(int expiresInSeconds)
会过期的数据提前过期时间,默认预留200秒的时间
|
String |
getAccessToken()
获取当前的 access_token
|
Lock |
getAccessTokenLock()
获取用于保护 access_token 更新的锁(线程安全用)
|
String |
getAesKey()
获取消息加解密使用的 AES 密钥(用于消息加密/解密)
|
ApacheHttpClientBuilder |
getApacheHttpClientBuilder()
获取用于创建 HTTP 客户端的 ApacheHttpClientBuilder
|
String |
getApiSignatureAesKey()
服务端 API 签名用到的 AES 密钥
API 签名文档
|
String |
getApiSignatureAesKeySn()
密钥对应的序号
|
String |
getApiSignatureRsaPrivateKey()
服务端 API 签名用到的 RSA 私钥(pkcs8 格式,会以 -----BEGIN PRIVATE KEY----- 开头,
'BEGIN RSA PRIVATE KEY' 的是 pkcs1 格式,需要转换(可用 openssl 转换)。
|
String |
getApiSignatureRsaPrivateKeySn()
密钥对应的序号
|
String |
getAppid()
获取小程序的 appId
|
String |
getCardApiTicket()
获取卡券相关的 api_ticket
|
Lock |
getCardApiTicketLock()
获取用于保护卡券 api_ticket 更新的锁(线程安全用)
|
String |
getCloudEnv()
获取云开发(Cloud)环境标识
|
long |
getExpiresTime()
获取 access_token 或 ticket 的过期时间(时间戳)
|
String |
getHttpProxyHost()
获取 HTTP 代理主机
|
String |
getHttpProxyPassword()
获取 HTTP 代理密码
|
int |
getHttpProxyPort()
获取 HTTP 代理端口
|
String |
getHttpProxyUsername()
获取 HTTP 代理用户名
|
String |
getJsapiTicket()
获取当前的 JSAPI ticket
|
Lock |
getJsapiTicketLock()
获取用于保护 jsapi_ticket 更新的锁(线程安全用)
|
int |
getMaxRetryTimes()
HTTP 请求最大重试次数
BaseWxMaServiceImpl.setMaxRetryTimes(int)
|
String |
getMsgDataFormat()
获取消息数据的格式(例如 json)
|
String |
getOriginalId()
获取原始 ID(原始公众号/小程序 ID)
|
int |
getRetrySleepMillis()
HTTP 请求重试间隔(毫秒)
BaseWxMaServiceImpl.setRetrySleepMillis(int)
|
String |
getSecret()
获取小程序的 secret
|
String |
getToken()
获取消息校验用的 token
|
String |
getWechatMpAppid()
密钥对应的小程序 ID(普通小程序为 appId,托管第三方平台为 componentAppId)
|
boolean |
isAccessTokenExpired()
判断 access_token 是否已过期
|
boolean |
isCardApiTicketExpired()
判断卡券 api_ticket 是否已过期
|
protected boolean |
isExpired(long expiresTime)
判断 expiresTime 是否已经过期
|
boolean |
isJsapiTicketExpired()
判断 jsapi_ticket 是否已过期
|
boolean |
isStableAccessToken() |
boolean |
isUseWxCloudRun()
是否使用微信云托管内网模式
当部署在微信云托管环境时,api.weixin.qq.com 会被解析为内网地址,此时需要使用 HTTP 协议访问
开启此配置后,SDK 会自动将 https://api.weixin.qq.com 替换为 http://api.weixin.qq.com
|
void |
setAccessToken(String accessToken) |
void |
setAccessTokenLock(Lock accessTokenLock) |
void |
setAccessTokenUrl(String accessTokenUrl)
设置自定义的获取 accessToken 地址,可用于设置获取 accessToken 的自定义服务
|
void |
setAesKey(String aesKey) |
void |
setApacheHttpClientBuilder(ApacheHttpClientBuilder apacheHttpClientBuilder) |
void |
setApiHostUrl(String apiHostUrl)
设置自定义的 apiHost 地址
具体取值,可以参考 API 域名文档
|
void |
setApiSignatureAesKey(String apiSignatureAesKey) |
void |
setApiSignatureAesKeySn(String apiSignatureAesKeySn) |
void |
setApiSignatureRsaPrivateKey(String apiSignatureRsaPrivateKey) |
void |
setApiSignatureRsaPrivateKeySn(String apiSignatureRsaPrivateKeySn) |
void |
setAppid(String appid) |
void |
setCloudEnv(String cloudEnv) |
void |
setExpiresTime(long expiresTime) |
void |
setHttpProxyHost(String httpProxyHost) |
void |
setHttpProxyPassword(String httpProxyPassword) |
void |
setHttpProxyPort(int httpProxyPort) |
void |
setHttpProxyUsername(String httpProxyUsername) |
void |
setMaxRetryTimes(int maxRetryTimes) |
void |
setMsgDataFormat(String msgDataFormat) |
void |
setOriginalId(String originalId) |
void |
setRetrySleepMillis(int retrySleepMillis) |
void |
setSecret(String secret) |
void |
setToken(String token) |
void |
setUseWxCloudRun(boolean useWxCloudRun)
设置是否使用微信云托管内网模式
当部署在微信云托管环境时,api.weixin.qq.com 会被解析为内网地址,此时需要使用 HTTP 协议访问
开启此配置后,SDK 会自动将 https://api.weixin.qq.com 替换为 http://api.weixin.qq.com
|
void |
setWechatMpAppid(String wechatMpAppid) |
String |
toString() |
void |
updateAccessToken(String accessToken,
int expiresInSeconds)
应该是线程安全的
|
void |
updateAccessTokenBefore(WxAccessTokenEntity wxAccessTokenEntity) |
void |
updateCardApiTicket(String cardApiTicket,
int expiresInSeconds)
应该是线程安全的
|
void |
updateJsapiTicket(String jsapiTicket,
int expiresInSeconds)
应该是线程安全的
|
void |
useStableAccessToken(boolean useStableAccessToken) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetAccessTokenUrl, getApiHostUrl, getEffectiveApiHostUrl, setUpdateAccessTokenBefore, updateAccessToken, updateAccessTokenProcessorprotected volatile String appid
protected volatile String token
protected volatile String originalId
protected Lock accessTokenLock
protected volatile File tmpDirFile
protected volatile Lock jsapiTicketLock
protected volatile Lock cardApiTicketLock
public void enableUpdateAccessTokenBefore(boolean enableUpdateAccessTokenBefore)
protected long expiresAheadInMillis(int expiresInSeconds)
protected boolean isExpired(long expiresTime)
public String getAccessToken()
WxMaConfiggetAccessToken 在接口中 WxMaConfigpublic void setAccessToken(String accessToken)
public boolean isStableAccessToken()
isStableAccessToken 在接口中 WxMaConfigpublic void useStableAccessToken(boolean useStableAccessToken)
useStableAccessToken 在接口中 WxMaConfigpublic Lock getAccessTokenLock()
WxMaConfiggetAccessTokenLock 在接口中 WxMaConfigpublic void setAccessTokenLock(Lock accessTokenLock)
public boolean isAccessTokenExpired()
WxMaConfigisAccessTokenExpired 在接口中 WxMaConfigpublic void updateAccessToken(String accessToken, int expiresInSeconds)
WxMaConfigupdateAccessToken 在接口中 WxMaConfigaccessToken - 新的 access_token 值expiresInSeconds - 过期时间,单位:秒public void updateAccessTokenBefore(WxAccessTokenEntity wxAccessTokenEntity)
updateAccessTokenBefore 在接口中 WxMaConfigpublic String getJsapiTicket()
WxMaConfiggetJsapiTicket 在接口中 WxMaConfigpublic Lock getJsapiTicketLock()
WxMaConfiggetJsapiTicketLock 在接口中 WxMaConfigpublic boolean isJsapiTicketExpired()
WxMaConfigisJsapiTicketExpired 在接口中 WxMaConfigpublic void expireJsapiTicket()
WxMaConfigexpireJsapiTicket 在接口中 WxMaConfigpublic void updateJsapiTicket(String jsapiTicket, int expiresInSeconds)
WxMaConfigupdateJsapiTicket 在接口中 WxMaConfigjsapiTicket - 新的 jsapi_ticket 值expiresInSeconds - 过期时间,单位:秒public String getCardApiTicket()
WxMaConfiggetCardApiTicket 在接口中 WxMaConfigpublic Lock getCardApiTicketLock()
WxMaConfiggetCardApiTicketLock 在接口中 WxMaConfigpublic boolean isCardApiTicketExpired()
WxMaConfigisCardApiTicketExpired 在接口中 WxMaConfigpublic void expireCardApiTicket()
WxMaConfigexpireCardApiTicket 在接口中 WxMaConfigpublic void updateCardApiTicket(String cardApiTicket, int expiresInSeconds)
WxMaConfigupdateCardApiTicket 在接口中 WxMaConfigcardApiTicket - 新的卡券 api_ticket 值expiresInSeconds - 过期时间,单位:秒public void expireAccessToken()
WxMaConfigexpireAccessToken 在接口中 WxMaConfigpublic String getSecret()
WxMaConfiggetSecret 在接口中 WxMaConfigpublic void setSecret(String secret)
public String getToken()
WxMaConfiggetToken 在接口中 WxMaConfigpublic void setToken(String token)
public long getExpiresTime()
WxMaConfiggetExpiresTime 在接口中 WxMaConfigpublic void setExpiresTime(long expiresTime)
public String getAesKey()
WxMaConfiggetAesKey 在接口中 WxMaConfigpublic void setAesKey(String aesKey)
public String getApiSignatureRsaPrivateKey()
WxMaConfiggetApiSignatureRsaPrivateKey 在接口中 WxMaConfigpublic void setApiSignatureRsaPrivateKey(String apiSignatureRsaPrivateKey)
public String getApiSignatureAesKey()
WxMaConfiggetApiSignatureAesKey 在接口中 WxMaConfigpublic void setApiSignatureAesKey(String apiSignatureAesKey)
public String getApiSignatureRsaPrivateKeySn()
WxMaConfiggetApiSignatureRsaPrivateKeySn 在接口中 WxMaConfigpublic void setApiSignatureRsaPrivateKeySn(String apiSignatureRsaPrivateKeySn)
public String getApiSignatureAesKeySn()
WxMaConfiggetApiSignatureAesKeySn 在接口中 WxMaConfigpublic void setApiSignatureAesKeySn(String apiSignatureAesKeySn)
public String getWechatMpAppid()
WxMaConfiggetWechatMpAppid 在接口中 WxMaConfigpublic void setWechatMpAppid(String wechatMpAppid)
public String getOriginalId()
WxMaConfiggetOriginalId 在接口中 WxMaConfigpublic void setOriginalId(String originalId)
public String getCloudEnv()
WxMaConfiggetCloudEnv 在接口中 WxMaConfigpublic void setCloudEnv(String cloudEnv)
public String getMsgDataFormat()
WxMaConfiggetMsgDataFormat 在接口中 WxMaConfigpublic void setMsgDataFormat(String msgDataFormat)
public String getHttpProxyHost()
WxMaConfiggetHttpProxyHost 在接口中 WxMaConfigpublic void setHttpProxyHost(String httpProxyHost)
public int getHttpProxyPort()
WxMaConfiggetHttpProxyPort 在接口中 WxMaConfigpublic void setHttpProxyPort(int httpProxyPort)
public String getHttpProxyUsername()
WxMaConfiggetHttpProxyUsername 在接口中 WxMaConfigpublic void setHttpProxyUsername(String httpProxyUsername)
public String getHttpProxyPassword()
WxMaConfiggetHttpProxyPassword 在接口中 WxMaConfigpublic void setHttpProxyPassword(String httpProxyPassword)
public int getRetrySleepMillis()
WxMaConfig
BaseWxMaServiceImpl.setRetrySleepMillis(int)
getRetrySleepMillis 在接口中 WxMaConfigpublic void setRetrySleepMillis(int retrySleepMillis)
public int getMaxRetryTimes()
WxMaConfig
BaseWxMaServiceImpl.setMaxRetryTimes(int)
getMaxRetryTimes 在接口中 WxMaConfigpublic void setMaxRetryTimes(int maxRetryTimes)
public ApacheHttpClientBuilder getApacheHttpClientBuilder()
WxMaConfiggetApacheHttpClientBuilder 在接口中 WxMaConfigpublic void setApacheHttpClientBuilder(ApacheHttpClientBuilder apacheHttpClientBuilder)
public boolean autoRefreshToken()
WxMaConfigautoRefreshToken 在接口中 WxMaConfigpublic void setApiHostUrl(String apiHostUrl)
WxMaConfigsetApiHostUrl 在接口中 WxMaConfigapiHostUrl - api 域名地址public void setAccessTokenUrl(String accessTokenUrl)
WxMaConfigsetAccessTokenUrl 在接口中 WxMaConfigaccessTokenUrl - 自定义的获取 accessToken 地址public boolean isUseWxCloudRun()
WxMaConfigisUseWxCloudRun 在接口中 WxMaConfigpublic void setUseWxCloudRun(boolean useWxCloudRun)
WxMaConfigsetUseWxCloudRun 在接口中 WxMaConfiguseWxCloudRun - 是否使用微信云托管模式public String getAppid()
WxMaConfiggetAppid 在接口中 WxMaConfigpublic void setAppid(String appid)
Copyright © 2026. All rights reserved.