More than 3 years have passed since last update.

FlutterでAndroidのリリース用APKをビルドする前の準備いろいろ

Last updated at 2020-05-30Posted at 2020-04-30

そろそろリリースビルドが近づいてきたので、いろいろ準備をしました。
その覚え書きです。

iOS版は開発者アカウントの承認が進んでいないのでいったん保留です(汗)

環境など

ツールなど	バージョンなど
MacBook Air Early2015	macOS Mojave 10.14.5
Android Studio	3.6.1
Java	1.8.0_131
Flutter	1.12.13+hotfix.5
Dart	2.7.0

Flutter SDKは、Mojaveで動かせる最終版を使用しているため、最新版ではありません

アプリの表示名の変更

1.Android

(1)build.gradleの変更

debugビルドとreleaseビルドでアプリ名を変えたかったので、app/build.gradleにいつものようにこうしました。

app/build.gradle

    buildTypes {
        debug {
            resValue "string", "app_name", "(d)アプリ名"
            applicationIdSuffix ".debug"
            versionNameSuffix "-d"
        }
        release {
            resValue "string", "app_name", "アプリ名"
        }
    }

※build.gradleは、android直下と、android/app下とに、二つありますのでご注意を。

applicationIdSuffixを付けてパッケージ名を変えたり、アプリ名を変えたりしているのは、debugビルド版とreleaseビルド版のアプリを端末に同居させたいことがあるからです。
パッケージ名が違うと、同一端末内に同時にインストール可能になりますが、そうなるとアプリ名で判断が付かなくなるので、変えているというわけです。

アプリ内課金などがあると使えない手なのですが、今回は関係ないのでこれでOK。

(2)マニフェストファイルを変更

android/app/src/main下にある、AndroidManifest.xmlを変更します。

AndroidManifest.xml

    <application
        android:name="io.flutter.app.FlutterApplication"
        android:label="@string/app_name"
        android:icon="@mipmap/ic_launcher">

android:label="@string/app_name"の箇所が変更箇所です。
これで、build.gradleで指定したリソース文字列を代入してくれます。

2.iOS

info.plistを直接書き変えます。

info.plist

	<key>CFBundleName</key>
	<string>アプリ名</string>

アプリアイコンの作成

1.素材の用意

私にとって最難関でした(笑)
というかもともと自分でデザインなど出来るわけがないので、最初からフリー素材にターゲットを絞って検索していました。

なんとなく、

カレンダー風
メモ帳風
食べ物系
豚
柴犬(黒柴)

というイメージで探していました。柴犬はまあ冗談ですがw

カレンダー風とメモ帳風は、カレンダー形式の記録アプリだからです。
食べ物系は、食事を思い起こさせる何かだと良いなと思って。
豚は、「豚になっちゃアカンから」という意味で(笑)
最後のは、黒柴が大好きなので、今後他に出そうと思ってるアプリでも使う感じでブランドアイコン的になるならと思ってましたが、なかなかなかったです。残念。

で、食事系に落ち着きました。
なかったら最悪お金を払っても、と思ってましたが、しっくりくるものが見つかりました。

ということで、こちらから素材をお借りしました。
http://flat-icon-design.com/

2.画像の調整

アイコンにするのには色々と調整が必要です。特にAndorid8.0以降のAdaptiveIconに対応させるために、余白などに気をつけなければなりません。

まず、背景と前景を分離します。
その上で、こちらのサイトで、前景が思った位置に納まるように微調整を繰り返しました。

画像の調整には、GIMPを使いましたが、結構時間かかりました(汗)

3.アプリアイコンリソースの生成

最後に、これらを解像度毎に吐き出す必要があるのですが、これがなかなか厄介です。
で、Flutterにはとても便利なパッケージを作って下さっている方がいました！

flutter_launcher_iconsパッケージです。

pubspec.yaml

dev_dependencies:
  flutter_test:
    sdk: flutter

  # icon generate
  flutter_launcher_icons: ^0.7.5

flutter_icons:
  ios: true
  android: true
  image_path: "assets/icon/icon.png"
  adaptive_icon_background: "assets/icon/ic_background.png"
  adaptive_icon_foreground: "assets/icon/ic_foreground.png"

上記のように記述して(インデントなど注意)、

$ flutter pub get
$ flutter pub run flutter_launcher_icons:main

とすれば生成されます。
生成されたリソースファイルは、それぞれ以下のフォルダで見つけられます。

android/app/src/main/res
ios/Runner/Assets.xcassets/AppIcon.appiconset

Apkのビルド

App Bundleにしろと言われますが、多言語対応など特にする予定は無いし、解像度別のリソースもアプリアイコンくらいなので、やりません。Apkでいきます。

