Flutter VPN配置插件wireguard_2govpn的使用

介绍

wireguard_2govpn 是一个用于通过 WireGuard 隧道设置和控制VPN连接的 Flutter 插件。

使用

初始化

首先，在你的项目中添加 wireguard_2govpn 依赖：

flutter pub add wireguard_2govpn

初始化 WireGuard 实例：

final wireguard = WireGuardFlutter.instance;

// 初始化接口
await wireguard.initialize(interfaceName: 'wg0');

然后声明 .conf 数据：

const String conf = '''[Interface]
PrivateKey = 0IZmHsxiNQ54TsUs0EQ71JNsa5f70zVf1LmDvON1CXc=
Address = 10.8.0.4/32
DNS = 1.1.1.1

[Peer]
PublicKey = 6uZg6T0J1bHuEmdqPx8OmxQ2ebBJ8TnVpnCdV8jHliQ=
PresharedKey = As6JiXcYcqwjSHxSOrmQT13uGVlBG90uXZWmtaezZVs=
AllowedIPs = 0.0.0.0/0, ::/0
PersistentKeepalive = 0
Endpoint = 38.180.13.85:51820''';

更多关于配置数据的信息，可以参见 文档 中的例子。

连接

初始化后，使用 startVpn 方法进行连接：

await wireguard.startVpn(
  serverAddress: address, // 例如 'demo.wireguard.com:51820'
  wgQuickConfig: conf, // 快速配置文件
  providerBundleIdentifier: 'com.example', // 你的应用标识符
);

断开连接

连接后，使用 stopVpn 方法断开连接：

await wireguard.stopVpn();

监听阶段变化

监听阶段变化使用 vpnStageSnapshot：

wireguard.vpnStageSnapshot.listen((event) {
  debugPrint("状态改变 $event");
});

或者获取当前阶段使用 getStage：

final stage = await wireguard.stage();

可用阶段包括：

支持的平台

Windows

在 Windows 上，应用必须以管理员身份运行才能创建和操作隧道。要调试应用，请从提升后的命令提示符运行 flutter run。要正常运行应用，系统会请求你以管理员身份运行应用。无需进行代码更改或外部依赖。

Linux

安装依赖

需要安装以下依赖：wireguard 和 wireguard-tools。

在 Ubuntu/Debian 上，使用以下命令安装依赖：

sudo apt install wireguard wireguard-tools openresolv

对于其他 Linux 发行版，请参阅 这里。

注意： 如果系统中未安装 openresolv，配置文件中的 DNS 可能无法连接。更多信息请参阅 此问题。

初始化

当调用 wireguard.initialize 时，应用程序将请求用户密码（[sudo] password for <user>:）。这是必要的，因为 WireGuard 必须以 root 身份运行才能创建和操作隧道。这适用于调试模式、发布模式或分布式可执行文件。

警告： 不要在 root 模式下运行应用（例如 sudo ./executable 或 sudo flutter run），否则连接将无法建立。

常见问题及故障排除

Linux 错误 resolvconf: command not found

在 Linux 上，可能会收到错误 resolvconf: command not found。这是因为 WireGuard 尝试调整名称服务器。确保安装了 openresolv 或不提供 “DNS” 字段。

示例代码

以下是一个完整的示例代码，展示了如何使用 wireguard_2govpn 插件：

import 'dart:async';

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

