WeChatConfig (wechat-tools-lib 1.0.1 API)

java.lang.Object
- org.kangspace.wechat.config.WeChatConfig

public class WeChatConfig
extends Object

作者:: kango2gler@gmail.com

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`WeChatConfig.AppIdSecret` AppId,AppSecret组合对象
`static class`	`WeChatConfig.MessageTemplateIdHelper` 消息模版Id帮助类
`static class`	`WeChatConfig.OAth2Scope` 网页授权作用域

字段概要

字段
限定符和类型	字段和说明
`static String`	`APP_ID` 默认APP_ID,从配置文件中获取
`static String`	`APP_ID_SECRETS` 多公众号APP_ID,APP_SECRET配置,从配置文件中获取
`static LinkedHashMap<String,WeChatConfig.AppIdSecret>`	`APP_ID_SECRETS_MAP` 多APP_ID,APP_SECRETS配置项Map map key: 配置项中的key map value: 配置项中APP_ID,APP_SECRET组成的对象
`static String`	`APP_SECRET` 默认APP_SECRET,从配置文件中获取
`static String`	`DEFAULT_APP_ID_SECRET_KEY` 多APP_ID,APP_SECRETS配置项Map的默认key
`static String`	`MP_ACCESS_TOKEN_URL` MP_ACCESS_TOKEN_URL, 公众号ACCESS_TOKEN接口请求链接,从配置文件中获取
`static String`	`MP_JS_SDK_TICKET_URL` MP_JS_SDK_TICKET_URL, 公众号jssdk jsApiTcket获取接口接口请求链接,从配置文件中获取
`static String`	`MP_MESSAGE_TEMPLATE_IDS` 模版id,格式: key:template_id,key2:template_id2... key为自定义的模版类型key,用于程序中获取template_id;template_id为微信模版Id
`static Map<String,String>`	`MP_MESSAGE_TEMPLATE_IDS_MAP` 模版KeyTemplateId Map
`static String`	`MP_MESSAGE_TEMPLATE_SEND_URL` MP_MESSAGE_TEMPLATE_SEND_URL, 发送模板消息接口接口请求链接,从配置文件中获取
`static String`	`MP_USER_INFO_BATCH_URL` MP_USER_INFO_BATCH_URL, 批量获取用户基本信息(UnionID机制)接口请求链接,从配置文件中获取
`static String`	`MP_USER_INFO_URL` MP_USER_INFO_URL, 获取用户基本信息(UnionID机制)接口请求链接,从配置文件中获取
`static String`	`MP_USER_LIST_URL` MP_USER_LIST, 获取关注者列表接口请求链接,从配置文件中获取取消关注,再次关注时,用户还在列表的原来位置
`static WeChatConfig.AppIdSecret`	`NULL_APP_ID_SECRET` 空APP_ID_SECRET对象
`static String`	`OAUTH2_ACCESS_TOKEN_URL` OAUTH2_ACCESS_TOKEN_URL, 网页授权获取ACCESS_TOKEN接口请求链接,从配置文件中获取
`static String`	`OAUTH2_AUTHORIZE_URL` OAUTH2_AUTHORIZE_URL, 网页授权接口请求链接,从配置文件中获取
`static String`	`OAUTH2_USER_INFO_URL` OAUTH2_USER_INFO_URL, 网页授权获取用户信息接口请求链接,从配置文件中获取

构造器概要

构造器
构造器和说明

