BaseWxCpServiceImpl (WxJava - CP Java SDK 3.3.4.B API)

java.lang.Object
- me.chanjar.weixin.cp.api.impl.BaseWxCpServiceImpl<H,P>

所有已实现的接口:

RequestHttp<H,P>, WxCpService

直接已知子类:

WxCpServiceApacheHttpClientImpl, WxCpServiceJoddHttpImpl, WxCpServiceOkHttpImpl
```
public abstract class BaseWxCpServiceImpl<H,P>
extends Object
implements WxCpService, RequestHttp<H,P>
```

字段概要

字段
限定符和类型	字段和说明
`protected WxCpConfigStorage`	`configStorage`
`protected Object`	`globalAccessTokenRefreshLock` 全局的是否正在刷新access token的锁
`protected Object`	`globalJsapiTicketRefreshLock` 全局的是否正在刷新jsapi_ticket的锁
`protected org.slf4j.Logger`	`log`
`protected WxSessionManager`	`sessionManager`
`protected File`	`tmpDirFile` 临时文件目录

构造器概要

构造器
构造器和说明

BaseWxCpServiceImpl()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`checkSignature(String msgSignature, String timestamp, String nonce, String data)` 验证推送过来的消息的正确性详情请见: http://mp.weixin.qq.com/wiki/index.php?
`WxJsapiSignature`	`createJsapiSignature(String url)` 创建调用jsapi时所需要的签名详情请见：http://qydev.weixin.qq.com/wiki/index.php?
`<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`	`getAccessToken()` 获取access_token, 不强制刷新access_token
`WxCpAgentService`	`getAgentService()`
`String[]`	`getCallbackIp()` 获取微信服务器的ip段 http://qydev.weixin.qq.com/wiki/index.php?
`WxCpChatService`	`getChatService()` 获取群聊服务
`WxCpDepartmentService`	`getDepartmentService()` 获取部门相关接口的服务类对象
`String`	`getJsapiTicket()` 获得jsapi_ticket,不强制刷新jsapi_ticket
`String`	`getJsapiTicket(boolean forceRefresh)` 获得jsapi_ticket 获得时会检查jsapiToken是否过期，如果过期了，那么就刷新一下，否则就什么都不干详情请见：http://qydev.weixin.qq.com/wiki/index.php?
`WxCpMediaService`	`getMediaService()` 获取媒体相关接口的服务类对象
`WxCpMenuService`	`getMenuService()` 获取菜单相关接口的服务类对象
`WxCpOAuth2Service`	`getOauth2Service()` 获取Oauth2相关接口的服务类对象
`RequestHttp<?,?>`	`getRequestHttp()` http请求对象
`WxSession`	`getSession(String id)` 获取某个sessionId对应的session,如果sessionId没有对应的session，则新建一个并返回。
`WxSession`	`getSession(String id, boolean create)` 获取某个sessionId对应的session,如果sessionId没有对应的session，若create为true则新建一个，否则返回null。
`WxCpTagService`	`getTagService()` 获取标签相关接口的服务类对象
`String`	`getTaskResult(String joinId)` 获取异步任务结果
`File`	`getTmpDirFile()`
`WxCpUserService`	`getUserService()` 获取用户相关接口的服务类对象
`WxCpMessageSendResult`	`messageSend(WxCpMessage message)` 发送消息详情请见: http://qydev.weixin.qq.com/wiki/index.php?
`String`	`post(String url, String postData)` 当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的POST请求
`String`	`replaceParty(String mediaId)` 上传部门列表覆盖企业号上的部门信息
`String`	`replaceUser(String mediaId)` 上传用户列表覆盖企业号上的用户信息
`void`	`setAgentService(WxCpAgentService agentService)`
`void`	`setDepartmentService(WxCpDepartmentService departmentService)`
`void`	`setMaxRetryTimes(int maxRetryTimes)` 设置当微信系统响应系统繁忙时，最大重试次数默认：5次
`void`	`setMediaService(WxCpMediaService mediaService)`
`void`	`setMenuService(WxCpMenuService menuService)`
`void`	`setOauth2Service(WxCpOAuth2Service oauth2Service)`
`void`	`setRetrySleepMillis(int retrySleepMillis)` 设置当微信系统响应系统繁忙时，要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试默认：1000ms
`void`	`setSessionManager(WxSessionManager sessionManager)` 设置WxSessionManager，只有当需要使用个性化的WxSessionManager的时候才需要调用此方法， WxCpService默认使用的是`StandardSessionManager`
`void`	`setTagService(WxCpTagService tagService)`
`void`	`setTmpDirFile(File tmpDirFile)`
`void`	`setUserService(WxCpUserService userService)`
`void`	`setWxCpConfigStorage(WxCpConfigStorage wxConfigProvider)` 注入 `WxCpConfigStorage` 的实现

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