1.アップロード鍵の用意

ビルドの前に、アップロード鍵を作って署名する準備をします。
割愛しようかと思ったけど、Androidを普通にビルドしたことが無い方もご覧になるかも知れないので、載せておきます。

※アップロード鍵での署名方法は、従来のアプリ署名方法と変わりません。
ここで署名した内容が、最初にPlayストアにApkなどを登録した際に、アップロード鍵として保管されます。

(1)証明書を作成

jksファイルを作成してkeystore.propertiesを作成して・・・
Androiderにはおなじみのやつです。

今回は、コンソールでやってみました。

$ keytool -genkey -v -keystore release.jks -alias alias_name -keyalg RSA -keysize 2048 -validity 10000
キーストアのパスワードを入力してください:  (パスワード)
新規パスワードを再入力してください: (再入力)
姓名は何ですか。(氏名または部署名などを入力)
組織単位名は何ですか。(会社等ならCOとか。個人なら何も入れずにリターンでOK)
組織名は何ですか。(会社名を入力。個人なら何も入れずにリターンでOK)
都市名または地域名は何ですか。(市区町村名。入れたくなければ何も入れずにリターンでOK)
都道府県名または州名は何ですか。(都道府県名。これぐらいは入れましょう)
この単位に該当する2文字の国コードは何ですか。JP(必須です)
CN=sk, OU=Unknown, O=Unknown, L=Unknown, ST=Tokyo, C=JPでよろしいですか。
(良ければy,やり直したければnを入れてリターン)
10,000日間有効な2,048ビットのRSAの鍵ペアと自己署名型証明書(SHA256withRSA)を生成しています
	ディレクトリ名: CN=姓名, OU=Unknown, O=Unknown, L=Unknown, ST=Tokyo, C=JP
<alias_name>の鍵パスワードを入力してください
	(キーストアのパスワードと同じ場合はRETURNを押してください):  (リターンでOK)

alias_nameには、任意の適切なエイリアス名を付けて下さい。
パスワードも忘れないようにメモしておいて下さい。

作成したrelease.jksは、android/app下に置きます。

(2)署名情報ファイルを作成

android下に、keystore.propertiesを作成します。

keystore.properties

storePassword=パスワード
keyPassword=パスワード
keyAlias=alias_name
storeFile=release.jks

(3)build.gradleを編集

app/build.gradle

apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'
apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"

// 追加する
def keystorePropertiesFile = rootProject.file("keystore.properties") 

android{
   ...

    defaultConfig {
        ...
    }

    // 以下を追加
    signingConfigs {
        release {
            if (keystorePropertiesFile.exists()) {
                def keystoreProperties = new Properties()
                keystoreProperties.load(new FileInputStream(keystorePropertiesFile))
                keyAlias keystoreProperties['keyAlias']
                keyPassword keystoreProperties['keyPassword']
                storeFile file(keystoreProperties['storeFile'])
                storePassword keystoreProperties['storePassword']
            }
        }
    }
    // 追加ここまで

    buildTypes {
        debug {
            ...
        }
        release {
            resValue "string", "app_name", "アプリ名"

            // 以下を追加
            signingConfig signingConfigs.release
            // 追加ここまで
        }
    }
 ...
}

(4)gitignoreに署名ファイルなどを追加

privateリポジトリなら上げてしまっても良いかも知れませんが、後で公開したときに履歴で見えてしまうので、やっぱり上げない方が吉だとは思います。コードを公開する予定は一切無い！という場合にはいいですけど。あと社内のGitLabだとか、そういう場合にも上げてしまっても良いでしょうね。

.gitignore

*.jks
keystore.properties

2. Apkをビルド

次のコマンドでビルドされます。

$ flutter build apk

生成されたapkは、以下のフォルダで見つけられます。

build/app/outputs/apk/release

Codemagicに入れてみた

まず、こちらの記事などを参考にワークフローが作成済みとします。

基本的にはこのページの通りです。
https://docs.codemagic.io/code-signing/android-code-signing/#setting-up-android-code-signing-on-codemagic

1.Codemagic用の署名設定をする

後段のところで設定できるのが見えていたので、これは不要になったかと思っていましたが、やっぱり必要みたいです。
1つに出来ないのかなあー。ねえ、Codemagicさん？
(でもFlutterがリリースビルド時に未署名のapkを作れないみたいなので、やむを得ないのかな・・・)

(1)build.gradleを変更する

先ほど、リリース署名用の情報を設定しましたが、そこにCodemagic用の設定も入れてやります。

