大家好,我是飘渺。在今天的DailyMart项目实战中,我们将探讨如何在领域驱动设计(DDD)开发中集成支付宝的网页支付功能,以及相关的步骤和注意事项。
一、申请阿里沙箱支付
首先,我们需要申请阿里沙箱支付环境,以便于方便地进行支付集成测试。以下是申请沙箱环境的简要流程:
1.访问支付宝沙箱环境,https://open.alipay.com/develop/sandbox/app,注册并登录。
图片
2.设置接口加签方式,并记录对应的公钥和私钥。
图片
二、准备内网穿透工具
支付宝支付完成后,支付结果将通过回调通知到您的应用程序(在发起支付时通过NotifyUrl参数指定)。为了确保在开发时接口能够在外网进行访问,我们可以借助内网穿透工具,将本地IP与端口映射成外网可访问地址。
作为示例,我选择使用花生壳进行内网穿透。你也可以根据需求选择其他工具。
注册并登录https://hsk.oray.com,下载最新客户端。
图片
登录以后配置外网映射,如上所示,我将本地ip+端口9090 (网关服务)映射成了外网访问,红框部分就是对外的访问地址。
三、支付Demo流程演示
完成上述操作后,我们可以借助Alipay提供的SDK,进行支付单元测试。代码位置:
com.jianzh5.dailymart.module.order.infrastructure.alipay.AliPayTest
@Test
public void test_AliPay() throws AlipayApiException {
AlipayConfig alipayConfig = new AlipayConfig();
alipayConfig.setAppId(app_id);
// 其他配置参数...
...
// 创建AlipayClient
AlipayClient alipayClient = new DefaultAlipayClient(alipayConfig);
// 创建支付请求
AlipayTradePagePayRequest request = new AlipayTradePagePayRequest();
// 设置回调地址
request.setNotifyUrl(notify_url);
Map<String,Object> requestMap = Maps.newHashMap();
requestMap.put("out_trade_no", "ddd20240221-001"); // 我们自己生成的订单编号
...
request.setBizContent(JsonUtils.obj2String(requestMap));
//调用SDK生成表单
String form = alipayClient.pageExecute(request).getBody();
log.info("测试结果:{}", form);
}
运行单元测试后可以得到如下的 HTML 脚本.
<form name="punchout_form" method="post" action="https://openapi-sandbox.dl.alipaydev.com/gateway.do?charset=UTF-8&method=alipay.trade.page.pay&sign=">
<input type="hidden" name="biz_content" value="{"out_trade_no":"2846741992449220601"DDD商城订单2846741992449220601"product_code":"FAST_INSTANT_TRADE_PAY"}">
<input type="submit" value="立即支付" style="display:none" >
</form>
<script>document.forms[0].submit();</script>
将这份脚本复制到html文件中就可以直接在浏览器打开,效果如下:
图片
然后从开发平台沙箱账号中拿到账号密码,进行支付。
图片
支付成功后的结果
图片
以上就是集成支付宝进行支付的一个流程,现在我们将支付流程集成到Dailymart中。
四、 DailyMart集成支付功能
4.1 订单支付流程梳理
在集成支付功能之前,我们首先需要梳理订单的创建与支付业务流程。主要包括以下步骤:
1.用户从购物车发起结算后调用后台接口生成订单,订单系统先对库存进行校验,在校验通过后保存商品订单,同时调用库存系统进行库存预扣。同时为了避免用户创建订单后不支付,在创建订单的同时还会向RocketMQ发送一条延时消息,如果用户不支付,30分钟后会删除对应的订单返回相应的库存。(此部分已经在之前的章节中完成)
2.用户确认订单后生成相应的交易流水记录以供后期查账使用,同时调用支付宝网关创建支付订单,系统引导用户跳转到支付宝支付页面。(即前文生成的HTML页面)
3.用户支付成功后,支付宝会通过配置好的NotifyUrl进行回调,在收到支付结果确认以后需要更新订单状态,调用库存服务进行库存扣减。
4.为了防止网络问题导致系统没收到支付宝的回调,还需要一个定时任务定时去检索未支付成功的交易单,调用支付网关确认支付结果并同时更新对应状态。
整体流程图如下所示:
图片
4.2 领域分析
根据订单支付流程,我们需要在订单上下文中创建三个领域对象:
- PaymentOrder:支付单,作为聚合对象,用于后期查账。
- PaymentInfo:支付信息,用于构建支付所需的相关数据,作为值对象。
- PaymentId:支付单的ID对象,也是值对象。
图片
4.3 核心代码示例
1.在订单基础设施层创建属性配置类,用于读取alipay的配置数据
@Component
@ConfigurationProperties(prefix = "alipay")
@Data
public class AliPayConfigProperties {
private String appId;
private String serverUrl;
private String privateKey;
private String alipayPublicKey;
private String notifyUrl;
private String format = "JSON";
private String charset = "UTF-8";
private String signType = "RSA2";
}
2.创建配置类,用于装载alipay的AlipayClient对象。
@Configuration
@EnableConfigurationProperties(AliPayConfigProperties.class)
public class AliPayConfig {
@Resource
private AliPayConfigProperties aliPayConfigProperties;
@Bean
@ConditionalOnClass(AlipayClient.class)
public AlipayClient alipayClient() {
return new DefaultAlipayClient(
aliPayConfigProperties.getServerUrl(),
aliPayConfigProperties.getAppId(),
aliPayConfigProperties.getPrivateKey(),
aliPayConfigProperties.getFormat(),
aliPayConfigProperties.getCharset(),
aliPayConfigProperties.getAlipayPublicKey(),
aliPayConfigProperties.getSignType()
) ;
}
}
3.需要与第三方交互,我们将交互的逻辑放在基础设施层,同时提供接口供上层使用
@Service
@RequiredArgsConstructor(onConstructor = @__(@Autowired))
@Slf4j
public class AliPaymentFacadeImpl implements PaymentFacade {
@Override
public String triggerPayment(PaymentInfo paymentInfo) {
// 发送请求的 Request类
AlipayTradePagePayRequest request = new AlipayTradePagePayRequest();
request.setNotifyUrl(aliPayConfigProperties.getNotifyUrl());
Map<String,Object> requestMap = Maps.newHashMap();
requestMap.put("out_trade_no", paymentInfo.getOrderNo()); // 我们自己生成的订单编号
requestMap.put("total_amount", paymentInfo.getTotalAmount()); // 订单的总金额
requestMap.put("subject", paymentInfo.getSubject()); // 支付的名称
requestMap.put("product_code", "FAST_INSTANT_TRADE_PAY"); // 固定配置
request.setBizContent(JsonUtils.obj2String(requestMap));
//调用SDK生成表单
String form = "";
try {
form = alipayClient.pageExecute(request).getBody();
log.info("订单{}, 生成的表单地址为:{}", paymentInfo.getOrderNo(),form);
} catch (AlipayApiException e) {
log.error("订单{}生成支付页面异常," ,paymentInfo.getOrderNo(),e);
throw new BusinessException("支付订单创建异常");
}
return form;
}
}
4.对外提供接口,用于生成alipay支付表单
@RestController
@RequiredArgsConstructor(onConstructor = @__(@Autowired))
@Tag(name = "AliPayController", description = "C端订单支付")
@Slf4j
public class AliPayController {
@Operation(summary = "生成支付表单")
@GetMapping("/api/pd/alipay/form")
public PaymentInfoDTO pay(@RequestParam("orderSn") String orderSn) {
return paymentService.createPaymentOrder(orderSn);
}
}
5.由应用领域层完成支付表单逻辑
@Service
@RequiredArgsConstructor(onConstructor = @__(@Autowired))
@Slf4j
public class PaymentServiceImpl implements PaymentService {
...
@Override
public PaymentInfoDTO createPaymentOrder(String orderSn) {
TradeOrder tradeOrder = Optional.ofNullable(tradeOrderService.getByOrderSn(orderSn)).orElseThrow(() -> new BusinessException("订单编号不存在"));
// 确保订单处于待支付状态
if (Objects.equals(tradeOrder.getStatus(), OrderStatusEnum.WAITING_PAYMENT.getStatus())) {
PaymentInfo paymentInfo = PaymentInfo.builder()
.orderNo(orderSn)
.totalAmount(String.valueOf(tradeOrder.getTotalAmount()))
.subject("DDD商城订单" + tradeOrder.getOrderSn())
.build();
//获取表单地址
String paymentForm = paymentFacade.triggerPayment(paymentInfo);
if(StringUtils.isNotEmpty(paymentForm)){
PaymentOrder paymentOrder = PaymentOrder.builder()
.orderNo(orderSn)
.userId(tradeOrder.getCustomerId())
.totalAmount(String.valueOf(tradeOrder.getTotalAmount()))
.tradeSubject("DDD商城订单" + tradeOrder.getOrderSn())
.orderTime(tradeOrder.getCreateTime())
.paymentForm(paymentForm)
.build();
//保存支付订单
paymentOrderService.save(paymentOrder);
return PaymentInfoDTO.builder()
.orderSn(tradeOrder.getOrderSn())
.payUrl(paymentForm)
.build();
}else{
throw new BusinessException("创建支付宝表单失败,请检查参数参数.");
}
} else {
throw new BusinessException("订单已支付,请勿重复提交...");
}
}
}
6.提供接口供alipay回调,在回调逻辑中完成订单状态和支付订单的更新,同时还需要调用库存服务进行库存扣减,为了实现分布式事务,这里借住RocketMQ的事务消息实现最终一致性。
/**
* 支付宝回调逻辑
* 1. 将订单状态修改成已支付
* 2. 占用库存
* 跨服务调用,基于RocketMQ来解决分布式事务
*/
@Operation(summary = "支付宝回调")
@PostMapping("/api/pd/alipay/notify")
public String payNotify(HttpServletRequest request){
String tradeStatus = request.getParameter("trade_status");
if (tradeStatus.equals("TRADE_SUCCESS")) {
Map<String, String> params = new HashMap<>();
Map<String, String[]> requestParams = request.getParameterMap();
for (String name : requestParams.keySet()) {
params.put(name, request.getParameter(name));
}
String sign = params.get("sign");
String aliPaySign = AlipaySignature.getSignCheckContentV1(params);
//支付宝公钥
String alipayPublicKey = aliPayConfigProperties.getAlipayPublicKey();
try {
boolean checkSignature = AlipaySignature.rsa256CheckContent(aliPaySign, sign, alipayPublicKey, "UTF-8");
//签名验证通过
if(checkSignature){
//更新订单状态
return paymentService.updatePayment(params);
}
} catch (AlipayApiException e) {
throw new RuntimeException(e);
}
}
return "false";
}
@Override
public String updatePayment(Map<String, String> requestParams) {
PaymentInfo paymentInfo = PaymentInfo.builder()
.orderNo(requestParams.get("out_trade_no"))
.tradeNo(requestParams.get("trade_no"))
...
.build();
OrderPaidEvent orderPaidEvent = new OrderPaidEvent(paymentInfo);
TradeOrder tradeOrder = Optional.ofNullable(tradeOrderService.getByOrderSn(paymentInfo.getOrderNo())).orElseThrow(() -> new BusinessException("订单编号不存在"));
if (Objects.equals(tradeOrder.getStatus(), OrderStatusEnum.WAITING_PAYMENT.getStatus())) {
TransactionSendResult sendResult = enhanceTemplate.sendTransaction("TRADE-ORDER", "ORDER-PAID", orderPaidEvent, OrderPaidTransactionConsumer.class);
if (SendStatus.SEND_OK == sendResult.getSendStatus() && sendResult.getLocalTransactionState() == LocalTransactionState.COMMIT_MESSAGE) {
return "success";
}
}
return "false";
}
7.支付单表结构
create table customer_payment
(
payment_id bigint auto_increment primary key, -- 主键
order_no varchar(32) null, -- 订单编号
user_id bigint null, -- 系统用户ID
trade_status varchar(50) null, -- 交易状态
trade_no varchar(100) null, -- 外部交易号
total_amount varchar(20) null, -- 支付金额
trade_subject varchar(200) null, -- 支付标题
payment_form varchar(2000) null, -- 支付表单
buyer_id varchar(100) null, -- 付款用户ID
buyer_pay_amount varchar(100) null, -- 实际付款金额
gmt_payment varchar(20) null, -- 实际支付时间
create_time datetime null,
update_time datetime null,
del_flag int null
);
五、小结
通过以上步骤,我们完成了在DDD开发中集成支付宝网页支付功能的实践。本文涉及的代码都已经上传至Github,感兴趣的可以通过文末方式获取。