Flutter问题记录 - Flutter插件创建Package项目报错：At least one platform must be selected

古城微笑少年丶 2024-05-24 21:43 100阅读 0赞

#### 文章目录 ####

*  前言
 *  开发环境
 *  问题描述
 *  问题分析
 *  解决方案
 *  总结
 *  最后

--------------------

## 前言 ##

大概一个多月前我遇到了这个问题，当时搜了搜发现在2021年出现过这个[问题][Link 1]，不过已经修复了，所以现在这个肯定又是一个新问题。当时简单折腾了一下，发现解决不了便先通过Flutter命令行工具创建Package项目，忙着工作忘了提个issue。

时隔一个多月，更新了Flutter和Flutter插件，创建Package项目发现问题竟然还在，不过已经有人提了[issue][]，这个问题的修复计划已经添加到了[里程碑][Link 2]，预计在72版本修复。

**2023/02/05更新：新发布的72.0版本已经修复该问题，涉及该问题修复的[PR][]。如果你只是想快速解决问题，升级Flutter插件版本即可。如果你对产生问题的原因感兴趣，欢迎阅读以下内容。**

## 开发环境 ##

*  Android Studio: 2021.3.1 Patch 1
 *  Flutter: 3.3.10
 *  Flutter插件: 71.2.3

## 问题描述 ##

通过Flutter插件创建Package项目，点击"Finish"按钮后创建Package项目失败并弹框报错：

![screenshot1][]

根据报错信息提示需要选择platform，但是现在是置灰的选择不了：

![screenshot2][]

正常情况下应该是这样的：

![screenshot3][]

## 问题分析 ##

首先怀疑是不是Flutter插件版本没更新导致的问题，检查发现已经是最新版本，卸载重装Flutter插件问题依旧还在。接着尝试升级Flutter版本，从3.3.5版本升到当时最新的3.3.8版本，问题依旧存在。

试了试在同事电脑上创建Package项目，一切正常。对比两台电脑的Flutter插件版本，我电脑上的版本是71.0.3，同事电脑上的版本是70.0.2，这两个版本有什么区别呢？

[Flutter插件版本列表][Flutter]部分截图：

![screenshot4][]

从上图中可以看出，Flutter插件版本主要看前两个数字，最后一个数字应该是用于兼容不同的Android Studio（IDEA）版本，不同的IDEA版本有不同的JDK版本等要求。通过Flutter插件的版本说明也可以看出，插件版本看前两个数字。

![screenshot5][]

现在两个插件版本除了大版本不一样，用于兼容处理的版本也不一样，所以可以初步确定，Flutter插件的问题不是出在功能更新上，就是Android Studio（IDEA）版本兼容出了问题，不过后者的可能性比较低。

先排查是不是Flutter插件功能更新引起的问题，把[Flutter插件仓库][Flutter 1]代码拉到本地，搜索关键词`At least one platform must be selected`定位报错位置：

![screenshot6][]

继续搜索关键词`npw_none_selected_error`：

![screenshot7][]

报错位置找到了，继续搜索关键词`isSomePlatformSelected`查看方法定义：

![screenshot8][]

从`isSomePlatformSelected`的方法定义可以看出，如果一个平台都没选择会返回false从而导致报错。可问题是，创建Package项目时支持的平台选项都置灰了，根本没办法选择。这块代码在70版本到71版本之间极有可能做了改动，现在需要定位Git历史提交记录看做了什么改动。\[选中`settings.isSomePlatformSelected()`\] -> \[右击选择Git\] -> \[`Show History for Selection`\]，通过这个操作可以快速定位这部分代码涉及的Git历史提交记录。

![screenshot9][]

`settings.isSomePlatformSelected()`代码涉及的Git历史提交记录：

![screenshot10][]

可以看到70版本到71版本之间有一个在10月28号的提交记录，继续往下查看这个提交改动了什么。

![screenshot11][]

比较代码可以看到移除了`isShowingPlatforms`判断，这个方法在当前插件项目中已经移除，所以搜索不到，不过我们可以查看这个[提交记录][Link 3]的全部改动。

![screenshot12][]

