BaseWxQidianServiceImpl (WxJava - 企点 Java SDK 4.2.2.B API)

java.lang.Object
- me.chanjar.weixin.qidian.api.impl.BaseWxQidianServiceImpl<H,P>

所有已实现的接口:

WxService, RequestHttp<H,P>, WxQidianService

直接已知子类:

WxQidianServiceHttpClientImpl, WxQidianServiceJoddHttpImpl, WxQidianServiceOkHttpImpl
```
public abstract class BaseWxQidianServiceImpl<H,P>
extends Object
implements WxQidianService, RequestHttp<H,P>
```
基础实现类.

作者:

someone

构造器概要

构造器
构造器和说明

BaseWxQidianServiceImpl()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addConfigStorage(String mpId, WxQidianConfigStorage configStorages)` Map里加入新的 `WxQidianConfigStorage`，适用于动态添加新的微信公众号配置.
`String`	`buildQrConnectUrl(String redirectUri, String scope, String state)` 构造第三方使用网站应用授权登录的url.
`boolean`	`checkSignature(String timestamp, String nonce, String signature)` 验证消息的确来自微信服务器.
`void`	`clearQuota(String appid)` 公众号调用或第三方平台帮公众号调用对公众号的所有api调用（包括第三方帮其调用）次数进行清零： HTTP调用：https://api.weixin.qq.com/cgi-bin/clear_quota?
`WxJsapiSignature`	`createJsapiSignature(String url)` 创建调用jsapi时所需要的签名.
`<T,E> T`	`execute(RequestExecutor<T,E> executor, String uri, E data)` 向微信端发送请求，在这里执行的策略是当发生access_token过期时才去刷新，然后重新执行请求，而不是全局定时请求.
`<T,E> T`	`execute(RequestExecutor<T,E> executor, WxQidianApiUrl url, E data)` Service没有实现某个API的时候，可以用这个，比`WxQidianService.get(me.chanjar.weixin.qidian.enums.WxQidianApiUrl, java.lang.String)`和`WxQidianService.post(me.chanjar.weixin.qidian.enums.WxQidianApiUrl, java.lang.String)`方法更灵活，可以自己构造RequestExecutor用来处理不同的参数和不同的返回类型。
`protected <T,E> T`	`executeInternal(RequestExecutor<T,E> executor, String uri, E data)`
`protected String`	`extractAccessToken(String resultContent)`
`String`	`get(String url, String queryParam)`
`String`	`get(WxQidianApiUrl url, String queryParam)` 当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的GET请求.
`String`	`getAccessToken()` 获取access_token, 不强制刷新access_token.
`String[]`	`getCallbackIP()` 获取微信服务器IP地址 http://mp.weixin.qq.com/wiki/0/2ad4b6bfd29f30f71d39616c2a0fcedc.html
`String`	`getJsapiTicket()` 获得jsapi_ticket,不强制刷新jsapi_ticket.
`String`	`getJsapiTicket(boolean forceRefresh)` 获得jsapi_ticket.
`RequestHttp`	`getRequestHttp()` 获取RequestHttp对象.
`String`	`getTicket(TicketType type)` 获得ticket,不强制刷新ticket.
`String`	`getTicket(TicketType type, boolean forceRefresh)` 获得ticket.
`WxQidianConfigStorage`	`getWxMpConfigStorage()` 获取WxMpConfigStorage 对象.
`WxNetCheckResult`	`netCheck(String action, String operator)` 网络检测 https://mp.weixin.qq.com/wiki?
`String`	`post(String url, com.google.gson.JsonObject jsonObject)`
`String`	`post(String url, Object obj)`
`String`	`post(String url, String postData)`
`String`	`post(String url, ToJson obj)`
`String`	`post(WxQidianApiUrl url, com.google.gson.JsonObject jsonObject)` 当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的POST请求.
`String`	`post(WxQidianApiUrl url, String postData)` 当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的POST请求.
`void`	`removeConfigStorage(String mpId)` 从 Map中移除 `mpId` 所对应的 `WxQidianConfigStorage`，适用于动态移除微信公众号配置.
`void`	`setMaxRetryTimes(int maxRetryTimes)` 设置当微信系统响应系统繁忙时，最大重试次数.
`void`	`setMultiConfigStorages(Map<String,WxQidianConfigStorage> configStorages)` 注入多个 `WxQidianConfigStorage` 的实现.
`void`	`setMultiConfigStorages(Map<String,WxQidianConfigStorage> configStorages, String defaultMpId)` 注入多个 `WxQidianConfigStorage` 的实现.
`void`	`setRetrySleepMillis(int retrySleepMillis)` 设置当微信系统响应系统繁忙时，要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试.
`void`	`setWxMpConfigStorage(WxQidianConfigStorage wxConfigProvider)` 设置 `WxQidianConfigStorage` 的实现.
`String`	`shortUrl(String longUrl)` 长链接转短链接接口.
`boolean`	`switchover(String mpId)` 进行相应的公众号切换.
`WxQidianService`	`switchoverTo(String mpId)` 进行相应的公众号切换.

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

从接口继承的方法 me.chanjar.weixin.qidian.api.WxQidianService
getAccessToken, getCallDataService, getDialService, initHttp

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

- 构造器详细资料
  - BaseWxQidianServiceImpl
```
public BaseWxQidianServiceImpl()
```
- 方法详细资料
  - checkSignature
```
public boolean checkSignature(String timestamp,
                              String nonce,
                              String signature)
