Help us understand the problem. What is going on with this article?

Android StudioでProduct Flavorを使う

More than 3 years have passed since last update.

経緯

Eclipseで作成していた某アプリをAndroid Studioに移行するにあたり今まで別々のプロジェクトとして管理していた通常版とデモ版を1つのプロジェクトで管理したくなったので、その時に色々と試した結果を備忘録がてらまとめてみます。

基本情報

Configuring Gradle Builds

環境

Android Studio 2.0 Preview 4

作業手順

Android Studioへのインポート

  1. 通常版のプロジェクトを[File] > [New] > [Import project] でAndroid Studioにインポートします。1

build.gradle(Modle:app)の編集(その1)

Project Structuresから修正するのが王道(?)。

  1. [File] > [Project Structure]を開く。
  2. [Modules] > [app]を開く。
  3. [Flavors]を開く。
  4. 画面下部の+ボタンをクリックして、Flavorを追加する。
  5. 「Name」に任意の名前をつける。
  6. 「ApplicationId」を指定する。
  7. OKボタンをクリックして保存する。

build.gradleを直接書き換えて、下記のように「productFlavors」を追加してもOK。と言うか、こっちの方が速い。

android {
  (略)
  productFlavors {
      regular {
          applicationId "com.foo.bar"
      }
      demo {
          applicationId "com.foo.bar.demo"
      }
  }
}

[メモ]

  • 未指定の箇所は「defaultConfig」の設定値が使用されるので、とりあえずはNameとApplicationIdの指定だけでとりあえずOK。
  • 通常版とデモ版の2つのAPKを作りたい場合、それぞれのFlavorを登録する必要があります。"defaultConfig"が通常版として使えるのかと思って、デモ版用のFlavorしか作らなかったら、デバッグとか、APK作成とかの際にデモ版しか作れず、しばらく悩みました。

デモ版用ソースコードの追加

  1. srcフォルダを右クリックして、[New] > [Directory]をクリック。
  2. 「directory name」に「demo」と入力し、OKボタンをクリック。
  3. demoフォルダを右クリックして、[New] > [Folder] > [Java Folder]をクリック。
  4. Finishボタンをクリック。
  5. 必要に応じて、res等のフォルダも追加する。
  6. demoフォルダの下にあるjavaフォルダを右クリックして[New] > [Package]をクリック。2
  7. デモ版に必要なコードを追加する(Eclipseのデモ版プロジェクトからコピーすればOK)。3
  8. プロジェクトのsrcフォルダを右クリックして、通常版用のフォルダ(regular)を追加。4

変更後のプロジェクトの構造は下記のようになります。

<通常版のみ>                    <通常版+デモ版>
プロジェクト名                  プロジェクト名
  ┗━app                         ┗━app
     ┗━src                         ┗━src
        ┗━main                        ┣━demo
           ┣━java                     ┃  ┣━java
           ┗━res                      ┃  ┗━res
                                      ┣━main
                                      ┃  ┣━java
                                      ┃  ┗━res
                                      ┗━regular

Android Manifestの追加

Android Manifestはマージされる。
Android Manifestはマージされる。

大事なことなので2回言いました。最初これを理解していなかったせいで、通常版とデモ版2つのアイコンが出たりして、かなり悩みました。

結論から言うと、通常版とデモ版、それに共通部分の3つのManifestを作りました。

なお、やり方によっては2つでも行けます(後述)が,Manifestが見辛くなるのでお勧めできません。

通常版とデモ版の差異

Android Manifestの追加・修正内容はアプリの内容により異なってくるかと思います。今回の場合、通常版とデモ版では下記のような差異がありますので、ここに記載する内容はこの差異に沿った内容です。

+ 起動時のActivityが異なる。
+ サービス等一部のコンポーネントが異なる。
+ 広告表示に必要なパーミッションが追加される。
+ ライセンス認証は行わないので、CHECK_LICENSEパーミッションは削除する。
+ アプリ名が異なる。

共通Manifest

  1. mainフォルダ内のAndroidManifest.xmlを開く。
  2. 通常版とデモ版の両方に共通しないコンポーネント(activity、service、receiver、provider、uses-permission等)に関する記述を削除。

通常版Manifest

  1. regularフォルダを右クリックして、[New] > [Other] > [Android Manifest]を開く。
  2. Finishボタンをクリック。
  3. 作成されたregular/AndroidManifest.xmlを開く。
  4. 通常版にのみ存在するコンポーネントに関する記述を追加。

今回は、<uses-permission android:name="com.android.vending.CHECK_LICENSE"/>を追加し、通常版起動時のActivityや、差異のあるコンポーネントを追加しました。