WeChatConfig()

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

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static WeChatConfig.AppIdSecret`	`getAppIdSecret(String appId)` 通过appId从`APP_ID_SECRETS_MAP`中获取AppIdSecret
`static WeChatConfig.AppIdSecret`	`getAppIdSecretByKey(String key)` 通过key从`APP_ID_SECRETS_MAP`中获取AppIdSecret
`static WeChatConfig.AppIdSecret`	`getDefaultAppIdSecret()` 获取默认的AppIdSecret
`static String`	`getMpAccesstokenUrl()` 获取公众号 AccessToken
`static String`	`getMpAccessTokenUrl(String appId)` 获取公众号 AccessToken
`static String`	`getMpJsSdkTicketUrl(String accessToken)` 获取公众号jssdk jsApiTcket接口 URL
`static String`	`getMpMessageTemplateSendUrl(String accessToken)` 获取发送模板消息接口 URL
`static String`	`getMpUserInfo(String accessToken, String openId)` 获取公众号获取用户基本信息
`static String`	`getMpUserInfoBatch(String accessToken)` 获取公众号批量获取用户基本信息
`static String`	`getMpUserList(String accessToken, String nextOpenId)` 获取公众号获取关注者列表
`static String`	`getOAth2UserInfoUrl(String accessToken, String openId, String lang)` 获取网页授权用户信息URL
`static String`	`getOauth2AccessTokenUrl(String code)` 获取网页授权AccessToken URL
`static String`	`getOauth2AccessTokenUrl(String appId, String code)` 获取网页授权AccessToken URL
`static String`	`getOauth2AuthorizeUrl(String appId, String redirectUri, WeChatConfig.OAth2Scope scope, String state)` 获取网页授权URL redirect将被URLEncode
`static String`	`getOauth2AuthorizeUrl(String redirectUri, WeChatConfig.OAth2Scope scope, String state)` 获取网页授权URL,默认微信APP_ID redirect将被URLEncode

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

- 字段详细资料
  - APP_ID
```
public static String APP_ID
```
    默认APP_ID,从配置文件中获取
  - APP_SECRET
```
public static String APP_SECRET
```
    默认APP_SECRET,从配置文件中获取
  - APP_ID_SECRETS
```
public static String APP_ID_SECRETS
```
    多公众号APP_ID,APP_SECRET配置,从配置文件中获取
  - OAUTH2_AUTHORIZE_URL
```
public static String OAUTH2_AUTHORIZE_URL
```
    OAUTH2_AUTHORIZE_URL, 网页授权接口请求链接,从配置文件中获取
  - OAUTH2_ACCESS_TOKEN_URL
```
public static String OAUTH2_ACCESS_TOKEN_URL
```
    OAUTH2_ACCESS_TOKEN_URL, 网页授权获取ACCESS_TOKEN接口请求链接,从配置文件中获取
  - OAUTH2_USER_INFO_URL
```
public static String OAUTH2_USER_INFO_URL
```
    OAUTH2_USER_INFO_URL, 网页授权获取用户信息接口请求链接,从配置文件中获取
  - MP_ACCESS_TOKEN_URL
```
public static String MP_ACCESS_TOKEN_URL
```
    MP_ACCESS_TOKEN_URL, 公众号ACCESS_TOKEN接口请求链接,从配置文件中获取
  - MP_USER_INFO_URL
```
public static String MP_USER_INFO_URL
```
    MP_USER_INFO_URL, 获取用户基本信息(UnionID机制)接口请求链接,从配置文件中获取
  - MP_USER_INFO_BATCH_URL
```
public static String MP_USER_INFO_BATCH_URL
```
    MP_USER_INFO_BATCH_URL, 批量获取用户基本信息(UnionID机制)接口请求链接,从配置文件中获取
  - MP_USER_LIST_URL
```
public static String MP_USER_LIST_URL
```
    MP_USER_LIST, 获取关注者列表接口请求链接,从配置文件中获取取消关注,再次关注时,用户还在列表的原来位置
  - MP_MESSAGE_TEMPLATE_SEND_URL
```
public static String MP_MESSAGE_TEMPLATE_SEND_URL
```
    MP_MESSAGE_TEMPLATE_SEND_URL, 发送模板消息接口接口请求链接,从配置文件中获取
  - MP_JS_SDK_TICKET_URL
```
public static String MP_JS_SDK_TICKET_URL
```
    MP_JS_SDK_TICKET_URL, 公众号jssdk jsApiTcket获取接口接口请求链接,从配置文件中获取
  - MP_MESSAGE_TEMPLATE_IDS
```
public static String MP_MESSAGE_TEMPLATE_IDS
```
    模版id,格式: key:template_id,key2:template_id2... key为自定义的模版类型key,用于程序中获取template_id;template_id为微信模版Id
  - MP_MESSAGE_TEMPLATE_IDS_MAP
```
public static Map<String,String> MP_MESSAGE_TEMPLATE_IDS_MAP
```
    模版KeyTemplateId Map
  - APP_ID_SECRETS_MAP
```
public static LinkedHashMap<String,WeChatConfig.AppIdSecret> APP_ID_SECRETS_MAP
```
```
 多APP_ID,APP_SECRETS配置项Map
 map key: 配置项中的key
 map value: 配置项中APP_ID,APP_SECRET组成的对象