```
    从接口复制的说明: WxQidianService
```
 验证消息的确来自微信服务器.
 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421135319&token=&lang=zh_CN
 
```
    指定者:
    
    checkSignature 在接口中 WxQidianService
    
    参数:
    
    timestamp - 时间戳
    
    nonce - 随机串
    
    signature - 签名
    
    返回:
    
    是否验证通过 boolean
  - getTicket
```
public String getTicket(TicketType type)
                 throws WxErrorException
```
    从接口复制的说明: WxQidianService
    
    获得ticket,不强制刷新ticket.
    
    指定者:
    
    getTicket 在接口中 WxQidianService
    
    参数:
    
    type - ticket 类型
    
    返回:
    
    ticket ticket
    
    抛出:
    
    WxErrorException - .
    
    另请参阅:
    
    #getTicket(TicketType, boolean)
  - getTicket
```
public String getTicket(TicketType type,
                        boolean forceRefresh)
                 throws WxErrorException
```
    从接口复制的说明: WxQidianService
```
 获得ticket.
 获得时会检查 Token是否过期，如果过期了，那么就刷新一下，否则就什么都不干
 
```
    指定者:
    
    getTicket 在接口中 WxQidianService
    
    参数:
    
    type - ticket类型
    
    forceRefresh - 强制刷新
    
    返回:
    
    ticket ticket
    
    抛出:
    
    WxErrorException - .
  - getJsapiTicket
```
public String getJsapiTicket()
                      throws WxErrorException
```
    从接口复制的说明: WxQidianService
    
    获得jsapi_ticket,不强制刷新jsapi_ticket.
    
    指定者:
    
    getJsapiTicket 在接口中 WxQidianService
    
    返回:
    
    jsapi ticket
    
    抛出:
    
    WxErrorException - .
    
    另请参阅:
    
    #getJsapiTicket(boolean)
  - getJsapiTicket
```
public String getJsapiTicket(boolean forceRefresh)
                      throws WxErrorException
```
    从接口复制的说明: WxQidianService
```
 获得jsapi_ticket.
 获得时会检查jsapiToken是否过期，如果过期了，那么就刷新一下，否则就什么都不干

 详情请见：http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141115&token=&lang=zh_CN
 
```
    指定者:
    
    getJsapiTicket 在接口中 WxQidianService
    
    参数:
    
    forceRefresh - 强制刷新
    
    返回:
    
    jsapi ticket
    
    抛出:
    
    WxErrorException - .
  - createJsapiSignature
```
public WxJsapiSignature createJsapiSignature(String url)
                                      throws WxErrorException
```
    从接口复制的说明: WxQidianService
```
 创建调用jsapi时所需要的签名.

 详情请见：http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141115&token=&lang=zh_CN
 
```
    指定者:
    
    createJsapiSignature 在接口中 WxQidianService
    
    参数:
    
    url - 地址
    
    返回:
    
    生成的签名对象 wx jsapi signature
    
    抛出:
    
    WxErrorException - .
  - getAccessToken
```
public String getAccessToken()
                      throws WxErrorException
