Flutter安全浏览插件safe_browsing的使用

使用google安全浏览API来检测URL是否安全。

必要条件

确保在Google云控制台中启用了安全浏览API：

• 步骤1: 前往 https://console.cloud.google.com/apis/library/safebrowsing.googleapis.com
• 步骤2: 选择当前项目
• 步骤3: 点击 启用

使用方法

该插件需要你使用 flutterfire_cli 创建 DefaultFirebaseOptions。更多详情请参阅 官方文档。

创建实例

/// 从 `DefaultFirebaseOptions` 创建实例
/// 此类由 `flutterfire_cli` 创建
final safeBrowsing = SafeBrowsing(
  options: DefaultFirebaseOptions.currentPlatform,
  isDebug: !kReleaseMode,
);

/// 想要检查的URL
final url = 'https://example.com';

/// 检查URL是否安全并返回 `SafeBrowsingState`
final state = await safeBrowsing.checkUrl(url);

/// 检查URL是否安全并返回 `bool`
final isSafe = await safeBrowsing.isUrlSafe(url);

检查结果的状态

state.isSafe // 表示结果是安全的
state.isNotSafe // 表示结果不安全。与 `!state.isSafe` 不同，因为可能会发生 `state.isError`
state.isError // 表示请求存在问题

请注意，!state.isSafe 与 state.isNotSafe 是不同的，因为 state.isError 可能会发生。

更具体的检查结果通过使用 state.type

/// 安全
SafeBrowsingStateType.safe

/// 不安全。查看 `state.matches` 获取详细信息。
SafeBrowsingStateType.notSafe

/// 输入为空
SafeBrowsingStateType.empty

/// 请求错误
SafeBrowsingStateType.requestError

/// 未知错误
SafeBrowsingStateType.unknown

当 state.isNotSafe 时获取威胁匹配列表

final listThreatMatches = state.matches;

高级用法

/// 检查条目
final state = await safeBrowsing.check(
  [ThreatEntry(url: 'url')],

  threatTypes: [
      ThreatType.MALWARE,
      ThreatType.SOCIAL_ENGINEERING,
      ThreatType.UNWANTED_SOFTWARE,
      ThreatType.POTENTIALLY_HARMFUL_APPLICATION,    
  ],

  platformTypes: [
      PlatformType.ALL_PLATFORMS,    
  ], 

  threatEntryTypes: [
      ThreatEntryType.URL,
  ],
);

额外功能

使用此方法验证URL：

SafeBrowsing.validateUrl(url);

示例代码

以下是完整的示例代码：

import 'package:flutter/material.dart';
import 'package:safe_browsing/safe_browsing.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  
  /// 从 `DefaultFirebaseOptions` 创建实例
  /// 此类由 `flutterfire_cli` 创建
  final safeBrowsing = SafeBrowsing(
    options: DefaultFirebaseOptions.currentPlatform,
    isDebug: !kReleaseMode,
  );

  runApp(MyApp(safeBrowsing: safeBrowsing));
}

class MyApp extends StatelessWidget {
  final SafeBrowsing safeBrowsing;

  MyApp({required this.safeBrowsing});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Safe Browsing Example')),
        body: Center(
          child: ElevatedButton(
            onPressed: () async {
              final url = 'https://example.com';
              
              /// 检查URL是否安全并返回 `SafeBrowsingState`
              final state = await safeBrowsing.checkUrl(url);
              
              /// 检查URL是否安全并返回 `bool`
              final isSafe = await safeBrowsing.isUrlSafe(url);
              
              if (state.isSafe) {
                print('$url is safe');
              } else if (state.isNotSafe) {
                print('$url is not safe');
              } else if (state.isError) {
                print('There was an error checking $url');
              }
            },
            child: Text('Check URL Safety'),
          ),
        ),
      ),
    );
  }
}