WxMaConfig (WxJava - MiniApp Java SDK 4.7.0 API)

所有已知实现类:

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

作者:

Binary Wang

方法概要

所有方法实例方法抽象方法默认方法
限定符和类型	方法和说明
`boolean`	`autoRefreshToken()` 是否自动刷新token
`void`	`expireAccessToken()` 强制将access token过期掉
`void`	`expireCardApiTicket()` 强制将卡券api ticket过期掉.
`void`	`expireJsapiTicket()` 强制将jsapi ticket过期掉
`String`	`getAccessToken()` Gets access token.
`Lock`	`getAccessTokenLock()` Gets access token lock.
`String`	`getAccessTokenUrl()` 获取自定义的获取accessToken地址，用于向自定义统一服务获取accessToken
`String`	`getAesKey()` Gets aes key.
`ApacheHttpClientBuilder`	`getApacheHttpClientBuilder()` http client builder
`String`	`getApiHostUrl()` 获取自定义的apiHost地址，用于替换原请求中的https://api.weixin.qq.com 具体取值，可以参考https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Interface_field_description.html
`String`	`getApiSignatureAesKey()` 服务端API签名用到的AES密钥 https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/getting_started/api_signature.html
`String`	`getApiSignatureAesKeySn()` 密钥对应的序号
`String`	`getApiSignatureRsaPrivateKey()` 服务端API签名用到的RSA私钥【pkcs8格式，会以 -----BEGIN PRIVATE KEY-----开头， 'BEGIN RSA PRIVATE KEY'的是pkcs1格式，需要转换（可用openssl转换）。
`String`	`getApiSignatureRsaPrivateKeySn()` 密钥对应的序号
`String`	`getAppid()` Gets appid.
`String`	`getCardApiTicket()` 卡券api_ticket.
`Lock`	`getCardApiTicketLock()` Gets card api ticket lock.
`String`	`getCloudEnv()` Gets cloud env.
`long`	`getExpiresTime()` Gets expires time.
`String`	`getHttpProxyHost()` Gets http proxy host.
`String`	`getHttpProxyPassword()` Gets http proxy password.
`int`	`getHttpProxyPort()` Gets http proxy port.
`String`	`getHttpProxyUsername()` Gets http proxy username.
`String`	`getJsapiTicket()` Gets jsapi ticket.
`Lock`	`getJsapiTicketLock()` Gets jsapi ticket lock.
`int`	`getMaxRetryTimes()` http 请求最大重试次数 `BaseWxMaServiceImpl.setMaxRetryTimes(int)`
`String`	`getMsgDataFormat()` Gets msg data format.
`String`	`getOriginalId()` Gets original id.
`int`	`getRetrySleepMillis()` http 请求重试间隔 `BaseWxMaServiceImpl.setRetrySleepMillis(int)`
`String`	`getSecret()` Gets secret.
`String`	`getToken()` Gets token.
`String`	`getWechatMpAppid()` 密钥对应的小程序ID （普通小程序同 appId，托管第三方平台的是 componentAppId）
`boolean`	`isAccessTokenExpired()` Is access token expired boolean.
`boolean`	`isCardApiTicketExpired()` Is card api ticket expired boolean.
`boolean`	`isJsapiTicketExpired()` Is jsapi ticket expired boolean.
`boolean`	`isStableAccessToken()`
`void`	`setAccessTokenUrl(String accessTokenUrl)` 设置自定义的获取accessToken地址可用于设置获取accessToken的自定义服务
`void`	`setApiHostUrl(String apiHostUrl)` 设置自定义的apiHost地址具体取值，可以参考https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Interface_field_description.html
`default void`	`setUpdateAccessTokenBefore(java.util.function.Consumer<WxAccessTokenEntity> updateAccessTokenBefore)`
`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)`

- 方法详细资料
  - setUpdateAccessTokenBefore
```
default void setUpdateAccessTokenBefore(java.util.function.Consumer<WxAccessTokenEntity> updateAccessTokenBefore)
```
  - getAccessToken
```
String getAccessToken()
```
    Gets access token.
    
    返回:
    
    the access token
  - isStableAccessToken
```
boolean isStableAccessToken()
```
  - useStableAccessToken
```
void useStableAccessToken(boolean useStableAccessToken)
```
  - getAccessTokenLock
```
Lock getAccessTokenLock()
```
    Gets access token lock.
    
    返回:
    
    the access token lock
  - isAccessTokenExpired
```
boolean isAccessTokenExpired()
```
    Is access token expired boolean.
    
    返回:
    
    the boolean
  - expireAccessToken
```
void expireAccessToken()
```
    强制将access token过期掉
  - updateAccessToken
```
default void updateAccessToken(WxAccessToken accessToken)
```
    应该是线程安全的
    
    参数:
    
    accessToken - 要更新的WxAccessToken对象
  - updateAccessToken
```
void updateAccessToken(String accessToken,
                       int expiresInSeconds)
```
    应该是线程安全的
    
    参数:
    
    accessToken - 新的accessToken值
    
    expiresInSeconds - 过期时间，以秒为单位
  - updateAccessTokenProcessor
```
default void updateAccessTokenProcessor(String accessToken,
                                        int expiresInSeconds)
```
  - updateAccessTokenBefore
