Package com.foxinmy.weixin4j.mp

Class WeixinComponentProxy

java.lang.Object

com.foxinmy.weixin4j.mp.WeixinComponentProxy

public class WeixinComponentProxy
extends Object

微信第三方应用接口实现

Since:

JDK 1.6

Author:

jinyu(foxinmy@gmail.com)

See Also:

ComponentApi, 公众号第三方应用

Field Summary

Fields

Modifier and Type	Field	Description
static String	VERSION

Constructor Summary

Constructors

Constructor	Description
WeixinComponentProxy()	微信第三方组件接口实现(使用weixin4j.properties配置的account#components账号信息, 使用FileCacheStorager文件方式缓存TOKEN)
WeixinComponentProxy(com.foxinmy.weixin4j.cache.CacheStorager<com.foxinmy.weixin4j.model.Token> cacheStorager)	微信第三方组件接口实现(使用weixin4j.properties配置的account#components账号信息)
WeixinComponentProxy(WeixinMpAccount weixinMpAccount, com.foxinmy.weixin4j.cache.CacheStorager<com.foxinmy.weixin4j.model.Token> cacheStorager)	微信第三方组件接口实现

Method Summary

Modifier and Type	Method	Description
void	cacheComponentTicket(String componentId, String componentTicket)	缓存组件ticket
ComponentApi	component()	获取组接口对象(只关注第一个组件
ComponentApi	component(String componentId)	获取套件接口对象(多个组件
String	getComponentAuthorizationURL(String componentId)	应用组件授权 需先缓存ticket redirectUri默认填写weixin4j.properties#component.oauth.redirect.uri state默认填写state
String	getComponentAuthorizationURL(String componentId, String redirectUri, String state)	应用组件授权 需先缓存ticket，在授权完成之后需要调用ComponentApi# exchangeAuthorizerToken方法 ,否则无法缓存token相关导致后续的组件接口调用失败
String	getPreComponentTicket(String componentId)	获取组件的预授权码 需先缓存ticket
WeixinMpAccount	getWeixinMpAccount()	获取微信账号信息
WeixinProxy	getWeixinProxy(String componentId, String authAppId)	创建WeixinProxy对象

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION

public static final String VERSION

Constructor Detail

WeixinComponentProxy

public WeixinComponentProxy()

微信第三方组件接口实现(使用weixin4j.properties配置的account#components账号信息, 使用FileCacheStorager文件方式缓存TOKEN)

WeixinComponentProxy

public WeixinComponentProxy(com.foxinmy.weixin4j.cache.CacheStorager<com.foxinmy.weixin4j.model.Token> cacheStorager)

微信第三方组件接口实现(使用weixin4j.properties配置的account#components账号信息)

Parameters:

cacheStorager - token管理

WeixinComponentProxy

public WeixinComponentProxy(WeixinMpAccount weixinMpAccount,
                            com.foxinmy.weixin4j.cache.CacheStorager<com.foxinmy.weixin4j.model.Token> cacheStorager)

微信第三方组件接口实现

Parameters:

weixinMpAccount - 账号信息

cacheStorager - token管理

Method Detail

getWeixinMpAccount

public WeixinMpAccount getWeixinMpAccount()

获取微信账号信息

Returns:

component

public ComponentApi component()

获取组接口对象(只关注第一个组件

Returns:

API实例

See Also:

ComponentApi

component

public ComponentApi component(String componentId)

获取套件接口对象(多个组件

Parameters:

componentId - 组件ID

Returns:

API实例

See Also:

ComponentApi

getPreComponentTicket

public String getPreComponentTicket(String componentId)
                             throws com.foxinmy.weixin4j.exception.WeixinException

获取组件的预授权码 需先缓存ticket

Parameters:

componentId - 组件ID

Returns:

预授权码

Throws:

com.foxinmy.weixin4j.exception.WeixinException

See Also:

cacheComponentTicket(String, String), ComponentApi, ComponentApi.getTicketManager(), ComponentApi.getPreCodeManager()

cacheComponentTicket

public void cacheComponentTicket(String componentId,
                                 String componentTicket)
                          throws com.foxinmy.weixin4j.exception.WeixinException

缓存组件ticket

Parameters:

componentId - 组件ID

componentTicket - 组件ticket内容

Throws:

com.foxinmy.weixin4j.exception.WeixinException

getComponentAuthorizationURL

public String getComponentAuthorizationURL(String componentId)
                                    throws com.foxinmy.weixin4j.exception.WeixinException

应用组件授权 需先缓存ticket

redirectUri默认填写weixin4j.properties#component.oauth.redirect.uri state默认填写state

Parameters:

componentId - 组件ID

Returns:

请求授权的URL

Throws:

com.foxinmy.weixin4j.exception.WeixinException

getComponentAuthorizationURL

public String getComponentAuthorizationURL(String componentId,
                                           String redirectUri,
                                           String state)
                                    throws com.foxinmy.weixin4j.exception.WeixinException

应用组件授权 需先缓存ticket，在授权完成之后需要调用ComponentApi# exchangeAuthorizerToken方法 ,否则无法缓存token相关导致后续的组件接口调用失败

Parameters:

componentId - 组件ID

redirectUri - 授权后重定向url

state - 回调后原样返回

Returns:

请求授权的URL

Throws:

com.foxinmy.weixin4j.exception.WeixinException

See Also:

cacheComponentTicket(String, String), ComponentApi, ComponentApi.getTicketManager(), ComponentApi.getPreCodeManager(), ComponentApi.exchangeAuthorizerToken(String), 应用组件授权

getWeixinProxy

public WeixinProxy getWeixinProxy(String componentId,
                                  String authAppId)

创建WeixinProxy对象

Parameters:

componentId - 组件ID

authAppId - 已授权的appid

Returns:

See Also:

WeixinProxy