WeiXinUtil (xnx3-weixin 1.0 API)

java.lang.Object
- com.xnx3.weixin.WeiXinUtil

```
public class WeiXinUtil
extends Object
```
微信基本操作-不涉及小程序。微信小程序使用 XiaoChengXuUtil

作者:

管雷鸣

字段概要

字段
限定符和类型	字段和说明
`static int`	`ACCESS_TOKEN_DELAY_TIME`
`static String`	`ACCESS_TOKEN_URL`
`boolean`	`debug`
`static int`	`JSAPI_TICKET_DELAY_TIME`
`static String`	`JSAPI_TICKET_URL`
`static String`	`OAUTH2_ACCESS_TOKEN_URL`
`static String`	`OAUTH2_URL`
`static String`	`OAUTH2_USER_INFO_URL`
`static String`	`USER_INFO_URL`

构造器概要

构造器
构造器和说明

WeiXinUtil(String appId, String appSecret, String token)
微信基本操作-不涉及小程序。

构造器
构造器和说明
`WeiXinUtil(String appId, String appSecret, String token)` 微信基本操作-不涉及小程序。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`autoReplyText(javax.servlet.http.HttpServletResponse response, MessageReceive messageReceive, String content)` 微信服务器接收消息或者事件后，推送到我们的服务器。
`AccessToken`	`getAccessToken()` 获取最新的普通access_token
`JsapiTicket`	`getJsapiTicket()` 获取 JS SDK 的 ticket
`SignatureBean`	`getJsSignature(String url)` JS-SDK 生成 signature 签名,可以在页面中直接使用，如分享到朋友圈等注意事项: 1.签名的noncestr和timestamp必须与wx.config中的nonceStr和timestamp相同。
`String`	`getOauth2ExpertUrl(String redirectUri)` 获取网页授权的URL跳转地址，不会出现授权页面，只能拿到用户openid
`String`	`getOauth2OpenId(String code)` 获取网页授权，获取用户的openid
`String`	`getOauth2SimpleUrl(String redirectUri)` 获取网页授权的URL跳转地址，弹出授权页面，可通过openid拿到昵称、性别、所在地。
`String`	`getOauth2Url(String redirectUri, String scope, String state)` 获取网页授权的URL跳转地址
`UserInfo`	`getOauth2UserInfo(String code)` 网页授权获取用户的个人信息
`UserInfo`	`getUserInfo(String openId)` 通过openId，获取用户的信息
`void`	`joinVerify(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` 微信公众号开发，需首先填入与微信服务器交互的我方URL地址，填写的URL需要正确响应微信发送的Token验证。
`MessageReceive`	`receiveMessage(javax.servlet.http.HttpServletRequest request)` 接收xml格式消息，用户通过微信公众号发送消息，有服务器接收。
`MessageReceive`	`receiveMessage(String messageContent)` 接收xml格式消息，用户通过微信公众号发送消息，有服务器接收。

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

- 字段详细资料
  - ACCESS_TOKEN_URL
```
public static String ACCESS_TOKEN_URL
```
  - USER_INFO_URL
```
public static String USER_INFO_URL
```
  - OAUTH2_URL
```
public static String OAUTH2_URL
```
  - OAUTH2_ACCESS_TOKEN_URL
```
public static String OAUTH2_ACCESS_TOKEN_URL
```
  - OAUTH2_USER_INFO_URL
```
public static String OAUTH2_USER_INFO_URL
```
  - JSAPI_TICKET_URL
```
public static String JSAPI_TICKET_URL
```
  - ACCESS_TOKEN_DELAY_TIME
```
public static int ACCESS_TOKEN_DELAY_TIME
```
  - JSAPI_TICKET_DELAY_TIME
```
public static int JSAPI_TICKET_DELAY_TIME
```
  - debug
```
public boolean debug
```
- 构造器详细资料
  - WeiXinUtil
```
public WeiXinUtil(String appId,
                  String appSecret,
                  String token)
```
    微信基本操作-不涉及小程序。微信小程序使用 XiaoChengXuUtil
    
    参数:
    
    appId - AppID(应用ID)
    
    appSecret - AppSecret(应用密钥)
    
    token - 用户于微信公众平台双方拟定的令牌Token。可为空。
- 方法详细资料
  - getAccessToken
```
public AccessToken getAccessToken()
```
    获取最新的普通access_token
    
    返回:
    
    AccessToken 若返回null，则获取access_token失败
  - getUserInfo
```
public UserInfo getUserInfo(String openId)
```
    通过openId，获取用户的信息
    参数:
    
    openId - 普通用户的标识，对当前公众号唯一
    
    返回:
    UserInfo
    
    若返回null，则获取失败
    
    若不为null，先判断其subscribe，若为true，已关注，则可以取到其他的信息
  - getOauth2Url
```
public String getOauth2Url(String redirectUri,
                           String scope,
                           String state)
```
    获取网页授权的URL跳转地址
    
    参数:
    
    redirectUri - 授权后重定向的回调链接地址，无需URL转码，原始url
    
    scope - 应用授权作用域，snsapi_base （不弹出授权页面，直接跳转，只能获取用户openid），snsapi_userinfo （弹出授权页面，可通过openid拿到昵称、性别、所在地。并且，即使在未关注的情况下，只要用户授权，也能获取其信息）
    
    state - 重定向后会带上state参数，开发者可以填写a-zA-Z0-9的参数值，最多128字节
    
    返回:
    
    url地址
  - getOauth2SimpleUrl
