open-source/payment-spring-boot
1
0
Fork 0
mirror of https://github.com/dromara/payment-spring-boot.git synced 2026-06-18 14:47:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update docs

Browse Source
This commit is contained in:
felord.cn
2021-02-04 21:41:03 +08:00
committed by felord.cn
parent d65fd0a243
commit b4c3525246
479 changed files with 79908 additions and 2827 deletions
Download Patch File Download Diff File Expand all files Collapse all files

160
docs/apidocs/cn/felord/payment/wechat/v3/SignatureProvider.html
View File

@@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="zh">
<head>
<!-- Generated by javadoc (1.8.0_252) on Sun Dec 13 22:43:47 CST 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Thu Feb 04 21:36:19 CST 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SignatureProvider (payment-spring-boot 1.0.0.RELEASE API)</title>
<meta name="date" content="2020-12-13">
<title>SignatureProvider (payment-spring-boot-autoconfigure 1.0.6.RELEASE API)</title>
<meta name="date" content="2021-02-04">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
@@ -13,14 +13,14 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SignatureProvider (payment-spring-boot 1.0.0.RELEASE API)";
parent.document.title="SignatureProvider (payment-spring-boot-autoconfigure 1.0.6.RELEASE API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","所有方法"],2:["t2","实例方法"],8:["t4","具体方法"]};
var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","所有方法"],1:["t1","静态方法"],2:["t2","实例方法"],8:["t4","具体方法"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
@@ -45,7 +45,6 @@ var activeTableTab = "activeTableTab";
<li><a href="package-tree.html">树</a></li>
<li><a href="../../../../../deprecated-list.html">已过时</a></li>
<li><a href="../../../../../index-all.html">索引</a></li>
<li><a href="../../../../../help-doc.html">帮助</a></li>
</ul>
</div>
<div class="subNav">
@@ -144,36 +143,42 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
<th class="colLast" scope="col">字段和说明</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../cn/felord/payment/wechat/v3/SignatureProvider.html#BC_PROVIDER">BC_PROVIDER</a></span></code>
<div class="block">加密算法提供方 - BouncyCastle</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="java.util中的类或接口">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/security/cert/Certificate.html?is-external=true" title="java.security.cert中的类或接口">Certificate</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../cn/felord/payment/wechat/v3/SignatureProvider.html#CERTIFICATE_MAP">CERTIFICATE_MAP</a></span></code>
<div class="block">微信平台证书容器 key = 序列号 value = 证书对象</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static org.springframework.util.IdGenerator</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../cn/felord/payment/wechat/v3/SignatureProvider.html#ID_GENERATOR">ID_GENERATOR</a></span></code>
<tr class="altColor">
<td class="colFirst"><code>private org.springframework.util.IdGenerator</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../cn/felord/payment/wechat/v3/SignatureProvider.html#nonceStrGenerator">nonceStrGenerator</a></span></code>
<div class="block">The constant ID_GENERATOR.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>private org.springframework.web.client.RestOperations</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../cn/felord/payment/wechat/v3/SignatureProvider.html#restOperations">restOperations</a></span></code>
<div class="block">The Rest operations.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../cn/felord/payment/wechat/v3/SignatureProvider.html#SCHEMA">SCHEMA</a></span></code>
<div class="block">The constant SCHEMA.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../cn/felord/payment/wechat/v3/SignatureProvider.html#TOKEN_PATTERN">TOKEN_PATTERN</a></span></code>
<div class="block">The constant TOKEN_PATTERN.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>private <a href="../../../../../cn/felord/payment/wechat/v3/WechatMetaContainer.html" title="cn.felord.payment.wechat.v3中的类">WechatMetaContainer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../cn/felord/payment/wechat/v3/SignatureProvider.html#wechatMetaContainer">wechatMetaContainer</a></span></code>
<div class="block">The Wechat meta container.</div>
@@ -208,13 +213,13 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
</a>
<h3>方法概要</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="方法概要表, 列表方法和解释">
<caption><span id="t0" class="activeTableTab"><span>所有方法</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">实例方法</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">具体方法</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<caption><span id="t0" class="activeTableTab"><span>所有方法</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">静态方法</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">实例方法</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">具体方法</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">限定符和类型</th>
<th class="colLast" scope="col">方法和说明</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a></code></td>
<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../cn/felord/payment/wechat/v3/SignatureProvider.html#createSign-java.lang.String...-">createSign</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>...&nbsp;components)</code>
<div class="block">请求时设置签名 组件</div>
</td>
@@ -229,27 +234,51 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../cn/felord/payment/wechat/v3/SignatureProvider.html#doRequestSign-java.security.PrivateKey-java.lang.String...-">doRequestSign</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/security/PrivateKey.html?is-external=true" title="java.security中的类或接口">PrivateKey</a>&nbsp;privateKey,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>...&nbsp;orderedComponents)</code>
<div class="block">Do request sign.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../cn/felord/payment/wechat/v3/SignatureProvider.html#encryptRequestMessage-java.lang.String-java.security.cert.Certificate-">encryptRequestMessage</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;message,
<a href="https://docs.oracle.com/javase/8/docs/api/java/security/cert/Certificate.html?is-external=true" title="java.security.cert中的类或接口">Certificate</a>&nbsp;certificate)</code>
<div class="block">对请求敏感字段进行加密</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>sun.security.x509.X509CertImpl</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../cn/felord/payment/wechat/v3/SignatureProvider.html#getCertificate--">getCertificate</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>org.springframework.util.IdGenerator</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../cn/felord/payment/wechat/v3/SignatureProvider.html#nonceStrGenerator--">nonceStrGenerator</a></span>()</code>
<div class="block">Nonce generator.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>private void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../cn/felord/payment/wechat/v3/SignatureProvider.html#refreshCertificate-java.lang.String-">refreshCertificate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;tenantId)</code>
<div class="block">当我方服务器不存在平台证书或者证书同当前响应报文中的证书序列号不一致时应当刷新 调用/v3/certificates</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../cn/felord/payment/wechat/v3/SignatureProvider.html#requestSign-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">requestSign</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;tenantId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;method,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;canonicalUrl,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;body)</code>
<div class="block">我方请求时加签，使用API证书.</div>
<div class="block">我方请求前用 SHA256withRSA 加签，使用API证书.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../cn/felord/payment/wechat/v3/SignatureProvider.html#responseSignVerify-cn.felord.payment.wechat.v3.model.ResponseSignVerifyParams-">responseSignVerify</a></span>(<a href="../../../../../cn/felord/payment/wechat/v3/model/ResponseSignVerifyParams.html" title="cn.felord.payment.wechat.v3.model中的类">ResponseSignVerifyParams</a>&nbsp;params)</code>
<div class="block">我方对响应验签，和应答签名做比较，使用微信平台证书.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../cn/felord/payment/wechat/v3/WechatMetaContainer.html" title="cn.felord.payment.wechat.v3中的类">WechatMetaContainer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../cn/felord/payment/wechat/v3/SignatureProvider.html#wechatMetaContainer--">wechatMetaContainer</a></span>()</code>
<div class="block">Wechat meta container.</div>
@@ -277,13 +306,13 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
<!-- -->
</a>
<h3>字段详细资料</h3>
<a name="ID_GENERATOR">
<a name="nonceStrGenerator">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ID_GENERATOR</h4>
<pre>private static final&nbsp;org.springframework.util.IdGenerator ID_GENERATOR</pre>
<h4>nonceStrGenerator</h4>
<pre>private final&nbsp;org.springframework.util.IdGenerator nonceStrGenerator</pre>
<div class="block">The constant ID_GENERATOR.</div>
</li>
</ul>
@@ -325,6 +354,20 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
<div class="block">微信平台证书容器 key = 序列号 value = 证书对象</div>
</li>
</ul>
<a name="BC_PROVIDER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BC_PROVIDER</h4>
<pre>private static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a> BC_PROVIDER</pre>
<div class="block">加密算法提供方 - BouncyCastle</div>
<dl>
<dt><span class="seeLabel">另请参阅:</span></dt>
<dd><a href="../../../../../constant-values.html#cn.felord.payment.wechat.v3.SignatureProvider.BC_PROVIDER">常量字段值</a></dd>
</dl>
</li>
</ul>
<a name="restOperations">
<!-- -->
</a>
@@ -385,7 +428,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;method,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;canonicalUrl,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;body)</pre>
<div class="block">我方请求时加签，使用API证书.</div>
<div class="block">我方请求前用 SHA256withRSA 加签，使用API证书.</div>
<dl>
<dt><span class="paramLabel">参数:</span></dt>
<dd><code>tenantId</code> - the properties key</dd>
@@ -397,6 +440,26 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
</dl>
</li>
</ul>
<a name="doRequestSign-java.security.PrivateKey-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doRequestSign</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;doRequestSign(<a href="https://docs.oracle.com/javase/8/docs/api/java/security/PrivateKey.html?is-external=true" title="java.security中的类或接口">PrivateKey</a>&nbsp;privateKey,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>...&nbsp;orderedComponents)</pre>
<div class="block">Do request sign.</div>
<dl>
<dt><span class="paramLabel">参数:</span></dt>
<dd><code>privateKey</code> - the private key</dd>
<dd><code>orderedComponents</code> - the orderedComponents</dd>
<dt><span class="returnLabel">返回:</span></dt>
<dd>the string</dd>
<dt><span class="simpleTagLabel">从以下版本开始:</span></dt>
<dd>1.0.4.RELEASE</dd>
</dl>
</li>
</ul>
<a name="responseSignVerify-cn.felord.payment.wechat.v3.model.ResponseSignVerifyParams-">
<!-- -->
</a>
@@ -449,6 +512,34 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
</dl>
</li>
</ul>
<a name="encryptRequestMessage-java.lang.String-java.security.cert.Certificate-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encryptRequestMessage</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;encryptRequestMessage(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;message,
<a href="https://docs.oracle.com/javase/8/docs/api/java/security/cert/Certificate.html?is-external=true" title="java.security.cert中的类或接口">Certificate</a>&nbsp;certificate)</pre>
<div class="block">对请求敏感字段进行加密</div>
<dl>
<dt><span class="paramLabel">参数:</span></dt>
<dd><code>message</code> - the message</dd>
<dt><span class="returnLabel">返回:</span></dt>
<dd>encrypt message</dd>
<dt><span class="simpleTagLabel">从以下版本开始:</span></dt>
<dd>1.0.6.RELEASE</dd>
</dl>
</li>
</ul>
<a name="getCertificate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCertificate</h4>
<pre>public&nbsp;sun.security.x509.X509CertImpl&nbsp;getCertificate()</pre>
</li>
</ul>
<a name="wechatMetaContainer--">
<!-- -->
</a>
@@ -463,13 +554,29 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
</dl>
</li>
</ul>
<a name="nonceStrGenerator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nonceStrGenerator</h4>
<pre>public&nbsp;org.springframework.util.IdGenerator&nbsp;nonceStrGenerator()</pre>
<div class="block">Nonce generator.</div>
<dl>
<dt><span class="returnLabel">返回:</span></dt>
<dd>the id generator</dd>
<dt><span class="simpleTagLabel">从以下版本开始:</span></dt>
<dd>1.0.4.RELEASE</dd>
</dl>
</li>
</ul>
<a name="createSign-java.lang.String...-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createSign</h4>
<pre>private&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;createSign(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>...&nbsp;components)</pre>
<pre>private static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;createSign(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>...&nbsp;components)</pre>
<div class="block">请求时设置签名 组件</div>
<dl>
<dt><span class="paramLabel">参数:</span></dt>
@@ -502,7 +609,6 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
<li><a href="package-tree.html">树</a></li>
<li><a href="../../../../../deprecated-list.html">已过时</a></li>
<li><a href="../../../../../index-all.html">索引</a></li>
<li><a href="../../../../../help-doc.html">帮助</a></li>
</ul>
</div>
<div class="subNav">
@@ -548,6 +654,6 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2020. All rights reserved.</small></p>
<p class="legalCopy"><small>Copyright &#169; 2021. All rights reserved.</small></p>
</body>
</html>