从接口继承的方法 me.chanjar.weixin.cp.api.WxCpService
getAccessToken, getWxCpConfigStorage, initHttp

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

- 字段详细资料
  - log
```
protected final org.slf4j.Logger log
```
  - globalAccessTokenRefreshLock
```
protected final Object globalAccessTokenRefreshLock
```
    全局的是否正在刷新access token的锁
  - globalJsapiTicketRefreshLock
```
protected final Object globalJsapiTicketRefreshLock
```
    全局的是否正在刷新jsapi_ticket的锁
  - configStorage
```
protected WxCpConfigStorage configStorage
```
  - sessionManager
```
protected WxSessionManager sessionManager
```
  - tmpDirFile
```
protected File tmpDirFile
```
    临时文件目录
- 构造器详细资料
  - BaseWxCpServiceImpl
```
public BaseWxCpServiceImpl()
```
- 方法详细资料
  - checkSignature
```
public boolean checkSignature(String msgSignature,
                              String timestamp,
                              String nonce,
                              String data)
```
    从接口复制的说明: WxCpService
```
 验证推送过来的消息的正确性
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=验证消息真实性
 
```
    指定者:
    
    checkSignature 在接口中 WxCpService
    
    参数:
    
    msgSignature - 消息签名
    
    timestamp - 时间戳
    
    nonce - 随机数
    
    data - 微信传输过来的数据，有可能是echoStr，有可能是xml消息
  - getAccessToken
```
public String getAccessToken()
                      throws WxErrorException
```
    从接口复制的说明: WxCpService
    
    获取access_token, 不强制刷新access_token
    
    指定者:
    
    getAccessToken 在接口中 WxCpService
    
    抛出:
    
    WxErrorException
    
    另请参阅:
    
    WxCpService.getAccessToken(boolean)
  - getJsapiTicket
```
public String getJsapiTicket()
                      throws WxErrorException
```
    从接口复制的说明: WxCpService
    
    获得jsapi_ticket,不强制刷新jsapi_ticket
    
    指定者:
    
    getJsapiTicket 在接口中 WxCpService
    
    抛出:
    
    WxErrorException
    
    另请参阅:
    
    WxCpService.getJsapiTicket(boolean)
  - getJsapiTicket
```
public String getJsapiTicket(boolean forceRefresh)
                      throws WxErrorException
```
    从接口复制的说明: WxCpService
```
 获得jsapi_ticket
 获得时会检查jsapiToken是否过期，如果过期了，那么就刷新一下，否则就什么都不干

 详情请见：http://qydev.weixin.qq.com/wiki/index.php?title=微信JS接口#.E9.99.84.E5.BD.951-JS-SDK.E4.BD.BF.E7.94.A8.E6.9D.83.E9.99.90.E7.AD.BE.E5.90.8D.E7.AE.97.E6.B3.95
 
```
    指定者:
    
    getJsapiTicket 在接口中 WxCpService
    
    参数:
    
    forceRefresh - 强制刷新
    
    抛出:
    
    WxErrorException
  - createJsapiSignature
```
public WxJsapiSignature createJsapiSignature(String url)
                                      throws WxErrorException
```
    从接口复制的说明: WxCpService
```
 创建调用jsapi时所需要的签名

 详情请见：http://qydev.weixin.qq.com/wiki/index.php?title=微信JS接口#.E9.99.84.E5.BD.951-JS-SDK.E4.BD.BF.E7.94.A8.E6.9D.83.E9.99.90.E7.AD.BE.E5.90.8D.E7.AE.97.E6.B3.95
 
```
    指定者:
    
    createJsapiSignature 在接口中 WxCpService
    
    参数:
    
    url - url
    
    抛出:
    
    WxErrorException
  - messageSend
```
public WxCpMessageSendResult messageSend(WxCpMessage message)
                                  throws WxErrorException
```
    从接口复制的说明: WxCpService
```
 发送消息
 详情请见: http://qydev.weixin.qq.com/wiki/index.php?title=%E5%8F%91%E9%80%81%E6%8E%A5%E5%8F%A3%E8%AF%B4%E6%98%8E
 
```
    指定者:
    
    messageSend 在接口中 WxCpService
    
    参数:
    
    message - 要发送的消息对象
    
    抛出:
    
    WxErrorException
  - getCallbackIp
```
public String[] getCallbackIp()
                       throws WxErrorException
```
    从接口复制的说明: WxCpService