```
    从接口复制的说明: WxQidianService
    
    获取access_token, 不强制刷新access_token.
    
    指定者:
    
    getAccessToken 在接口中 WxQidianService
    
    返回:
    
    token access token
    
    抛出:
    
    WxErrorException - .
    
    另请参阅:
    
    #getAccessToken(boolean)
  - shortUrl
```
public String shortUrl(String longUrl)
                throws WxErrorException
```
    从接口复制的说明: WxQidianService
```
 长链接转短链接接口.
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=长链接转短链接接口
 
```
    指定者:
    
    shortUrl 在接口中 WxQidianService
    
    参数:
    
    longUrl - 长url
    
    返回:
    
    生成的短地址 string
    
    抛出:
    
    WxErrorException - .
  - buildQrConnectUrl
```
public String buildQrConnectUrl(String redirectUri,
                                String scope,
                                String state)
```
    从接口复制的说明: WxQidianService
```
 构造第三方使用网站应用授权登录的url.
 详情请见: 网站应用微信登录开发指南
 URL格式为：https://open.weixin.qq.com/connect/qrconnect?appid=APPID&redirect_uri=REDIRECT_URI&response_type=code&scope=SCOPE&state=STATE#wechat_redirect
 
```
    指定者:
    
    buildQrConnectUrl 在接口中 WxQidianService
    
    参数:
    
    redirectUri - 用户授权完成后的重定向链接，无需urlencode, 方法内会进行encode
    
    scope - 应用授权作用域，拥有多个作用域用逗号（,）分隔，网页应用目前仅填写snsapi_login即可
    
    state - 非必填，用于保持请求和回调的状态，授权请求后原样带回给第三方。该参数可用于防止csrf攻击（跨站请求伪造攻击），建议第三方带上该参数，可设置为简单的随机数加session进行校验
    
    返回:
    
    url string
  - getCallbackIP
```
public String[] getCallbackIP()
                       throws WxErrorException
```
    从接口复制的说明: WxQidianService
```
 获取微信服务器IP地址
 http://mp.weixin.qq.com/wiki/0/2ad4b6bfd29f30f71d39616c2a0fcedc.html
 
```
    指定者:
    
    getCallbackIP 在接口中 WxQidianService
    
    返回:
    
    微信服务器ip地址数组 string [ ]
    
    抛出:
    
    WxErrorException - .
  - netCheck
```
public WxNetCheckResult netCheck(String action,
                                 String operator)
                          throws WxErrorException
```
    从接口复制的说明: WxQidianService
```
  网络检测
  https://mp.weixin.qq.com/wiki?t=resource/res_main&id=21541575776DtsuT
  为了帮助开发者排查回调连接失败的问题，提供这个网络检测的API。它可以对开发者URL做域名解析，然后对所有IP进行一次ping操作，得到丢包率和耗时。
 
```
    指定者:
    
    netCheck 在接口中 WxQidianService
    
    参数:
    
    action - 执行的检测动作
    
    operator - 指定平台从某个运营商进行检测
    
    返回:
    
    检测结果 wx net check result
    
    抛出:
    
    WxErrorException - .
  - clearQuota
```
public void clearQuota(String appid)
                throws WxErrorException
```
    从接口复制的说明: WxQidianService
```
  公众号调用或第三方平台帮公众号调用对公众号的所有api调用（包括第三方帮其调用）次数进行清零：
  HTTP调用：https://api.weixin.qq.com/cgi-bin/clear_quota?access_token=ACCESS_TOKEN
  接口文档地址：https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433744592

 
```
    指定者:
    
    clearQuota 在接口中 WxQidianService
    
    参数:
    
    appid - 公众号的APPID
    
    抛出:
    
    WxErrorException - the wx error exception
  - get
```
public String get(String url,
                  String queryParam)
           throws WxErrorException
```
    指定者:
    
    get 在接口中 WxService
    
    抛出:
    
    WxErrorException
  - get
```
public String get(WxQidianApiUrl url,
                  String queryParam)
           throws WxErrorException
```
    从接口复制的说明: WxQidianService
    
    当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的GET请求.
    
    指定者:
    
    get 在接口中 WxQidianService
    
    参数:
    
    url - 请求接口地址
    
    queryParam - 参数
    
    返回:
    
    接口响应字符串 string
    
    抛出:
    
    WxErrorException - 异常
  - post
```
public String post(String url,
                   String postData)
            throws WxErrorException
```
    指定者:
    
    post 在接口中 WxService
    
    抛出:
    
    WxErrorException
  - post
```
public String post(WxQidianApiUrl url,
                   String postData)
            throws WxErrorException
