WxMaDefaultConfigImpl (WxJava - MiniApp Java SDK 4.7.0 API)

java.lang.Object
- cn.binarywang.wx.miniapp.config.impl.WxMaDefaultConfigImpl

所有已实现的接口:

WxMaConfig

直接已知子类:

AbstractWxMaRedisConfig, WxMaRedisBetterConfigImpl, WxMaRedissonConfigImpl
```
public class WxMaDefaultConfigImpl
extends Object
implements WxMaConfig
```
基于内存的微信配置provider，在实际生产环境中应该将这些配置持久化

作者:

Binary Wang

字段概要

字段
限定符和类型	字段和说明
`protected Lock`	`accessTokenLock`
`protected String`	`appid`
`protected Lock`	`cardApiTicketLock`
`protected Lock`	`jsapiTicketLock`
`protected String`	`originalId` 小程序原始ID
`protected File`	`tmpDirFile` 临时文件目录.
`protected String`	`token`

构造器概要

构造器
构造器和说明

WxMaDefaultConfigImpl()

构造器
构造器和说明
`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()` Gets access token.
`Lock`	`getAccessTokenLock()` Gets access token lock.
`String`	`getAesKey()` Gets aes key.
`ApacheHttpClientBuilder`	`getApacheHttpClientBuilder()` http client builder
`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.
`protected boolean`	`isExpired(long expiresTime)` 判断 expiresTime 是否已经过期
`boolean`	`isJsapiTicketExpired()` Is jsapi ticket expired boolean.
`boolean`	`isStableAccessToken()`
`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地址具体取值，可以参考https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Interface_field_description.html
`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`	`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)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 cn.binarywang.wx.miniapp.config.WxMaConfig
getAccessTokenUrl, getApiHostUrl, setUpdateAccessTokenBefore, updateAccessToken, updateAccessTokenProcessor

- 字段详细资料
  - appid
```
protected volatile String appid
```
  - token
```
protected volatile String token
```
  - originalId
```
protected volatile String originalId
```
    小程序原始ID
  - accessTokenLock
```
protected Lock accessTokenLock
```
  - tmpDirFile
```
protected volatile File tmpDirFile
```
    临时文件目录.
  - jsapiTicketLock
```
protected volatile Lock jsapiTicketLock
```
  - cardApiTicketLock
```
protected volatile Lock cardApiTicketLock
```
- 构造器详细资料
  - WxMaDefaultConfigImpl
```
public WxMaDefaultConfigImpl()
```
- 方法详细资料
  - enableUpdateAccessTokenBefore
```
public void enableUpdateAccessTokenBefore(boolean enableUpdateAccessTokenBefore)
```
    可临时关闭更新token回调，主要用于其他介质初始化数据时，可不进行回调
  - expiresAheadInMillis
```
protected long expiresAheadInMillis(int expiresInSeconds)
```
    会过期的数据提前过期时间，默认预留200秒的时间
  - isExpired
```
protected boolean isExpired(long expiresTime)
```
    判断 expiresTime 是否已经过期
  - getAccessToken
```
public String getAccessToken()
```
    从接口复制的说明: WxMaConfig
    
    Gets access token.
    
    指定者:
    
    getAccessToken 在接口中 WxMaConfig
    
    返回:
    
    the access token
  - setAccessToken
```
public void setAccessToken(String accessToken)
```
  - isStableAccessToken
```
public boolean isStableAccessToken()
```
    指定者:
    
    isStableAccessToken 在接口中 WxMaConfig
  - useStableAccessToken
```
public void useStableAccessToken(boolean useStableAccessToken)
```
    指定者:
    
    useStableAccessToken 在接口中 WxMaConfig
  - getAccessTokenLock
```
public Lock getAccessTokenLock()
```
    从接口复制的说明: WxMaConfig
    
    Gets access token lock.
    
    指定者:
    
    getAccessTokenLock 在接口中 WxMaConfig
    
    返回:
    
    the access token lock
  - setAccessTokenLock
```
public void setAccessTokenLock(Lock accessTokenLock)
```
  - isAccessTokenExpired
```
public boolean isAccessTokenExpired()
```
    从接口复制的说明: WxMaConfig
    
    Is access token expired boolean.
    
    指定者:
    
    isAccessTokenExpired 在接口中 WxMaConfig
    
    返回:
    
    the boolean
  - updateAccessToken
```
public void updateAccessToken(String accessToken,
                              int expiresInSeconds)
