BaseWxCpTpServiceImpl (WxJava - CP Java SDK 4.0.2.B API)

java.lang.Object
- me.chanjar.weixin.cp.tp.service.impl.BaseWxCpTpServiceImpl<H,P>

所有已实现的接口:

RequestHttp<H,P>, WxCpTpService

直接已知子类:

WxCpTpServiceApacheHttpClientImpl
```
public abstract class BaseWxCpTpServiceImpl<H,P>
extends Object
implements WxCpTpService, RequestHttp<H,P>
```
.

作者:

zhenjun cai

字段概要

字段
限定符和类型	字段和说明
`protected WxCpTpConfigStorage`	`configStorage`
`protected Object`	`globalJsApiTicketRefreshLock` 全局的是否正在刷新jsapi_ticket的锁.
`protected Object`	`globalSuiteAccessTokenRefreshLock` 全局的是否正在刷新access token的锁.
`protected Object`	`globalSuiteTicketRefreshLock` 全局刷新suite ticket的锁

构造器概要

构造器
构造器和说明

BaseWxCpTpServiceImpl()

构造器
构造器和说明
`BaseWxCpTpServiceImpl()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`checkSignature(String msgSignature, String timestamp, String nonce, String data)` 验证推送过来的消息的正确性详情请见: https://work.weixin.qq.com/api/doc#90000/90139/90968/消息体签名校验
`<T,E> T`	`execute(RequestExecutor<T,E> executor, String uri, E data)` 向微信端发送请求，在这里执行的策略是当发生access_token过期时才去刷新，然后重新执行请求，而不是全局定时请求.
`protected <T,E> T`	`executeInternal(RequestExecutor<T,E> executor, String uri, E data)`
`String`	`get(String url, String queryParam)` 当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的GET请求.
`String`	`getAuthCorpJsApiTicket(String authCorpId)` 获取授权企业的 jsapi ticket
`WxCpTpAuthInfo`	`getAuthInfo(String authCorpId, String permanentCode)` 获取企业的授权信息
`WxAccessToken`	`getCorpToken(String authCorpid, String permanentCode)` 获取企业凭证
`WxCpTpCorp`	`getPermanentCode(String authCode)` 获取企业永久授权码 .
`WxCpTpPermanentCodeInfo`	`getPermanentCodeInfo(String authCode)` 获取企业永久授权码信息原来的方法实现不全
`String`	`getPreAuthUrl(String redirectUri, String state)` 获取预授权链接
`String`	`getPreAuthUrl(String redirectUri, String state, int authType)` 获取预授权链接，测试环境下使用
`RequestHttp<?,?>`	`getRequestHttp()` http请求对象.
`WxSessionManager`	`getSessionManager()` 获取WxSessionManager 对象
`String`	`getSuiteAccessToken()` 获取suite_access_token, 不强制刷新suite_access_token
`String`	`getSuiteJsApiTicket(String authCorpId)` 获取应用的 jsapi ticket
`String`	`getSuiteTicket()` 获得suite_ticket,不强制刷新suite_ticket
`String`	`getSuiteTicket(boolean forceRefresh)` 获得suite_ticket 由于suite_ticket是微信服务器定时推送（每10分钟），不能主动获取，如果碰到过期只能抛异常详情请见：https://work.weixin.qq.com/api/doc#90001/90143/90628
`File`	`getTmpDirFile()`
`WxCpTpUserDetail`	`getUserDetail3rd(String userTicket)` 获取访问用户敏感信息
`WxCpTpUserInfo`	`getUserInfo3rd(String code)` 获取访问用户身份
`WxCpMaJsCode2SessionResult`	`jsCode2Session(String jsCode)` 小程序登录凭证校验
`String`	`post(String url, String postData)` 当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的POST请求.
`void`	`setMaxRetryTimes(int maxRetryTimes)` 设置当微信系统响应系统繁忙时，最大重试次数.
`void`	`setRetrySleepMillis(int retrySleepMillis)` 设置当微信系统响应系统繁忙时，要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试.
`void`	`setSuiteTicket(String suiteTicket)` 保存企业微信定时推送的suite_ticket,（每10分钟）详情请见：https://work.weixin.qq.com/api/doc#90001/90143/90628 注意：微信不是固定10分钟推送suite_ticket的, 且suite_ticket的有效期为30分钟 https://work.weixin.qq.com/api/doc/10975#%E8%8E%B7%E5%8F%96%E7%AC%AC%E4%B8%89%E6%96%B9%E5%BA%94%E7%94%A8%E5%87%AD%E8%AF%81
`void`	`setSuiteTicket(String suiteTicket, int expiresInSeconds)` 保存企业微信定时推送的suite_ticket,（每10分钟）详情请见：https://work.weixin.qq.com/api/doc#90001/90143/90628 注意：微信不是固定10分钟推送suite_ticket的, 且suite_ticket的有效期为30分钟 https://work.weixin.qq.com/api/doc/10975#%E8%8E%B7%E5%8F%96%E7%AC%AC%E4%B8%89%E6%96%B9%E5%BA%94%E7%94%A8%E5%87%AD%E8%AF%81
`void`	`setTmpDirFile(File tmpDirFile)`
`void`	`setWxCpTpConfigStorage(WxCpTpConfigStorage wxConfigProvider)` 注入 `WxCpTpConfigStorage` 的实现.

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

从接口继承的方法 me.chanjar.weixin.cp.tp.service.WxCpTpService
getSuiteAccessToken, getWxCpTpConfigStorage, initHttp

从接口继承的方法 me.chanjar.weixin.common.util.http.RequestHttp
getRequestHttpClient, getRequestHttpProxy, getRequestType

- 字段详细资料
  - globalSuiteAccessTokenRefreshLock
```
protected final Object globalSuiteAccessTokenRefreshLock
```
    全局的是否正在刷新access token的锁.
  - globalSuiteTicketRefreshLock
```
protected final Object globalSuiteTicketRefreshLock
```
    全局刷新suite ticket的锁
  - globalJsApiTicketRefreshLock
```
protected final Object globalJsApiTicketRefreshLock
```
    全局的是否正在刷新jsapi_ticket的锁.
  - configStorage
```
protected WxCpTpConfigStorage configStorage
```
- 构造器详细资料
  - BaseWxCpTpServiceImpl
```
public BaseWxCpTpServiceImpl()
```
- 方法详细资料
  - checkSignature
```
public boolean checkSignature(String msgSignature,
                              String timestamp,
                              String nonce,
                              String data)
