WxMaConfig (WxJava - MiniApp Java SDK 4.8.0 API)

所有已知实现类:

AbstractWxMaRedisConfig, WxMaDefaultConfigImpl, WxMaRedisBetterConfigImpl, WxMaRedisConfigImpl, WxMaRedisConnectionConfigImpl, WxMaRedissonConfigImpl
```
public interface WxMaConfig
```
小程序配置

作者:

Binary Wang

字段概要

字段
限定符和类型	字段和说明
`static String`	`CLOUD_RUN_API_HOST_URL` 微信云托管使用的 HTTP 协议主机地址
`static String`	`DEFAULT_API_HOST_URL` 微信 API 默认主机地址

方法概要

所有方法实例方法抽象方法默认方法
限定符和类型	方法和说明
`boolean`	`autoRefreshToken()` 是否在 token 失效时自动刷新
`void`	`expireAccessToken()` 强制将 access_token 标记为已过期
`void`	`expireCardApiTicket()` 强制将卡券 api_ticket 标记为已过期
`void`	`expireJsapiTicket()` 强制将 jsapi_ticket 标记为已过期
`String`	`getAccessToken()` 获取当前的 access_token
`Lock`	`getAccessTokenLock()` 获取用于保护 access_token 更新的锁（线程安全用）
`String`	`getAccessTokenUrl()` 获取自定义的获取 accessToken 地址，用于向自定义统一服务获取 accessToken
`String`	`getAesKey()` 获取消息加解密使用的 AES 密钥（用于消息加密/解密）
`ApacheHttpClientBuilder`	`getApacheHttpClientBuilder()` 获取用于创建 HTTP 客户端的 ApacheHttpClientBuilder
`String`	`getApiHostUrl()` 获取自定义的 apiHost 地址，用于替换原请求中的 https://api.weixin.qq.com 具体取值，可以参考 API 域名文档
`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）环境标识
`default String`	`getEffectiveApiHostUrl()` 根据配置获取实际应使用的 API 主机地址优先级：自定义 apiHostUrl > 微信云托管模式 > 默认 HTTPS 地址
`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 是否已过期
`boolean`	`isJsapiTicketExpired()` 判断 jsapi_ticket 是否已过期
`boolean`	`isStableAccessToken()`
`default boolean`	`isUseWxCloudRun()` 是否使用微信云托管内网模式当部署在微信云托管环境时，api.weixin.qq.com 会被解析为内网地址，此时需要使用 HTTP 协议访问开启此配置后，SDK 会自动将 https://api.weixin.qq.com 替换为 http://api.weixin.qq.com
`void`	`setAccessTokenUrl(String accessTokenUrl)` 设置自定义的获取 accessToken 地址，可用于设置获取 accessToken 的自定义服务
`void`	`setApiHostUrl(String apiHostUrl)` 设置自定义的 apiHost 地址具体取值，可以参考 API 域名文档
`default void`	`setUpdateAccessTokenBefore(java.util.function.Consumer<WxAccessTokenEntity> updateAccessTokenBefore)`
`default void`	`setUseWxCloudRun(boolean useWxCloudRun)` 设置是否使用微信云托管内网模式当部署在微信云托管环境时，api.weixin.qq.com 会被解析为内网地址，此时需要使用 HTTP 协议访问开启此配置后，SDK 会自动将 https://api.weixin.qq.com 替换为 http://api.weixin.qq.com
`void`	`updateAccessToken(String accessToken, int expiresInSeconds)` 应该是线程安全的
`default void`	`updateAccessToken(WxAccessToken accessToken)` 应该是线程安全的
`default void`	`updateAccessTokenBefore(WxAccessTokenEntity wxAccessTokenEntity)`
`default void`	`updateAccessTokenProcessor(String accessToken, int expiresInSeconds)`
`void`	`updateCardApiTicket(String apiTicket, int expiresInSeconds)` 应该是线程安全的
`void`	`updateJsapiTicket(String jsapiTicket, int expiresInSeconds)` 应该是线程安全的
`void`	`useStableAccessToken(boolean useStableAccessToken)`