```
    从接口复制的说明: WxMaConfig
    
    应该是线程安全的
    
    指定者:
    
    updateAccessToken 在接口中 WxMaConfig
    
    参数:
    
    accessToken - 新的accessToken值
    
    expiresInSeconds - 过期时间，以秒为单位
  - updateAccessTokenBefore
```
public void updateAccessTokenBefore(WxAccessTokenEntity wxAccessTokenEntity)
```
    指定者:
    
    updateAccessTokenBefore 在接口中 WxMaConfig
  - getJsapiTicket
```
public String getJsapiTicket()
```
    从接口复制的说明: WxMaConfig
    
    Gets jsapi ticket.
    
    指定者:
    
    getJsapiTicket 在接口中 WxMaConfig
    
    返回:
    
    the jsapi ticket
  - getJsapiTicketLock
```
public Lock getJsapiTicketLock()
```
    从接口复制的说明: WxMaConfig
    
    Gets jsapi ticket lock.
    
    指定者:
    
    getJsapiTicketLock 在接口中 WxMaConfig
    
    返回:
    
    the jsapi ticket lock
  - isJsapiTicketExpired
```
public boolean isJsapiTicketExpired()
```
    从接口复制的说明: WxMaConfig
    
    Is jsapi ticket expired boolean.
    
    指定者:
    
    isJsapiTicketExpired 在接口中 WxMaConfig
    
    返回:
    
    the boolean
  - expireJsapiTicket
```
public void expireJsapiTicket()
```
    从接口复制的说明: WxMaConfig
    
    强制将jsapi ticket过期掉
    
    指定者:
    
    expireJsapiTicket 在接口中 WxMaConfig
  - updateJsapiTicket
```
public void updateJsapiTicket(String jsapiTicket,
                              int expiresInSeconds)
```
    从接口复制的说明: WxMaConfig
    
    应该是线程安全的
    
    指定者:
    
    updateJsapiTicket 在接口中 WxMaConfig
    
    参数:
    
    jsapiTicket - 新的jsapi ticket值
    
    expiresInSeconds - 过期时间，以秒为单位
  - getCardApiTicket
```
public String getCardApiTicket()
```
    从接口复制的说明: WxMaConfig
    
    卡券api_ticket.
    
    指定者:
    
    getCardApiTicket 在接口中 WxMaConfig
    
    返回:
    
    the card api ticket
  - getCardApiTicketLock
```
public Lock getCardApiTicketLock()
```
    从接口复制的说明: WxMaConfig
    
    Gets card api ticket lock.
    
    指定者:
    
    getCardApiTicketLock 在接口中 WxMaConfig
    
    返回:
    
    the card api ticket lock
  - isCardApiTicketExpired
```
public boolean isCardApiTicketExpired()
```
    从接口复制的说明: WxMaConfig
    
    Is card api ticket expired boolean.
    
    指定者:
    
    isCardApiTicketExpired 在接口中 WxMaConfig
    
    返回:
    
    the boolean
  - expireCardApiTicket
```
public void expireCardApiTicket()
```
    从接口复制的说明: WxMaConfig
    
    强制将卡券api ticket过期掉.
    
    指定者:
    
    expireCardApiTicket 在接口中 WxMaConfig
  - updateCardApiTicket
```
public void updateCardApiTicket(String cardApiTicket,
                                int expiresInSeconds)
