BaseWxMaServiceImpl (WxJava - MiniApp Java SDK 4.0.0 API)

java.lang.Object
- cn.binarywang.wx.miniapp.api.impl.BaseWxMaServiceImpl<H,P>

所有已实现的接口:

WxMaService, WxService, RequestHttp<H,P>

直接已知子类:

WxMaServiceHttpClientImpl, WxMaServiceJoddHttpImpl, WxMaServiceOkHttpImpl
```
public abstract class BaseWxMaServiceImpl<H,P>
extends Object
implements WxMaService, RequestHttp<H,P>
```
作者:

Binary Wang

另请参阅:

doGetAccessTokenRequest()

字段概要

字段
限定符和类型字段和说明

protected static com.google.gson.Gson GSON
- 从接口继承的字段 cn.binarywang.wx.miniapp.api.WxMaService
  GET_ACCESS_TOKEN_URL, GET_PAID_UNION_ID_URL, JSCODE_TO_SESSION_URL, SET_DYNAMIC_DATA_URL

字段
限定符和类型	字段和说明
`protected static com.google.gson.Gson`	`GSON`

构造器概要

构造器
构造器和说明

BaseWxMaServiceImpl()

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

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`void`	`addConfig(String mpId, WxMaConfig configStorages)` Map里加入新的 `WxMaConfig`，适用于动态添加新的微信公众号配置.
`boolean`	`checkSignature(String timestamp, String nonce, String signature)` 验证消息的确来自微信服务器.
`protected abstract String`	`doGetAccessTokenRequest()` 通过网络请求获取AccessToken
`<T,E> T`	`execute(RequestExecutor<T,E> executor, String uri, E data)` 向微信端发送请求，在这里执行的策略是当发生access_token过期时才去刷新，然后重新执行请求，而不是全局定时请求
`protected String`	`extractAccessToken(String resultContent)` 设置当前的AccessToken
`String`	`get(String url, String queryParam)`
`String`	`getAccessToken()` 获取access_token, 不强制刷新access_token.
`String`	`getAccessToken(boolean forceRefresh)` 获取access_token，本方法线程安全.
`WxMaAnalysisService`	`getAnalysisService()` 数据分析相关查询服务.
`WxMaCloudService`	`getCloudService()` 获取云开发接口服务对象
`WxMaCodeService`	`getCodeService()` 返回代码操作相关的 API.
`WxMaExpressService`	`getExpressService()` 获取物流助手接口服务对象
`WxImgProcService`	`getImgProcService()` 返回图像处理接口的实现类对象，以方便调用其各个接口.
`WxMaJsapiService`	`getJsapiService()` 返回jsapi操作相关的 API服务类对象.
`WxMaLiveGoodsService`	`getLiveGoodsService()` 获取直播间商品服务对象
`WxMaLiveService`	`getLiveService()` 获取直播接口服务对象
`WxMaMediaService`	`getMediaService()` 返回素材相关接口方法的实现类对象，以方便调用其各个接口.
`WxMaMsgService`	`getMsgService()` 返回消息（客服消息和模版消息）发送接口方法实现类，以方便调用其各个接口.
`WxOcrService`	`getOcrService()` 获取ocr实现接口服务对象
`String`	`getPaidUnionId(String openid, String transactionId, String mchId, String outTradeNo)` 用户支付完成后，获取该用户的 UnionId，无需用户授权。
`WxMaPluginService`	`getPluginService()` 返回插件相关接口服务对象.
`WxMaQrcodeService`	`getQrcodeService()` 返回二维码相关接口方法的实现类对象，以方便调用其各个接口.
`RequestHttp`	`getRequestHttp()` 请求http请求相关信息.
`WxMaRunService`	`getRunService()` 返回微信运动相关接口服务对象.
`WxMaSecCheckService`	`getSecCheckService()` 返回内容安全相关接口服务对象.
`WxMaSettingService`	`getSettingService()` 小程序修改服务器地址、成员管理 API.
`WxMaShareService`	`getShareService()` 返回分享相关查询服务.
`WxMaSubscribeService`	`getSubscribeService()` 返回订阅消息配置相关接口方法的实现类对象, 以方便调用其各个接口.
`WxMaUserService`	`getUserService()` 返回用户相关接口方法的实现类对象，以方便调用其各个接口.
`WxMaConfig`	`getWxMaConfig()` 获取WxMaConfig 对象.
`WxMaJscode2SessionResult`	`jsCode2SessionInfo(String jsCode)` 获取登录后的session信息.
`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)`
`void`	`removeConfig(String miniappId)` 从 Map中移除 `miniappId` 所对应的 `WxMaConfig`，适用于动态移除小程序配置.
`void`	`setDynamicData(int lifespan, String type, int scene, String data)` 导入抽样数据第三方通过调用微信API，将数据写入到setdynamicdata这个API。
`void`	`setMaxRetryTimes(int maxRetryTimes)` 设置当微信系统响应系统繁忙时，最大重试次数.
`void`	`setMultiConfigs(Map<String,WxMaConfig> configs)` 注入多个 `WxMaConfig` 的实现.
`void`	`setMultiConfigs(Map<String,WxMaConfig> configs, String defaultMiniappId)` 注入多个 `WxMaConfig` 的实现.
`void`	`setRetrySleepMillis(int retrySleepMillis)` 设置当微信系统响应系统繁忙时，要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试.
`void`	`setWxMaConfig(WxMaConfig maConfig)` 注入 `WxMaConfig` 的实现.
`boolean`	`switchover(String mpId)` 进行相应的公众号切换.
`WxMaService`	`switchoverTo(String miniappId)` 进行相应的公众号切换.

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

