Flutter IP构建工具插件dart_builder_ip的使用

Flutter IP构建工具插件dart_builder_ip的使用

问题

在开发与本地模拟器（如Firebase模拟器）交互的Flutter应用时，通常需要指定模拟器的IP地址。虽然在开发机上localhost可以正常工作，但在物理设备上运行应用时则无法使用。每次IP地址更改时手动更新它会非常麻烦。

解决方案

此包引入了一个源代码生成器，在构建应用时自动生成一个包含机器IP地址的常量。这使得您的应用可以在物理设备上连接到开发机上运行的模拟器。

使用方法

添加依赖

在pubspec.yaml文件中添加以下依赖：

dev_dependencies:
  build_runner: ^2.1.7
  builder_ip: ^1.0.0 # 替换为最新版本

创建build.yaml

创建或编辑build.yaml文件，添加以下内容：

targets:
  $default:
    builders:
      dart_builder_ip|builder_ip:
        generate_for:
          - lib/file_that_uses_builderIp.dart  # 替换为您实际使用的文件

在Dart代码中使用生成器

在需要使用IP地址的Dart文件中导入生成的文件，并使用生成的builderIp常量：

import 'file_that_uses_builderIp.builder-ip.dart';

void main() {
  print('Builder IP: $builderIp'); 
  // 使用builderIp来连接您的模拟器
}

示例：使用Firebase模拟器

以下是一个完整的示例，展示如何在使用Firebase模拟器时使用该插件：

import 'package:firebase_core/firebase_core.dart';
import 'package:flutter/material.dart';
import 'firebase_options.dart';

part 'main.builder-ip.dart'; // 导入生成的文件

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await Firebase.initializeApp(
    options: DefaultFirebaseOptions.currentPlatform,
  );

  if (kDebugMode) {
    FirebaseFirestore.instance.useFirestoreEmulator(builderIp, 8080);
    await FirebaseAuth.instance.useAuthEmulator(builderIp, 9099);
  }

  // 应用的其余部分...
}

注意：记得将main.dart添加到build.yaml文件中的generate_for列表中。

如何工作

builder_ip包利用了代码生成技术。在构建过程中，它会识别运行构建的机器的IP地址，并将其注入到您指定的Dart文件中的builderIp常量。

好处

  • 简化模拟器连接：无需再手动更新IP地址。
  • 改进开发流程：专注于构建应用，而不是配置连接。
  • 增强可移植性：轻松地在不同设备上运行应用而无需更改代码。

完整示例代码

// 导入生成的文件
part "dart_builder_ip_example.builder-ip.dart";

void main() {
  print('Builder ip: $builderIp');
}

更多关于Flutter IP构建工具插件dart_builder_ip的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter IP构建工具插件dart_builder_ip的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


dart_builder_ip 是一个用于在 Flutter 项目中生成 IP 地址相关代码的工具插件。它可以帮助开发者自动生成与 IP 地址相关的 Dart 代码，从而减少手动编写重复代码的工作量。以下是如何使用 dart_builder_ip 插件的基本步骤：

1. 添加依赖

首先，你需要在 pubspec.yaml 文件中添加 dart_builder_ip 插件的依赖。通常，这个插件会作为开发依赖（dev_dependencies）来使用。

dev_dependencies:
  dart_builder_ip: ^1.0.0  # 请使用最新版本

然后运行 flutter pub get 来获取依赖。

2. 配置 build.yaml

为了使用 dart_builder_ip，你需要在项目根目录下创建一个 build.yaml 文件，并配置生成器的相关设置。

targets:
  $default:
    builders:
      dart_builder_ip|ip_builder:
        enabled: true
        generate_for:
          - lib/**/*.dart

3. 定义 IP 地址模型

在你的 Dart 代码中，定义一个包含 IP 地址的模型类，并使用 @IP 注解来标记需要生成相关代码的字段。

import 'package:dart_builder_ip/annotations.dart';

part 'ip_model.g.dart';  // 生成的代码文件

@IP()
class IPModel {
  final String ipAddress;

  IPModel(this.ipAddress);
}

4. 运行代码生成器

在终端中运行以下命令来生成代码：

flutter pub run build_runner build

这将根据你在 IPModel 类中使用 @IP 注解的字段，生成相关的 IP 地址处理代码，并保存到 ip_model.g.dart 文件中。

5. 使用生成的代码

生成的代码会自动包含一些与 IP 地址相关的实用方法，例如验证 IP 地址的格式、转换 IP 地址的表示形式等。你可以直接在项目中使用这些方法。

void main() {
  var ipModel = IPModel('192.168.1.1');
  
  if (ipModel.isValidIP()) {
    print('Valid IP Address');
  } else {
    print('Invalid IP Address');
  }
}

6. 自动重建代码

如果你在开发过程中修改了模型类，可以再次运行 flutter pub run build_runner build 来重新生成代码。你也可以使用 flutter pub run build_runner watch 来监听文件变化并自动重建代码。

7. 处理生成的文件

生成的代码文件（如 ip_model.g.dart）通常会被 Git 忽略，因此你不需要手动管理这些文件。确保在 .gitignore 文件中包含以下内容：

*.g.dart
回到顶部