```
    从接口复制的说明: WxCpTpService
```
 验证推送过来的消息的正确性
 详情请见: https://work.weixin.qq.com/api/doc#90000/90139/90968/消息体签名校验
 
```
    指定者:
    
    checkSignature 在接口中 WxCpTpService
    
    参数:
    
    msgSignature - 消息签名
    
    timestamp - 时间戳
    
    nonce - 随机数
    
    data - 微信传输过来的数据，有可能是echoStr，有可能是xml消息
    
    返回:
    
    the boolean
  - getSuiteAccessToken
```
public String getSuiteAccessToken()
                           throws WxErrorException
```
    从接口复制的说明: WxCpTpService
    
    获取suite_access_token, 不强制刷新suite_access_token
    
    指定者:
    
    getSuiteAccessToken 在接口中 WxCpTpService
    
    返回:
    
    the suite access token
    
    抛出:
    
    WxErrorException - the wx error exception
    
    另请参阅:
    
    #getSuiteAccessToken(boolean)
  - getSuiteTicket
```
public String getSuiteTicket()
                      throws WxErrorException
```
    从接口复制的说明: WxCpTpService
    
    获得suite_ticket,不强制刷新suite_ticket
    
    指定者:
    
    getSuiteTicket 在接口中 WxCpTpService
    
    返回:
    
    the suite ticket
    
    抛出:
    
    WxErrorException - the wx error exception
    
    另请参阅:
    
    #getSuiteTicket(boolean)
  - getSuiteTicket
```
public String getSuiteTicket(boolean forceRefresh)
                      throws WxErrorException