```
    另请参阅:
    
    DEFAULT_APP_ID_SECRET_KEY,
  - NULL_APP_ID_SECRET
```
public static WeChatConfig.AppIdSecret NULL_APP_ID_SECRET
```
    空APP_ID_SECRET对象
  - DEFAULT_APP_ID_SECRET_KEY
```
public static String DEFAULT_APP_ID_SECRET_KEY
```
    多APP_ID,APP_SECRETS配置项Map的默认key
    
    另请参阅:
    
    APP_ID_SECRETS_MAP
- 构造器详细资料
  - WeChatConfig
```
public WeChatConfig()
```
- 方法详细资料
  - getOauth2AuthorizeUrl
```
public static String getOauth2AuthorizeUrl(String redirectUri,
                                           WeChatConfig.OAth2Scope scope,
                                           String state)
                                    throws UnsupportedEncodingException
```
    获取网页授权URL,默认微信APP_ID redirect将被URLEncode
    
    参数:
    
    redirectUri - 回调路径
    
    scope - 授权作用域 WeChatConfig.OAth2Scope
    
    state - 重定向后会带上state参数，开发者可以填写a-zA-Z0-9的参数值，最多128字节
    
    返回:
    
    抛出:
    
    UnsupportedEncodingException
    
    另请参阅:
    
    getOauth2AuthorizeUrl(String, String, OAth2Scope, String)
  - getOauth2AuthorizeUrl
```
public static String getOauth2AuthorizeUrl(String appId,
                                           String redirectUri,
                                           WeChatConfig.OAth2Scope scope,
                                           String state)
                                    throws UnsupportedEncodingException
```
    获取网页授权URL redirect将被URLEncode
    
    参数:
    
    appId - 微信APP_ID
    
    redirectUri - 回调路径
    
    scope - 授权作用域 WeChatConfig.OAth2Scope
    
    state - 重定向后会带上state参数，开发者可以填写a-zA-Z0-9的参数值，最多128字节
    
    返回:
    
    抛出:
    
    UnsupportedEncodingException
    
    另请参阅:
    
    getOauth2AuthorizeUrl(String, OAth2Scope, String)
  - getOauth2AccessTokenUrl
```
public static String getOauth2AccessTokenUrl(String code)
```
    获取网页授权AccessToken URL
    
    参数:
    
    code - 网页授权返回的code
    
    返回:
  - getOauth2AccessTokenUrl
```
public static String getOauth2AccessTokenUrl(String appId,
                                             String code)
```
    获取网页授权AccessToken URL
    
    参数:
    
    appId - 微信APP_ID
    
    code - 网页授权返回的code
    
    返回:
    
    另请参阅:
    
    getOauth2AccessTokenUrl(String)
  - getMpAccesstokenUrl
```
public static String getMpAccesstokenUrl()
```
    获取公众号 AccessToken
    
    参数:
    
    -
    
    返回:
  - getMpAccessTokenUrl
```
public static String getMpAccessTokenUrl(String appId)
```
    获取公众号 AccessToken
    
    参数:
    
    -
    
    返回:
  - getMpUserInfo
```
public static String getMpUserInfo(String accessToken,
                                   String openId)
