com.github.cuter44.wxpay.servlet

类 SnsapiBase

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.github.cuter44.wxpay.servlet.SnsapiBase

所有已实现的接口:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class SnsapiBase
extends javax.servlet.http.HttpServlet

网页授权(snsapi_base)的基础实现, 为网页前端取得当前用户的 openid. 关于该 servlet 的工作流程请参见 网页授权获取用户基本信息↗ 需要在微信客户端上执行 直至微信6.0为止都无法使用 Ajax 调用此方法, 该尿性是由微信客户端造成的.

    GET /snsapi-base.api
    取得 openid

    参数
    code    :string , 从 open.weixin.qq.com 跳转时带入, 无需客户端处理.
    redir   :url    , 可选, 允许带参数, 在 QueryString 中附加 openid=:openid 重定向. 请勿用作用户身份验证.

    响应
    当未附带 redir 参数时:
    application/json
    openid  :string , 当前用户的openid=:openid.

    当附带 redir 参数时:
    302 Found
    Location: :redir?openid=:openid

 

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
protected java.lang.String	appid
protected static java.lang.String	CODE
protected static java.lang.String	KEY_APPID
protected static java.lang.String	KEY_SECRET
protected static java.lang.String	OPENID
protected static java.lang.String	REDIR
protected java.lang.String	secret

构造器概要

构造器

构造器和说明
SnsapiBase()

方法概要

方法

限定符和类型	方法和说明
void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
java.lang.String	getAppid(javax.servlet.http.HttpServletRequest req) 提供 appid 参数 servlet 从此方法取得必需参数 appid, 覆盖此方法可以自定义 appid 的来源.
java.lang.String	getSecret(java.lang.String appid) 提供 secret 参数 servlet 从此方法取得必需参数 secret, 覆盖此方法可以自定义 secret 的来源.
void	init(javax.servlet.ServletConfig config) 读取配置文件 覆盖此方法可以删除对配置文件的访问.
void	response(SnsOAuthAccessTokenResponse snsapiBaseResp, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) 构造响应 覆盖此方法可以自行构造响应 默认实现如文档所述
void	trigger(SnsOAuthAccessTokenResponse resp, javax.servlet.http.HttpServletRequest req) 在取得 openid 后, 发送响应前的回调.

从类继承的方法 javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

从类继承的方法 javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

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

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

字段详细资料

KEY_APPID

protected static final java.lang.String KEY_APPID

另请参阅:

常量字段值

KEY_SECRET

protected static final java.lang.String KEY_SECRET

另请参阅:

常量字段值

CODE

protected static final java.lang.String CODE

另请参阅:

常量字段值

REDIR

protected static final java.lang.String REDIR

另请参阅:

常量字段值

OPENID

protected static final java.lang.String OPENID

另请参阅:

常量字段值

appid

protected java.lang.String appid

secret

protected java.lang.String secret

构造器详细资料

SnsapiBase

public SnsapiBase()

方法详细资料

getAppid

public java.lang.String getAppid(javax.servlet.http.HttpServletRequest req)

提供 appid 参数 servlet 从此方法取得必需参数 appid, 覆盖此方法可以自定义 appid 的来源. 默认实现从配置文件 /wxpay.properties 读取

getSecret

public java.lang.String getSecret(java.lang.String appid)

提供 secret 参数 servlet 从此方法取得必需参数 secret, 覆盖此方法可以自定义 secret 的来源. 默认实现从配置文件 /wxpay.properties 读取

trigger

public void trigger(SnsOAuthAccessTokenResponse resp,
           javax.servlet.http.HttpServletRequest req)

在取得 openid 后, 发送响应前的回调. 覆盖此方法可以触发想要的动作 默认实现是 NOOP

response

public void response(SnsOAuthAccessTokenResponse snsapiBaseResp,
            javax.servlet.http.HttpServletRequest req,
            javax.servlet.http.HttpServletResponse resp)
              throws java.io.IOException

构造响应 覆盖此方法可以自行构造响应 默认实现如文档所述

抛出:

java.io.IOException

init

public void init(javax.servlet.ServletConfig config)

读取配置文件 覆盖此方法可以删除对配置文件的访问.

指定者:

init 在接口中 javax.servlet.Servlet

覆盖:

init 在类中 javax.servlet.GenericServlet

doGet

public void doGet(javax.servlet.http.HttpServletRequest req,
         javax.servlet.http.HttpServletResponse resp)
           throws java.io.IOException,
                  javax.servlet.ServletException

覆盖:

doGet 在类中 javax.servlet.http.HttpServlet

抛出:

java.io.IOException

javax.servlet.ServletException