`isShowingPlatforms`的值由`projectTypeHasPlatforms`和`platformsForm.shouldBeVisible`决定，`projectTypeHasPlatforms`的定义看下图：

![screenshot13][]

从图中被移除的代码可以看出，如果项目类型为Package会返回false，也就是说70版本的时候这个逻辑是没问题的，71版本少了这个判断导致在`validateSettings`方法校验设置的时候报错。至于`platformsForm.shouldBeVisible`这个方法的移除应该不是导致这个问题的原因，`platformsForm.shouldBeVisible`的定义如下：

![screenshot14][]

图中`ch.id > ID.STABLE || sdkGetter.get().version.stableChannelSupportsPlatforms()`代码的作用是如果当前Flutter SDK渠道不是稳定版直接返回true，也就是创建项目时支持的平台是可见的，如果当前是稳定版，则需要判断一下当前版本是否大于最大不支持平台选择的稳定版本。简单来说就是Flutter在`1.22.6`版本以后才支持平台选择，所以需要做兼容判断。

查看这个提交记录的过程，我发现了71版本平台选项置灰不可选择的原因。

![screenshot15][]

`areLanguageFeaturesVisible`的定义：

boolean areLanguageFeaturesVisible = projectType != FlutterProjectType.PACKAGE && projectType != FlutterProjectType.MODULE;

71版本之前，`isShowingPlatforms`为true才设置平台表单组件是否可选择，这就导致创建项目类型为`PACKAGE`或`MODULE`的项目时默认可以选择平台，但这个选择是不生效的。在Flutter插件项目中`FlutterCreateAdditionalSettingsFields`类中的`getAdditionalSettings`方法对平台选项做了过滤，不符合项目类型的平台相关参数会被设为`null`。  
`PACKAGE`和`MODULE`这两个项目类型选择平台不生效的原因有点不同，`PACKAGE`项目是纯dart项目，不区分平台，`MODULE`项目默认只支持Android和iOS两个平台，无法自定义，感兴趣的可以翻一翻[Flutter关于命令行创建项目的代码][Flutter 2]。

Flutter关于命令行创建项目的部分代码：

![screenshot16][]

71版本改动后，平台表单组件可不可以选择完全由`areLanguageFeaturesVisible`属性决定。

到此，问题分析完了，后续的修复很简单就不赘述，感兴趣的可以看看我提的这个[PR][]。

## 解决方案 ##

最好的方案就是等待Flutter插件问题修复后更新，如果你急着创建Package项目，这边提供两种解决方案：

1.  Flutter插件降版本

前往[Flutter插件版本列表][Flutter]下载`70.2.X`版本，具体的`X`请对照自己安装的Android Studio（IDEA）版本，例如Android Studio 2021.3.1 版本对应的插件版本是70.2.3。下载完成后，如果系统自动对压缩文件做了解压处理并移到了废纸篓，需要将移到废纸篓的`flutter-intellij.zip`文件放回原处，这是因为Android Studio安装插件时需要插件的压缩文件，选择解压后的文件是无法安装成功的。

Android Studio插件安装步骤请看下图：

![screenshot17][]

如果已经安装有最新版本的Flutter插件，不用先卸载，Android Studio支持覆盖安装插件。安装成功后可以看到版本变为了70.2.3：

![screenshot18][]

这时就暂时别升级版本了，等问题修复后再升级。

1.  Flutter命令行工具创建Package项目

虽然Flutter插件创建Package项目有问题，但是命令行工具是没问题的。创建Package项目是个低频操作，完全可以先通过命令行工具临时解决。

先看看Flutter插件正常创建Package项目时需要什么参数：

![screenshot3][]

可以看到创建一个Package项目需要五个参数，一是项目名称，二是项目路径，三是项目描述，四是项目类型，五是支持的平台，根据前面的问题分析，支持的平台参数是不需要的。

再来看看Flutter创建命令有什么参数可以用：

flutter help create

执行输出（省略部分）：