app/build.gradle

    signingConfigs {
        release {
            if (System.getenv()["CI"]) { // CI=true is exported by Codemagic
                storeFile file(System.getenv()["FCI_BUILD_DIR"] + "/keystore.jks")
                storePassword System.getenv()["FCI_KEYSTORE_PASSWORD"]
                keyAlias System.getenv()["FCI_KEY_ALIAS"]
                keyPassword System.getenv()["FCI_KEY_PASSWORD"]
            } else if (keystorePropertiesFile.exists()) {
                ...
            }
        }
    }

(2)証明書ファイルのBase64エンコード文字列を書き出す

$ cd android/app
$ openssl base64 -in <infile> -out <outfile>

このファイルもコミットされないように注意してください。(後で使ったら削除して大丈夫)

以上でコミットしておきましょう。
pushでワークフローがトリガーされるようになっている人は、まだpushしない方が良いです。

2.ワークフローの変更

私はCodemagicではmasterへのPRで走るようにし、そもそもリリースビルドする用にすることが目的でした。なので既存のワークフローを変更しますが、developテスト用にも回すのを残しておきたい方は、ワークフローを複製してもう一つ用意するのでも良いかも知れませんね。

(1)ビルドトリガーの追加

Githubでtagを作成したときに走るように設定します。

(2)セキュアな環境変数を追加する

Environment variables設定を開き、以下の内容をSecureとして保存する。

FCI_KEYSTORE_PASSWORD=キーストアパスワード
FCI_KEY_ALIAS=エイリアス名
FCI_KEY_PASSWORD=鍵パスワード
FCI_KEYSTORE_FILE=Base64エンコードした署名ファイルの文字列

1つずつ、変数名を入れ、値をコピペし、Secureというチェックボックスにチェックを入れ、[Add]をクリックして追加していきます。

全部追加し終わったら、[Save]をクリックするのを忘れずに。

(3)証明書ファイルの内容をdecodeするスクリプトを追加する

以下の内容を、スクリプト欄に貼り付けます。

#!/usr/bin/env sh
set -e # exit on first failed commandset
echo $FCI_KEYSTORE_FILE | base64 --decode > $FCI_BUILD_DIR/keystore.jks

これはBuildタスクの前ならどこでも良いです。
例として、Post-clone scriptに入れています。

[Save]をクリックするのを忘れずに!

(4)Buildモードを変更する

Build設定を開き、Modeをreleaseにします。

変更したら[Save]をクリックするのを忘れずに!!

(5)Android code signingを設定する

こっちは多分ビルドには関係なくて、Playストアなどにアップロードする際に必要っぽいですが、一緒に設定してしまっておきます。

※ここの設定は、前段で設定した内容と明らかに重複していて冗長な作業なので、なんとか統一して貰いたいところです・・・

Publish設定を開く

Android code signing設定を開く
証明書ファイル(release.jksなど)をDnDでアップロード
- アップロードすると、Enable Android code signingがチェックできるようになる
パスワード、エイリアス情報を入力する
Enable Android code signingにチェックを入れる

[Save]をクリック!!!

(6)Github releasesの設定をする

Publish設定を開く
Github releasesを開く

[Save]をクリック!!!!

3.ワークフローを走らせる

pushで動くようにしている人は、ここで変更をpushします。
PRやtag付けで動くようにしている人は、pushした上で、PRを作るかtag付けをします。

CodemagicからのSlack通知。

GithubのPR。

tag付けしたら、またワークフローが走って、GithubのReleaseページに追加されました！

感想

[Save]をクリックってうるさいって？だって忘れるんだもん。しょっちゅう。
Codemagicの公式ドキュメントを読んでても、書いてあるよ、しょっちゅう。Saveクリックすんの忘れんな、って。
みんな忘れるんだね(笑・・・えない)

Playストアへのアップロードは次にでも。
Google開発者登録して10年。やっとアップロードするときが・・・

おまけ：Firebaseのテスト

このままリリースするのもなんか怖いので、念のためFirebaseのTest Labでも回してみましょうか。
Test Labは、ロボテスト(ランダムUIテスト)をしてくれるツールです。
UnitTestを実行も可能ですが、これはネイティブ言語で書いたときだけなので、Flutterでは使えません。

1.Firebaseコンソールにログイン(or サインアップ)

Google、G Suiteのアカウントがあれば直ぐにログイン出来ます。

2.プロジェクトを作成

Google Analyticsを入れるか聞かれますが、まあ入れておいた方が良いでしょう。ただ、今はFirebaseSDKを入れないので、何も取れないと思いますが。
(クラッシュレポートも、いわゆる"NDK"で作られているので、Java/Kotlinのようにスタックトレースが分かりやすいってことも無いはず・・・)

GAのアカウントを用意してない場合は、ここで作るように言われると思います。

少し待つと、プロジェクトページに遷移します。