```
    获取公众号获取用户基本信息
    
    参数:
    
    accessToken -
    
    openId - 用户openId
    
    返回:
  - getMpUserInfoBatch
```
public static String getMpUserInfoBatch(String accessToken)
```
    获取公众号批量获取用户基本信息
    
    参数:
    
    accessToken -
    
    返回:
  - getMpUserList
```
public static String getMpUserList(String accessToken,
                                   String nextOpenId)
```
    获取公众号获取关注者列表
    
    参数:
    
    accessToken -
    
    nextOpenId - 第一个拉取的OPENID，不填默认从头开始拉取
    
    返回:
  - getMpMessageTemplateSendUrl
```
public static String getMpMessageTemplateSendUrl(String accessToken)
```
    获取发送模板消息接口 URL
    
    参数:
    
    accessToken -
    
    返回:
  - getMpJsSdkTicketUrl
```
public static String getMpJsSdkTicketUrl(String accessToken)
```
    获取公众号jssdk jsApiTcket接口 URL
    
    参数:
    
    accessToken -
    
    返回:
  - getOAth2UserInfoUrl
```
public static String getOAth2UserInfoUrl(String accessToken,
                                         String openId,
                                         String lang)
```
    获取网页授权用户信息URL
    
    参数:
    
    accessToken -
    
    openId -
    
    返回:
  - getAppIdSecretByKey
```
public static WeChatConfig.AppIdSecret getAppIdSecretByKey(String key)
```
    通过key从APP_ID_SECRETS_MAP中获取AppIdSecret
    
    参数:
    
    key -
    
    返回:
    
    另请参阅:
    
    getDefaultAppIdSecret(), _AppIdSecretsMapInit(), getAppIdSecret(String)
  - getAppIdSecret
```
public static WeChatConfig.AppIdSecret getAppIdSecret(String appId)
```
    通过appId从APP_ID_SECRETS_MAP中获取AppIdSecret
    
    参数:
    
    appId -
    
    返回:
    
    另请参阅:
    
    getDefaultAppIdSecret(), _AppIdSecretsMapInit()
  - getDefaultAppIdSecret
```
public static WeChatConfig.AppIdSecret getDefaultAppIdSecret()
```
    获取默认的AppIdSecret
    
    返回:
    
    另请参阅:
    
    getAppIdSecret(String), _AppIdSecretsMapInit()

类 WeChatConfig

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

APP_ID

APP_SECRET

APP_ID_SECRETS

OAUTH2_AUTHORIZE_URL

OAUTH2_ACCESS_TOKEN_URL

OAUTH2_USER_INFO_URL

MP_ACCESS_TOKEN_URL

MP_USER_INFO_URL

MP_USER_INFO_BATCH_URL

MP_USER_LIST_URL

MP_MESSAGE_TEMPLATE_SEND_URL

MP_JS_SDK_TICKET_URL

MP_MESSAGE_TEMPLATE_IDS

MP_MESSAGE_TEMPLATE_IDS_MAP

APP_ID_SECRETS_MAP

NULL_APP_ID_SECRET

DEFAULT_APP_ID_SECRET_KEY

构造器详细资料

WeChatConfig

方法详细资料

getOauth2AuthorizeUrl

getOauth2AuthorizeUrl

getOauth2AccessTokenUrl

getOauth2AccessTokenUrl

getMpAccesstokenUrl

getMpAccessTokenUrl

getMpUserInfo

getMpUserInfoBatch

getMpUserList

getMpMessageTemplateSendUrl

getMpJsSdkTicketUrl

getOAth2UserInfoUrl

getAppIdSecretByKey

getAppIdSecret

getDefaultAppIdSecret