What a build contains
What a build of an application with spring_boot_starter_flutter contains, and when something is not in it. A module that follows a key reads it when build_runner runs, from application.yml or application.properties without a profile (see Modules left out of the build). The modules of the packages it depends on come with it: for spring_boot_dart, see Auto-configuration.
Always in
No build: and no platform:: in every build of an application that depends on the starter.
| Module | What it holds |
|---|---|
springBootStarterFlutterAutoConfiguration |
Support for asset: locations; the advice for @NotifyListeners and @ChangeNotifierComponent beans and the one that tells Spring widgets which beans their build read; the themes (SpringThemes, ThemeSelection, the loader of themes from a URL); the app's files (FileStore, FileTemplate); the keyboard shortcuts; the theme the user chose, kept between runs; with spring.flutter.splash.warm-up.text.enabled, the text warm-up of the splash. |
By key
build: AutoConfigurationBuild(key): true puts the module in every build, false leaves it out with all its code, and when the key is not set the Not set column decides.
| Module | Key | Not set | What it holds |
|---|---|---|---|
springBootStarterFlutterDebugAutoConfiguration |
spring.flutter.debug.enabled |
debug and profile builds only | The debug panel (debugPanel) and its sections (logs, frames, configuration, beans, themes, start), and the customizer that puts it over the app. |
springBootStarterFlutterDebugFrameMeterAutoConfiguration |
spring.flutter.debug.frame-meter.enabled |
debug and profile builds only | The frame meter over the app (debugFrameMeter). Apart from the panel, so a release can have the meter alone. |
springBootStarterFlutterDebugMotionAutoConfiguration |
spring.flutter.debug.motion.enabled |
debug and profile builds only | The switch for every animation of the app (debugMotion). |
springBootStarterFlutterDebugTimelineAutoConfiguration |
spring.flutter.debug.timeline.enabled |
debug and profile builds only | The timeline of the start and the observations (debugTimeline) and its timelineObservations handler; with it each bean's creation is measured too. |
springBootStarterFlutterDebugIsolatesAutoConfiguration |
spring.flutter.debug.isolates.enabled |
debug and profile builds only | The task manager of the app's isolates and the engine's threads (debugIsolates, flutterEngineLoads). |
springBootStarterFlutterDebugDragAutoConfiguration |
spring.flutter.debug.drag.enabled |
no build | Dragging the debug overlays (debugOverlayDrag). Without true there is no code to drag. |
A module left to notInRelease is dropped from Flutter's release builds and from dart compile exe. dart run and dart compile js / wasm define no dart.vm.product, so there the module stays when the key is not set; only false leaves it out.
What the generator writes for it
A part of the generator (see Starter parts) runs only when the application reaches its package.
| Part or builder | What it does |
|---|---|
Flutter part (spring_boot_starter_flutter) |
Scans the Spring widgets and the @ThemeLoaderKind classes; writes the SpringWidgetBindings bean, registers the loader kinds and writes extension SpringBeans on BuildContext (the @BuildContextAccess getters); checks @Value('asset:...') against pubspec.yaml; adds the loaderKinds and the theme's schema to spring_metadata.json. |
Change notifier part (spring_boot_starter_flutter) |
The proxy of a @ChangeNotifierComponent that is no ChangeNotifier mixes ChangeNotifier in; the build fails when the class cannot work as written. |
Builder spring_flutter_keys |
lib/spring_gen/theme.spring.keys.dart and messages.spring.keys.dart (context.theme, context.messages); only when the package has theme properties or message files. |
Builder spring_flutter_page_loader |
The page loader block of web/index.html and the browser cache of web/_headers; only when web/index.html exists. |
Builder spring_flutter_web |
web_dev_config.yaml for flutter run on the web; only when spring.flutter.web.dev-server.* or spring.flutter.security.web.mode is set. |
Builder spring_flutter_seo |
The pages for search engines, sitemap.xml, robots.txt and llms.txt in web/; only when spring.flutter.web.seo.enabled is true and web/index.html exists. |
| Through its dependencies | The web part, since the starter depends on spring_web_dart. |
Good to know
- The dock of the debug overlays is made by the first module of a feature that has one (the frame meter, the timeline, the task manager), so it is in the build only with such a feature.
- The scenes' and the signals' tabs of the debug panel are modules of their own in their starters, and show where the panel is in the build.