build_apk.dart 4.29 KB
Newer Older
1 2 3 4 5 6
// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:async';

7
import '../android/android_builder.dart';
8 9 10
import '../base/terminal.dart';
import '../build_info.dart';
import '../globals.dart';
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
  BuildApkCommand({bool verboseHelp = false}) {
18
    usesTargetOption();
19
    addBuildModeFlags(verboseHelp: verboseHelp);
20
    usesFlavorOption();
21
    usesPubOption();
22 23
    usesBuildNumberOption();
    usesBuildNameOption();
Emmanuel Garcia's avatar
Emmanuel Garcia committed
24
    addShrinkingFlag();
25 26

    argParser
27
      ..addFlag('split-per-abi',
28
        negatable: false,
29
        help: 'Whether to split the APKs per ABIs. '
30
              'To learn more, see: https://developer.android.com/studio/build/configure-apk-splits#configure-abi-split',
31
      )
32 33
      ..addMultiOption('target-platform',
        splitCommas: true,
34
        defaultsTo: <String>['android-arm', 'android-arm64', 'android-x64'],
35 36 37
        allowed: <String>['android-arm', 'android-arm64', 'android-x86', 'android-x64'],
        help: 'The target platform for which the app is compiled.',
      );
38
    usesTrackWidgetCreation(verboseHelp: verboseHelp);
39 40
  }

41 42 43 44
  @override
  final String name = 'apk';

  @override
45
  final String description = 'Build an Android APK file from your app.\n\n'
46 47
    '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 '
48
    'suitable for deploying to app stores.';
49

50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
  @override
  Future<Map<CustomDimensions, String>> get usageValues async {
    final Map<CustomDimensions, String> usage = <CustomDimensions, String>{};

    usage[CustomDimensions.commandBuildApkTargetPlatform] =
        (argResults['target-platform'] as List<String>).join(',');
    usage[CustomDimensions.commandBuildApkSplitPerAbi] =
        argResults['split-per-abi'].toString();

    if (argResults['release']) {
      usage[CustomDimensions.commandBuildApkBuildMode] = 'release';
    } else if (argResults['debug']) {
      usage[CustomDimensions.commandBuildApkBuildMode] = 'debug';
    } else if (argResults['profile']) {
      usage[CustomDimensions.commandBuildApkBuildMode] = 'profile';
    } else {
      // The build defaults to release.
      usage[CustomDimensions.commandBuildApkBuildMode] = 'release';
    }
    return usage;
  }

72
  @override
73
  Future<FlutterCommandResult> runCommand() async {
74
    final BuildInfo buildInfo = getBuildInfo();
Emmanuel Garcia's avatar
Emmanuel Garcia committed
75 76
    final AndroidBuildInfo androidBuildInfo = AndroidBuildInfo(
      buildInfo,
77
      splitPerAbi: argResults['split-per-abi'],
78
      targetArchs: argResults['target-platform'].map<AndroidArch>(getAndroidArchForName),
Emmanuel Garcia's avatar
Emmanuel Garcia committed
79
      shrink: argResults['shrink'],
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
    );

    if (buildInfo.isRelease && !androidBuildInfo.splitPerAbi && androidBuildInfo.targetArchs.length > 1) {
      final String targetPlatforms = argResults['target-platform'].join(', ');

      printStatus('You are building a fat APK that includes binaries for '
                  '$targetPlatforms.', emphasis: true, color: TerminalColor.green);
      printStatus('If you are deploying the app to the Play Store, '
                  'it\'s recommended to use app bundles or split the APK to reduce the APK size.', emphasis: true);
      printStatus('To generate an app bundle, run:', emphasis: true, indent: 4);
      printStatus('flutter build appbundle '
                  '--target-platform ${targetPlatforms.replaceAll(' ', '')}',indent: 8);
      printStatus('Learn more on: https://developer.android.com/guide/app-bundle',indent: 8);
      printStatus('To split the APKs per ABI, run:', emphasis: true, indent: 4);
      printStatus('flutter build apk '
                  '--target-platform ${targetPlatforms.replaceAll(' ', '')} '
                  '--split-per-abi', indent: 8);
      printStatus('Learn more on:  https://developer.android.com/studio/build/configure-apk-splits#configure-abi-split',indent: 8);
    }
99
    await androidBuilder.buildApk(
100
      project: FlutterProject.current(),
101
      target: targetFile,
102
      androidBuildInfo: androidBuildInfo,
103
    );
104
    return null;
105
  }
106
}