Qt开源网络库[12]-身份验证

小灰灰 2022-09-12 09:49 193阅读 0赞

> 主要更新内容：添加了身份验证的支持。

当带有身份验证的请求时，我们需要填写用户名和密码等信息，但`QNetworkAccessManager`操作略显繁琐，所以特意封装了一下，简化用户操作。并在此基础上添加`自动填写用户信息`，`验证次数限制`和`错误处理`等功能。

### 1. 接口： ###

1.  自动填写身份验证信息。注：当QNetworkAccessManager的authenticationRequired信号触发时，会自动往QAuthenticator填写用户名和密码信息。

HttpRequest &autoAuthenticationRequired(const QAuthenticator &authenticator);
    HttpRequest &autoAuthenticationRequired(const QString &user, const QString &password);

1.  通过回调/槽函数手动填写身份验证信息。

inline HttpRequest &onAuthenticationRequired(const QObject *receiver, const char *method);
    inline HttpRequest &onAuthenticationRequired(std::function<void (QAuthenticator *)> lambda);

1.  设置限制身份验证的次数，超过身份验证计数则触发失败并中断请求。

<table> 
 <thead> 
  <tr> 
   <th>变量</th> 
   <th>解释</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>count &lt; 0</code></td> 
   <td>不限制验证次数</td> 
  </tr> 
  <tr> 
   <td><code>count = 0</code></td> 
   <td>不验证</td> 
  </tr> 
  <tr> 
   <td><code>count = 1</code></td> 
   <td>限制验证1次(默认值)</td> 
  </tr> 
  <tr> 
   <td><code>count &gt; 0</code></td> 
   <td>限制count次</td> 
  </tr> 
 </tbody> 
</table>

inline HttpRequest &authenticationRequiredCount(int count = 1);

1.  身份验证失败后错误回调。

inline HttpRequest &onAuthenticationRequireFailed(const QObject *receiver, const char *method);
    inline HttpRequest &onAuthenticationRequireFailed(std::function<void ()> lambda);
    inline HttpRequest &onAuthenticationRequireFailed(std::function<void (QNetworkReply *)> lambda);

### 2. 例子 ###

1.  身份验证

client.get("https://httpbin.org/basic-auth/admin/123456")
          .onAuthenticationRequired([](QAuthenticator *authenticator) { 
                authenticator->setUser("admin");
                authenticator->setPassword("123456");
                qDebug() << "=============";
            })
          .onSuccess([](QString result){ qDebug()<<"success: "<<result;})
          .onFailed([](QString err){ qDebug()<<"failed: "<<err;})
          .exec();

1.  身份自动验证

client.get("https://httpbin.org/basic-auth/admin/123456")
          .autoAuthenticationRequired("admin", "123456")
          .onSuccess([](QString result){ qDebug()<<"success: "<<result;})
          .onFailed([](QString err){ qDebug()<<"failed: "<<err;})
          .exec();

1.  身份验证次数与错误处理

client.get("https://httpbin.org/basic-auth/admin/123456")
          .authenticationRequiredCount(2) // 最大重试验证次数为2次(默认值为1次)
          .onAuthenticationRequired([](QAuthenticator *authenticator) { 
                authenticator->setUser("admin");
                authenticator->setPassword("1234563"); // 错误输入
            })
          .onAuthenticationRequireFailed([](){  // 验证身份失败的回调
                qDebug() << "authentication failed!";
            })
          .onSuccess([](QString result){ qDebug()<<"success: "<<result;})
          .onFailed([](QString err){ qDebug()<<"failed: "<<err;})
          .exec();

## 3. 注意 ##

*  `autoAuthenticationRequired`和`onAuthenticationRequired`不能同时使用，因为它们是互斥实现。如不慎同时使用，只会生效`autoAuthenticationRequired`操作。

## 4. 代码地址： ##

https://github.com/aeagean/QtNetworkService