wechatpay guzzle middleware
1.0.0
O middleware Guzzle HttpClient da API de pagamento WeChat v3 implementa a geração de assinaturas de solicitação e a verificação de assinaturas de resposta.
Se você for um desenvolvedor comercial usando Guzzle, poderá passar WechatPayGuzzleMiddleware ao construir GuzzleHttpClient . A instância GuzzleHttpClient resultante carregará automaticamente informações de autenticação de identidade ao executar uma solicitação e verificará a assinatura WeChat Pay da resposta.
A versão atual é a versão de teste 0.2.0 . Preste atenção à correção e compatibilidade do sistema e software, bem como aos riscos envolvidos, ao utilizar o pessoal profissional e técnico do comerciante.
Este projeto está em manutenção . Recomendamos que todos os desenvolvedores dêem prioridade ao uso da nova biblioteca de desenvolvimento PHP do WeChat Pay, wechatpay-php.
O ambiente que usamos para desenvolvimento e teste é o seguinte:
Nota: A razão específica pela qual guzzle7 não é suportado pode ser encontrada na discussão no item 54. Desenvolvedores que confiam no guzzle7 use wechatpay-php.
Você pode usar o compositor da ferramenta de gerenciamento de pacotes PHP para introduzir o SDK no projeto:
Método 1: No diretório do projeto, adicione através da linha de comando do compositor:
composer require wechatpay/wechatpay-guzzle-middlewareMétodo 2: adicione a seguinte configuração ao compositor.json do projeto:
"require" : {
"wechatpay/wechatpay-guzzle-middleware" : " ^0.2.0 "
}Após adicionar a configuração, execute a instalação
composer install Primeiro, crie um WechatPayMiddleware por meio de WechatPayMiddlewareBuilder e, em seguida, adicione-o ao HandlerStack de GuzzleHttpClient . Fornecemos métodos correspondentes para transmitir informações de maneira conveniente, como chaves privadas de comerciantes e certificados da plataforma de pagamento 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 ); Quando os métodos locais padrão de assinatura e verificação não são adequados para o seu sistema, você pode personalizar a assinatura e a verificação implementando Signer ou Verifier . Por exemplo, se o seu sistema armazena centralmente chaves privadas do comerciante e o sistema comercial precisa executar assinaturas por meio de chamadas remotas, você pode fazer isso.
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 (); Usar WechatPayMiddlewareBuilder requer chamar withWechatpay para definir o certificado da plataforma de pagamento WeChat, e o certificado da plataforma só pode ser baixado chamando a API Get Platform Certificate. Para quebrar o "loop infinito", você pode "ignorar" temporariamente a verificação da assinatura da resposta ao baixar o certificado da plataforma pela primeira vez, como segue.
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 ();Observação : use o processo de inicialização padrão para solicitações comerciais e certifique-se de verificar a assinatura da resposta.
Consulte AesUtil.php.
Recomenda-se atualizar para o swoole 4.6+. O swoole adicionou suporte a curl nativo (swoole/swoole-src#3863) na versão 4.6.0. Para informações mais detalhadas, consulte o nº 36.
Se você encontrar um BUG ou tiver alguma dúvida ou sugestão, forneça feedback sobre o problema.
Bem-vindo também à nossa comunidade de desenvolvedores.
