Flutter数据安全与防护插件datadome的使用

DataDome Flutter 插件是对 DataDome iOS 和 Android SDK 的适配。该插件提供了接口来执行网络请求，确保您的应用程序网络层受到 DataDome 的保护。该插件通过 URLSession API 在 iOS 上映射到原生 SDK，并通过 OkHttp API 在 Android 上映射到原生 SDK。显示验证码、管理cookies以及处理事件跟踪都由底层原生组件管理。

安装插件

要安装插件，请将 DataDome 依赖项添加到您的 pubspec.yaml 文件中：

dependencies:
  datadome: ^1.0.1
  flutter:
    sdk: flutter

注意：确保您的项目支持 Swift/Kotlin。如果不支持，请通过执行以下命令启用 Swift/Kotlin：

flutter create -i swift -a kotlin

对于iOS：

更新 iOS 项目的 Info.plist 文件：

1. 添加一个新条目，键为 DataDomeKey，值为您的 DataDome 客户端密钥。
2. 添加一个新条目，键为 DataDomeProxyEnabled，值为 NO（确保条目的类型为 Boolean）。

现在插件已经准备好使用了。

使用方法

DataDome Flutter 插件提供了一组 API 来执行网络请求。插件会执行请求，拦截来自 DataDome 远程保护模块的任何信号，如果有必要则显示验证码，然后重新尝试失败的请求。所有这些操作都由 DataDome 客户端管理。

初始化 DataDome 客户端

确保您创建了一个 DataDome 客户端实例：

DataDome client = DataDome('YOUR_DATADOME_CLIENT_SIDE_KEY');

根据请求类型，使用以下方法之一：

执行 GET/DELETE 请求

使用 DataDome 客户端的 get 或 delete 方法来执行 GET/DELETE 请求：

Future<http.Response> get({
    @required String url,
    Map<String, String> headers = const {}
}) async

Future<http.Response> delete({
    @required String url,
    Map<String, String> headers = const {}
}) async

方法接受以下参数：

• url：请求 URL 的字符串表示。
• headers：可选的包含头部字段和值的 Map。

该方法执行请求并返回 http.Response 实例。

这里是一个执行 GET 请求的示例代码：

// 导入所需包
import 'package:datadome/datadome.dart';
import 'package:http/http.dart' as http;

// 创建 DataDome 客户端
DataDome client = DataDome('DATADOME_CLIENT_SIDE_KEY');

// 执行 GET 请求
http.Response response = await client.get(url: 'https://datadome.co/wp-json');

// 使用响应
print('Response status: ${response.statusCode}');
print('Response headers: ${response.headers}');
print('Response body: ${response.body}');

执行 POST/PUT/PATCH 请求

使用 DataDome 客户端的以下方法之一来执行所需的请求：

POST

Future<http.Response> post({
      @required String url,
      Map<String, String> headers = const {},
      body
}) async

PUT

Future<http.Response> put({
      @required String url,
      Map<String, String> headers = const {},
      body
}) async

PATCH

Future<http.Response> patch({
      @required String url,
      Map<String, String> headers = const {},
      body
}) async

上述方法接受以下参数：

• url：请求 URL 的字符串表示。
• headers：可选的包含头部字段和值的 Map。
• body：请求体，可以是 List 或 Map 类型的数据。

该方法执行请求并返回 http.Response 实例。

这里是一个执行 POST 请求的示例代码：

// 导入所需包
import 'package:datadome/datadome.dart';
import 'package:http/http.dart' as http;

// 创建 DataDome 客户端
DataDome client = DataDome('DATADOME_CLIENT_SIDE_KEY');

// 执行 POST 请求
http.Response response = await client.post(url: 'https://jsonplaceholder.typicode.com/posts', body: {'title': 'foo', 'body': 'bar', 'userId': '1'});

// 使用响应
print('Response status: ${response.statusCode}');
print('Response headers: ${response.headers}');
print('Response body: ${response.body}');

强制显示验证码

为了测试和验证您的集成，可以使用特定的头部来强制 DataDome 远程保护模块阻止请求并强制底层原生 SDK 显示验证码。我们使用 User-Agent 头部并将值设置为 BLOCKUA 以提示远程模块阻止请求。请注意，验证码只会显示一次，然后生成的 cookie 将被存储在本地。

这里是一个执行 GET 请求并强制显示验证码的示例代码：

// 导入所需包
import 'package:datadome/datadome.dart';
import 'package:http/http.dart' as http;

// 创建 DataDome 客户端
DataDome client = DataDome('DATADOME_CLIENT_SIDE_KEY');

// 执行 GET 请求并强制显示验证码
http.Response response = await client.get(url: 'https://datadome.co/wp-json', headers: {'User-Agent': 'BLOCKUA'});

// 使用响应
print('Response status: ${response.statusCode}');
print('Response headers: ${response.headers}');
print('Response body: ${response.body}');

重要提示：不要在生产环境中留下此头部。这将导致所有用户至少看到一次验证码。

完整示例代码

import 'package:flutter/material.dart';
import 'package:datadome/datadome.dart';
import 'package:http/http.dart' as http;

void main() {
  runApp(MyApp());
}

class MyApp extends StatefulWidget {
  [@override](/user/override)
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {

  [@override](/user/override)
  void initState() {
    super.initState();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('DataDome 示例应用'),
        ),
        body: Center(
          child: MaterialButton(
            onPressed: () async {
              // 执行请求
              DataDome client = DataDome('client_key');

              http.Response response = await client.post(
                url: 'test_url',
                headers: {'User-Agent': 'BLOCKUA'},
                body: []
              );

              print('Response status: ${response.statusCode}');
              print('Response headers: ${response.headers}');
              print('Response body: ${response.body}');
            },
            child: Text('发起请求'),
          ),
        ),
      ),
    );
  }
}