Flutter 如何将示例项目添加到颤振包？

有没有办法为包中的示例映射结构自动生成模板代码

大多数包在包根目录中都有一个/example文件夹，用于显示包的功能。 我不确定创建示例的“最佳”方式是什么，或者它是否重要

我是否单独创建所有文件？ 我是否创建一个新项目，然后将其复制到包根目录？ 我可以直接在项目中自动生成示例项目吗

---

这是我第一次尝试创建一个包，我想第一次就把它做好。

在项目的根目录中创建一个名为example的新项目，然后删除不必要的文件，如

变更日志

、

许可证

和

自述文件

，因为它们将在您的包文件夹中

以下是我创建的一个包的示例（并非双关语）：

现在，在

pubspec.yaml

中，您应该将包作为开发依赖项包括在内，如下所示：

dev_dependencies:
  your_package:
    path: ../

我相信您也可以使用常规依赖项，但这对我很有用

---

现在，在

/lib

中，您可以添加一个

main.dart

文件，导入包，然后创建一个示例项目

使用项目根目录中的内置flatter命令行工具完成所有工作：

/e/projects/myproject # flutter create example

其中有以下输出：

Creating project example... androidx: true
  example\.gitignore (created)
  example\.idea\libraries\Dart_SDK.xml (created)
  example\.idea\libraries\Flutter_for_Android.xml (created)
  example\.idea\libraries\KotlinJavaRuntime.xml (created)
  example\.idea\modules.xml (created)
  example\.idea\runConfigurations\main_dart.xml (created)
  example\.idea\workspace.xml (created)
  example\.metadata (created)
  example\android\app\build.gradle (created)
  example\android\app\src\main\kotlin\com\example\example\MainActivity.kt (created)
  example\android\build.gradle (created)
  example\android\example_android.iml (created)
  example\android\.gitignore (created)
  example\android\app\src\debug\AndroidManifest.xml (created)
  example\android\app\src\main\AndroidManifest.xml (created)
  example\android\app\src\main\res\drawable\launch_background.xml (created)
  example\android\app\src\main\res\mipmap-hdpi\ic_launcher.png (created)
  example\android\app\src\main\res\mipmap-mdpi\ic_launcher.png (created)
  example\android\app\src\main\res\mipmap-xhdpi\ic_launcher.png (created)
  example\android\app\src\main\res\mipmap-xxhdpi\ic_launcher.png (created)
  example\android\app\src\main\res\mipmap-xxxhdpi\ic_launcher.png (created)
  example\android\app\src\main\res\values\styles.xml (created)
  example\android\app\src\profile\AndroidManifest.xml (created)
  example\android\gradle\wrapper\gradle-wrapper.properties (created)
  example\android\gradle.properties (created)
  example\android\settings.gradle (created)
  example\ios\Runner\AppDelegate.swift (created)
  example\ios\Runner\Runner-Bridging-Header.h (created)
  example\ios\Runner.xcodeproj\project.pbxproj (created)
  example\ios\Runner.xcodeproj\xcshareddata\xcschemes\Runner.xcscheme (created)
  example\ios\.gitignore (created)
  example\ios\Flutter\AppFrameworkInfo.plist (created)
  example\ios\Flutter\Debug.xcconfig (created)
  example\ios\Flutter\Release.xcconfig (created)
  example\ios\Runner\Assets.xcassets\AppIcon.appiconset\Contents.json (created)
  example\ios\Runner\Assets.xcassets\AppIcon.appiconset\Icon-App-1024x1024@1x.png (created)
  example\ios\Runner\Assets.xcassets\AppIcon.appiconset\Icon-App-20x20@1x.png (created)
  example\ios\Runner\Assets.xcassets\AppIcon.appiconset\Icon-App-20x20@2x.png (created)
  example\ios\Runner\Assets.xcassets\AppIcon.appiconset\Icon-App-20x20@3x.png (created)
  example\ios\Runner\Assets.xcassets\AppIcon.appiconset\Icon-App-29x29@1x.png (created)
  example\ios\Runner\Assets.xcassets\AppIcon.appiconset\Icon-App-29x29@2x.png (created)
  example\ios\Runner\Assets.xcassets\AppIcon.appiconset\Icon-App-29x29@3x.png (created)
  example\ios\Runner\Assets.xcassets\AppIcon.appiconset\Icon-App-40x40@1x.png (created)
  example\ios\Runner\Assets.xcassets\AppIcon.appiconset\Icon-App-40x40@2x.png (created)
  example\ios\Runner\Assets.xcassets\AppIcon.appiconset\Icon-App-40x40@3x.png (created)
  example\ios\Runner\Assets.xcassets\AppIcon.appiconset\Icon-App-60x60@2x.png (created)
  example\ios\Runner\Assets.xcassets\AppIcon.appiconset\Icon-App-60x60@3x.png (created)
  example\ios\Runner\Assets.xcassets\AppIcon.appiconset\Icon-App-76x76@1x.png (created)
  example\ios\Runner\Assets.xcassets\AppIcon.appiconset\Icon-App-76x76@2x.png (created)
  example\ios\Runner\Assets.xcassets\AppIcon.appiconset\Icon-App-83.5x83.5@2x.png (created)
  example\ios\Runner\Assets.xcassets\LaunchImage.imageset\Contents.json (created)
  example\ios\Runner\Assets.xcassets\LaunchImage.imageset\LaunchImage.png (created)
  example\ios\Runner\Assets.xcassets\LaunchImage.imageset\LaunchImage@2x.png (created)
  example\ios\Runner\Assets.xcassets\LaunchImage.imageset\LaunchImage@3x.png (created)
  example\ios\Runner\Assets.xcassets\LaunchImage.imageset\README.md (created)
  example\ios\Runner\Base.lproj\LaunchScreen.storyboard (created)
  example\ios\Runner\Base.lproj\Main.storyboard (created)
  example\ios\Runner\Info.plist (created)
  example\ios\Runner.xcodeproj\project.xcworkspace\contents.xcworkspacedata (created)
  example\ios\Runner.xcworkspace\contents.xcworkspacedata (created)
  example\lib\main.dart (created)
  example\example.iml (created)
  example\pubspec.yaml (created)
  example\README.md (created)
  example\test\widget_test.dart (created)
