cn.binarywang.wx.miniapp.api

接口 WxMaService

所有超级接口:

WxService

所有已知实现类:

BaseWxMaServiceImpl, WxMaServiceHttpClientImpl, WxMaServiceImpl, WxMaServiceJoddHttpImpl, WxMaServiceOkHttpImpl

public interface WxMaService
extends WxService

作者:

Binary Wang

字段概要

字段

限定符和类型	字段和说明
static String	GET_ACCESS_TOKEN_URL 获取access_token.
static String	GET_PAID_UNION_ID_URL getPaidUnionId
static String	JSCODE_TO_SESSION_URL
static String	SET_DYNAMIC_DATA_URL 导入抽样数据

方法概要

限定符和类型	方法和说明
boolean	checkSignature(String timestamp, String nonce, String signature) 验证消息的确来自微信服务器.
<T,E> T	execute(RequestExecutor<T,E> executor, String uri, E data) Service没有实现某个API的时候，可以用这个， 比WxService.get(java.lang.String, java.lang.String)和WxService.post(java.lang.String, java.lang.String)方法更灵活，可以自己构造RequestExecutor用来处理不同的参数和不同的返回类型。
String	getAccessToken() 获取access_token, 不强制刷新access_token.
String	getAccessToken(boolean forceRefresh) 获取access_token，本方法线程安全.
WxMaAnalysisService	getAnalysisService() 数据分析相关查询服务.
WxMaCloudService	getCloudService() 获取云开发接口服务对象
WxMaCodeService	getCodeService() 返回代码操作相关的 API.
WxMaExpressService	getExpressService() 获取物流助手接口服务对象
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() 返回订阅消息配置相关接口方法的实现类对象, 以方便调用其各个接口.
WxMaTemplateService	getTemplateService() 返回模板配置相关接口方法的实现类对象, 以方便调用其各个接口.
WxMaUserService	getUserService() 返回用户相关接口方法的实现类对象，以方便调用其各个接口.
WxMaConfig	getWxMaConfig() 获取WxMaConfig 对象.
void	initHttp() 初始化http请求对象.
WxMaJscode2SessionResult	jsCode2SessionInfo(String jsCode) 获取登录后的session信息.
void	setDynamicData(int lifespan, String type, int scene, String data) 导入抽样数据 第三方通过调用微信API，将数据写入到setdynamicdata这个API。
void	setMaxRetryTimes(int maxRetryTimes) 设置当微信系统响应系统繁忙时，最大重试次数.
void	setRetrySleepMillis(int retrySleepMillis) 设置当微信系统响应系统繁忙时，要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试.
void	setWxMaConfig(WxMaConfig wxConfigProvider) 注入 WxMaConfig 的实现.

从接口继承的方法 me.chanjar.weixin.common.service.WxService

get, post, post

字段详细资料

GET_ACCESS_TOKEN_URL

static final String GET_ACCESS_TOKEN_URL

获取access_token.

另请参阅:

常量字段值

JSCODE_TO_SESSION_URL

static final String JSCODE_TO_SESSION_URL

另请参阅:

常量字段值

GET_PAID_UNION_ID_URL

static final String GET_PAID_UNION_ID_URL

getPaidUnionId

另请参阅:

常量字段值

SET_DYNAMIC_DATA_URL

static final String SET_DYNAMIC_DATA_URL

导入抽样数据

另请参阅:

常量字段值

方法详细资料

jsCode2SessionInfo

WxMaJscode2SessionResult jsCode2SessionInfo(String jsCode)
                                     throws WxErrorException

获取登录后的session信息.

参数:

jsCode - 登录时获取的 code

抛出:

WxErrorException

setDynamicData

void setDynamicData(int lifespan,
                    String type,
                    int scene,
                    String data)
             throws WxErrorException

导入抽样数据

 第三方通过调用微信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
 

参数:

data - 推送到微信后台的数据列表，该数据被微信用于流量分配，注意该字段为string类型而不是object

lifespan - 数据有效时间，秒为单位，一般为86400，一天一次导入的频率

scene - 1代表用于搜索的数据

type - 用于标识数据所属的服务类目

抛出:

WxErrorException - .

checkSignature

boolean checkSignature(String timestamp,
                       String nonce,
                       String signature)

 验证消息的确来自微信服务器.
 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421135319&token=&lang=zh_CN
 

getAccessToken

String getAccessToken()
               throws WxErrorException

获取access_token, 不强制刷新access_token.