```
    从接口复制的说明: WxCpTpService
```
 获得suite_ticket
 由于suite_ticket是微信服务器定时推送（每10分钟），不能主动获取，如果碰到过期只能抛异常

 详情请见：https://work.weixin.qq.com/api/doc#90001/90143/90628
 
```
    指定者:
    
    getSuiteTicket 在接口中 WxCpTpService
    
    参数:
    
    forceRefresh - 强制刷新
    
    返回:
    
    the suite ticket
    
    抛出:
    
    WxErrorException - the wx error exception
    
    另请参阅:
    
    WxCpTpService.setSuiteTicket(String)
  - setSuiteTicket
```
public void setSuiteTicket(String suiteTicket)
```
    从接口复制的说明: WxCpTpService
```
 保存企业微信定时推送的suite_ticket,（每10分钟）
 详情请见：https://work.weixin.qq.com/api/doc#90001/90143/90628

 注意：微信不是固定10分钟推送suite_ticket的, 且suite_ticket的有效期为30分钟
 https://work.weixin.qq.com/api/doc/10975#%E8%8E%B7%E5%8F%96%E7%AC%AC%E4%B8%89%E6%96%B9%E5%BA%94%E7%94%A8%E5%87%AD%E8%AF%81
 
```
    指定者:
    
    setSuiteTicket 在接口中 WxCpTpService
  - setSuiteTicket
```
public void setSuiteTicket(String suiteTicket,
                           int expiresInSeconds)
```
    从接口复制的说明: WxCpTpService
```
 保存企业微信定时推送的suite_ticket,（每10分钟）
 详情请见：https://work.weixin.qq.com/api/doc#90001/90143/90628

 注意：微信不是固定10分钟推送suite_ticket的, 且suite_ticket的有效期为30分钟
 https://work.weixin.qq.com/api/doc/10975#%E8%8E%B7%E5%8F%96%E7%AC%AC%E4%B8%89%E6%96%B9%E5%BA%94%E7%94%A8%E5%87%AD%E8%AF%81
 
```
    指定者:
    
    setSuiteTicket 在接口中 WxCpTpService
  - getSuiteJsApiTicket
```
public String getSuiteJsApiTicket(String authCorpId)
                           throws WxErrorException
```
    从接口复制的说明: WxCpTpService
    
    获取应用的 jsapi ticket
    
    指定者:
    
    getSuiteJsApiTicket 在接口中 WxCpTpService
    
    参数:
    
    authCorpId - 授权企业的cropId
    
    返回:
    
    jsapi ticket
    
    抛出:
    
    WxErrorException
  - getAuthCorpJsApiTicket
```
public String getAuthCorpJsApiTicket(String authCorpId)
                              throws WxErrorException
```
    从接口复制的说明: WxCpTpService
    
    获取授权企业的 jsapi ticket
    
    指定者:
    
    getAuthCorpJsApiTicket 在接口中 WxCpTpService
    
    参数:
    
    authCorpId - 授权企业的cropId
    
    返回:
    
    jsapi ticket
    
    抛出:
    
    WxErrorException
  - jsCode2Session
```
public WxCpMaJsCode2SessionResult jsCode2Session(String jsCode)
                                          throws WxErrorException
```
    从接口复制的说明: WxCpTpService
    
    小程序登录凭证校验
    
    指定者:
    
    jsCode2Session 在接口中 WxCpTpService
    
    参数:
    
    jsCode - 登录时获取的 code
    
    返回:
    
    the wx cp ma js code 2 session result
    
    抛出:
    
    WxErrorException - the wx error exception
  - getCorpToken
```
public WxAccessToken getCorpToken(String authCorpid,
                                  String permanentCode)
                           throws WxErrorException
```
    从接口复制的说明: WxCpTpService
    
    获取企业凭证
    
    指定者:
    
    getCorpToken 在接口中 WxCpTpService
    
    参数:
    
    authCorpid - 授权方corpid
    
    permanentCode - 永久授权码，通过get_permanent_code获取
    
    返回:
    
    the corp token
    
    抛出:
    
    WxErrorException - the wx error exception
  - getPermanentCode
```
public WxCpTpCorp getPermanentCode(String authCode)
                            throws WxErrorException