- 字段详细资料
  - DEFAULT_API_HOST_URL
```
static final String DEFAULT_API_HOST_URL
```
    微信 API 默认主机地址
    
    另请参阅:
    
    常量字段值
  - CLOUD_RUN_API_HOST_URL
```
static final String CLOUD_RUN_API_HOST_URL
```
    微信云托管使用的 HTTP 协议主机地址
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - setUpdateAccessTokenBefore
```
default void setUpdateAccessTokenBefore(java.util.function.Consumer<WxAccessTokenEntity> updateAccessTokenBefore)
```
  - getAccessToken
```
String getAccessToken()
```
    获取当前的 access_token
    
    返回:
    
    当前的 access_token 字符串
  - isStableAccessToken
```
boolean isStableAccessToken()
```
  - useStableAccessToken
```
void useStableAccessToken(boolean useStableAccessToken)
```
  - getAccessTokenLock
```
Lock getAccessTokenLock()
```
    获取用于保护 access_token 更新的锁（线程安全用）
    
    返回:
    
    access_token 的锁对象
  - isAccessTokenExpired
```
boolean isAccessTokenExpired()
```
    判断 access_token 是否已过期
    
    返回:
    
    如果已过期则返回 true，否则返回 false
  - expireAccessToken
```
void expireAccessToken()
```
    强制将 access_token 标记为已过期
  - updateAccessToken
```
default void updateAccessToken(WxAccessToken accessToken)
```
    应该是线程安全的
    
    参数:
    
    accessToken - 要更新的 WxAccessToken 对象
  - updateAccessToken
```
void updateAccessToken(String accessToken,
                       int expiresInSeconds)
```
    应该是线程安全的
    
    参数:
    
    accessToken - 新的 access_token 值
    
    expiresInSeconds - 过期时间，单位：秒
  - updateAccessTokenProcessor
```
default void updateAccessTokenProcessor(String accessToken,
                                        int expiresInSeconds)
```
  - updateAccessTokenBefore
```
default void updateAccessTokenBefore(WxAccessTokenEntity wxAccessTokenEntity)
```
  - getJsapiTicket
```
String getJsapiTicket()
```
    获取当前的 JSAPI ticket
    
    返回:
    
    当前的 jsapi_ticket 字符串
  - getJsapiTicketLock
```
Lock getJsapiTicketLock()
```
    获取用于保护 jsapi_ticket 更新的锁（线程安全用）
    
    返回:
    
    jsapi_ticket 的锁对象
  - isJsapiTicketExpired
```
boolean isJsapiTicketExpired()
```
    判断 jsapi_ticket 是否已过期
    
    返回:
    
    如果已过期则返回 true，否则返回 false
  - expireJsapiTicket
```
void expireJsapiTicket()
```
    强制将 jsapi_ticket 标记为已过期
  - updateJsapiTicket
```
void updateJsapiTicket(String jsapiTicket,
                       int expiresInSeconds)
```
    应该是线程安全的
    
    参数:
    
    jsapiTicket - 新的 jsapi_ticket 值
    
    expiresInSeconds - 过期时间，单位：秒
  - getCardApiTicket
```
String getCardApiTicket()
```
    获取卡券相关的 api_ticket
    
    返回:
    
    卡券 api_ticket 字符串
  - getCardApiTicketLock
```
Lock getCardApiTicketLock()
```
    获取用于保护卡券 api_ticket 更新的锁（线程安全用）
    
    返回:
    
    卡券 api_ticket 的锁对象
  - isCardApiTicketExpired
```
boolean isCardApiTicketExpired()
```
    判断卡券 api_ticket 是否已过期
    
    返回:
    
    如果已过期则返回 true，否则返回 false
  - expireCardApiTicket
```
void expireCardApiTicket()
```
    强制将卡券 api_ticket 标记为已过期
  - updateCardApiTicket