```
 获取微信服务器的ip段
 http://qydev.weixin.qq.com/wiki/index.php?title=回调模式#.E8.8E.B7.E5.8F.96.E5.BE.AE.E4.BF.A1.E6.9C.8D.E5.8A.A1.E5.99.A8.E7.9A.84ip.E6.AE.B5
 
```
    指定者:
    
    getCallbackIp 在接口中 WxCpService
    
    返回:
    
    { "ip_list": ["101.226.103.*", "101.226.62.*"] }
    
    抛出:
    
    WxErrorException
  - get
```
public String get(String url,
                  String queryParam)
           throws WxErrorException
```
    从接口复制的说明: WxCpService
    
    当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的GET请求
    
    指定者:
    
    get 在接口中 WxCpService
    
    参数:
    
    url - 接口地址
    
    queryParam - 请求参数
    
    抛出:
    
    WxErrorException
  - post
```
public String post(String url,
                   String postData)
            throws WxErrorException
```
    从接口复制的说明: WxCpService
    
    当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的POST请求
    
    指定者:
    
    post 在接口中 WxCpService
    
    参数:
    
    url - 接口地址
    
    postData - 请求body字符串
    
    抛出:
    
    WxErrorException
  - execute
```
public <T,E> T execute(RequestExecutor<T,E> executor,
                       String uri,
                       E data)
                throws WxErrorException
```
    向微信端发送请求，在这里执行的策略是当发生access_token过期时才去刷新，然后重新执行请求，而不是全局定时请求.
    
    指定者:
    
    execute 在接口中 WxCpService
    
    类型参数:
    
    T - 请求值类型
    
    E - 返回值类型
    
    参数:
    
    executor - 执行器
    
    uri - 请求地址
    
    data - 参数
    
    抛出:
    
    WxErrorException
  - executeInternal
```
protected <T,E> T executeInternal(RequestExecutor<T,E> executor,
                                  String uri,
                                  E data)
                           throws WxErrorException
```
    抛出:
    
    WxErrorException
  - setWxCpConfigStorage
```
public void setWxCpConfigStorage(WxCpConfigStorage wxConfigProvider)
```
    从接口复制的说明: WxCpService
    
    注入 WxCpConfigStorage 的实现
    
    指定者:
    
    setWxCpConfigStorage 在接口中 WxCpService
    
    参数:
    
    wxConfigProvider - 配置对象
  - setRetrySleepMillis
```
public void setRetrySleepMillis(int retrySleepMillis)
```
    从接口复制的说明: WxCpService
```
 设置当微信系统响应系统繁忙时，要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试
 默认：1000ms
 
```
    指定者:
    
    setRetrySleepMillis 在接口中 WxCpService
    
    参数:
    
    retrySleepMillis - 重试休息时间
  - setMaxRetryTimes
```
public void setMaxRetryTimes(int maxRetryTimes)
```
    从接口复制的说明: WxCpService
```
 设置当微信系统响应系统繁忙时，最大重试次数
 默认：5次
 
```
    指定者:
    
    setMaxRetryTimes 在接口中 WxCpService
    
    参数:
    
    maxRetryTimes - 最大重试次数
  - getSession
```
public WxSession getSession(String id)
```
    从接口复制的说明: WxCpService
    
    获取某个sessionId对应的session,如果sessionId没有对应的session，则新建一个并返回。
    
    指定者:
    
    getSession 在接口中 WxCpService
    
    参数:
    
    id - id可以为任意字符串，建议使用FromUserName作为id
  - getSession
```
public WxSession getSession(String id,
                            boolean create)
```
    从接口复制的说明: WxCpService
    
    获取某个sessionId对应的session,如果sessionId没有对应的session，若create为true则新建一个，否则返回null。
    
    指定者:
    
    getSession 在接口中 WxCpService
    
    参数:
    
    id - id可以为任意字符串，建议使用FromUserName作为id
    
    create - 是否新建
  - setSessionManager
```
public void setSessionManager(WxSessionManager sessionManager)
```
    从接口复制的说明: WxCpService
```
 设置WxSessionManager，只有当需要使用个性化的WxSessionManager的时候才需要调用此方法，
 WxCpService默认使用的是StandardSessionManager
 
```
    指定者:
    
    setSessionManager 在接口中 WxCpService
    
    参数:
    
    sessionManager - 会话管理器
  - replaceParty
```
public String replaceParty(String mediaId)
                    throws WxErrorException
```
    从接口复制的说明: WxCpService
    
    上传部门列表覆盖企业号上的部门信息
    
    指定者:
    
    replaceParty 在接口中 WxCpService
    
    参数:
    
    mediaId - 媒体id
    
    抛出:
    
    WxErrorException
  - replaceUser