从接口继承的方法 cn.binarywang.wx.miniapp.api.WxMaService
initHttp

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

- 字段详细资料
  - GSON
```
protected static final com.google.gson.Gson GSON
```
- 构造器详细资料
  - BaseWxMaServiceImpl
```
public BaseWxMaServiceImpl()
```
- 方法详细资料
  - getRequestHttp
```
public RequestHttp getRequestHttp()
```
    从接口复制的说明: WxMaService
    
    请求http请求相关信息.
    
    指定者:
    
    getRequestHttp 在接口中 WxMaService
    
    返回:
    
    .
  - getPaidUnionId
```
public String getPaidUnionId(String openid,
                             String transactionId,
                             String mchId,
                             String outTradeNo)
                      throws WxErrorException
```
    从接口复制的说明: WxMaService
```
 用户支付完成后，获取该用户的 UnionId，无需用户授权。本接口支持第三方平台代理查询。

 注意：调用前需要用户完成支付，且在支付后的五分钟内有效。
 请求地址： GET https://api.weixin.qq.com/wxa/getpaidunionid?access_token=ACCESS_TOKEN&openid=OPENID
 文档地址：https://developers.weixin.qq.com/miniprogram/dev/api/getPaidUnionId.html
 
```
    指定者:
    
    getPaidUnionId 在接口中 WxMaService
    
    参数:
    
    openid - 必填支付用户唯一标识
    
    transactionId - 非必填微信支付订单号
    
    mchId - 非必填微信支付分配的商户号，和商户订单号配合使用
    
    outTradeNo - 非必填微信支付商户订单号，和商户号配合使用
    
    返回:
    
    UnionId.
    
    抛出:
    
    WxErrorException - .
  - jsCode2SessionInfo
```
public WxMaJscode2SessionResult jsCode2SessionInfo(String jsCode)
                                            throws WxErrorException
```
    从接口复制的说明: WxMaService
    
    获取登录后的session信息.
    
    指定者:
    
    jsCode2SessionInfo 在接口中 WxMaService
    
    参数:
    
    jsCode - 登录时获取的 code
    
    抛出:
    
    WxErrorException
  - setDynamicData
```
public void setDynamicData(int lifespan,
                           String type,
                           int scene,
                           String data)
                    throws WxErrorException
```
    从接口复制的说明: WxMaService
    导入抽样数据
```
 第三方通过调用微信API，将数据写入到setdynamicdata这个API。每个Post数据包不超过5K，若数据过多可开多进（线）程并发导入数据（例如：数据量为十万量级可以开50个线程并行导数据）。
 文档地址：https://wsad.weixin.qq.com/wsad/zh_CN/htmledition/widget-docs-v3/html/custom/quickstart/implement/import/index.html
 http请求方式：POST http(s)://api.weixin.qq.com/wxa/setdynamicdata?access_token=ACCESS_TOKEN
 
```
    指定者:
    
    setDynamicData 在接口中 WxMaService
    
    参数:
    
    lifespan - 数据有效时间，秒为单位，一般为86400，一天一次导入的频率
    
    type - 用于标识数据所属的服务类目
    
    scene - 1代表用于搜索的数据
    
    data - 推送到微信后台的数据列表，该数据被微信用于流量分配，注意该字段为string类型而不是object
    
    抛出:
    
    WxErrorException - .
  - checkSignature
