Flutter多渠道打包插件walle_kit的使用

Flutter多渠道打包插件walle_kit的使用

1. 简介

walle_kit 是一个用于Flutter项目的多渠道打包工具，基于美团的Walle库。它可以帮助开发者轻松地为不同的应用分发渠道生成带有渠道标识的APK文件。本文将详细介绍如何在Flutter项目中使用 walle_kit 进行多渠道打包，并提供一个完整的示例Demo。

2. 安装与配置

2.1 添加依赖

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

dependencies:
  walle_kit: ^latest_version  # 请替换为最新版本号

或者使用Git仓库中的快照版本：

dependencies:
  walle_kit:
    git:
      url: https://github.com/rxreader/walle_kit.git

2.2 配置 Android 项目

在 android/app/build.gradle 文件中应用 walle_kit 的 Gradle脚本。根据需求选择是否使用 flavors（产品变种）和是否支持360加固。

2.2.1 不使用 flavors

如果你不需要使用 flavors，可以直接在 build.gradle 中配置 walle_kit_v2.gradle 或 walle_kit.gradle。推荐使用 walle_kit_v2.gradle，因为它不依赖 CLI 方式，且不支持360加固。

// android/app/build.gradle
apply from: "${project(':walle_kit').projectDir}/walle_kit_v2.gradle"  // 推荐

walle {
    enabled = true

    tencent {
        secretId = 'your_secret_id'  // 腾讯云访问管理SecretId
        secretKey = 'your_secret_key'  // 腾讯云访问管理SecretKey
        channels = ['tencent', 'tencent-alias']  // 渠道列表
    }

    outputDir = file("${project.buildDir}/outputs/apk/walle")  // 输出目录
    fileNameFormat = '${appName}-${buildType}-${channelId}.apk'  // 文件命名格式
    channelFile = file('channel')  // 渠道配置文件路径
}

2.2.2 使用 flavors

如果你需要使用 flavors，可以在 build.gradle 中为每个 flavor 配置 walle_kit。

// android/app/build.gradle
android {
    productFlavors {
        prod {  // 定义一个名为prod的flavor
        }
    }

    walleConfigs {
        prod {  // 为prod flavor配置walle_kit
            enabled = true

            tencent {
                secretId = 'your_secret_id'  // 腾讯云访问管理SecretId
                secretKey = 'your_secret_key'  // 腾讯云访问管理SecretKey
                channels = ['tencent', 'tencent-alias']  // 渠道列表
            }

            outputDir = file("${project.buildDir}/outputs/apk/walle")  // 输出目录
            fileNameFormat = '${appName}-${buildType}-${channelId}.apk'  // 文件命名格式
            channelFile = file('channel')  // 渠道配置文件路径
        }
    }
}

walle {
    enabled = false  // 禁用默认配置
}

3. 渠道配置文件

walle_kit 支持通过 channel 文件或 channel.json 文件来定义渠道信息。你可以根据自己的需求选择合适的格式。

• channel 文件：每行一个渠道ID，适用于简单的渠道配置。

# channel
tencent
tencent-alias
qihu360
qihu360-alias

• channel.json 文件：支持更复杂的渠道配置，例如可以为每个渠道指定额外的参数。

{
  "channels": [
    {
      "id": "tencent",
      "extra": {
        "param1": "value1"
      }
    },
    {
      "id": "tencent-alias",
      "extra": {
        "param2": "value2"
      }
    }
  ]
}

4. 打包命令

完成上述配置后，你可以使用以下命令进行多渠道打包：

flutter build apk --release

walle_kit 会自动根据配置生成多个带有不同渠道标识的APK文件，并将它们保存到指定的输出目录中。

5. 示例代码

下面是一个完整的Flutter Demo，展示了如何在应用中获取并显示当前的渠道ID。

import 'dart:async';

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

void main() => runApp(MyApp());

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

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

class _MyAppState extends State<MyApp> {
  String _channelId = '';

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

  Future<void> _initChannelId() async {
    // 获取渠道ID
    final String? channelId = await Walle.instance.getChannelId();

    if (!mounted) {
      return;
    }

    // 更新UI
    setState(() {
      _channelId = channelId ?? 'unknown';
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('walle_kit 示例'),
        ),
        body: Center(
          child: Text('当前渠道ID: $_channelId\n'),
        ),
      ),
    );
  }
}