Flutter虚拟专用网络插件blackhole_vpn的使用

Flutter虚拟专用网络插件blackhole_vpn的使用

Blackhole Vpn设置了一个虚拟专用网络（VPN）客户端，用于阻止选定应用的连接。

Android有VpnManager API，可以为指定的应用创建一个VPN连接。通过此插件，选定应用的网络将由一个不进行任何实际连接的虚拟专用网络管理。

无需root权限。

支持的平台

• Android

欢迎提交其他平台的支持请求。

使用场景

• 防火墙应用
• 节省数据的应用

如何使用

此插件使用BIND_VPN_SERVICE权限来设置VPN服务。

如果你希望在Google Play商店发布你的应用，你需要在商店列表中记录使用VPN服务的情况。更多信息可以在这里查看。

不需要编辑AndroidManifest.xml

确保在android/app/build.gradle中的最低SDK版本为21或更高：

defaultConfig {
    minSdkVersion 21
}

导入包

所有方法在导入包并获取插件实例后可用：

import 'package:blackhole_vpn/blackhole_vpn.dart';
final blackholeVpn = BlackholeVpnPlatform.instance;

启动VPN以指定应用

你必须知道你想使用的应用的包名。例如应用使用了android_package_manager插件。

// 请求权限然后启动黑洞VPN以指定应用
await blackholeVpn.runVpnService(["com.google.youtube", "com.android.chrome"]);

指定应用将无法连接到互联网和本地网络。返回一个bool值表示用户是否接受权限。

检查黑洞VPN是否激活

await blackholeVpn.isActive(); // 返回一个bool值

停止黑洞VPN

await blackholeVpn.stopVpn(); // 用户也可以通过VPN通知或系统设置停止它

跟踪VPN状态变化

Android允许用户通过VPN通知或系统设置启动或停止VPN服务。你可以通过特定的方法跟踪VPN状态的变化。

• 使用VpnStateObserver小部件

VpnStateObserver(
    builder: (isActive) => switch (isActive) {
        true => Text("Blackhole vpn active"),
        false => Text("Blackhole vpn not active"),
        null => Text("Loading")
    })

• 监听vpnStatusStream

blackholeVpn.vpnStatusStream.listen((isActive) {
    if (isActive) {
        print("Blackhole vpn active");
    } else {
        print("Blackhole vpn not active");
    }
});

// `vpnStatusStream`是一个广播流，它可以被多次监听。如果VPN状态未改变，它可能不会发出任何值。在监听之前检查状态与`isActive()`推荐。

测试

import 'package:flutter_test/flutter_test.dart';
import 'package:blackhole_vpn/blackhole_vpn.dart';
import 'package:blackhole_vpn/blackhole_vpn_platform_interface.dart';
import 'package:plugin_platform_interface/plugin_platform_interface.dart';

class TestBlackholeVpnPlatform
    with MockPlatformInterfaceMixin
    implements BlackholeVpnPlatform {
  var _isActive = false;
  [@override](/user/override)
  Future<bool> runVpnService(_) async {
    _isActive = true;
    return true;
  }

  [@override](/user/override)
  Future<bool> isActive() async {
    return _isActive;
  }

  [@override](/user/override)
  Future<void> stopVpnService() async {
    _isActive = false;
  }

  [@override](/user/override)
  Stream<bool> getVpnStatusStream() => throw UnimplementedError();
}

void main() {
  BlackholeVpnPlatform.instance = TestBlackholeVpnPlatform();
  test('test runVpnService', () async {
    final blackholeVpn = BlackholeVpnPlatform.instance;
    expect(await blackholeVpn.runVpnService([]), isTrue);
    expect(await blackholeVpn.isActive(), isTrue);
  });
}

示例代码

import 'dart:developer' show log;

import 'package:flutter/material.dart';
import 'package:blackhole_vpn/blackhole_vpn.dart';
import 'package:android_package_manager/android_package_manager.dart';

final blackholeVpn = BlackholeVpnPlatform.instance;
void main() async {
  WidgetsFlutterBinding.ensureInitialized(); // 添加这行以便在运行应用前使用flutter插件
  final isVpnActive = await blackholeVpn.isActive(); // 获取VPN是否已激活

  // 在示例应用中，我们使用了一个来自这里的flutter插件: https://pub.dev/packages/android_package_manager
  final installedApps = await AndroidPackageManager().getInstalledApplications();

  // 使用Set而不是List，因为相同的app名称可能会重复。
  final installedAppsNames = {
    for (final app in installedApps!) if (app.name != null) app.name!
  };

  runApp(MyApp(
    isVpnActive: isVpnActive,
    installedAppNames: installedAppsNames.toList(),
  ));
}

class MyApp extends StatefulWidget {
  const MyApp({
    super.key,
    required this.isVpnActive,
    required this.installedAppNames,
  });
  final bool isVpnActive;
  final List<String> installedAppNames;
  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  late var _isVpnOn = widget.isVpnActive;

  // 选择要传递给blackhole vpn的应用
  final _selectedApps = <String>[];

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Blackhole Vpn Example'),
        ),
        body: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            VpnStateObserver(
                builder: (isActive) => switch (isActive) {
                      true => const Text("Blackhole vpn active"),
                      false => const Text(
                          "Select the apps which you want to prevent to connect internet"),
                      null => const Text("Loading")
                    }),
            Expanded(
              child: ListView.builder(
                itemCount: widget.installedAppNames.length,
                itemBuilder: (context, index) {
                  final appName = widget.installedAppNames[index];
                  return SwitchListTile(
                    title: Text(appName),
                    value: _selectedApps.contains(appName),
                    onChanged: (bool value) {
                      if (value) {
                        setState(() {
                          _selectedApps.add(appName);
                        });
                      } else {
                        setState(() {
                          _selectedApps.remove(appName);
                        });
                      }
                    },
                  );
                },
              ),
            ),
            ElevatedButton(
                onPressed: _isVpnOn
                    ? () async {
                        await blackholeVpn
                            .stopVpnService(); // 停止Blackhole Vpn
                        setState(() {
                          _isVpnOn = false;
                        });
                      }
                    : () async {
                        // 启动vpn服务
                        final isActivated =
                            await blackholeVpn.runVpnService(_selectedApps);
                        if (isActivated) {
                          // Vpn权限已授予
                          setState(() {
                            _isVpnOn = true;
                          });
                        } else {
                          // Vpn权限未授予
                          log("Vpn permission not granted");
                        }
                      },
                child: Text(
                    _isVpnOn ? "Stop Blackhole Vpn" : "Start Blackhole Vpn"))
          ],
        ),
      ),
    );
  }
}