```
public String getOauth2SimpleUrl(String redirectUri)
```
    获取网页授权的URL跳转地址，弹出授权页面，可通过openid拿到昵称、性别、所在地。并且，即使在未关注的情况下，只要用户授权，也能获取其信息
    
    参数:
    
    redirectUri - 授权后重定向的回调链接地址，无需URL转码，原始url
    
    返回:
    
    url地址
  - getOauth2ExpertUrl
```
public String getOauth2ExpertUrl(String redirectUri)
```
    获取网页授权的URL跳转地址，不会出现授权页面，只能拿到用户openid
    
    参数:
    
    redirectUri - 授权后重定向的回调链接地址，无需URL转码，原始url
    
    返回:
    
    url地址
  - getOauth2OpenId
```
public String getOauth2OpenId(String code)
```
    获取网页授权，获取用户的openid
    
    参数:
    
    code - 如果用户同意授权，页面将跳转至 redirect_uri/?code=CODE&state=STATE，授权成功会get方式传过来
    
    返回:
    
    用户openid 若为null，则获取失败
  - getOauth2UserInfo
```
public UserInfo getOauth2UserInfo(String code)
```
    网页授权获取用户的个人信息
    参数:
    
    code - 如果用户同意授权，页面将跳转至 redirect_uri/?code=CODE&state=STATE，授权成功会get方式传过来
    
    返回:
    结果：
    
    若成功，返回UserInfo (无 subscribeTime 项)
    
    若失败，返回null
  - receiveMessage
```
public MessageReceive receiveMessage(javax.servlet.http.HttpServletRequest request)
                              throws org.dom4j.DocumentException
```
    接收xml格式消息，用户通过微信公众号发送消息，有服务器接收。这里将微信服务器推送来的消息进行格式化为 MessageReceive对象
    通常此会存在于一个Servlet中，用于接收微信服务器推送来的消息。
    
    参数:
    
    request - 这里便是微信服务器接收到消息后，将消息POST提交过来的请求，会自动从request中取微信post的消息内容
    
    返回:
    
    返回 MessageReceive
    
    抛出:
    
    org.dom4j.DocumentException - 异常
  - receiveMessage
```
public MessageReceive receiveMessage(String messageContent)
                              throws org.dom4j.DocumentException
```
    接收xml格式消息，用户通过微信公众号发送消息，有服务器接收。这里将微信服务器推送来的消息进行格式化为 MessageReceive对象
    通常此会存在于一个Servlet中，用于接收微信服务器推送来的消息。例如SpringMVC中可以这样写：
```
        MessageReceive message = new WeiXinUtil(......).receiveMessage(request);
 
```
    参数:
    
    messageContent - 这里便是微信服务器接收到消息后，将消息POST提交过来消息内容
    
    返回:
    
    返回 MessageReceive
    
    抛出:
    
    org.dom4j.DocumentException - 异常
  - autoReplyText
```
public void autoReplyText(javax.servlet.http.HttpServletResponse response,
                          MessageReceive messageReceive,
                          String content)
```
    微信服务器接收消息或者事件后，推送到我们的服务器。我们服务器会自动处理并给微信服务器返回一个响应：微信公众号会自动给这个用户发送一条文字消息
    相当于：
```
        MessageReply messageReply = new MessageReply(messageReceive.getFromUserName(), messageReceive.getToUserName());
        messageReply.replyText(response, content);
 
```
    参数:
    
    response - HttpServletResponse响应，输出返回值给微信服务器。
    
    messageReceive - 使用receiveMessage(HttpServletRequest)方法获取到的 MessageReceive。这里面可以拿到是要回复给哪个用户。
    
    content - 微信公众号自动给触发此响应的用户发送的文字消息，这里便是文字消息的内容
  - joinVerify
```
public void joinVerify(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
```
    微信公众号开发，需首先填入与微信服务器交互的我方URL地址，填写的URL需要正确响应微信发送的Token验证。这里便是接入时的验证的作用
    使用时，如 SpringMVC 中：
```
        @RequestMapping("weixin")
        public void verify(HttpServletRequest request, HttpServletResponse response){
                WeiXinUtil.joinVerify(request, response);
        }
 
```
    参数:
    
    request - HttpServletRequest
    
    response - HttpServletResponse
  - getJsapiTicket
```
public JsapiTicket getJsapiTicket()
```
    获取 JS SDK 的 ticket
    
    返回:
    
    当前可用的 ticket
  - getJsSignature
```
public SignatureBean getJsSignature(String url)
```
    JS-SDK 生成 signature 签名,可以在页面中直接使用，如分享到朋友圈等 注意事项:
    1.签名的noncestr和timestamp必须与wx.config中的nonceStr和timestamp相同。
    
    2.签名用的url必须是调用JS接口页面的完整URL。
    
    3.出于安全考虑，开发者必须在服务器端实现签名的逻辑。
    
    参数:
    
    url - 当前网页的URL，不包含#及其后面部分,如 http://mp.weixin.qq.com?params=value
    
    返回:
    
    signature 签名，已处理好，拿来即可直接使用

类 WeiXinUtil

字段概要

构造器概要

方法概要

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

字段详细资料

ACCESS_TOKEN_URL

USER_INFO_URL

OAUTH2_URL

OAUTH2_ACCESS_TOKEN_URL

OAUTH2_USER_INFO_URL

JSAPI_TICKET_URL

ACCESS_TOKEN_DELAY_TIME

JSAPI_TICKET_DELAY_TIME

debug

构造器详细资料

WeiXinUtil

方法详细资料

getAccessToken

getUserInfo

getOauth2Url

getOauth2SimpleUrl

getOauth2ExpertUrl

getOauth2OpenId

getOauth2UserInfo

receiveMessage

receiveMessage

autoReplyText

joinVerify

getJsapiTicket

getJsSignature