build_apk.dart 4.5 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5
import '../android/android_builder.dart';
6
import '../android/build_validation.dart';
7
import '../android/gradle_utils.dart';
8
import '../build_info.dart';
9
import '../cache.dart';
10
import '../globals.dart' as globals;
11
import '../project.dart';
12
import '../reporting/reporting.dart';
13
import '../runner/flutter_command.dart' show FlutterCommandResult;
14
import 'build.dart';
15

16
class BuildApkCommand extends BuildSubCommand {
17 18 19
  BuildApkCommand({
    required super.logger, bool verboseHelp = false
  }) : super(verboseHelp: verboseHelp) {
20
    addTreeShakeIconsFlag();
21
    usesTargetOption();
22
    addBuildModeFlags(verboseHelp: verboseHelp);
23
    usesFlavorOption();
24
    usesPubOption();
25 26
    usesBuildNumberOption();
    usesBuildNameOption();
27
    addShrinkingFlag(verboseHelp: verboseHelp);
28
    addSplitDebugInfoOption();
29
    addDartObfuscationOption();
30
    usesDartDefineOption();
31
    usesExtraDartFlagOptions(verboseHelp: verboseHelp);
32
    addBundleSkSLPathOption(hide: !verboseHelp);
33
    addEnableExperimentation(hide: !verboseHelp);
34
    addBuildPerformanceFile(hide: !verboseHelp);
35
    addNullSafetyModeOptions(hide: !verboseHelp);
36
    usesAnalyzeSizeFlag();
37
    addAndroidSpecificBuildOptions(hide: !verboseHelp);
38
    addMultidexOption();
39
    addIgnoreDeprecationOption();
40
    argParser
41
      ..addFlag('split-per-abi',
42
        negatable: false,
43
        help: 'Whether to split the APKs per ABIs. '
44
              'To learn more, see: https://developer.android.com/studio/build/configure-apk-splits#configure-abi-split',
45
      )
46 47 48
      ..addFlag('config-only',
          help: 'Generate build files used by flutter but '
                'do not build any artifacts.')
49
      ..addMultiOption('target-platform',
50
        defaultsTo: <String>['android-arm', 'android-arm64', 'android-x64'],
51 52 53
        allowed: <String>['android-arm', 'android-arm64', 'android-x86', 'android-x64'],
        help: 'The target platform for which the app is compiled.',
      );
54
    usesTrackWidgetCreation(verboseHelp: verboseHelp);
55 56
  }

57 58 59
  @override
  final String name = 'apk';

60
  @override
61
  DeprecationBehavior get deprecationBehavior => boolArg('ignore-deprecation') ? DeprecationBehavior.ignore : DeprecationBehavior.exit;
62

63
  bool get configOnly => boolArg('config-only');
64

65 66 67 68 69
  @override
  Future<Set<DevelopmentArtifact>> get requiredArtifacts async => <DevelopmentArtifact>{
    DevelopmentArtifact.androidGenSnapshot,
  };

70
  @override
71
  final String description = 'Build an Android APK file from your app.\n\n'
72 73
    "This command can build debug and release versions of your application. 'debug' builds support "
    "debugging and a quick development cycle. 'release' builds don't support debugging and are "
74
    'suitable for deploying to app stores. If you are deploying the app to the Play Store, '
75
    "it's recommended to use app bundles or split the APK to reduce the APK size. Learn more at:\n\n"
76 77
    ' * https://developer.android.com/guide/app-bundle\n'
    ' * https://developer.android.com/studio/build/configure-apk-splits#configure-abi-split';
78

79
  @override
80 81
  Future<CustomDimensions> get usageValues async {
    String buildMode;
82

83
    if (boolArg('release')) {
84
      buildMode = 'release';
85
    } else if (boolArg('debug')) {
86
      buildMode = 'debug';
87
    } else if (boolArg('profile')) {
88
      buildMode = 'profile';
89 90
    } else {
      // The build defaults to release.
91
      buildMode = 'release';
92
    }
93 94 95 96

    return CustomDimensions(
      commandBuildApkTargetPlatform: stringsArg('target-platform').join(','),
      commandBuildApkBuildMode: buildMode,
97
      commandBuildApkSplitPerAbi: boolArg('split-per-abi'),
98
    );
99 100
  }

101
  @override
102
  Future<FlutterCommandResult> runCommand() async {
103
    if (globals.androidSdk == null) {
104 105
      exitWithNoSdkMessage();
    }
106
    final BuildInfo buildInfo = await getBuildInfo();
Emmanuel Garcia's avatar
Emmanuel Garcia committed
107 108
    final AndroidBuildInfo androidBuildInfo = AndroidBuildInfo(
      buildInfo,
109
      splitPerAbi: boolArg('split-per-abi'),
110
      targetArchs: stringsArg('target-platform').map<AndroidArch>(getAndroidArchForName),
111
      multidexEnabled: boolArg('multidex'),
112
    );
113
    validateBuild(androidBuildInfo);
114
    displayNullSafetyMode(androidBuildInfo.buildInfo);
115
    globals.terminal.usesTerminalUi = true;
116
    await androidBuilder?.buildApk(
117
      project: FlutterProject.current(),
118
      target: targetFile,
119
      androidBuildInfo: androidBuildInfo,
120
      configOnly: configOnly,
121
    );
122
    return FlutterCommandResult.success();
123
  }
124
}