はじめに

今回と次回の2回にかけて，イマイチよくわかってないAndroid Studioのプロジェクト管理ファイルについて解説します。途中で飽きちゃう人のために，最低限共有する必要のある（バージョン管理する必要のある）管理ファイルを紹介します。

ここでの対象は.ideaディレクトリだけなので，説明のしやすさも兼ねて <PROJECT_HOME>/.idea/.gitignoreを作成し「.ideaディレクトリに対するホワイトリスト」を提示していきます。

*.xml
!/gradle.xml

/.gradle/
/local.properties
.DS_Store
*.iml

前回紹介した.gitignoreはbuild.gradle以外を除外するため，Android Studioにとっては「Gradleのプロジェクト」と認識します。「⁠Android Studioのプロジェクト」として認識させるには「<PROJECE_HOME>に.ideaディレクトリがあること」で，その中身を必要最低限まで削るとgradle.xmlだけが残ります。

.idea/gradle.xmlだけあればAndroid Studioは，そのディレクトリを自身のプロジェクトとして認識します。あとは，必要に応じて他に共有したい設定を追記していくことになります。どんなときに／どの設定ファイルを共有したら良いかが中編・後編の内容になります。

<option name="linkedExternalProjectsSettings">
  <GradleProjectSettings>
    <option name="distributionType" value="DEFAULT_WRAPPED" />
    <option name="externalProjectPath" value="C:\Users\masanobuimai\AndroidStudioProjects\MyApplication" />
  </GradleProjectSettings>

<option name="externalProjectPath" value="$PROJECT_DIR$"/>

Android Studioの管理ファイルについて

Android Studioの管理ファイルは大きく分けて次の二種類があります。

モジュール定義ファイル（*.iml）

Android StudioやIntelliJでは，プロジェクトは「場」であって，その中にモジュールという「実体」があります。Eclipseにたとえると，プロジェクトが（Eclipseの）ワークスペースで，モジュールが（Eclipseの）プロジェクトです。

モジュール定義ファイル（*.iml）はそのモジュールごとの定義情報を保存しています。もう少し具体的に言うと「Project Structure」の設定内容がここに保存されます。ちなみに，このファイルの中身はXMLです。

.ideaディレクトリ配下の設定ファイル

<PROJECT_HOME>直下にある.ideaディレクトリです。ここには主にプロジェクト固有の設定情報が格納されます。もっと具体的に言うと「Preferences」の「Proejct Settings」部分のほとんどと，（⁠本連載ではまだ説明していませんが）「⁠Run/Debug Configuration」の一部が保存されます。

このディレクトリに保存される設定ファイルもすべてXMLファイルです。厳密なルールはありませんが「Preferences」の設定項目ごとに設定ファイルが独立しています。

Android Studioは，この.ideaディレクトリを含むディレクトリを「プロジェクト」と認識します。ディレクトリ名が.ideaなのは，Android StudioのベースとなったのがIntelliJ IDEAだからです。実を言えば，IntelliJベースの他のIDEもすべてこの形式なので，複数のJetBrains系IDEを併用している場合はちょっとした混乱の元になります。

これらの設定ファイルも基本的にはバージョン管理下に置き共有するのが望ましいと言われています。一応，公式な見解があり，それに従うと次のようになります。

• .idea/workspace.xmlと.idea/tasks.xmlは共有してはいけない。
• .idea/dictionary/も共有しないほうがいい。
  • 参考：How to manage projects under Version Control Systemsより

これ，間違ってはいないのですが，正解でもありません。共有しないほうが良いファイルはもう少しあり，一部の設定ファイルは条件に応じて共有するかどうかを決めた方がよいものがあります。そして何より情報が古いです。

また，github / gitignoreにあるJetBrains.gitignoreもだいぶ極端な設定になっています。