```
    从接口复制的说明: WxQidianService
    
    当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的POST请求.
    
    指定者:
    
    post 在接口中 WxQidianService
    
    参数:
    
    url - 请求接口地址
    
    postData - 请求参数json值
    
    返回:
    
    接口响应字符串 string
    
    抛出:
    
    WxErrorException - 异常
  - post
```
public String post(WxQidianApiUrl url,
                   com.google.gson.JsonObject jsonObject)
            throws WxErrorException
```
    从接口复制的说明: WxQidianService
    
    当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的POST请求.
    
    指定者:
    
    post 在接口中 WxQidianService
    
    参数:
    
    url - 请求接口地址
    
    jsonObject - 请求参数json对象
    
    返回:
    
    接口响应字符串 string
    
    抛出:
    
    WxErrorException - 异常
  - post
```
public String post(String url,
                   ToJson obj)
            throws WxErrorException
```
    指定者:
    
    post 在接口中 WxService
    
    抛出:
    
    WxErrorException
  - post
```
public String post(String url,
                   com.google.gson.JsonObject jsonObject)
            throws WxErrorException
```
    指定者:
    
    post 在接口中 WxService
    
    抛出:
    
    WxErrorException
  - post
```
public String post(String url,
                   Object obj)
            throws WxErrorException
```
    指定者:
    
    post 在接口中 WxService
    
    抛出:
    
    WxErrorException
  - execute
```
public <T,E> T execute(RequestExecutor<T,E> executor,
                       WxQidianApiUrl url,
                       E data)
                throws WxErrorException
```
    从接口复制的说明: WxQidianService
```
 Service没有实现某个API的时候，可以用这个，
 比WxQidianService.get(me.chanjar.weixin.qidian.enums.WxQidianApiUrl, java.lang.String)和WxQidianService.post(me.chanjar.weixin.qidian.enums.WxQidianApiUrl, java.lang.String)方法更灵活，可以自己构造RequestExecutor用来处理不同的参数和不同的返回类型。
 可以参考，MediaUploadRequestExecutor的实现方法
 
```
    指定者:
    
    execute 在接口中 WxQidianService
    
    类型参数:
    
    T - the type parameter
    
    E - the type parameter
    
    参数:
    
    executor - 执行器
    
    url - 接口地址
    
    data - 参数数据
    
    返回:
    
    结果 t
    
    抛出:
    
    WxErrorException - 异常
  - execute
```
public <T,E> T execute(RequestExecutor<T,E> executor,
                       String uri,
                       E data)
                throws WxErrorException
```
    向微信端发送请求，在这里执行的策略是当发生access_token过期时才去刷新，然后重新执行请求，而不是全局定时请求.
    
    指定者:
    
    execute 在接口中 WxQidianService
    
    类型参数:
    
    T - the type parameter
    
    E - the type parameter
    
    参数:
    
    executor - 执行器
    
    uri - 接口地址
    
    data - 参数数据
    
    返回:
    
    结果 t
    
    抛出:
    
    WxErrorException - 异常
  - executeInternal
```
protected <T,E> T executeInternal(RequestExecutor<T,E> executor,
                                  String uri,
                                  E data)
                           throws WxErrorException
```
    抛出:
    
    WxErrorException
  - getWxMpConfigStorage
```
public WxQidianConfigStorage getWxMpConfigStorage()
```
    从接口复制的说明: WxQidianService
    
    获取WxMpConfigStorage 对象.
    
    指定者:
    
    getWxMpConfigStorage 在接口中 WxQidianService
    
    返回:
    
    WxMpConfigStorage wx mp config storage
  - extractAccessToken
```
protected String extractAccessToken(String resultContent)
                             throws WxErrorException
```
    抛出:
    
    WxErrorException
  - setWxMpConfigStorage
```
public void setWxMpConfigStorage(WxQidianConfigStorage wxConfigProvider)
```
    从接口复制的说明: WxQidianService
    
    设置 WxQidianConfigStorage 的实现. 兼容老版本
    
    指定者:
    
    setWxMpConfigStorage 在接口中 WxQidianService
    
    参数:
    
    wxConfigProvider - .
  - setMultiConfigStorages
```
public void setMultiConfigStorages(Map<String,WxQidianConfigStorage> configStorages)
```
    从接口复制的说明: WxQidianService
    
    注入多个 WxQidianConfigStorage 的实现. 并为每个 WxQidianConfigStorage 赋予不同的 mpId 值随机采用一个mpId进行Http初始化操作
    
    指定者:
    
    setMultiConfigStorages 在接口中 WxQidianService
    
    参数:
    
    configStorages - WxMpConfigStorage map
  - setMultiConfigStorages
```
public void setMultiConfigStorages(Map<String,WxQidianConfigStorage> configStorages,
                                   String defaultMpId)