デモ版Manifest

  1. demoフォルダを右クリックして、[New] > [Other] > [Android Manifest]を開く。
  2. Finishボタンをクリック。
  3. 作成されたregular/AndroidManifest.xmlを開く。
  4. 通常版にのみ存在するコンポーネントに関する記述を追加。
  5. manifestタグ内にxmlns:tools="http://schemas.android.com/tools"を追加。
  6. applicationタグ内の「android:label」をデモ版用のアプリ名に変更。
  7. applicationタグ内にtools:replace="android:label"を追加。

今回は、広告表示に必要なパーミッションを追加し、デモ版起動時のActivityや、差異のあるコンポーネントを追加しました。

また、android:labelを書き換えただけでは競合しているというエラーが出るので、tools:replace="android:label"を設定して競合を解消してやります。

[メモ]

  • マージ後のManifestは「AndroidStudio_workspace/プロジェクト/app/build/intermediates/manifests/full」配下に出力されます。

通常版のManifestを作らない方法

Manifest Mergingを斜め読みして最初に試した方法がコチラ。

mainフォルダ配下のAndroidManifest.xmlに通常版+共通コンポーネントの記述を全て書いて、demoフォルダ配下のAndroidManifest.xmlで不要なコンポーネントのタグにtools:node='remove'を追加して削除します(もちろんデモ版で必要なコンポーネントの記述も追加する)。

ただ、やってみると分かりますが、Manifestがとっても読みにくくなります。

build.gradle(Module:app)の編集(その2)

ここまでの内容と、デモ版に必要な設定をbuild.gradleに反映します。多分一部は反映されているハズです。

デモ版のソースコードの位置指定

上記の手順でやっている場合は、作業しなくても反映されているハズですが、念のため。

  1. build.gradle(Module: app)を開く。
  2. sourceSetsに以下の記述を追加する。5
sourceSets {
    main {
      (略)
    }
    demo {
        java.srcDirs = ['src/demo/java']
        res.srcDirs  = ['src/demo/res']
    }
}

広告表示用ライブラリの追加

デモ版だけで広告表示用のライブラリを使用するように設定します。

  1. build.gradle(Module: app)を開く。
  2. dependenciesに以下の記述を追加(libs/ads.jarは広告表示用のライブラリ)。
dependencies {
    (略)
    demoCompile files('libs/ads.jar')
}

デモ版用Proguardの設定

広告ライブラリに対応するため、デモ版は通常版とは異なるProguard設定を使用しました。

  1. build.gradle(Module: app)を開く。
  2. productFlaveorsに以下の記述を追加。
productFlavors {
    regular {
      (略)
    }
    demo {
        (略)
        proguardFile('proguard-rules_demo.so')
    }
}

バージョン名の変更

アプリ名と合わせて、バージョン名も変更しました。

  1. build.gradle(Module: app)を開く。
  2. productFlaveorsに以下の記述を追加。
productFlavors {
    regular {
        (略)
        versionName "1.0.0"
    }
    demo {
        (略)
        versionName "1.0.0(demo)"
    }
}

実行と署名付きAPKの作成

実行

デモ版と通常版の切り替えは「Build Variants」で行えます。

  1. Android Studioのウィンドウの枠の左下部にある「Build Variants」をクリック(画像参照)。
  2. 「app」で起動したいBuild variantを選択。
  3. 実行ボタンをクリックして実行。

スクリーンショット 2015-12-27 1.26.45.png

署名付きAPKの作成

最後に作成したいFlavorを選択するだけで、他は何も変わりません。

署名を変えたい場合は、build.gradleで使用する署名を指定するらしいです(未確認)。
(参考)Signing Your Applications

更新履歴

2015/12/25 初版


  1. デモ版のプロジェクトはインポートする必要はありません。 

  2. ここでPackageが選択できない場合は、Android Studioのウィンドウの左端の下の方にある「Build Variants」を開いて「app」を「demo***」(DebugでもReleaseでも)に変更してみます。それでもダメなら、パッケージと同じになるようにDirectoryで作っていけばOK。 

  3. マージされるので、通常版と共通のコードは追加しなくて大丈夫。 

  4. 本来はregularフォルダの下に通常版用のコード類を置くんだと思いますが、今回はmain配下に配置したので、javaフォルダなどは作りませんでした。regularフォルダには、後でAndroidManifest.xmlだけを配置します。 

  5. 今回通常版のソースをregularに置かなかったので、mainにはjava.srcDirs、res.srcDisの記載はなくても大丈夫。 

Why do not you register as a user and use Qiita more conveniently?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away