```
public boolean checkSignature(String timestamp,
                              String nonce,
                              String signature)
```
    从接口复制的说明: WxMaService
```
 验证消息的确来自微信服务器.
 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421135319&token=&lang=zh_CN
 
```
    指定者:
    
    checkSignature 在接口中 WxMaService
  - getAccessToken
```
public String getAccessToken()
                      throws WxErrorException
```
    从接口复制的说明: WxMaService
    
    获取access_token, 不强制刷新access_token.
    
    指定者:
    
    getAccessToken 在接口中 WxMaService
    
    抛出:
    
    WxErrorException
    
    另请参阅:
    
    WxMaService.getAccessToken(boolean)
  - getAccessToken
```
public String getAccessToken(boolean forceRefresh)
                      throws WxErrorException
```
    从接口复制的说明: WxMaService
```
 获取access_token，本方法线程安全.
 且在多线程同时刷新时只刷新一次，避免超出2000次/日的调用次数上限

 另：本service的所有方法都会在access_token过期是调用此方法

 程序员在非必要情况下尽量不要主动调用此方法

 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140183&token=&lang=zh_CN
 
```
    指定者:
    
    getAccessToken 在接口中 WxMaService
    
    参数:
    
    forceRefresh - 强制刷新
    
    抛出:
    
    WxErrorException
  - doGetAccessTokenRequest
```
protected abstract String doGetAccessTokenRequest()
                                           throws IOException
```
    通过网络请求获取AccessToken
    
    返回:
    
    .
    
    抛出:
    
    IOException - .
  - get
```
public String get(String url,
                  String queryParam)
           throws WxErrorException
```
    指定者:
    
    get 在接口中 WxService
    
    抛出:
    
    WxErrorException
  - post
```
public String post(String url,
                   String postData)
            throws WxErrorException
```
    指定者:
    
    post 在接口中 WxService
    
    抛出:
    
    WxErrorException
  - post
```
public String post(String url,
                   Object obj)
            throws WxErrorException
```
    指定者:
    
    post 在接口中 WxService
    
    抛出:
    
    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
  - execute
```
public <T,E> T execute(RequestExecutor<T,E> executor,
                       String uri,
                       E data)
                throws WxErrorException
```
    向微信端发送请求，在这里执行的策略是当发生access_token过期时才去刷新，然后重新执行请求，而不是全局定时请求
    
    指定者:
    
    execute 在接口中 WxMaService
    
    类型参数:
    
    T - .
    
    E - .
    
    参数:
    
    executor - 执行器
    
    uri - 接口请求地址
    
    data - 参数或请求数据
    
    返回:
    
    .
    
    抛出:
    
    WxErrorException
  - extractAccessToken
```
protected String extractAccessToken(String resultContent)
                             throws WxErrorException
```
    设置当前的AccessToken
    
    参数:
    
    resultContent - 响应内容
    
    返回:
    
    access token
    
    抛出:
    
    WxErrorException - 异常
  - getWxMaConfig
```
public WxMaConfig getWxMaConfig()
```
    从接口复制的说明: WxMaService
    
    获取WxMaConfig 对象.
    
    指定者:
    
    getWxMaConfig 在接口中 WxMaService
    
    返回:
    
    WxMaConfig
  - setWxMaConfig
```
public void setWxMaConfig(WxMaConfig maConfig)
```
    从接口复制的说明: WxMaService
    
    注入 WxMaConfig 的实现.
    
    指定者:
    
    setWxMaConfig 在接口中 WxMaService
    
    参数:
    
    maConfig - config
  - setMultiConfigs
```
public void setMultiConfigs(Map<String,WxMaConfig> configs)
```
    从接口复制的说明: WxMaService
    
    注入多个 WxMaConfig 的实现. 并为每个 WxMaConfig 赋予不同的 mpId 值随机采用一个mpId进行Http初始化操作
    
    指定者:
    
    setMultiConfigs 在接口中 WxMaService
    
    参数:
    
    configs - WxMaConfig map
  - setMultiConfigs
```
public void setMultiConfigs(Map<String,WxMaConfig> configs,
                            String defaultMiniappId)
```
    从接口复制的说明: WxMaService
    
    注入多个 WxMaConfig 的实现. 并为每个 WxMaConfig 赋予不同的 label 值
    
    指定者:
    
    setMultiConfigs 在接口中 WxMaService
    
    参数:
    
    configs - WxMaConfig map
    
    defaultMiniappId - 设置一个WxMaConfig 所对应的defaultMiniappId进行Http初始化
  - addConfig