```
default void updateAccessTokenBefore(WxAccessTokenEntity wxAccessTokenEntity)
```
  - getJsapiTicket
```
String getJsapiTicket()
```
    Gets jsapi ticket.
    
    返回:
    
    the jsapi ticket
  - getJsapiTicketLock
```
Lock getJsapiTicketLock()
```
    Gets jsapi ticket lock.
    
    返回:
    
    the jsapi ticket lock
  - isJsapiTicketExpired
```
boolean isJsapiTicketExpired()
```
    Is jsapi ticket expired boolean.
    
    返回:
    
    the boolean
  - expireJsapiTicket
```
void expireJsapiTicket()
```
    强制将jsapi ticket过期掉
  - updateJsapiTicket
```
void updateJsapiTicket(String jsapiTicket,
                       int expiresInSeconds)
```
    应该是线程安全的
    
    参数:
    
    jsapiTicket - 新的jsapi ticket值
    
    expiresInSeconds - 过期时间，以秒为单位
  - getCardApiTicket
```
String getCardApiTicket()
```
    卡券api_ticket.
    
    返回:
    
    the card api ticket
  - getCardApiTicketLock
```
Lock getCardApiTicketLock()
```
    Gets card api ticket lock.
    
    返回:
    
    the card api ticket lock
  - isCardApiTicketExpired
```
boolean isCardApiTicketExpired()
```
    Is card api ticket expired boolean.
    
    返回:
    
    the boolean
  - expireCardApiTicket
```
void expireCardApiTicket()
```
    强制将卡券api ticket过期掉.
  - updateCardApiTicket
```
void updateCardApiTicket(String apiTicket,
                         int expiresInSeconds)
```
    应该是线程安全的.
    
    参数:
    
    apiTicket - 新的卡券api ticket值
    
    expiresInSeconds - 过期时间，以秒为单位
  - getAppid
```
String getAppid()
```
    Gets appid.
    
    返回:
    
    the appid
  - getSecret
```
String getSecret()
```
    Gets secret.
    
    返回:
    
    the secret
  - getToken
```
String getToken()
```
    Gets token.
    
    返回:
    
    the token
  - getAesKey
```
String getAesKey()
```
    Gets aes key.
    
    返回:
    
    the aes key
  - getOriginalId
```
String getOriginalId()
```
    Gets original id.
    
    返回:
    
    the original id
  - getCloudEnv
```
String getCloudEnv()
```
    Gets cloud env.
    
    返回:
    
    the cloud env
  - getMsgDataFormat
```
String getMsgDataFormat()
```
    Gets msg data format.
    
    返回:
    
    the msg data format
  - getExpiresTime
```
long getExpiresTime()
```
    Gets expires time.
    
    返回:
    
    the expires time
  - getHttpProxyHost
```
String getHttpProxyHost()
```
    Gets http proxy host.
    
    返回:
    
    the http proxy host
  - getHttpProxyPort
```
int getHttpProxyPort()
```
    Gets http proxy port.
    
    返回:
    
    the http proxy port
  - getHttpProxyUsername
```
String getHttpProxyUsername()
```
    Gets http proxy username.
    
    返回:
    
    the http proxy username
  - getHttpProxyPassword
```
String getHttpProxyPassword()
```
    Gets http proxy password.
    
    返回:
    
    the http proxy password
  - getRetrySleepMillis
```
int getRetrySleepMillis()
```
    http 请求重试间隔
```
   BaseWxMaServiceImpl.setRetrySleepMillis(int)
 
```
  - getMaxRetryTimes
```
int getMaxRetryTimes()
```
    http 请求最大重试次数
```
   BaseWxMaServiceImpl.setMaxRetryTimes(int)
 
```
  - getApacheHttpClientBuilder
```
ApacheHttpClientBuilder getApacheHttpClientBuilder()
```
    http client builder
    
    返回:
    
    ApacheHttpClientBuilder apache http client builder
  - autoRefreshToken
```
boolean autoRefreshToken()
```
    是否自动刷新token
    
    返回:
    
    the boolean
  - setApiHostUrl
```
void setApiHostUrl(String apiHostUrl)
```
    设置自定义的apiHost地址具体取值，可以参考https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Interface_field_description.html
    
    参数:
    
    apiHostUrl - api域名地址
  - getApiHostUrl
```
String getApiHostUrl()
```
    获取自定义的apiHost地址，用于替换原请求中的https://api.weixin.qq.com 具体取值，可以参考https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Interface_field_description.html
    
    返回:
    
    自定义的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转换）。设置参考： https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/getting_started/api_signature.html
    
    返回:
    
    rsa private key string
  - getApiSignatureAesKey
```
String getApiSignatureAesKey()
```
    服务端API签名用到的AES密钥 https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/getting_started/api_signature.html
    
    返回:
    
    aes key string
  - getApiSignatureAesKeySn
```
String getApiSignatureAesKeySn()
```
    密钥对应的序号
  - getApiSignatureRsaPrivateKeySn
```
String getApiSignatureRsaPrivateKeySn()
```
    密钥对应的序号
  - getWechatMpAppid
```
String getWechatMpAppid()
```
    密钥对应的小程序ID （普通小程序同 appId，托管第三方平台的是 componentAppId）

接口 WxMaConfig

方法概要

方法详细资料

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