```
    从接口复制的说明: WxCpTpService
    
    获取企业永久授权码 .
    
    指定者:
    
    getPermanentCode 在接口中 WxCpTpService
    
    参数:
    
    authCode - .
    
    返回:
    
    . permanent code
    
    抛出:
    
    WxErrorException - the wx error exception
  - getPermanentCodeInfo
```
public WxCpTpPermanentCodeInfo getPermanentCodeInfo(String authCode)
                                             throws WxErrorException
```
    从接口复制的说明: WxCpTpService
    获取企业永久授权码信息
```
   原来的方法实现不全
 
```
    指定者:
    
    getPermanentCodeInfo 在接口中 WxCpTpService
    
    参数:
    
    authCode - the auth code
    
    返回:
    
    permanent code info
    
    抛出:
    
    WxErrorException - the wx error exception
  - getPreAuthUrl
```
public String getPreAuthUrl(String redirectUri,
                            String state)
                     throws WxErrorException
```
    从接口复制的说明: WxCpTpService
```
   获取预授权链接
 
```
    指定者:
    
    getPreAuthUrl 在接口中 WxCpTpService
    
    参数:
    
    redirectUri - 授权完成后的回调网址
    
    state - a-zA-Z0-9的参数值（不超过128个字节），用于第三方自行校验session，防止跨域攻击
    
    返回:
    
    pre auth url
    
    抛出:
    
    WxErrorException - the wx error exception
  - getPreAuthUrl
```
public String getPreAuthUrl(String redirectUri,
                            String state,
                            int authType)
                     throws WxErrorException
```
    从接口复制的说明: WxCpTpService
```
   获取预授权链接，测试环境下使用
```
    指定者:
    
    getPreAuthUrl 在接口中 WxCpTpService
    
    参数:
    
    redirectUri - 授权完成后的回调网址
    
    state - a-zA-Z0-9的参数值（不超过128个字节），用于第三方自行校验session，防止跨域攻击
    
    authType - 授权类型：0 正式授权， 1 测试授权。
    
    返回:
    
    pre auth url
    
    抛出:
    
    WxErrorException - the wx error exception
  - getAuthInfo
```
public WxCpTpAuthInfo getAuthInfo(String authCorpId,
                                  String permanentCode)
                           throws WxErrorException
```
    从接口复制的说明: WxCpTpService
    
    获取企业的授权信息
    
    指定者:
    
    getAuthInfo 在接口中 WxCpTpService
    
    参数:
    
    authCorpId - 授权企业的corpId
    
    permanentCode - 授权企业的永久授权码
    
    返回:
    
    auth info
    
    抛出:
    
    WxErrorException - the wx error exception
  - get
```
public String get(String url,
                  String queryParam)
           throws WxErrorException
```
    从接口复制的说明: WxCpTpService
    
    当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的GET请求.
    
    指定者:
    
    get 在接口中 WxCpTpService
    
    参数:
    
    url - 接口地址
    
    queryParam - 请求参数
    
    返回:
    
    the string
    
    抛出:
    
    WxErrorException - the wx error exception
  - post
```
public String post(String url,
                   String postData)
            throws WxErrorException
```
    从接口复制的说明: WxCpTpService
    
    当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的POST请求.
    
    指定者:
    
    post 在接口中 WxCpTpService
    
    参数:
    
    url - 接口地址
    
    postData - 请求body字符串
    
    返回:
    
    the string
    
    抛出:
    
    WxErrorException - the wx error exception
  - execute
```
public <T,E> T execute(RequestExecutor<T,E> executor,
                       String uri,
                       E data)
                throws WxErrorException
```
    向微信端发送请求，在这里执行的策略是当发生access_token过期时才去刷新，然后重新执行请求，而不是全局定时请求.
    
    指定者:
    
    execute 在接口中 WxCpTpService
    
    类型参数:
    
    T - 请求值类型
    
    E - 返回值类型
    
    参数:
    
    executor - 执行器
    
    uri - 请求地址
    
    data - 参数
    
    返回:
    
    the t
    
    抛出:
    
    WxErrorException - the wx error exception
  - executeInternal
```
protected <T,E> T executeInternal(RequestExecutor<T,E> executor,
                                  String uri,
                                  E data)
                           throws WxErrorException