```
public void addConfig(String mpId,
                      WxMaConfig configStorages)
```
    从接口复制的说明: WxMaService
    
    Map里加入新的 WxMaConfig，适用于动态添加新的微信公众号配置.
    
    指定者:
    
    addConfig 在接口中 WxMaService
    
    参数:
    
    mpId - 小程序标识
    
    configStorages - 新的微信配置
  - removeConfig
```
public void removeConfig(String miniappId)
```
    从接口复制的说明: WxMaService
    
    从 Map中移除 miniappId 所对应的 WxMaConfig，适用于动态移除小程序配置.
    
    指定者:
    
    removeConfig 在接口中 WxMaService
    
    参数:
    
    miniappId - 对应小程序的标识
  - switchoverTo
```
public WxMaService switchoverTo(String miniappId)
```
    从接口复制的说明: WxMaService
    
    进行相应的公众号切换.
    
    指定者:
    
    switchoverTo 在接口中 WxMaService
    
    参数:
    
    miniappId - 小程序标识
    
    返回:
    
    切换成功，则返回当前对象，方便链式调用，否则抛出异常
  - switchover
```
public boolean switchover(String mpId)
```
    从接口复制的说明: WxMaService
    
    进行相应的公众号切换.
    
    指定者:
    
    switchover 在接口中 WxMaService
    
    参数:
    
    mpId - 公众号标识
    
    返回:
    
    切换是否成功
  - setRetrySleepMillis
```
public void setRetrySleepMillis(int retrySleepMillis)
```
    从接口复制的说明: WxMaService
```
 设置当微信系统响应系统繁忙时，要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试.
 默认：1000ms
 
```
    指定者:
    
    setRetrySleepMillis 在接口中 WxMaService
    
    参数:
    
    retrySleepMillis - 重试等待毫秒数
  - setMaxRetryTimes
```
public void setMaxRetryTimes(int maxRetryTimes)
```
    从接口复制的说明: WxMaService
```
 设置当微信系统响应系统繁忙时，最大重试次数.
 默认：5次
 
```
    指定者:
    
    setMaxRetryTimes 在接口中 WxMaService
    
    参数:
    
    maxRetryTimes - 最大重试次数
  - getMsgService
```
public WxMaMsgService getMsgService()
```
    从接口复制的说明: WxMaService
    
    返回消息（客服消息和模版消息）发送接口方法实现类，以方便调用其各个接口.
    
    指定者:
    
    getMsgService 在接口中 WxMaService
    
    返回:
    
    WxMaMsgService
  - getMediaService
```
public WxMaMediaService getMediaService()
```
    从接口复制的说明: WxMaService
    
    返回素材相关接口方法的实现类对象，以方便调用其各个接口.
    
    指定者:
    
    getMediaService 在接口中 WxMaService
    
    返回:
    
    WxMaMediaService
  - getUserService
```
public WxMaUserService getUserService()
```
    从接口复制的说明: WxMaService
    
    返回用户相关接口方法的实现类对象，以方便调用其各个接口.
    
    指定者:
    
    getUserService 在接口中 WxMaService
    
    返回:
    
    WxMaUserService
  - getQrcodeService
```
public WxMaQrcodeService getQrcodeService()
```
    从接口复制的说明: WxMaService
    
    返回二维码相关接口方法的实现类对象，以方便调用其各个接口.
    
    指定者:
    
    getQrcodeService 在接口中 WxMaService
    
    返回:
    
    WxMaQrcodeService
  - getSubscribeService
```
public WxMaSubscribeService getSubscribeService()
```
    从接口复制的说明: WxMaService
    
    返回订阅消息配置相关接口方法的实现类对象, 以方便调用其各个接口.
    
    指定者:
    
    getSubscribeService 在接口中 WxMaService
    
    返回:
    
    WxMaSubscribeService
  - getAnalysisService
```
public WxMaAnalysisService getAnalysisService()
```
    从接口复制的说明: WxMaService
    
    数据分析相关查询服务.
    
    指定者:
    
    getAnalysisService 在接口中 WxMaService
    
    返回:
    
    WxMaAnalysisService
  - getCodeService
```
public WxMaCodeService getCodeService()
```
    从接口复制的说明: WxMaService
    
    返回代码操作相关的 API.
    
    指定者:
    
    getCodeService 在接口中 WxMaService
    
    返回:
    
    WxMaCodeService
  - getJsapiService
