JSSDKConfig

java.lang.Object
- javax.servlet.GenericServlet
- - javax.servlet.http.HttpServlet
  - - com.github.cuter44.wxpay.servlet.JSSDKConfig

所有已实现的接口:: java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class JSSDKConfig
extends javax.servlet.http.HttpServlet

JS-SDK config 签名 API 为 JS-SDK config 提供签名支持, 工作模式参见 @see 微信JSSDK说明文档↗


    GET /jssdk-config.api
    取得 openid, 头像等

    参数
    appId       :string         , 可选, APPID   , 缺省时由服务器取得
    timestamp   :unix-time-ms   , 可选, 时间戳  , 缺省时使用服务器时间
    nonceStr    :string         , 可选, 盐      , 缺省由服务器生成
    url         :url            , 必需, 当前 location.href , 不包含#及其后面部分

    响应
    application/json; charset=utf-8
    appId       :string         , APPID
    timestamp   :unix-time-ms   , 时间戳
    nonceStr    :string         , 盐
    signature   :string         , 签名

另请参阅:: 序列化表格

字段概要

字段
限定符和类型	字段和说明
`protected static java.lang.String`	`APP_ID`
`protected java.lang.String`	`appid`
`protected com.github.cuter44.nyafx.crypto.CryptoBase`	`crypto`
`protected static java.lang.String`	`DEBUG`
`protected static java.lang.String`	`JS_API_LIST`
`protected static java.lang.String`	`KEY_APPID`
`protected static java.lang.String`	`KEY_OPENID`
`protected static java.lang.String`	`KEY_SECRET`
`protected static java.lang.String`	`NONCE_STR`
`protected static java.lang.String`	`NONCESTR`
`protected java.lang.String`	`secret`
`protected static java.lang.String`	`SIGNATURE`
`protected static java.lang.String`	`TIMESTAMP`
`protected TokenKeeper`	`tokenKeeper`
`protected static java.lang.String`	`URL`

构造器概要

构造器
构造器和说明

JSSDKConfig()

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

方法概要

方法
限定符和类型	方法和说明
`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`	`getTicket(java.lang.String appid)` 提供 ticket 参数 servlet 从此方法取得必需参数 ticket, 覆盖此方法可以自定义 ticket 的来源.
`void`	`ifAcceptURL(java.lang.String url)` 校验 URL servlet 调用此方法以检定是否为传入的 url 参数生成签名, 覆盖此方法可以自行实现 url 鉴定策略以阻挡外部请求.
`void`	`init(javax.servlet.ServletConfig config)` 读取配置文件覆盖此方法可以删除对配置文件的访问.
`void`	`response(java.lang.String appId, java.lang.Long timestamp, java.lang.String nonceStr, java.lang.String signature, javax.servlet.http.HttpServletResponse resp)` 构造响应覆盖此方法可以自行构造响应默认实现如文档所述

从类继承的方法 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
```
    另请参阅:
    常量字段值
  - KEY_OPENID
```
protected static final java.lang.String KEY_OPENID
```
    另请参阅:
    常量字段值
  - DEBUG
```
protected static final java.lang.String DEBUG
```
    另请参阅:
    常量字段值
  - APP_ID
```
protected static final java.lang.String APP_ID
```
    另请参阅:
    常量字段值
  - TIMESTAMP
```
protected static final java.lang.String TIMESTAMP
```
    另请参阅:
    常量字段值
  - NONCESTR
```
protected static final java.lang.String NONCESTR
```
    另请参阅:
    常量字段值
  - NONCE_STR
```
protected static final java.lang.String NONCE_STR
```
    另请参阅:
    常量字段值
  - SIGNATURE
```
protected static final java.lang.String SIGNATURE
```
    另请参阅:
    常量字段值
  - URL
```
protected static final java.lang.String URL
```
    另请参阅:
    常量字段值
  - JS_API_LIST
```
protected static final java.lang.String JS_API_LIST
```
    另请参阅:
    常量字段值
  - appid
```
protected java.lang.String appid
```
  - secret
```
protected java.lang.String secret
```
  - tokenKeeper
```
protected TokenKeeper tokenKeeper
```
  - crypto
```
protected com.github.cuter44.nyafx.crypto.CryptoBase crypto
```
- 构造器详细资料
  - JSSDKConfig
```
public JSSDKConfig()
```
- 方法详细资料
  - getAppid
```
public java.lang.String getAppid(javax.servlet.http.HttpServletRequest req)
```
    提供 appid 参数 servlet 从此方法取得必需参数 appid, 覆盖此方法可以自定义 appid 的来源. 默认实现从配置文件 /wxpay.properties 读取
  - getTicket
```
public java.lang.String getTicket(java.lang.String appid)
```
    提供 ticket 参数 servlet 从此方法取得必需参数 ticket, 覆盖此方法可以自定义 ticket 的来源. 默认实现从 WxFactory.getDefaultInstance() 获取 TokenKeeper
    
    另请参阅:
    TokenKeeper
  - ifAcceptURL
```
public void ifAcceptURL(java.lang.String url)
```
    校验 URL servlet 调用此方法以检定是否为传入的 url 参数生成签名, 覆盖此方法可以自行实现 url 鉴定策略以阻挡外部请求. 默认实现直接返回. 如果要阻止操作, 抛出任意异常.
    
    另请参阅:
    TokenKeeper
  - response
```
public void response(java.lang.String appId,
            java.lang.Long timestamp,
            java.lang.String nonceStr,
            java.lang.String signature,
            javax.servlet.http.HttpServletResponse resp)
              throws java.io.IOException
```
    构造响应覆盖此方法可以自行构造响应默认实现如文档所述
    
    抛出:
    
    java.io.IOException
  - init
```
public void init(javax.servlet.ServletConfig config)
```
    读取配置文件覆盖此方法可以删除对配置文件的访问. 除非显式调用 super.init(config) 否则 getAppid(), getJSSDKTicket() 均需要自行实现.
    
    指定者:
    
    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

类 JSSDKConfig

字段概要

构造器概要

方法概要

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

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

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

字段详细资料

KEY_APPID

KEY_SECRET

KEY_OPENID

DEBUG

APP_ID

TIMESTAMP

NONCESTR

NONCE_STR

SIGNATURE

URL

JS_API_LIST

appid

secret

tokenKeeper

crypto

构造器详细资料

JSSDKConfig

方法详细资料

getAppid

getTicket

ifAcceptURL

response

init

doGet