```
    从接口复制的说明: WxMaConfig
    
    应该是线程安全的.
    
    指定者:
    
    updateCardApiTicket 在接口中 WxMaConfig
    
    参数:
    
    cardApiTicket - 新的卡券api ticket值
    
    expiresInSeconds - 过期时间，以秒为单位
  - expireAccessToken
```
public void expireAccessToken()
```
    从接口复制的说明: WxMaConfig
    
    强制将access token过期掉
    
    指定者:
    
    expireAccessToken 在接口中 WxMaConfig
  - getSecret
```
public String getSecret()
```
    从接口复制的说明: WxMaConfig
    
    Gets secret.
    
    指定者:
    
    getSecret 在接口中 WxMaConfig
    
    返回:
    
    the secret
  - setSecret
```
public void setSecret(String secret)
```
  - getToken
```
public String getToken()
```
    从接口复制的说明: WxMaConfig
    
    Gets token.
    
    指定者:
    
    getToken 在接口中 WxMaConfig
    
    返回:
    
    the token
  - setToken
```
public void setToken(String token)
```
  - getExpiresTime
```
public long getExpiresTime()
```
    从接口复制的说明: WxMaConfig
    
    Gets expires time.
    
    指定者:
    
    getExpiresTime 在接口中 WxMaConfig
    
    返回:
    
    the expires time
  - setExpiresTime
```
public void setExpiresTime(long expiresTime)
```
  - getAesKey
```
public String getAesKey()
```
    从接口复制的说明: WxMaConfig
    
    Gets aes key.
    
    指定者:
    
    getAesKey 在接口中 WxMaConfig
    
    返回:
    
    the aes key
  - setAesKey
```
public void setAesKey(String aesKey)
```
  - getApiSignatureRsaPrivateKey
```
public String getApiSignatureRsaPrivateKey()
```
    从接口复制的说明: WxMaConfig
    
    服务端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
    
    指定者:
    
    getApiSignatureRsaPrivateKey 在接口中 WxMaConfig
    
    返回:
    
    rsa private key string
  - setApiSignatureRsaPrivateKey
```
public void setApiSignatureRsaPrivateKey(String apiSignatureRsaPrivateKey)
```
  - getApiSignatureAesKey
```
public String getApiSignatureAesKey()
```
    从接口复制的说明: WxMaConfig
    
    服务端API签名用到的AES密钥 https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/getting_started/api_signature.html
    
    指定者:
    
    getApiSignatureAesKey 在接口中 WxMaConfig
    
    返回:
    
    aes key string
  - setApiSignatureAesKey
```
public void setApiSignatureAesKey(String apiSignatureAesKey)
```
  - getApiSignatureRsaPrivateKeySn
```
public String getApiSignatureRsaPrivateKeySn()
```
    从接口复制的说明: WxMaConfig
    
    密钥对应的序号
    
    指定者:
    
    getApiSignatureRsaPrivateKeySn 在接口中 WxMaConfig
  - setApiSignatureRsaPrivateKeySn
```
public void setApiSignatureRsaPrivateKeySn(String apiSignatureRsaPrivateKeySn)
```
  - getApiSignatureAesKeySn
```
public String getApiSignatureAesKeySn()
```
    从接口复制的说明: WxMaConfig
    
    密钥对应的序号
    
    指定者:
    
    getApiSignatureAesKeySn 在接口中 WxMaConfig
  - setApiSignatureAesKeySn
```
public void setApiSignatureAesKeySn(String apiSignatureAesKeySn)
```
  - getWechatMpAppid
```
public String getWechatMpAppid()
```
    从接口复制的说明: WxMaConfig
    
    密钥对应的小程序ID （普通小程序同 appId，托管第三方平台的是 componentAppId）
    
    指定者:
    
    getWechatMpAppid 在接口中 WxMaConfig
  - setWechatMpAppid
```
public void setWechatMpAppid(String wechatMpAppid)
```
  - getOriginalId
```
public String getOriginalId()
```
    从接口复制的说明: WxMaConfig
    
    Gets original id.
    
    指定者:
    
    getOriginalId 在接口中 WxMaConfig
    
    返回:
    
    the original id
  - setOriginalId
```
public void setOriginalId(String originalId)
```
  - getCloudEnv
```
public String getCloudEnv()
```
    从接口复制的说明: WxMaConfig
    
    Gets cloud env.
    
    指定者:
    
    getCloudEnv 在接口中 WxMaConfig
    
    返回:
    
    the cloud env
  - setCloudEnv
```
public void setCloudEnv(String cloudEnv)
```
  - getMsgDataFormat
```
public String getMsgDataFormat()
```
    从接口复制的说明: WxMaConfig
    
    Gets msg data format.
    
    指定者:
    
    getMsgDataFormat 在接口中 WxMaConfig
    
    返回:
    
    the msg data format
  - setMsgDataFormat
```
public void setMsgDataFormat(String msgDataFormat)
```
  - getHttpProxyHost
```
public String getHttpProxyHost()
```
    从接口复制的说明: WxMaConfig
    
    Gets http proxy host.
    
    指定者:
    
    getHttpProxyHost 在接口中 WxMaConfig
    
    返回:
    
    the http proxy host
  - setHttpProxyHost
```
public void setHttpProxyHost(String httpProxyHost)
```
  - getHttpProxyPort
```
public int getHttpProxyPort()
```
    从接口复制的说明: WxMaConfig
    
    Gets http proxy port.
    
    指定者:
    
    getHttpProxyPort 在接口中 WxMaConfig
    
    返回:
    
    the http proxy port
  - setHttpProxyPort
```
public void setHttpProxyPort(int httpProxyPort)
```
  - getHttpProxyUsername
```
public String getHttpProxyUsername()
```
    从接口复制的说明: WxMaConfig
    
    Gets http proxy username.
    
    指定者:
    
    getHttpProxyUsername 在接口中 WxMaConfig
    
    返回:
    
    the http proxy username
  - setHttpProxyUsername
```
public void setHttpProxyUsername(String httpProxyUsername)
```
  - getHttpProxyPassword
```
public String getHttpProxyPassword()
```
    从接口复制的说明: WxMaConfig
    
    Gets http proxy password.
    
    指定者:
    
    getHttpProxyPassword 在接口中 WxMaConfig
    
    返回:
    
    the http proxy password
  - setHttpProxyPassword
```
public void setHttpProxyPassword(String httpProxyPassword)
```
  - getRetrySleepMillis
```
public int getRetrySleepMillis()
```
    从接口复制的说明: WxMaConfig
    http 请求重试间隔
```
   BaseWxMaServiceImpl.setRetrySleepMillis(int)
 