抛出:

WxErrorException

另请参阅:

getAccessToken(boolean)

getAccessToken

String getAccessToken(boolean forceRefresh)
               throws WxErrorException

 获取access_token，本方法线程安全.
 且在多线程同时刷新时只刷新一次，避免超出2000次/日的调用次数上限

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

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

 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140183&token=&lang=zh_CN
 

参数:

forceRefresh - 强制刷新

抛出:

WxErrorException

getPaidUnionId

String getPaidUnionId(String openid,
                      String transactionId,
                      String mchId,
                      String outTradeNo)
               throws WxErrorException

 用户支付完成后，获取该用户的 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
 

参数:

openid - 必填 支付用户唯一标识

transactionId - 非必填 微信支付订单号

mchId - 非必填 微信支付分配的商户号，和商户订单号配合使用

outTradeNo - 非必填 微信支付商户订单号，和商户号配合使用

返回:

UnionId.

抛出:

WxErrorException - .

execute

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

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

类型参数:

E - .

T - .

参数:

data - 参数或请求数据

executor - 执行器

uri - 接口请求地址

返回:

.

抛出:

WxErrorException

setRetrySleepMillis

void setRetrySleepMillis(int retrySleepMillis)

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

参数:

retrySleepMillis - 重试等待毫秒数

setMaxRetryTimes

void setMaxRetryTimes(int maxRetryTimes)

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

参数:

maxRetryTimes - 最大重试次数

getWxMaConfig

WxMaConfig getWxMaConfig()

获取WxMaConfig 对象.

返回:

WxMaConfig

setWxMaConfig

void setWxMaConfig(WxMaConfig wxConfigProvider)

注入 WxMaConfig 的实现.

参数:

wxConfigProvider - config

getMsgService

WxMaMsgService getMsgService()

返回消息（客服消息和模版消息）发送接口方法实现类，以方便调用其各个接口.

返回:

WxMaMsgService

getMediaService

WxMaMediaService getMediaService()

返回素材相关接口方法的实现类对象，以方便调用其各个接口.

返回:

WxMaMediaService

getUserService

WxMaUserService getUserService()

返回用户相关接口方法的实现类对象，以方便调用其各个接口.

返回:

WxMaUserService

getQrcodeService

WxMaQrcodeService getQrcodeService()

返回二维码相关接口方法的实现类对象，以方便调用其各个接口.

返回:

WxMaQrcodeService

getTemplateService

WxMaTemplateService getTemplateService()

返回模板配置相关接口方法的实现类对象, 以方便调用其各个接口.

返回:

WxMaTemplateService

getSubscribeService

WxMaSubscribeService getSubscribeService()

返回订阅消息配置相关接口方法的实现类对象, 以方便调用其各个接口.

返回:

WxMaSubscribeService

getAnalysisService

WxMaAnalysisService getAnalysisService()

数据分析相关查询服务.

返回:

WxMaAnalysisService

getCodeService

WxMaCodeService getCodeService()

返回代码操作相关的 API.

返回:

WxMaCodeService

getJsapiService

WxMaJsapiService getJsapiService()

返回jsapi操作相关的 API服务类对象.

返回:

WxMaJsapiService

getSettingService

WxMaSettingService getSettingService()

小程序修改服务器地址、成员管理 API.

返回:

WxMaSettingService

getShareService

WxMaShareService getShareService()

返回分享相关查询服务.

返回:

WxMaShareService

getRunService

WxMaRunService getRunService()

返回微信运动相关接口服务对象.

返回:

WxMaShareService

getSecCheckService

WxMaSecCheckService getSecCheckService()

返回内容安全相关接口服务对象.

返回:

WxMaShareService

getPluginService

WxMaPluginService getPluginService()

返回插件相关接口服务对象.

返回:

WxMaPluginService

initHttp

void initHttp()

初始化http请求对象.

getRequestHttp

RequestHttp getRequestHttp()

请求http请求相关信息.

返回:

.

getExpressService

WxMaExpressService getExpressService()

获取物流助手接口服务对象

返回:

.

getCloudService

WxMaCloudService getCloudService()

获取云开发接口服务对象

返回:

.

getLiveService

WxMaLiveService getLiveService()

获取直播接口服务对象

返回:

.

getLiveGoodsService

WxMaLiveGoodsService getLiveGoodsService()

获取直播间商品服务对象

返回:

.

getOcrService

WxOcrService getOcrService()

获取ocr实现接口服务对象

返回:

。