void main() {
  runApp(
    MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('WireGuard 示例应用'),
        ),
        body: const MyApp(),
      ),
    ),
  );
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final wireguard = WireGuardFlutter.instance;

  late String name;

  [@override](/user/override)
  void initState() {
    super.initState();
    wireguard.vpnStageSnapshot.listen((event) {
      debugPrint("状态改变 $event");
      if (mounted) {
        ScaffoldMessenger.of(context).clearSnackBars();
        ScaffoldMessenger.of(context).showSnackBar(SnackBar(
          content: Text('状态改变: $event'),
        ));
      }
    });
    name = 'my_wg_vpn';
  }

  Future<void> initialize() async {
    try {
      await wireguard.initialize(interfaceName: name);
      debugPrint("初始化成功 $name");
    } catch (error, stack) {
      debugPrint("初始化失败: $error\n$stack");
    }
  }

  void startVpn() async {
    try {
      await wireguard.startVpn(
        serverAddress: '167.235.55.239:51820',
        wgQuickConfig: conf,
        providerBundleIdentifier: 'com.billion.wireguardvpn.WGExtension',
      );
    } catch (error, stack) {
      debugPrint("启动失败 $error\n$stack");
    }
  }

  void disconnect() async {
    try {
      await wireguard.stopVpn();
    } catch (e, str) {
      debugPrint('断开失败 $e\n$str');
    }
  }

  void getStatus() async {
    debugPrint("获取状态");
    final stage = await wireguard.stage();
    debugPrint("阶段: $stage");

    if (mounted) {
      ScaffoldMessenger.of(context).showSnackBar(SnackBar(
        content: Text('阶段: $stage'),
      ));
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Container(
      constraints: const BoxConstraints.expand(),
      padding: const EdgeInsets.all(16),
      child: Column(
        mainAxisAlignment: MainAxisAlignment.center,
        crossAxisAlignment: CrossAxisAlignment.center,
        children: [
          const SizedBox(height: 20),
          TextButton(
            onPressed: initialize,
            style: ButtonStyle(
                minimumSize: MaterialStateProperty.all<Size>(const Size(100, 50)),
                padding: MaterialStateProperty.all(const EdgeInsets.fromLTRB(20, 15, 20, 15)),
                backgroundColor: MaterialStateProperty.all<Color>(Colors.blueAccent),
                overlayColor: MaterialStateProperty.all<Color>(Colors.white.withOpacity(0.1))),
            child: const Text(
              '初始化',
              style: TextStyle(color: Colors.white),
            ),
          ),
          const SizedBox(height: 20),
          TextButton(
            onPressed: startVpn,
            style: ButtonStyle(
                minimumSize: MaterialStateProperty.all<Size>(const Size(100, 50)),
                padding: MaterialStateProperty.all(const EdgeInsets.fromLTRB(20, 15, 20, 15)),
                backgroundColor: MaterialStateProperty.all<Color>(Colors.blueAccent),
                overlayColor: MaterialStateProperty.all<Color>(Colors.white.withOpacity(0.1))),
            child: const Text(
              '连接',
              style: TextStyle(color: Colors.white),
            ),
          ),
          const SizedBox(height: 20),
          TextButton(
            onPressed: disconnect,
            style: ButtonStyle(
                minimumSize: MaterialStateProperty.all<Size>(const Size(100, 50)),
                padding: MaterialStateProperty.all(const EdgeInsets.fromLTRB(20, 15, 20, 15)),
                backgroundColor: MaterialStateProperty.all<Color>(Colors.blueAccent),
                overlayColor: MaterialStateProperty.all<Color>(Colors.white.withOpacity(0.1))),
            child: const Text(
              '断开连接',
              style: TextStyle(color: Colors.white),
            ),
          ),
          const SizedBox(height: 20),
          TextButton(
            onPressed: getStatus,
            style: ButtonStyle(
                minimumSize: MaterialStateProperty.all<Size>(const Size(100, 50)),
                padding: MaterialStateProperty.all(const EdgeInsets.fromLTRB(20, 15, 20, 15)),
                backgroundColor: MaterialStateProperty.all<Color>(Colors.blueAccent),
                overlayColor: MaterialStateProperty.all<Color>(Colors.white.withOpacity(0.1))),
            child: const Text(
              '获取状态',
              style: TextStyle(color: Colors.white),
            ),
          ),
        ],
      ),
    );
  }
}

const String conf = '''[Interface]
PrivateKey = 0IZmHsxiNQ54TsUs0EQ71JNsa5f70zVf1LmDvON1CXc=
Address = 10.8.0.4/32
DNS = 1.1.1.1

[Peer]
PublicKey = 6uZg6T0J1bHuEmdqPx8OmxQ2ebBJ8TnVpnCdV8jHliQ=
PresharedKey = As6JiXcYcqwjSHxSOrmQT13uGVlBG90uXZWmtaezZVs=
AllowedIPs = 0.0.0.0/0, ::/0
PersistentKeepalive = 0
Endpoint = 38.180.13.85:51820''';