通过

将 winapp CLI 与 Flutter 配合使用

本指南演示如何将 winapp CLI 与 Flutter 应用程序配合使用，以 MSIX 的形式添加包标识和打包应用。

包标识是Windows app模型中的核心概念。 它允许应用程序access特定的 Windows API（例如通知、安全、AI API 等），具有全新安装/卸载体验等。

先决条件

  1. Flutter SDK：按照 官方指南安装 Flutter。

  2. winapp CLI：通过 winget 安装 winapp CLI：

    winget install Microsoft.winappcli --source winget

1.创建新的 Flutter 应用

按照官方 Flutter 文档中的指南创建新的应用程序并运行它。

2.更新代码以检查标识

添加 ffi 包：

flutter pub add ffi

用以下代码替换 lib/main.dart 的内容，该代码通过 Dart FFI 使用 Windows GetCurrentPackageFamilyName API 检查包标识。

import 'dart:ffi';
import 'dart:io' show Platform;

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

String? getPackageFamilyName() {
  if (!Platform.isWindows) return null;

  final kernel32 = DynamicLibrary.open('kernel32.dll');
  final getCurrentPackageFamilyName = kernel32.lookupFunction<
      Int32 Function(Pointer<Uint32>, Pointer<Uint16>),
      int Function(
          Pointer<Uint32>, Pointer<Uint16>)>('GetCurrentPackageFamilyName');

  final length = calloc<Uint32>();
  try {
    final result =
        getCurrentPackageFamilyName(length, Pointer<Uint16>.fromAddress(0));
    if (result != 122) return null; // ERROR_INSUFFICIENT_BUFFER = 122

    final namePtr = calloc<Uint16>(length.value);
    try {
      final result2 = getCurrentPackageFamilyName(length, namePtr);
      if (result2 == 0) {
        return namePtr.cast<Utf16>().toDartString();
      }
      return null;
    } finally {
      calloc.free(namePtr);
    }
  } finally {
    calloc.free(length);
  }
}

void main() {
  runApp(const MyApp());
}

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

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});
  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;
  late final String? _packageFamilyName;

  @override
  void initState() {
    super.initState();
    _packageFamilyName = getPackageFamilyName();
  }

  void _incrementCounter() {
    setState(() { _counter++; });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            Container(
              padding: const EdgeInsets.all(16),
              margin: const EdgeInsets.only(bottom: 24),
              decoration: BoxDecoration(
                color: _packageFamilyName != null
                    ? Colors.green.shade50
                    : Colors.orange.shade50,
                borderRadius: BorderRadius.circular(8),
                border: Border.all(
                  color: _packageFamilyName != null
                      ? Colors.green
                      : Colors.orange,
                ),
              ),
              child: Text(
                _packageFamilyName != null
                    ? 'Package Family Name:\n$_packageFamilyName'
                    : 'Not packaged',
                textAlign: TextAlign.center,
                style: Theme.of(context).textTheme.bodyLarge,
              ),
            ),
            const Text('You have pushed the button this many times:'),
            Text('$_counter',
                style: Theme.of(context).textTheme.headlineMedium),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}

3.在没有标识的情况下运行

生成并运行应用：

flutter build windows
.\build\windows\x64\runner\Release\flutter_app.exe

你应该会看到带有橙色“未打包”指示器的应用程序。

4. 使用 winapp CLI 初始化项目

winapp init

出现提示时：

  • 包名称：按 Enter 接受默认值
  • 发布者名称：按 Enter 接受默认值或输入名称
  • 版本：按 Enter 接受 1.0.0.0
  • 入口点：按 Enter 接受默认值（flutter_app.exe）
  • Setup SDK：选择“稳定 SDK”以下载Windows App SDK并生成 C++ 标头

5. 使用身份进行调试

  1. 生成应用：

    flutter build windows

  2. 应用调试标识：

    winapp create-debug-identity .\build\windows\x64\runner\Release\flutter_app.exe

  3. 运行可执行文件：

    .\build\windows\x64\runner\Release\flutter_app.exe

应会看到应用，其中显示程序包系列名称的绿色指示器。

注释

运行 flutter clean 或重新生成后，需要重新运行 create-debug-identity ，因为可执行文件被替换。

6. 使用 MSIX 打包

  1. 准备发布

    flutter build windows

  2. 准备包目录：

    mkdir dist
copy .\build\windows\x64\runner\Release\* .\dist\ -Recurse

  3. 生成开发证书：

    winapp cert generate --if-exists skip

  4. 打包和签名：

    winapp pack .\dist --cert .\devcert.pfx

  5. 安装证书 （以管理员身份运行）：

    winapp cert install .\devcert.pfx

  6. 安装包：

    Add-AppxPackage .\flutter-app.msix

小窍门

  • 微软商店为你签署MSIX，无需在提交之前签署。
  • Azure 受信任的签名是安全管理 CI/CD 管道证书的绝佳方法。
  • Last updated on