```
void updateCardApiTicket(String apiTicket,
                         int expiresInSeconds)
```
    应该是线程安全的
    
    参数:
    
    apiTicket - 新的卡券 api_ticket 值
    
    expiresInSeconds - 过期时间，单位：秒
  - getAppid
```
String getAppid()
```
    获取小程序的 appId
    
    返回:
    
    小程序的 appId
  - getSecret
```
String getSecret()
```
    获取小程序的 secret
    
    返回:
    
    小程序的 secret
  - getToken
```
String getToken()
```
    获取消息校验用的 token
    
    返回:
    
    token 字符串
  - getAesKey
```
String getAesKey()
```
    获取消息加解密使用的 AES 密钥（用于消息加密/解密）
    
    返回:
    
    AES 密钥字符串
  - getOriginalId
```
String getOriginalId()
```
    获取原始 ID（原始公众号/小程序 ID）
    
    返回:
    
    原始 ID 字符串
  - getCloudEnv
```
String getCloudEnv()
```
    获取云开发（Cloud）环境标识
    
    返回:
    
    云环境 ID
  - getMsgDataFormat
```
String getMsgDataFormat()
```
    获取消息数据的格式（例如 json）
    
    返回:
    
    消息数据格式字符串
  - getExpiresTime
```
long getExpiresTime()
```
    获取 access_token 或 ticket 的过期时间（时间戳）
    
    返回:
    
    过期时间的毫秒时间戳
  - getHttpProxyHost
```
String getHttpProxyHost()
```
    获取 HTTP 代理主机
    
    返回:
    
    代理主机名或 IP
  - getHttpProxyPort
```
int getHttpProxyPort()
```
    获取 HTTP 代理端口
    
    返回:
    
    代理端口号
  - getHttpProxyUsername
```
String getHttpProxyUsername()
```
    获取 HTTP 代理用户名
    
    返回:
    
    代理用户名
  - getHttpProxyPassword
```
String getHttpProxyPassword()
```
    获取 HTTP 代理密码
    
    返回:
    
    代理密码
  - getRetrySleepMillis
```
int getRetrySleepMillis()
```
    HTTP 请求重试间隔（毫秒）
```
   BaseWxMaServiceImpl.setRetrySleepMillis(int)
 
```
    返回:
    
    重试间隔，单位：毫秒
  - getMaxRetryTimes
```
int getMaxRetryTimes()
```
    HTTP 请求最大重试次数
```
   BaseWxMaServiceImpl.setMaxRetryTimes(int)
 
```
    返回:
    
    最大重试次数
  - getApacheHttpClientBuilder
```
ApacheHttpClientBuilder getApacheHttpClientBuilder()
```
    获取用于创建 HTTP 客户端的 ApacheHttpClientBuilder
    
    返回:
    
    ApacheHttpClientBuilder 实例
  - autoRefreshToken
```
boolean autoRefreshToken()
```
    是否在 token 失效时自动刷新
    
    返回:
    
    如果自动刷新则返回 true，否则返回 false
  - setApiHostUrl
```
void setApiHostUrl(String apiHostUrl)
```
    设置自定义的 apiHost 地址具体取值，可以参考 API 域名文档
    
    参数:
    
    apiHostUrl - api 域名地址
  - getApiHostUrl
```
String getApiHostUrl()
```
    获取自定义的 apiHost 地址，用于替换原请求中的 https://api.weixin.qq.com 具体取值，可以参考 API 域名文档
    
    返回:
    
    自定义的 api 域名地址
  - getAccessTokenUrl
```
String getAccessTokenUrl()
```
    获取自定义的获取 accessToken 地址，用于向自定义统一服务获取 accessToken
    
    返回:
    
    自定义的获取 accessToken 地址
  - setAccessTokenUrl
```
void setAccessTokenUrl(String accessTokenUrl)
```
    设置自定义的获取 accessToken 地址，可用于设置获取 accessToken 的自定义服务
    
    参数:
    
    accessTokenUrl - 自定义的获取 accessToken 地址
  - getApiSignatureRsaPrivateKey
