Skip to content

Commit 8217168

Browse files
binarywangbinarywang
committed
优化javadoc
1 parent d7b32d2 commit 8217168

File tree

1 file changed

+104
-110
lines changed

1 file changed

+104
-110
lines changed

‎weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/WxPayUnifiedOrderRequest.java‎

Lines changed: 104 additions & 110 deletions
Original file line numberDiff line numberDiff line change
@@ -10,43 +10,36 @@
1010
* <pre>
1111
* 统一下单请求参数对象
1212
* 参考文档：https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_1
13-
* 注释中各行每个字段描述对应如下：
14-
* <li>字段名
15-
* <li>变量名
16-
* <li>是否必填
17-
* <li>类型
18-
* <li>示例值
19-
* <li>描述
2013
* </pre>
2114
* Created by Binary Wang on 2016/9/25.
2215
*
2316
* @author binarywang (https://github.com/binarywang)
2417
*/
2518
@XStreamAlias("xml")
2619
public class WxPayUnifiedOrderRequest extends WxPayBaseRequest {
27-
private static final String[] TRADE_TYPES = new String[]{"JSAPI", "NATIVE", "APP","MWEB"};
20+
private static final String[] TRADE_TYPES = new String[]{"JSAPI", "NATIVE", "APP", "MWEB"};
2821

2922
/**
3023
* <pre>
31-
* 设备号
32-
* device_info
33-
* 否
34-
* String(32)
35-
* 013467007045764
36-
* 终端设备号(门店号或收银设备Id)，注意：PC网页或公众号内支付请传"WEB"
24+
* 字段名：设备号
25+
* 变量名：device_info
26+
* 是否必填：否
27+
* 类型：String(32)
28+
* 示例值：013467007045764
29+
* 描述：终端设备号(门店号或收银设备Id)，注意：PC网页或公众号内支付请传"WEB"
3730
* </pre>
3831
*/
3932
@XStreamAlias("device_info")
4033
private String deviceInfo;
4134

4235
/**
4336
* <pre>
44-
* 商品描述
45-
* body
46-
* 是
47-
* String(128)
48-
* 腾讯充值中心-QQ会员充值
49-
* 商品简单描述，该字段须严格按照规范传递，具体请见参数规定
37+
* 字段名：商品描述
38+
* 变量名：body
39+
* 是否必填：是
40+
* 类型：String(128)
41+
* 示例值： 腾讯充值中心-QQ会员充值
42+
* 描述：商品简单描述，该字段须严格按照规范传递，具体请见参数规定
5043
* </pre>
5144
*/
5245
@Required
@@ -55,12 +48,12 @@ public class WxPayUnifiedOrderRequest extends WxPayBaseRequest {
5548

5649
/**
5750
* <pre>
58-
* 商品详情
59-
* detail
60-
* 否
61-
* String(6000)
62-
* { "goods_detail":[
63-
* {
51+
* 字段名：商品详情
52+
* 变量名：detail
53+
* 是否必填：否
54+
* 类型：String(6000)
55+
* 示例值： { "goods_detail":[
56+
* {
6457
* "goods_id":"iphone6s_16G",
6558
* "wxpay_goods_id":"1001",
6659
* "goods_name":"iPhone6s 16G",
@@ -80,7 +73,7 @@ public class WxPayUnifiedOrderRequest extends WxPayBaseRequest {
8073
* }
8174
* ]
8275
* }
83-
* 商品详细列表，使用Json格式，传输签名前请务必使用CDATA标签将JSON文本串保护起来。
76+
* 描述：商品详细列表，使用Json格式，传输签名前请务必使用CDATA标签将JSON文本串保护起来。
8477
* goods_detail []：
8578
* └ goods_id String 必填 32 商品的编号
8679
* └ wxpay_goods_id String 可选 32 微信支付定义的统一商品编号
@@ -96,25 +89,25 @@ public class WxPayUnifiedOrderRequest extends WxPayBaseRequest {
9689

9790
/**
9891
* <pre>
99-
* 附加数据
100-
* attach
101-
* 否
102-
* String(127)
103-
* 深圳分店
104-
* 附加数据，在查询API和支付通知中原样返回，该字段主要用于商户携带订单的自定义数据
92+
* 字段名：附加数据
93+
* 变量名：attach
94+
* 是否必填：否
95+
* 类型：String(127)
96+
* 示例值： 深圳分店
97+
* 描述： 附加数据，在查询API和支付通知中原样返回，该字段主要用于商户携带订单的自定义数据
10598
* </pre>
10699
*/
107100
@XStreamAlias("attach")
108101
private String attach;
109102

110103
/**
111104
* <pre>
112-
* 商户订单号
113-
* out_trade_no
114-
* 是
115-
* String(32)
116-
* 20150806125346
117-
* 商户系统内部的订单号,32个字符内、可包含字母, 其他说明见商户订单号
105+
* 字段名：商户订单号
106+
* 变量名：out_trade_no
107+
* 是否必填：是
108+
* 类型：String(32)
109+
* 示例值：20150806125346
110+
* 描述：商户系统内部的订单号,32个字符内、可包含字母, 其他说明见商户订单号
118111
* </pre>
119112
*/
120113
@Required
@@ -123,25 +116,25 @@ public class WxPayUnifiedOrderRequest extends WxPayBaseRequest {
123116

124117
/**
125118
* <pre>
126-
* 货币类型
127-
* fee_type
128-
* 否
129-
* String(16)
130-
* CNY
131-
* 符合ISO 4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型
119+
* 字段名：货币类型
120+
* 变量名：fee_type
121+
* 是否必填：否
122+
* 类型：String(16)
123+
* 示例值：CNY
124+
* 描述： 符合ISO 4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型
132125
* </pre>
133126
*/
134127
@XStreamAlias("fee_type")
135128
private String feeType;
136129

137130
/**
138131
* <pre>
139-
* 总金额
140-
* total_fee
141-
* 是
142-
* Int
143-
* 888
144-
* 订单总金额，单位为分，详见支付金额
132+
* 字段名：总金额
133+
* 变量名：total_fee
134+
* 是否必填：是
135+
* 类型：Int
136+
* 示例值： 888
137+
* 描述：订单总金额，单位为分，详见支付金额
145138
* </pre>
146139
*/
147140
@Required
@@ -150,12 +143,12 @@ public class WxPayUnifiedOrderRequest extends WxPayBaseRequest {
150143

151144
/**
152145
* <pre>
153-
* 终端IP
154-
* spbill_create_ip
155-
* 是
156-
* String(16)
157-
* 123.12.12.123
158-
* APP和网页支付提交用户端ip，Native支付填调用微信支付API的机器IP。
146+
* 字段名：终端IP
147+
* 变量名：spbill_create_ip
148+
* 是否必填：是
149+
* 类型：String(16)
150+
* 示例值：123.12.12.123
151+
* 描述：APP和网页支付提交用户端ip，Native支付填调用微信支付API的机器IP。
159152
* </pre>
160153
*/
161154
@Required
@@ -164,25 +157,25 @@ public class WxPayUnifiedOrderRequest extends WxPayBaseRequest {
164157

165158
/**
166159
* <pre>
167-
* 交易起始时间
168-
* time_start
169-
* 否
170-
* String(14)
171-
* 20091225091010
172-
* 订单生成时间，格式为yyyyMMddHHmmss，如2009年12月25日9点10分10秒表示为20091225091010。其他详见时间规则
160+
* 字段名：交易起始时间
161+
* 变量名：time_start
162+
* 是否必填：否
163+
* 类型：String(14)
164+
* 示例值：20091225091010
165+
* 描述：订单生成时间，格式为yyyyMMddHHmmss，如2009年12月25日9点10分10秒表示为20091225091010。其他详见时间规则
173166
* </pre>
174167
*/
175168
@XStreamAlias("time_start")
176169
private String timeStart;
177170

178171
/**
179172
* <pre>
180-
* 交易结束时间
181-
* time_expire
182-
* 否
183-
* String(14)
184-
* 20091227091010
185-
* 订单失效时间，格式为yyyyMMddHHmmss，如2009年12月27日9点10分10秒表示为20091227091010。其他详见时间规则
173+
* 字段名：交易结束时间
174+
* 变量名：time_expire
175+
* 是否必填：否
176+
* 类型：String(14)
177+
* 示例值：20091227091010
178+
* 描述：订单失效时间，格式为yyyyMMddHHmmss，如2009年12月27日9点10分10秒表示为20091227091010。其他详见时间规则
186179
* 注意：最短失效时间间隔必须大于5分钟
187180
* </pre>
188181
*/
@@ -191,25 +184,25 @@ public class WxPayUnifiedOrderRequest extends WxPayBaseRequest {
191184

192185
/**
193186
* <pre>
194-
* 商品标记
195-
* goods_tag
196-
* 否
197-
* String(32)
198-
* WXG
199-
* 商品标记，代金券或立减优惠功能的参数，说明详见代金券或立减优惠
187+
* 字段名：商品标记
188+
* 变量名：goods_tag
189+
* 是否必填：否
190+
* 类型：String(32)
191+
* 示例值：WXG
192+
* 描述：商品标记，代金券或立减优惠功能的参数，说明详见代金券或立减优惠
200193
* </pre>
201194
*/
202195
@XStreamAlias("goods_tag")
203196
private String goodsTag;
204197

205198
/**
206199
* <pre>
207-
* 通知地址
208-
* notify_url
209-
* 是
210-
* String(256)
211-
* http://www.weixin.qq.com/wxpay/pay.php
212-
* 接收微信支付异步通知回调地址，通知url必须为直接可访问的url，不能携带参数。
200+
* 字段名：通知地址
201+
* 变量名：notify_url
202+
* 是否必填：是
203+
* 类型：String(256)
204+
* 示例值：http://www.weixin.qq.com/wxpay/pay.php
205+
* 描述：接收微信支付异步通知回调地址，通知url必须为直接可访问的url，不能携带参数。
213206
* </pre>
214207
*/
215208
@Required
@@ -218,12 +211,12 @@ public class WxPayUnifiedOrderRequest extends WxPayBaseRequest {
218211

219212
/**
220213
* <pre>
221-
* 交易类型
222-
* trade_type
223-
* 是
224-
* String(16)
225-
* JSAPI
226-
* 取值如下：JSAPI，NATIVE，APP，详细说明见参数规定:
214+
* 字段名：交易类型
215+
* 变量名：trade_type
216+
* 是否必填：是
217+
* 类型：String(16)
218+
* 示例值： JSAPI
219+
* 描述： 取值如下：JSAPI，NATIVE，APP，详细说明见参数规定:
227220
* JSAPI--公众号支付、NATIVE--原生扫码支付、APP--app支付，统一下单接口trade_type的传参可参考这里
228221
* </pre>
229222
*/
@@ -233,37 +226,38 @@ public class WxPayUnifiedOrderRequest extends WxPayBaseRequest {
233226

234227
/**
235228
* <pre>
236-
* 商品Id
237-
* product_id
238-
* 否
239-
* String(32)
240-
* 12235413214070356458058
241-
* trade_type=NATIVE，此参数必传。此id为二维码中包含的商品Id，商户自行定义。
229+
* 字段名：商品Id
230+
* 变量名：product_id
231+
* 是否必填：否
232+
* 类型：String(32)
233+
* 示例值：12235413214070356458058
234+
* 描述：trade_type=NATIVE，此参数必传。此id为二维码中包含的商品Id，商户自行定义。
242235
* </pre>
243236
*/
244237
@XStreamAlias("product_id")
245238
private String productId;
246239

247240
/**
248241
* <pre>
249-
* 指定支付方式
250-
* limit_pay
251-
* 否
252-
* String(32)
253-
* no_credit no_credit--指定不能使用信用卡支付
242+
* 字段名：指定支付方式
243+
* 变量名：limit_pay
244+
* 是否必填：否
245+
* 类型：String(32)
246+
* 示例值：no_credit
247+
* 描述：no_credit--指定不能使用信用卡支付
254248
* </pre>
255249
*/
256250
@XStreamAlias("limit_pay")
257251
private String limitPay;
258252

259253
/**
260254
* <pre>
261-
* 用户标识
262-
* openid
263-
* 否
264-
* String(128)
265-
* oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
266-
* trade_type=JSAPI，此参数必传，用户在商户appid下的唯一标识。
255+
* 字段名：用户标识
256+
* 变量名：openid
257+
* 是否必填：否
258+
* 类型：String(128)
259+
* 示例值：oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
260+
* 描述：trade_type=JSAPI，此参数必传，用户在商户appid下的唯一标识。
267261
* openid如何获取，可参考【获取openid】。
268262
* 企业号请使用【企业号OAuth2.0接口】获取企业号内成员userid，再调用【企业号userid转openid接口】进行转换
269263
* </pre>
@@ -273,12 +267,12 @@ public class WxPayUnifiedOrderRequest extends WxPayBaseRequest {
273267

274268
/**
275269
* <pre>
276-
* 用户子标识
277-
* sub_openid
278-
* 否
279-
* String(128)
280-
* oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
281-
* trade_type=JSAPI，此参数必传，用户在子商户appid下的唯一标识。
270+
* 字段名：用户子标识
271+
* 变量名：sub_openid
272+
* 是否必填：否
273+
* 类型：String(128)
274+
* 示例值：oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
275+
* 描述：trade_type=JSAPI，此参数必传，用户在子商户appid下的唯一标识。
282276
* openid和sub_openid可以选传其中之一，如果选择传sub_openid,则必须传sub_appid。
283277
* 下单前需要调用【网页授权获取用户信息】接口获取到用户的Openid。
284278
* </pre>

0 commit comments

Comments
 (0)