```
public WxMaJsapiService getJsapiService()
```
    从接口复制的说明: WxMaService
    
    返回jsapi操作相关的 API服务类对象.
    
    指定者:
    
    getJsapiService 在接口中 WxMaService
    
    返回:
    
    WxMaJsapiService
  - getSettingService
```
public WxMaSettingService getSettingService()
```
    从接口复制的说明: WxMaService
    
    小程序修改服务器地址、成员管理 API.
    
    指定者:
    
    getSettingService 在接口中 WxMaService
    
    返回:
    
    WxMaSettingService
  - getShareService
```
public WxMaShareService getShareService()
```
    从接口复制的说明: WxMaService
    
    返回分享相关查询服务.
    
    指定者:
    
    getShareService 在接口中 WxMaService
    
    返回:
    
    WxMaShareService
  - getRunService
```
public WxMaRunService getRunService()
```
    从接口复制的说明: WxMaService
    
    返回微信运动相关接口服务对象.
    
    指定者:
    
    getRunService 在接口中 WxMaService
    
    返回:
    
    WxMaShareService
  - getSecCheckService
```
public WxMaSecCheckService getSecCheckService()
```
    从接口复制的说明: WxMaService
    
    返回内容安全相关接口服务对象.
    
    指定者:
    
    getSecCheckService 在接口中 WxMaService
    
    返回:
    
    WxMaShareService
  - getPluginService
```
public WxMaPluginService getPluginService()
```
    从接口复制的说明: WxMaService
    
    返回插件相关接口服务对象.
    
    指定者:
    
    getPluginService 在接口中 WxMaService
    
    返回:
    
    WxMaPluginService
  - getExpressService
```
public WxMaExpressService getExpressService()
```
    从接口复制的说明: WxMaService
    
    获取物流助手接口服务对象
    
    指定者:
    
    getExpressService 在接口中 WxMaService
    
    返回:
    
    .
  - getCloudService
```
public WxMaCloudService getCloudService()
```
    从接口复制的说明: WxMaService
    
    获取云开发接口服务对象
    
    指定者:
    
    getCloudService 在接口中 WxMaService
    
    返回:
    
    .
  - getLiveService
```
public WxMaLiveService getLiveService()
```
    从接口复制的说明: WxMaService
    
    获取直播接口服务对象
    
    指定者:
    
    getLiveService 在接口中 WxMaService
    
    返回:
    
    .
  - getLiveGoodsService
```
public WxMaLiveGoodsService getLiveGoodsService()
```
    从接口复制的说明: WxMaService
    
    获取直播间商品服务对象
    
    指定者:
    
    getLiveGoodsService 在接口中 WxMaService
    
    返回:
    
    .
  - getOcrService
```
public WxOcrService getOcrService()
```
    从接口复制的说明: WxMaService
    
    获取ocr实现接口服务对象
    
    指定者:
    
    getOcrService 在接口中 WxMaService
    
    返回:
    
    。
  - getImgProcService
```
public WxImgProcService getImgProcService()
```
    从接口复制的说明: WxMaService
    
    返回图像处理接口的实现类对象，以方便调用其各个接口.
    
    指定者:
    
    getImgProcService 在接口中 WxMaService
    
    返回:
    
    WxImgProcService

类 BaseWxMaServiceImpl<H,P>

字段概要

从接口继承的字段 cn.binarywang.wx.miniapp.api.WxMaService

构造器概要

方法概要

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

从接口继承的方法 cn.binarywang.wx.miniapp.api.WxMaService

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

字段详细资料

GSON

构造器详细资料

BaseWxMaServiceImpl

方法详细资料

getRequestHttp

getPaidUnionId

jsCode2SessionInfo

setDynamicData

checkSignature

getAccessToken

getAccessToken

doGetAccessTokenRequest

get

post

post

post

post

execute

extractAccessToken

getWxMaConfig

setWxMaConfig

setMultiConfigs

setMultiConfigs

addConfig

removeConfig

switchoverTo

switchover

setRetrySleepMillis

setMaxRetryTimes

getMsgService

getMediaService

getUserService

getQrcodeService

getSubscribeService

getAnalysisService

getCodeService

getJsapiService

getSettingService

getShareService

getRunService

getSecCheckService

getPluginService

getExpressService

getCloudService

getLiveService

getLiveGoodsService

getOcrService

getImgProcService