```
    从接口复制的说明: WxQidianService
    
    注入多个 WxQidianConfigStorage 的实现. 并为每个 WxQidianConfigStorage 赋予不同的 label 值
    
    指定者:
    
    setMultiConfigStorages 在接口中 WxQidianService
    
    参数:
    
    configStorages - WxMpConfigStorage map
    
    defaultMpId - 设置一个WxQidianConfigStorage 所对应的mpId进行Http初始化
  - addConfigStorage
```
public void addConfigStorage(String mpId,
                             WxQidianConfigStorage configStorages)
```
    从接口复制的说明: WxQidianService
    
    Map里加入新的 WxQidianConfigStorage，适用于动态添加新的微信公众号配置.
    
    指定者:
    
    addConfigStorage 在接口中 WxQidianService
    
    参数:
    
    mpId - 公众号id
    
    configStorages - 新的微信配置
  - removeConfigStorage
```
public void removeConfigStorage(String mpId)
```
    从接口复制的说明: WxQidianService
    
    从 Map中移除 mpId 所对应的 WxQidianConfigStorage，适用于动态移除微信公众号配置.
    
    指定者:
    
    removeConfigStorage 在接口中 WxQidianService
    
    参数:
    
    mpId - 对应公众号的标识
  - switchoverTo
```
public WxQidianService switchoverTo(String mpId)
```
    从接口复制的说明: WxQidianService
    
    进行相应的公众号切换.
    
    指定者:
    
    switchoverTo 在接口中 WxQidianService
    
    参数:
    
    mpId - 公众号标识
    
    返回:
    
    切换成功，则返回当前对象，方便链式调用，否则抛出异常
  - switchover
```
public boolean switchover(String mpId)
```
    从接口复制的说明: WxQidianService
    
    进行相应的公众号切换.
    
    指定者:
    
    switchover 在接口中 WxQidianService
    
    参数:
    
    mpId - 公众号标识
    
    返回:
    
    切换是否成功 boolean
  - setRetrySleepMillis
```
public void setRetrySleepMillis(int retrySleepMillis)
```
    从接口复制的说明: WxQidianService
    
    设置当微信系统响应系统繁忙时，要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试.
    
    指定者:
    
    setRetrySleepMillis 在接口中 WxQidianService
    
    参数:
    
    retrySleepMillis - 默认：1000ms
  - setMaxRetryTimes
```
public void setMaxRetryTimes(int maxRetryTimes)
```
    从接口复制的说明: WxQidianService
```
 设置当微信系统响应系统繁忙时，最大重试次数.
 默认：5次
 
```
    指定者:
    
    setMaxRetryTimes 在接口中 WxQidianService
    
    参数:
    
    maxRetryTimes - 最大重试次数
  - getRequestHttp
```
public RequestHttp getRequestHttp()
```
    从接口复制的说明: WxQidianService
    
    获取RequestHttp对象.
    
    指定者:
    
    getRequestHttp 在接口中 WxQidianService
    
    返回:
    
    RequestHttp对象 request http

类 BaseWxQidianServiceImpl<H,P>

构造器概要

方法概要

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

从接口继承的方法 me.chanjar.weixin.qidian.api.WxQidianService

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

构造器详细资料

BaseWxQidianServiceImpl

方法详细资料

checkSignature

getTicket

getTicket

getJsapiTicket

getJsapiTicket

createJsapiSignature

getAccessToken

shortUrl

buildQrConnectUrl

getCallbackIP

netCheck

clearQuota

get

get

post

post

post

post

post

post

execute

execute

executeInternal

getWxMpConfigStorage

extractAccessToken

setWxMpConfigStorage

setMultiConfigStorages

setMultiConfigStorages

addConfigStorage

removeConfigStorage

switchoverTo

switchover

setRetrySleepMillis

setMaxRetryTimes

getRequestHttp