```
String getApiSignatureRsaPrivateKey()
```
    服务端 API 签名用到的 RSA 私钥（pkcs8 格式，会以 -----BEGIN PRIVATE KEY----- 开头， 'BEGIN RSA PRIVATE KEY' 的是 pkcs1 格式，需要转换（可用 openssl 转换）。设置参考： API 签名文档
    
    返回:
    
    RSA 私钥字符串（pkcs8 格式）
  - getApiSignatureAesKey
```
String getApiSignatureAesKey()
```
    服务端 API 签名用到的 AES 密钥 API 签名文档
    
    返回:
    
    AES 密钥字符串
  - getApiSignatureAesKeySn
```
String getApiSignatureAesKeySn()
```
    密钥对应的序号
  - getApiSignatureRsaPrivateKeySn
```
String getApiSignatureRsaPrivateKeySn()
```
    密钥对应的序号
  - getWechatMpAppid
```
String getWechatMpAppid()
```
    密钥对应的小程序 ID（普通小程序为 appId，托管第三方平台为 componentAppId）
  - isUseWxCloudRun
```
default boolean isUseWxCloudRun()
```
    是否使用微信云托管内网模式当部署在微信云托管环境时，api.weixin.qq.com 会被解析为内网地址，此时需要使用 HTTP 协议访问开启此配置后，SDK 会自动将 https://api.weixin.qq.com 替换为 http://api.weixin.qq.com
    
    返回:
    
    是否使用微信云托管模式
    
    另请参阅:
    
    微信云托管内网调用微信接口
  - setUseWxCloudRun
```
default void setUseWxCloudRun(boolean useWxCloudRun)
```
    设置是否使用微信云托管内网模式当部署在微信云托管环境时，api.weixin.qq.com 会被解析为内网地址，此时需要使用 HTTP 协议访问开启此配置后，SDK 会自动将 https://api.weixin.qq.com 替换为 http://api.weixin.qq.com
    
    参数:
    
    useWxCloudRun - 是否使用微信云托管模式
    
    另请参阅:
    
    微信云托管内网调用微信接口
  - getEffectiveApiHostUrl
```
default String getEffectiveApiHostUrl()
```
    根据配置获取实际应使用的 API 主机地址优先级：自定义 apiHostUrl > 微信云托管模式 > 默认 HTTPS 地址
    
    返回:
    
    实际应使用的 API 主机地址

接口 WxMaConfig

字段概要

方法概要

字段详细资料

DEFAULT_API_HOST_URL

CLOUD_RUN_API_HOST_URL

方法详细资料

setUpdateAccessTokenBefore

getAccessToken

isStableAccessToken

useStableAccessToken

getAccessTokenLock

isAccessTokenExpired

expireAccessToken

updateAccessToken

updateAccessToken

updateAccessTokenProcessor

updateAccessTokenBefore

getJsapiTicket

getJsapiTicketLock

isJsapiTicketExpired

expireJsapiTicket

updateJsapiTicket

getCardApiTicket

getCardApiTicketLock

isCardApiTicketExpired

expireCardApiTicket

updateCardApiTicket

getAppid

getSecret

getToken

getAesKey

getOriginalId

getCloudEnv

getMsgDataFormat

getExpiresTime

getHttpProxyHost

getHttpProxyPort

getHttpProxyUsername

getHttpProxyPassword

getRetrySleepMillis

getMaxRetryTimes

getApacheHttpClientBuilder

autoRefreshToken

setApiHostUrl

getApiHostUrl

getAccessTokenUrl

setAccessTokenUrl

getApiSignatureRsaPrivateKey

getApiSignatureAesKey

getApiSignatureAesKeySn

getApiSignatureRsaPrivateKeySn

getWechatMpAppid

isUseWxCloudRun

setUseWxCloudRun

getEffectiveApiHostUrl