```
public String replaceUser(String mediaId)
                   throws WxErrorException
```
    从接口复制的说明: WxCpService
    
    上传用户列表覆盖企业号上的用户信息
    
    指定者:
    
    replaceUser 在接口中 WxCpService
    
    参数:
    
    mediaId - 媒体id
    
    抛出:
    
    WxErrorException
  - getTaskResult
```
public String getTaskResult(String joinId)
                     throws WxErrorException
```
    从接口复制的说明: WxCpService
    
    获取异步任务结果
    
    指定者:
    
    getTaskResult 在接口中 WxCpService
    
    抛出:
    
    WxErrorException
  - getTmpDirFile
```
public File getTmpDirFile()
```
  - setTmpDirFile
```
public void setTmpDirFile(File tmpDirFile)
```
  - getDepartmentService
```
public WxCpDepartmentService getDepartmentService()
```
    从接口复制的说明: WxCpService
    
    获取部门相关接口的服务类对象
    
    指定者:
    
    getDepartmentService 在接口中 WxCpService
  - getMediaService
```
public WxCpMediaService getMediaService()
```
    从接口复制的说明: WxCpService
    
    获取媒体相关接口的服务类对象
    
    指定者:
    
    getMediaService 在接口中 WxCpService
  - getMenuService
```
public WxCpMenuService getMenuService()
```
    从接口复制的说明: WxCpService
    
    获取菜单相关接口的服务类对象
    
    指定者:
    
    getMenuService 在接口中 WxCpService
  - getOauth2Service
```
public WxCpOAuth2Service getOauth2Service()
```
    从接口复制的说明: WxCpService
    
    获取Oauth2相关接口的服务类对象
    
    指定者:
    
    getOauth2Service 在接口中 WxCpService
  - getTagService
```
public WxCpTagService getTagService()
```
    从接口复制的说明: WxCpService
    
    获取标签相关接口的服务类对象
    
    指定者:
    
    getTagService 在接口中 WxCpService
  - getUserService
```
public WxCpUserService getUserService()
```
    从接口复制的说明: WxCpService
    
    获取用户相关接口的服务类对象
    
    指定者:
    
    getUserService 在接口中 WxCpService
  - getChatService
```
public WxCpChatService getChatService()
```
    从接口复制的说明: WxCpService
    
    获取群聊服务
    
    指定者:
    
    getChatService 在接口中 WxCpService
    
    返回:
    
    群聊服务
  - getRequestHttp
```
public RequestHttp<?,?> getRequestHttp()
```
    从接口复制的说明: WxCpService
    
    http请求对象
    
    指定者:
    
    getRequestHttp 在接口中 WxCpService
  - setUserService
```
public void setUserService(WxCpUserService userService)
```
    指定者:
    
    setUserService 在接口中 WxCpService
  - setDepartmentService
```
public void setDepartmentService(WxCpDepartmentService departmentService)
```
    指定者:
    
    setDepartmentService 在接口中 WxCpService
  - setMediaService
```
public void setMediaService(WxCpMediaService mediaService)
```
    指定者:
    
    setMediaService 在接口中 WxCpService
  - setMenuService
```
public void setMenuService(WxCpMenuService menuService)
```
    指定者:
    
    setMenuService 在接口中 WxCpService
  - setOauth2Service
```
public void setOauth2Service(WxCpOAuth2Service oauth2Service)
```
    指定者:
    
    setOauth2Service 在接口中 WxCpService
  - setTagService
```
public void setTagService(WxCpTagService tagService)
```
    指定者:
    
    setTagService 在接口中 WxCpService
  - getAgentService
```
public WxCpAgentService getAgentService()
```
    指定者:
    
    getAgentService 在接口中 WxCpService
  - setAgentService
```
public void setAgentService(WxCpAgentService agentService)
```

类 BaseWxCpServiceImpl<H,P>

字段概要

构造器概要

方法概要

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

从接口继承的方法 me.chanjar.weixin.cp.api.WxCpService

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

字段详细资料

log

globalAccessTokenRefreshLock

globalJsapiTicketRefreshLock

configStorage

sessionManager

tmpDirFile

构造器详细资料

BaseWxCpServiceImpl

方法详细资料

checkSignature

getAccessToken

getJsapiTicket

getJsapiTicket

createJsapiSignature

messageSend

getCallbackIp

get

post

execute

executeInternal

setWxCpConfigStorage

setRetrySleepMillis

setMaxRetryTimes

getSession

getSession

setSessionManager

replaceParty

replaceUser

getTaskResult

getTmpDirFile

setTmpDirFile

getDepartmentService

getMediaService

getMenuService

getOauth2Service

getTagService

getUserService

getChatService

getRequestHttp

setUserService

setDepartmentService

setMediaService

setMenuService

setOauth2Service

setTagService

getAgentService

setAgentService