```
    抛出:
    
    WxErrorException
  - setWxCpTpConfigStorage
```
public void setWxCpTpConfigStorage(WxCpTpConfigStorage wxConfigProvider)
```
    从接口复制的说明: WxCpTpService
    
    注入 WxCpTpConfigStorage 的实现.
    
    指定者:
    
    setWxCpTpConfigStorage 在接口中 WxCpTpService
    
    参数:
    
    wxConfigProvider - 配置对象
  - setRetrySleepMillis
```
public void setRetrySleepMillis(int retrySleepMillis)
```
    从接口复制的说明: WxCpTpService
```
 设置当微信系统响应系统繁忙时，要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试.
 默认：1000ms
 
```
    指定者:
    
    setRetrySleepMillis 在接口中 WxCpTpService
    
    参数:
    
    retrySleepMillis - 重试休息时间
  - setMaxRetryTimes
```
public void setMaxRetryTimes(int maxRetryTimes)
```
    从接口复制的说明: WxCpTpService
```
 设置当微信系统响应系统繁忙时，最大重试次数.
 默认：5次
 
```
    指定者:
    
    setMaxRetryTimes 在接口中 WxCpTpService
    
    参数:
    
    maxRetryTimes - 最大重试次数
  - getTmpDirFile
```
public File getTmpDirFile()
```
  - setTmpDirFile
```
public void setTmpDirFile(File tmpDirFile)
```
  - getRequestHttp
```
public RequestHttp<?,?> getRequestHttp()
```
    从接口复制的说明: WxCpTpService
    
    http请求对象.
    
    指定者:
    
    getRequestHttp 在接口中 WxCpTpService
    
    返回:
    
    the request http
  - getSessionManager
```
public WxSessionManager getSessionManager()
```
    从接口复制的说明: WxCpTpService
    
    获取WxSessionManager 对象
    
    指定者:
    
    getSessionManager 在接口中 WxCpTpService
    
    返回:
    
    WxSessionManager session manager
  - getUserInfo3rd
```
public WxCpTpUserInfo getUserInfo3rd(String code)
                              throws WxErrorException
```
    从接口复制的说明: WxCpTpService
```
 获取访问用户身份
 
```
    指定者:
    
    getUserInfo3rd 在接口中 WxCpTpService
    
    返回:
    
    抛出:
    
    WxErrorException
  - getUserDetail3rd
```
public WxCpTpUserDetail getUserDetail3rd(String userTicket)
                                  throws WxErrorException
```
    从接口复制的说明: WxCpTpService
```
 获取访问用户敏感信息
 
```
    指定者:
    
    getUserDetail3rd 在接口中 WxCpTpService
    
    返回:
    
    抛出:
    
    WxErrorException

类 BaseWxCpTpServiceImpl<H,P>

字段概要

构造器概要

方法概要

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

从接口继承的方法 me.chanjar.weixin.cp.tp.service.WxCpTpService

从接口继承的方法 me.chanjar.weixin.common.util.http.RequestHttp

字段详细资料

globalSuiteAccessTokenRefreshLock

globalSuiteTicketRefreshLock

globalJsApiTicketRefreshLock

configStorage

构造器详细资料

BaseWxCpTpServiceImpl

方法详细资料

checkSignature

getSuiteAccessToken

getSuiteTicket

getSuiteTicket

setSuiteTicket

setSuiteTicket

getSuiteJsApiTicket

getAuthCorpJsApiTicket

jsCode2Session

getCorpToken

getPermanentCode

getPermanentCodeInfo

getPreAuthUrl

getPreAuthUrl

getAuthInfo

get

post

execute

executeInternal

setWxCpTpConfigStorage

setRetrySleepMillis

setMaxRetryTimes

getTmpDirFile

setTmpDirFile

getRequestHttp

getSessionManager

getUserInfo3rd

getUserDetail3rd