me.chanjar.weixin.cp.api

接口 WxCpTpService

所有已知实现类:

BaseWxCpTpServiceImpl, WxCpTpServiceApacheHttpClientImpl, WxCpTpServiceImpl

public interface WxCpTpService

微信第三方应用API的Service.

作者:

zhenjun cai

方法概要

限定符和类型	方法和说明
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) Service没有实现某个API的时候，可以用这个， 比get(java.lang.String, java.lang.String)和post(java.lang.String, java.lang.String)方法更灵活，可以自己构造RequestExecutor用来处理不同的参数和不同的返回类型。
String	get(String url, String queryParam) 当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的GET请求
WxAccessToken	getCorpToken(String authCorpid, String permanentCode) 获取企业凭证
WxCpTpCorp	getPermanentCode(String authCode) 获取企业永久授权码
RequestHttp<?,?>	getRequestHttp() http请求对象
String	getSuiteAccessToken() 获取suite_access_token, 不强制刷新suite_access_token
String	getSuiteAccessToken(boolean forceRefresh) 获取suite_access_token，本方法线程安全 且在多线程同时刷新时只刷新一次，避免超出2000次/日的调用次数上限 另：本service的所有方法都会在suite_access_token过期是调用此方法 程序员在非必要情况下尽量不要主动调用此方法 详情请见: https://work.weixin.qq.com/api/doc#90001/90143/90600
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
WxCpTpConfigStorage	getWxCpTpConfigStorage() 获取WxMpConfigStorage 对象
void	initHttp() 初始化http请求对象
WxCpMaJsCode2SessionResult	jsCode2Session(String jsCode) 小程序登录凭证校验
String	post(String url, String postData) 当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的POST请求
void	setMaxRetryTimes(int maxRetryTimes) 设置当微信系统响应系统繁忙时，最大重试次数 默认：5次
void	setRetrySleepMillis(int retrySleepMillis) 设置当微信系统响应系统繁忙时，要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试 默认：1000ms
void	setWxCpTpConfigStorage(WxCpTpConfigStorage wxConfigProvider) 注入 WxCpTpConfigStorage 的实现

方法详细资料

checkSignature

boolean checkSignature(String msgSignature,
                       String timestamp,
                       String nonce,
                       String data)

 验证推送过来的消息的正确性
 详情请见: https://work.weixin.qq.com/api/doc#90000/90139/90968/消息体签名校验
 

参数:

msgSignature - 消息签名

timestamp - 时间戳

nonce - 随机数

data - 微信传输过来的数据，有可能是echoStr，有可能是xml消息

getSuiteAccessToken

String getSuiteAccessToken()
                    throws WxErrorException

获取suite_access_token, 不强制刷新suite_access_token

抛出:

WxErrorException

另请参阅:

getSuiteAccessToken(boolean)

getSuiteAccessToken

String getSuiteAccessToken(boolean forceRefresh)
                    throws WxErrorException

 获取suite_access_token，本方法线程安全
 且在多线程同时刷新时只刷新一次，避免超出2000次/日的调用次数上限
 另：本service的所有方法都会在suite_access_token过期是调用此方法
 程序员在非必要情况下尽量不要主动调用此方法
 详情请见: https://work.weixin.qq.com/api/doc#90001/90143/90600
 

参数:

forceRefresh - 强制刷新

抛出:

WxErrorException

getSuiteTicket

String getSuiteTicket()
               throws WxErrorException

获得suite_ticket,不强制刷新suite_ticket

抛出:

WxErrorException

另请参阅:

getSuiteTicket(boolean)

getSuiteTicket

String getSuiteTicket(boolean forceRefresh)
               throws WxErrorException

 获得suite_ticket
 由于suite_ticket是微信服务器定时推送（每10分钟），不能主动获取，如果碰到过期只能抛异常

 详情请见：https://work.weixin.qq.com/api/doc#90001/90143/90628
 

参数:

forceRefresh - 强制刷新

抛出:

WxErrorException

jsCode2Session

WxCpMaJsCode2SessionResult jsCode2Session(String jsCode)
                                   throws WxErrorException

小程序登录凭证校验

参数:

jsCode - 登录时获取的 code

抛出:

WxErrorException

getCorpToken

WxAccessToken getCorpToken(String authCorpid,
                           String permanentCode)
                    throws WxErrorException

获取企业凭证

参数:

authCorpid - 授权方corpid

permanentCode - 永久授权码，通过get_permanent_code获取

抛出:

WxErrorException

getPermanentCode

WxCpTpCorp getPermanentCode(String authCode)
                     throws WxErrorException

获取企业永久授权码

参数:

authCode -

返回:

抛出:

WxErrorException

get

String get(String url,
           String queryParam)
    throws WxErrorException

当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的GET请求

参数:

url - 接口地址

queryParam - 请求参数

抛出:

WxErrorException

post

String post(String url,
            String postData)
     throws WxErrorException

当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的POST请求

参数:

url - 接口地址

postData - 请求body字符串

抛出:

WxErrorException

execute

<T,E> T execute(RequestExecutor<T,E> executor,
                String uri,
                E data)
         throws WxErrorException

 Service没有实现某个API的时候，可以用这个，
 比get(java.lang.String, java.lang.String)和post(java.lang.String, java.lang.String)方法更灵活，可以自己构造RequestExecutor用来处理不同的参数和不同的返回类型。
 可以参考，MediaUploadRequestExecutor的实现方法
 

类型参数:

T - 请求值类型

E - 返回值类型

参数:

executor - 执行器

uri - 请求地址

data - 参数

抛出:

WxErrorException

setRetrySleepMillis

void setRetrySleepMillis(int retrySleepMillis)

 设置当微信系统响应系统繁忙时，要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试
 默认：1000ms
 

参数:

retrySleepMillis - 重试休息时间

setMaxRetryTimes

void setMaxRetryTimes(int maxRetryTimes)

 设置当微信系统响应系统繁忙时，最大重试次数
 默认：5次
 

参数:

maxRetryTimes - 最大重试次数

initHttp

void initHttp()

初始化http请求对象

getWxCpTpConfigStorage

WxCpTpConfigStorage getWxCpTpConfigStorage()

获取WxMpConfigStorage 对象

返回:

WxMpConfigStorage

setWxCpTpConfigStorage

void setWxCpTpConfigStorage(WxCpTpConfigStorage wxConfigProvider)

注入 WxCpTpConfigStorage 的实现

参数:

wxConfigProvider - 配置对象

getRequestHttp

RequestHttp<?,?> getRequestHttp()

http请求对象