```
    指定者:
    
    getRetrySleepMillis 在接口中 WxMaConfig
  - setRetrySleepMillis
```
public void setRetrySleepMillis(int retrySleepMillis)
```
  - getMaxRetryTimes
```
public int getMaxRetryTimes()
```
    从接口复制的说明: WxMaConfig
    http 请求最大重试次数
```
   BaseWxMaServiceImpl.setMaxRetryTimes(int)
 
```
    指定者:
    
    getMaxRetryTimes 在接口中 WxMaConfig
  - setMaxRetryTimes
```
public void setMaxRetryTimes(int maxRetryTimes)
```
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - getApacheHttpClientBuilder
```
public ApacheHttpClientBuilder getApacheHttpClientBuilder()
```
    从接口复制的说明: WxMaConfig
    
    http client builder
    
    指定者:
    
    getApacheHttpClientBuilder 在接口中 WxMaConfig
    
    返回:
    
    ApacheHttpClientBuilder apache http client builder
  - setApacheHttpClientBuilder
```
public void setApacheHttpClientBuilder(ApacheHttpClientBuilder apacheHttpClientBuilder)
```
  - autoRefreshToken
```
public boolean autoRefreshToken()
```
    从接口复制的说明: WxMaConfig
    
    是否自动刷新token
    
    指定者:
    
    autoRefreshToken 在接口中 WxMaConfig
    
    返回:
    
    the boolean
  - setApiHostUrl
```
public void setApiHostUrl(String apiHostUrl)
```
    从接口复制的说明: WxMaConfig
    
    设置自定义的apiHost地址具体取值，可以参考https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Interface_field_description.html
    
    指定者:
    
    setApiHostUrl 在接口中 WxMaConfig
    
    参数:
    
    apiHostUrl - api域名地址
  - setAccessTokenUrl
```
public void setAccessTokenUrl(String accessTokenUrl)
```
    从接口复制的说明: WxMaConfig
    
    设置自定义的获取accessToken地址可用于设置获取accessToken的自定义服务
    
    指定者:
    
    setAccessTokenUrl 在接口中 WxMaConfig
    
    参数:
    
    accessTokenUrl - 自定义的获取accessToken地址
  - getAppid
```
public String getAppid()
```
    从接口复制的说明: WxMaConfig
    
    Gets appid.
    
    指定者:
    
    getAppid 在接口中 WxMaConfig
    
    返回:
    
    the appid
  - setAppid
```
public void setAppid(String appid)
```

类 WxMaDefaultConfigImpl

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 cn.binarywang.wx.miniapp.config.WxMaConfig

字段详细资料

appid

token

originalId

accessTokenLock

tmpDirFile

jsapiTicketLock

cardApiTicketLock

构造器详细资料

WxMaDefaultConfigImpl

方法详细资料

enableUpdateAccessTokenBefore

expiresAheadInMillis

isExpired

getAccessToken

setAccessToken

isStableAccessToken

useStableAccessToken

getAccessTokenLock

setAccessTokenLock

isAccessTokenExpired

updateAccessToken

updateAccessTokenBefore

getJsapiTicket

getJsapiTicketLock

isJsapiTicketExpired

expireJsapiTicket

updateJsapiTicket

getCardApiTicket

getCardApiTicketLock

isCardApiTicketExpired

expireCardApiTicket

updateCardApiTicket

expireAccessToken

getSecret

setSecret

getToken

setToken

getExpiresTime

setExpiresTime

getAesKey

setAesKey

getApiSignatureRsaPrivateKey

setApiSignatureRsaPrivateKey

getApiSignatureAesKey

setApiSignatureAesKey

getApiSignatureRsaPrivateKeySn

setApiSignatureRsaPrivateKeySn

getApiSignatureAesKeySn

setApiSignatureAesKeySn

getWechatMpAppid

setWechatMpAppid

getOriginalId

setOriginalId

getCloudEnv

setCloudEnv

getMsgDataFormat

setMsgDataFormat

getHttpProxyHost

setHttpProxyHost

getHttpProxyPort

setHttpProxyPort

getHttpProxyUsername

setHttpProxyUsername

getHttpProxyPassword

setHttpProxyPassword

getRetrySleepMillis

setRetrySleepMillis

getMaxRetryTimes

setMaxRetryTimes

toString

getApacheHttpClientBuilder

setApacheHttpClientBuilder

autoRefreshToken