wechatpay guzzle middleware
1.0.0
Промежуточное программное обеспечение Guzzle HttpClient WeChat Payment API v3 реализует генерацию подписей запросов и проверку подписей ответов.
Если вы являетесь разработчиком магазина, использующим Guzzle, вы можете передать WechatPayGuzzleMiddleware при создании GuzzleHttpClient . Полученный экземпляр GuzzleHttpClient будет автоматически переносить информацию аутентификации личности при выполнении запроса и проверять подпись WeChat Pay в ответе.
Текущая версия — тестовая версия 0.2.0 . Пожалуйста, обратите внимание на правильность и совместимость системы и программного обеспечения, а также на связанные с этим риски при использовании профессионального и технического персонала продавца.
Этот проект находится на техническом обслуживании . Мы рекомендуем всем разработчикам отдать приоритет использованию новой библиотеки разработки PHP WeChat Pay wechatpay-php.
Среда, которую мы используем для разработки и тестирования, выглядит следующим образом:
Примечание. Конкретную причину, по которой guzzle7 не поддерживается, можно найти в обсуждении в #54. Разработчикам, которые полагаются на guzzle7, используйте wechatpay-php.
Вы можете использовать композитор инструмента управления пакетами PHP, чтобы внедрить SDK в проект:
Способ 1. В каталоге проекта добавьте через командную строку композитора:
composer require wechatpay/wechatpay-guzzle-middlewareСпособ 2. Добавьте следующую конфигурацию в композитор.json проекта:
"require" : {
"wechatpay/wechatpay-guzzle-middleware" : " ^0.2.0 "
}После добавления конфигурации выполните установку
composer install Сначала создайте WechatPayMiddleware через WechatPayMiddlewareBuilder , а затем добавьте его в HandlerStack GuzzleHttpClient . Мы предоставляем соответствующие методы для удобной передачи такой информации, как закрытые ключи торговцев и сертификаты платежной платформы WeChat.
use GuzzleHttp Exception RequestException ;
use WechatPay GuzzleMiddleware WechatPayMiddleware ;
use WechatPay GuzzleMiddleware Util PemUtil ;
// 商户相关配置
$ merchantId = ' 1000100 ' ; // 商户号
$ merchantSerialNumber = ' XXXXXXXXXX ' ; // 商户API证书序列号
$ merchantPrivateKey = PemUtil:: loadPrivateKey ( ' /path/to/mch/private/key.pem ' ); // 商户私钥
// 微信支付平台配置
$ wechatpayCertificate = PemUtil:: loadCertificate ( ' /path/to/wechatpay/cert.pem ' ); // 微信支付平台证书
// 构造一个WechatPayMiddleware
$ wechatpayMiddleware = WechatPayMiddleware:: builder ()
-> withMerchant ( $ merchantId , $ merchantSerialNumber , $ merchantPrivateKey ) // 传入商户相关配置
-> withWechatPay ([ $ wechatpayCertificate ]) // 可传入多个微信支付平台证书，参数类型为array
-> build ();
// 将WechatPayMiddleware添加到Guzzle的HandlerStack中
$ stack = GuzzleHttp HandlerStack:: create ();
$ stack -> push ( $ wechatpayMiddleware , ' wechatpay ' );
// 创建Guzzle HTTP Client时，将HandlerStack传入
$ client = new GuzzleHttp Client ([ ' handler ' => $ stack ]);
// 接下来，正常使用Guzzle发起API请求，WechatPayMiddleware会自动地处理签名和验签
try {
$ resp = $ client -> request ( ' GET ' , ' https://api.mch.weixin.qq.com/v3/... ' , [ // 注意替换为实际URL
' headers ' => [ ' Accept ' => ' application/json ' ]
]);
echo $ resp -> getStatusCode (). ' ' . $ resp -> getReasonPhrase (). "n" ;
echo $ resp -> getBody (). "n" ;
$ resp = $ client -> request ( ' POST ' , ' https://api.mch.weixin.qq.com/v3/... ' , [
' json ' => [ // JSON请求体
' field1 ' => ' value1 ' ,
' field2 ' => ' value2 '
],
' headers ' => [ ' Accept ' => ' application/json ' ]
]);
echo $ resp -> getStatusCode (). ' ' . $ resp -> getReasonPhrase (). "n" ;
echo $ resp -> getBody (). "n" ;
} catch ( RequestException $ e ) {
// 进行错误处理
echo $ e -> getMessage (). "n" ;
if ( $ e -> hasResponse ()) {
echo $ e -> getResponse ()-> getStatusCode (). ' ' . $ e -> getResponse ()-> getReasonPhrase (). "n" ;
echo $ e -> getResponse ()-> getBody ();
}
return ;
} // 参考上述指引说明，并引入 `MediaUtil` 正常初始化，无额外条件
use WechatPay GuzzleMiddleware Util MediaUtil ;
// 实例化一个媒体文件流，注意文件后缀名需符合接口要求
$ media = new MediaUtil ( ' /your/file/path/with.extension ' );
// 正常使用Guzzle发起API请求
try {
$ resp = $ client -> request ( ' POST ' , ' https://api.mch.weixin.qq.com/v3/[merchant/media/video_upload|marketing/favor/media/image-upload] ' , [
' body ' => $ media -> getStream (),
' headers ' => [
' Accept ' => ' application/json ' ,
' content-type ' => $ media -> getContentType (),
]
]);
// POST 语法糖
$ resp = $ client -> post ( ' merchant/media/upload ' , [
' body ' => $ media -> getStream (),
' headers ' => [
' Accept ' => ' application/json ' ,
' content-type ' => $ media -> getContentType (),
]
]);
echo $ resp -> getStatusCode (). ' ' . $ resp -> getReasonPhrase (). "n" ;
echo $ resp -> getBody (). "n" ;
} catch ( Exception $ e ) {
echo $ e -> getMessage (). "n" ;
if ( $ e -> hasResponse ()) {
echo $ e -> getResponse ()-> getStatusCode (). ' ' . $ e -> getResponse ()-> getReasonPhrase (). "n" ;
echo $ e -> getResponse ()-> getBody ();
}
return ;
} // 参考上上述说明，引入 `SensitiveInfoCrypto`
use WechatPay GuzzleMiddleware Util SensitiveInfoCrypto ;
// 上行加密API 多于 下行解密，默认为加密，实例后直接当方法用即可
$ encryptor = new SensitiveInfoCrypto (PemUtil:: loadCertificate ( ' /path/to/wechatpay/cert.pem ' ));
// 正常使用Guzzle发起API请求
try {
// POST 语法糖
$ resp = $ client -> post ( ' /v3/applyment4sub/applyment/ ' , [
' json ' => [
' business_code ' => ' APL_98761234 ' ,
' contact_info ' => [
' contact_name ' => $ encryptor ( ' value of `contact_name` ' ),
' contact_id_number ' => $ encryptor ( ' value of `contact_id_number ' ),
' mobile_phone ' => $ encryptor ( ' value of `mobile_phone` ' ),
' contact_email ' => $ encryptor ( ' value of `contact_email` ' ),
],
//...
],
' headers ' => [
// 命令行获取证书序列号
// openssl x509 -in /path/to/wechatpay/cert.pem -noout -serial | awk -F= '{print $2}'
// 或者使用工具类获取证书序列号 `PemUtil::parseCertificateSerialNo($certificate)`
' Wechatpay-Serial ' => ' must be the serial number via the downloaded pem file of `/v3/certificates` ' ,
' Accept ' => ' application/json ' ,
],
]);
echo $ resp -> getStatusCode (). ' ' . $ resp -> getReasonPhrase (). "n" ;
echo $ resp -> getBody (). "n" ;
} catch ( Exception $ e ) {
echo $ e -> getMessage (). "n" ;
if ( $ e -> hasResponse ()) {
echo $ e -> getResponse ()-> getStatusCode (). ' ' . $ e -> getResponse ()-> getReasonPhrase (). "n" ;
echo $ e -> getResponse ()-> getBody ();
}
return ;
}
// 单例加解密示例如下
$ crypto = new SensitiveInfoCrypto ( $ wechatpayCertificate , $ merchantPrivateKey );
$ encrypted = $ crypto ( ' Alice ' );
$ decrypted = $ crypto -> setStage ( ' decrypt ' )( $ encrypted ); Если локальные методы подписи и проверки по умолчанию не подходят для вашей системы, вы можете настроить подпись и проверку, внедрив Signer или Verifier . Например, если ваша система централизованно хранит закрытые ключи торговцев, а бизнес-системе необходимо выполнять подписи посредством удаленных вызовов, вы можете это сделать.
use WechatPay GuzzleMiddleware Auth Signer ;
use WechatPay GuzzleMiddleware Auth SignatureResult ;
use WechatPay GuzzleMiddleware Auth WechatPay2Credentials ;
class CustomSigner implements Signer
{
public function sign ( $ message )
{
// 调用签名RPC服务，然后返回包含签名和证书序列号的SignatureResult
return new SignatureResult ( ' xxxx ' , ' yyyyy ' );
}
}
$ credentials = new WechatPay2Credentials ( $ merchantId , new CustomSigner );
$ wechatpayMiddleware = WechatPayMiddleware:: builder ()
-> withCredentials ( $ credentials )
-> withWechatPay ([ $ wechatpayCertificate ])
-> build (); Для использования WechatPayMiddlewareBuilder требуется вызов withWechatpay для установки сертификата платежной платформы WeChat, а сертификат платформы можно загрузить только путем вызова API получения сертификата платформы. Чтобы разорвать «бесконечный цикл», вы можете временно «пропустить» проверку подписи ответа при первой загрузке сертификата платформы следующим образом.
use WechatPay GuzzleMiddleware Validator ;
class NoopValidator implements Validator
{
public function validate ( Psr Http Message ResponseInterface $ response )
{
return true ;
}
}
$ wechatpayMiddleware = WechatPayMiddleware:: builder ()
-> withMerchant ( $ merchantId , $ merchantSerialNumber , $ merchantPrivateKey )
-> withValidator ( new NoopValidator ) // NOTE: 设置一个空的应答签名验证器，**不要**用在业务请求
-> build ();Примечание . Используйте стандартный процесс инициализации для бизнес-запросов и обязательно проверьте подпись ответа.
Пожалуйста, обратитесь к AesUtil.php.
Рекомендуется обновиться до версии 4.6+. В версии 4.6.0 добавлена поддержка встроенного Curl (swoole/swoole-src#3863). Мы проверили, что его можно использовать в обычном режиме. Более подробную информацию см. в № 36.
Если вы обнаружили ОШИБКУ или у вас есть какие-либо вопросы или предложения, оставьте отзыв через проблему.
Также добро пожаловать в наше сообщество разработчиков.