Usage: flutter create <output directory>
    -h, --help                   Print this usage information.
        --[no-]pub               Whether to run "flutter pub get" after the project
                                 has been created.
                                 (defaults to on)
        --[no-]offline           When "flutter pub get" is run by the create
                                 command, this indicates whether to run it in
                                 offline mode or not. In offline mode, it will need
                                 to have all dependencies already available in the
                                 pub cache to succeed.
        --[no-]overwrite         When performing operations, overwrite existing
                                 files.
        --description            The description to use for your new Flutter
                                 project. This string ends up in the pubspec.yaml
                                 file.
                                 (defaults to "A new Flutter project.")
        --org                    The organization responsible for your new Flutter
                                 project, in reverse domain name notation. This
                                 string is used in Java package names and as prefix
                                 in the iOS bundle identifier.
                                 (defaults to "com.example")
        --project-name           The project name for this new Flutter project. This
                                 must be a valid dart package name.
    -i, --ios-language           The language to use for iOS-specific code, either
                                 Objective-C (legacy) or Swift (recommended).
                                 [objc, swift (default)]
    -a, --android-language       The language to use for Android-specific code,
                                 either Java (legacy) or Kotlin (recommended).
                                 [java, kotlin (default)]
        --platforms              The platforms supported by this project. Platform
                                 folders (e.g. android/) will be generated in the
                                 target project. This argument only works when
                                 "--template" is set to app or plugin. When adding
                                 platforms to a plugin project, the pubspec.yaml
                                 will be updated with the requested platform. Adding
                                 desktop platforms requires the corresponding
                                 desktop config setting to be enabled.
                                 [ios (default), android (default), windows
                                 (default), linux (default), macos (default), web
                                 (default)]
    -t, --template=<type>        Specify the type of project to create.
    
              [app]              (default) Generate a Flutter application.
              [module]           Generate a project to add a Flutter module to an
                                 existing Android or iOS application.
              [package]          Generate a shareable Flutter project containing
                                 modular Dart code.
              [plugin]           Generate a shareable Flutter project containing an
                                 API in Dart code with a platform-specific
                                 implementation through method channels for Android,
                                 iOS, Linux, macOS, Windows, web, or any combination
                                 of these.
              [plugin_ffi]       Generate a shareable Flutter project containing an
                                 API in Dart code with a platform-specific
                                 implementation through dart:ffi for Android, iOS,
                                 Linux, macOS, Windows, or any combination of these.
              [skeleton]         Generate a List View / Detail View Flutter
                                 application that follows community best practices.
    
    -s, --sample=<id>            Specifies the Flutter code sample to use as the
                                 "main.dart" for an application. Implies
                                 "--template=app". The value should be the sample ID
                                 of the desired sample from the API documentation
                                 website (http://docs.flutter.dev/). An example can
                                 be found at:
                                 https://api.flutter.dev/flutter/widgets/SingleChild
                                 ScrollView-class.html
        --list-samples=<path>    Specifies a JSON output file for a listing of
                                 Flutter code samples that can be created with
                                 "--sample".

可以看到flutter create后面跟的占位参数`<output directory>`就是用来指定项目路径的，项目名称通过`--project-name`指定，项目描述通过`--description`指定，项目类型通过`-t`或`--template`指定。到此，创建Package项目的参数已经集齐，创建命令格式如下：

flutter create 项目路径 --project-name 项目名称 --description 项目描述 -t package

项目描述不是很重要而且后面可以随时在`pubspec.yaml`文件内修改，所以可以暂时不指定：

flutter create 项目路径 --project-name 项目名称 -t package

到此，第二种方案写完啦。以下是一些不太重要的探索，不感兴趣的可以略过。

根据问题分析中对Flutter插件项目的理解，创建项目类型为`PACKAGE`或`MODULE`的项目时，选择支持的平台是无效的。那Flutter创建命令是这样的吗？查看`--platforms`的描述里面说明了只有项目类型指定为`app`或`plugin`时才有效（描述有点小问题，后面增加的`plugin_ffi`和`skeleton`也是支持选择平台，在Flutter 3.6版本会增加`-e, --[no-]empty`参数用于指定`EMPTY`项目类型，这个也支持选择平台），现在可以确定Flutter创建命令也是这样的。如果创建Package项目时指定了`--platforms`会报以下错误：

The "--platforms" argument is not supported in package template.

通过以上报错信息，我们可以定位到前面提到的[Flutter关于命令行创建项目的代码][Flutter 2]：

![screenshot19][]

再通过查找报错信息涉及的Git历史提交记录，可以看到这段报错信息是在Flutter `plugin`项目创建支持指定`--platforms`时添加的，于2020年6月提交。

![screenshot20][]

那Flutter插件关于平台是否可选择的代码是在什么时候添加的呢？

![screenshot21][]

从历史提交记录可以看到，是在2021年2月添加的。在2月19号首次提交时，平台表单组件可不可以选择完全由`areLanguageFeaturesVisible`属性决定，在2月24号不知道因为什么原因加上了`isShowingPlatforms`判断，一直持续到了2022年10月28号。Flutter插件支持平台选择的提交记录可以追溯到2020年12月，从支持平台选择开始到平台不可以选择（置灰），这段期间创建Package项目时指定的平台都是无效的。

可能有人会有点疑惑，在[Pub][]仓库能看到一些Package类型的库显示只支持某些平台，不是说Package项目创建时指定平台无效吗？关于这个，感兴趣的请看这篇文章[Flutter & Dart - Package类型项目的平台支持][Flutter _ Dart - Package]。

## 总结 ##

写这篇文章初衷只是想简单记录一下这个问题，结果在梳理问题的过程中越写越多，谁能想到就这么一个小问题牵扯的东西一点也不少。本来元旦写的差不多了，结果忙忘记了一直没发。

## 最后 ##

如果这篇文章对你有所帮助，请不要吝啬你的点赞?加星?，谢谢～

[Link 1]: https://github.com/flutter/flutter-intellij/issues/5249
[issue]: https://github.com/flutter/flutter-intellij/issues/6431
[Link 2]: https://github.com/flutter/flutter-intellij/milestone/84
[PR]: https://github.com/flutter/flutter-intellij/pull/6542
[screenshot1]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/61befb945d3442548b9ba9c45cdf1dc6.png
[screenshot2]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/beac57def0d4480bbffc6f8f85509045.png
[screenshot3]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/526d7ccd7dea43b3a74165c97c70110e.png
[Flutter]: https://plugins.jetbrains.com/plugin/9212-flutter/versions/stable
[screenshot4]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/7618c048f3e146a490ca70a2305083ed.png
[screenshot5]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/79a60dda1e354f0e89427be1c2406f93.png
[Flutter 1]: https://github.com/flutter/flutter-intellij
[screenshot6]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/8fd953b51fa344eab77a509f8946682a.png
[screenshot7]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/fbafa3d36c6947c29f46dc0d8fbdb309.png
[screenshot8]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/6d7c217aab4545a990daac73748b8b9f.png
[screenshot9]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/47da39edd7a045dcad177a322a1b768e.png
[screenshot10]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/5e482c132efe4c0facf126581e7a7bcd.png
[screenshot11]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/bbfcf9f087754be7b5cc35f3e974b182.png
[Link 3]: https://github.com/flutter/flutter-intellij/commit/b471e1f288627eb5f6172c76f3d9d8042dfad220
[screenshot12]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/e29715d00f2947f1ad3d54dce901f86f.png
[screenshot13]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/417b3da3a2f44b6f857537751e8d0dc3.png
[screenshot14]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/c9e49962fabf479aac1d7abc595d3871.png
[screenshot15]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/92de492afc11429bba14e553f4e9b7b8.png
[Flutter 2]: https://github.com/flutter/flutter/blob/master/packages/flutter_tools/lib/src/commands/create.dart
[screenshot16]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/c6d629bd17f84ccca525b20558cf7860.png
[screenshot17]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/5604022d09c2498cad1a41d02260e636.png
[screenshot18]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/ae2574c833114814858b8b9ffbd220db.png
[screenshot19]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/8d812974154e4375805f5050a3d1903c.png
[screenshot20]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/abccc7cc96ae476a9482a9d6e9a69644.png
[screenshot21]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/5321e356271142eeb3a9a092acc0db27.png
[Pub]: https://pub.flutter-io.cn
[Flutter _ Dart - Package]: https://blog.csdn.net/crasowas/article/details/128638295