Running "flutter pub get" in example...                             3.0s
Wrote 68 files.

All done!
[√] Flutter: is fully installed. (Channel stable, v1.12.13+hotfix.5, on Microsoft Windows [Version 6.1.7601], locale en-US)
[√] Android toolchain - develop for Android devices: is fully installed. (Android SDK version 29.0.2)
[√] Android Studio: is fully installed. (version 3.5)
[√] Connected device: is fully installed. (2 available)

In order to run your application, type:

  $ cd example
  $ flutter run

Your application code is in example\lib\main.dart.

如果使用Android Studio 3.5.2，请运行默认示例以确保：

通过选择“编辑配置”，为示例main.dart添加新配置。。。从工具栏上的“颤振”下拉列表中

选择运行/调试配置对话框左侧的颤振目录，然后按+按钮

选择颤振

通过单击dart entrypoint:对话框中的文件夹，在新的example/lib目录中浏览main.dart

单击工具栏上的“三角形梯段”按钮

我只是为我自己的项目执行了这些步骤，效果非常好

然后，要为您的项目进行自定义，请编辑示例的pubspec.yaml文件，并向您的项目添加依赖项：

dev_dependencies:
  my_project:
    path: ../

---

在Android Studio中使用示例创建颤振包

创建新的颤振项目

选择颤振包

在Android Studio中打开新项目后，选择“终端”选项卡，然后运行：

颤振创建示例

选择“编辑配置”->添加配置->选择位于example/lib文件夹中的main.dart文件

打开示例pubspec.yaml并通过添加以下内容链接到库：

您的\u包\u名称： 路径：\

注意：当您打开示例文件夹时，它看起来就像嵌套在项目中的整个颤振应用程序；那是因为它是。只需打开io和android文件夹，查看它们是否共享该模式：

---

转到您的项目根文件夹并运行

flattercreate example

---

就这样。

为了澄清，请转到项目根文件夹并运行

flatter create example

。就是这样。@JoelBroström顺便说一句，您可以将

自述文件

保存在示例项目中，例如pub.dev上的“示例”选项卡，否则它只会显示代码。@JoelBroström请将其作为答案添加，而不是您所说的“响应ID”。谢谢你提醒我。这可能是我在stackoverflow上看到的最好的答案。非常感谢。