本記事ではFlutterのObjectBoxの利用方法とサンプルを記載します。VSCodeを用いて実施するので環境構築が住んでいない方は以下をご覧ください

Flutter開発入門 VSCodeを使った開発

この記事では、VSCodeを活用したFlutter開発の手順を初心者から経験者まで分かりやすく解説します。Flutter SDKのセットアップから、アプリの実行、デバッグ、ビルド、デプロイまでの詳細なプロセスを学び、開発効率を最大化しましょう。

techgrowup.net

2024.08.27

　ObjectBoxは、高速なトランザクションを実現するために特化したモバイルとIoT向けの軽量データベースです。他のデータベースライブラリと比較して、ObjectBoxの主な利点は以下の通りです。
　また、2024年８月時点で更新されているので、オープンソース上の開発も盛んに行われています。

• 高速性: ObjectBoxは読み書きの速度が非常に速く、大量のデータ操作でも効率的に処理します。
• リソース効率: 非常に少ないメモリとストレージを使用し、リソースが限られたデバイスでも高いパフォーマンスを発揮します。
• 開発の容易さ: ObjectBoxのAPIはシンプルで直感的なため、開発者は短時間でデータベース操作を学び、適用することが可能です。

これらの特性により、ObjectBoxはモバイルデバイスやIoTデバイスに最適な選択肢となっています。

2. 環境設定

　　では実際にFlutterプロジェクトを作成するところから始めていきます。プロジェクト名は「objectbox_sample」としました。

1. Flutterプロジェクトの作成:
   • Visual Studio Codeを開き、コマンドパレット (Ctrl+Shift+P / Cmd+Shift+P) を使用して「Flutter: New Project」と入力します。
   • プロジェクトの種類を選択し、プロジェクト名と保存先を指定してプロジェクトを作成します。
2. ObjectBox Flutterの依存関係を追加:
   • pubspec.yaml ファイルを開き、dependenciesセクションにobjectbox_flutter_libs、objectbox、objectbox_generator、build_runnerを追加します。

dependencies:
  flutter:
    sdk: flutter

  objectbox: ^4.0.2 #ここを追加
  objectbox_flutter_libs: any #ここを追加

dev_dependencies:
  flutter_test:
    sdk: flutter

  objectbox_generator: any  #ここを追加
  build_runner: ^2.4.12 #ここを追加

3. パッケージのインストール:
   • 以下コマンドを叩いてパッケージをインストールします。

flutter pub get

3. モデルの定義

　ここでは簡単なモデルを作成します。user.dartを作成して以下を記述します。
ポイントとしては@Entity()でエンティティの定義をしていることと、idは必須になるので定義しています。

import 'package:objectbox/objectbox.dart';

@Entity()
class User {
  int id = 0; // ObjectBoxはデフォルトでidを必要とします。

  String name;
  int age;

  User({this.id = 0, required this.name, required this.age});
}

　次にObjectBoxを実行するために以下コマンドを実行します。

flutter pub run build_runner build

　実行すると、objectbox-model.jsonとobjectbox.g.dartが生成されたことを確認してください。

4. ObjectBoxの初期化

　ObjectBoxを初期化します。少し長いのでmain.dartをそのまま記載します。

import 'package:flutter/material.dart';
import 'package:objectbox/objectbox.dart';
import 'package:objectbox_sample/objectbox.g.dart';
import 'package:path/path.dart' as p;
import 'package:path_provider/path_provider.dart';

late final ObjectBox box;
void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // ObjectBoxの初期化
  box = await ObjectBox.create();

  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  // This widget is the root of your application.
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});
  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}

class ObjectBox {
  late final Store store;

  ObjectBox._create(this.store) {}

  static Future<ObjectBox> create() async {
    final docsDir = await getApplicationDocumentsDirectory();
    final store = await openStore(directory: p.join(docsDir.path, "obx-store"));
    return ObjectBox._create(store);
  }
}

5. データベースの操作

　次にObjectBoxを使ってデータベースを操作してみます。今回はシンプルなCRUD処理を作成しました。

// データの挿入
  void insertUser(User user) {
    final userBox = box.store.box<User>();
    userBox.put(user);
  }

// データの読み出し
  User? getUser(int id) {
    final userBox = box.store.box<User>();
    return userBox.get(id);
  }

// データの更新
  void updateUser(User user) {
    final userBox = box.store.box<User>();
    user.name = 'Updated Name'; // 名前を更新
    userBox.put(user);
  }

// データの削除
  void deleteUser(int id) {
    final userBox = box.store.box<User>();
    userBox.remove(id);
  }

　以上がObjectBoxの環境作成から操作までのコードになります。

6. パフォーマンスと最適化

　ObjectBoxを利用する上で簡単にパフォーマンスの最適化のヒントを記載します。実際のコードはプロジェクトの特性などを加味して設計してください。※一般的なDB技術と重複します。

1. インデックスの適用: 頻繁にアクセスする属性にインデックスを適用することで、検索速度が大幅に向上します。例えば、ユーザー名やIDのような属性にインデックスを設定すると効果的です。
2. 関連データの効率的な管理: エンティティ間の関係を適切に設計することで、データベースの構造を単純化し、関連データの取得コストを削減します。
3. 非同期処理の活用: ObjectBoxは非同期APIを提供しており、これを利用することで、重いデータ操作がアプリケーションの応答性を阻害することなくバックグラウンドで実行されます。
4. トランザクションの最適化: ObjectBoxでは、複数の書き込み操作を一つのトランザクションでまとめて実行することで、オーバーヘッドを減らし、効率を向上させることができます。

8. まとめ

　この記事では、Visual Studio Code (VSCode) を使って Flutter アプリケーションに ObjectBox データベースを統合する方法について詳しく説明しました。環境設定から始め、モデルの定義、データベースの初期化、CRUD操作までのステップバイステップのプロセスを解説し、パフォーマンスの最適化についても触れました。是非ObjectBoxを使ってみてください。

私の場合はAndriodアプリの開発をしているときに出てきましたが、gradleを使おうとすると既に他のプロセスに使われていてロックされている状態になります。何度もビルドしようとしても同じエラーが出てしまうため意図的にロックされているファイルを消す必要がありました。

対処法

下記コマンドを叩けば一発で直りました。

find ~/.gradle -type f -name "*.lock" -delete

　Media3はJetpackライブラリの１つで、2021年10月27日にバージョン1.0.0-alpha01が公開されています。主な用途としてはメディア（動画、配信）周りのサポートをしてくれるライブラリで、元々ExoPlayerというAndroidで利用されているライブラリがありましたが、それを元に作成されたようです。
　現状はMedia3とExoPlayerは別のレポジトリとして開発が行われ、しばらくは並行して行っていくようですが、将来的にはMedia3に置き換わっていくように記載されていました。

ローカルファイルの再生

　今回はアプリ内にあるmp4ファイルを再生する簡単なアプリを作ってみます。Media3はExoPlayerと同様にメディアセッションの管理やDASH、HLSのサポートやエラー処理など幅広い機能がありますが、それらを実装するとソースコードが増えてしまいますので、最低限の実装を記載しつつ必要であればリファレンスなどを参考にしながら実装してみてください。

　まずライブラリをbuild.gradle(app)に足します。以下は最低限のみ記載していますが、他にも多くのライブラリがコンポーネントごとに作られていますので、必要そうなのは取ってきても大丈夫です！

    def media3_version = "1.0.0-alpha01"
    implementation "androidx.media3:media3-exoplayer:$media3_version"
    implementation "androidx.media3:media3-ui:$media3_version"
    implementation "androidx.media3:media3-session:$media3_version"
    implementation "androidx.media3:media3-test-utils:$media3_version"

　続いて、xmlにはStyledPlayerViewというコンポーネントを配置しましょう。以前はPlayerViewというのが主流だったように記憶していますが、ここ数年はStyledPlayerViewが主流なんですかね。間違っていたらすいません…

    <androidx.media3.ui.StyledPlayerView
        android:id="@+id/player_view"
        android:layout_width="match_parent"
        android:layout_height="match_parent">
    </androidx.media3.ui.StyledPlayerView>

　最後にアクティビティのコードを記載します。特にこれといったことはしていませんが、createMediaItems関数で再生したいMediaItemのリストとして作成し、initializePlayer関数で作成しています。

class SamplePlayer : AppCompatActivity() {
    private lateinit var binding: ActivitySamplePlayerBinding

    private lateinit var mediaItems: MutableList<MediaItem>
    private var player: ExoPlayer? = null
    private var trackSelectionParameters: DefaultTrackSelector.Parameters? = null
    private lateinit var trackSelector: DefaultTrackSelector

    private var startAutoPlay: Boolean = false
    private var startItemIndex: Int = 0
    private var startPosition: Long = 0L

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        binding = ActivitySamplePlayerBinding.inflate(layoutInflater)
        val view = binding.root
        setContentView(view)

        binding.playerView.requestFocus()

        trackSelectionParameters =
            DefaultTrackSelector.ParametersBuilder( /* context= */this).build()
        clearStartPosition()
    }

    override fun onStart() {
        super.onStart()
        if (Util.SDK_INT > 23) {
            initializePlayer()
            binding.playerView.onResume()
        }
    }

    private fun initializePlayer() {
        if (player == null) {
            mediaItems = createMediaItems()
            trackSelector = DefaultTrackSelector(this)
            player = ExoPlayer.Builder(this)
                .setTrackSelector(trackSelector)
                .build()

            player?.trackSelectionParameters = trackSelectionParameters!!
            player?.setAudioAttributes(AudioAttributes.DEFAULT, true)
            player?.playWhenReady = startAutoPlay
            binding.playerView.player = player
        }

        val haveStartPosition = startItemIndex != C.INDEX_UNSET
        if (haveStartPosition) {
            player?.seekTo(startItemIndex, startPosition)
        }
        player?.setMediaItems(mediaItems, !haveStartPosition)
        player?.prepare()
    }

    private fun createMediaItems(): MutableList<MediaItem> {
        val mediaItems = mutableListOf<MediaItem>()

        val rawDataSource = RawResourceDataSource(this)
        rawDataSource.open(DataSpec(RawResourceDataSource.buildRawResourceUri(R.raw.<ここにmp4ファイル名>)))
        mediaItems.add(
            MediaItem.fromUri(rawDataSource.uri!!)
        )
        return mediaItems
    }

    private fun clearStartPosition() {
        startAutoPlay = true
        startItemIndex = C.INDEX_UNSET
        startPosition = C.TIME_UNSET
    }
}

　これはmoshi 1.9.0からはkotlin-reflectまたはmoshi-kotlin-codegenを全てのKotlinクラスに利用する必要があるからとのことですので、下記の対処法のどちらかを行いましょう

moshi/CHANGELOG.md at master · square/moshi

A modern JSON library for Kotlin and Java. Contribute to square/moshi development by creating an account on GitHub.

github.com

KotlinJsonAdapterFactoryを利用する

　Moshiのインスタンスを作成するときに、下記のように.add()を追加して、Kotlin用のアダプターを追加しましょう。

Moshi.Builder()
    .add(KotlinJsonAdapterFactory())
    .build()

codegenアノテーションプロセッサを利用する

　data classなどに下記のアノテーションを追加しましょう。

@JsonClass(generateAdapter = true)
data class Sample(
        val hoge: Hoge,
        val fuga: Fuga
)

余談

　1.9.0以上の変更については、以前はMoshiはKotlinとjavaを区別していなかったようなのですが、nullをNonNullのフィールドに入れてしまうなどの悪影響が大きかったため、このような修正に至ったようです。

　本記事ではAndroidアプリ開発における、Intentとはという点について概要から、実際のIntentの使い方例を交えて解説していきたいと思います。

Intentとは

　インテントとは、「何かを行う意図」という意味で、幅広い役割として利用可能ですが、特定のアクションをリクエストする時に使用できる、メッセージングオブジェクトのことを意味しています。例えば別の画面を開きたい時に、AndroidではActivity単位で画面が作られますが、「開いている画面に対して別の画面を開いてください」とアプリにメッセージとして伝えることで、別の画面を開くことが可能になります。
　今回は基本的な使い方として、「Activityを起動する」、「Serviceを起動する」、「ブロードキャストを配信する」の3点をIntentを使った例として紹介します。

Activityを起動する

　まずActivityを起動する例について、Activityについて詳しく知りたい方は下記記事をご覧ください。

【Androidアプリ開発】アクティビティとライフサイクルの重要性

Androidアプリ開発におけるActivityとライフサイクルの概念を説明しています。Androidアプリ開発ではライフサイクルを意識することで、高品質なアプリを作ることが出来ますので、必ず学んでください。

techgrowup.net

2024.10.29

　簡単にActivityについて説明しておくと、Activityはアプリにおいて1つの画面を表しています。Activityがあることでユーザーは画面を用いて、何かしらのボタンを押すことが出来たり、処理を行うことが出来るのです。
　Intentを用いることで、別のActivityを開始することが出来ます。下記の例は、MainActvitiyからSampleActivityに遷移させる時のコード例です。

val intent:Intent = Intent(this,SampleActivity().javaClass)
startActivity(intent)

　Intent(this,SampleActivity().javaclass))というのがIntentのメッセージの内容を示しており、thisはMainActivityの事なので、Intentには「MainActivityからSampleActivityを開く」という意味が込められていることになります。
　そしてstartActivityという関数にintentを受け渡すことで、処理が行われます。

　また、上記の例でSampleActivityから何かしらの結果を受け取りたい場合は、startActivityForResult()という関数を呼び出すことで、MainActivityでSampleActivityの結果を受け取ることができます。こちらについては最初に下記のようにAcitivtyを開始させます。

startActivityForResult(intent,1)

　1というのはREQUEST_CODEなので、Int型であれば何でも大丈夫です。
その後、MainActivityに画面が戻った時に、onActivityResultというコールバック関数でデータなどを受け取ることが可能です。
　Intentにデータを含める方法は後述します。

override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
	super.onActivityResult(requestCode, resultCode, data)
}

Serviceを起動する

　続いて、Intentを使ったServiceについてですが、Serviceとは「ユーザーインターフェースを持たず、バックグラウンドで操作を実行するコンポーネント」を表しています。例えば音楽アプリの場合だと、音楽をバックグラウンドでも再生したいという際などに、Serivceを用いて可能にします。
　Serivceを起動するにはIntentを利用する必要があり、SampleServiceというServiceを継承させたクラスの場合には、下記のように実行します。

val intent:Intent = Intent(this,SampleService().javaClass)
startService(intent)

　使い方としては、Activityとほぼ同じになります。また、Android 5.0(APIレベル21)以降では、サービスを開始するためにJobSchedulerを利用することができます。JobSchedulerの場合には、通常Intentを使わないで利用されますので、こちらについては別記事で説明します。

ブロードキャストを配信する

　最後にブロードキャスト配信についてです。ブロードキャストという言葉にはネットワークを学んだことがある方であれば馴染み深いと思いますが、「全員に送る」というような意味が込められています。すなわち、Androidアプリ開発におけるブロードキャストとは、全アプリに対して送ることが出来るメッセージを意味します。
　下記がコード例ですが、Intentを用いてIntentに内容を詰め込み、sendBroadcastで送信することが出来ます。受け取るときはBroadcastReceiverというクラスを用いて、実際のデータを受け取ります。

Intent().also { intent ->
	intent.setAction("com.example.intentapplication.broadcast.MY_NOTIFICATION")
	intent.putExtra("data", "通知だよ！")
	sendBroadcast(intent)
}

インテントタイプについて

　インテントには2種類のタイプが存在します。インテントは何かしらのメッセージをリクエストするものというのは冒頭に説明しましたが、例えば「メールアプリを開く」という場合や、「マップアプリを開く」という動作を行いたい場合に、暗黙的インテントを利用することでユーザーに利用するアプリを選択させることが出来ます。
　ここでは2種類のタイプの、「明示的インテント」と「暗黙的インテント」について説明します。

明示的インテント

　明示的インテントとは、特定のアプリを指定した上で処理を実行させるパターンです。例えば「Activityを起動する」という項目がありましたが、こちらはMainActivity、すなわち自分自身のアプリのMainActivityに対して、自分自身のSampleActivityという画面を遷移させるコード例を見せましたが、これが明示的にアプリを指定して動作させているということになります。

暗黙的インテント

　一方で暗黙的インテントでは、特定のアプリを指定するのではなく、OSに対して「地図を表示したい」というリクエストをインテントを通して伝えてあげることで、端末上で利用できるアプリを探し出し、選択できるようにすることができます。
　下記の例では、いくつかのマップアプリをインストールした状態で、「地図を表示したい」という暗黙的インテントを発行した際に、表示されるものになります。OSがマップアプリと認識しているアプリに対して、ユーザーにどれを選ぶか選択させるような画面が表示されます。

インテントを使ってデータを渡す

　最後にインテントを使って、何かしらのデータを送りたい時に、どんなデータが渡せることができ、どうやって渡すのかを説明したいと思います。

アクション

　まず1つ目ですが、アクションというのは実行する「表示」や「選択」などのアクションを指定する文字列になります。これを利用することで、受け取る側はどんなアクションが来たかを判別できるようになります。
　インテントに含める際には、下記のように記述します。

intent.setAction(Intent.ACTION_VIEW)

　上記例ではACTION_VIEWというのを定義しており、ACTION_VIEWは「表示」という意味を表していて、マップアプリで住所を表示するときなどに利用されます。
　またACTION_SENDというのは共有できるデータが有る場合になどに利用されます。例えばメールアプリを開くときなどに、相手のメアド情報のデータなどが該当します。
　その他にもアクションはIntentクラス内で多数定義されていますので、確認してみてください。

Intent  |  API reference  |  Android Developers

developer.android.com

データ

　次にデータですが、こちらは何となく色んなデータを入れると思いがちですが、実際にはUriオブジェクトを代入します。例えばWebviewを使ってインターネットのサイトを開きたい場合、urlが必ず必要になりますので、このような場合にはインテントにurlを下記のように入れます。

intent.setData(Uri.parse("https://techgrowup.net"))

　またUriとして画像データなどを送る際には、オーディオファイルなどとは区別しなければならないので、MIMEタイプを指定することになります。MIMEタイプはsetTypeで呼び出すことができ、下記のように指定します。

intent.setData(Uri.parse("file:///sdcard/sample.jpg"))
intent.setType("image/jpeg")

カテゴリ

　続いてカテゴリですが、こちらはコンポーネントの種類に対する追加情報を含めるためのものです。よく使われるカテゴリだと、CATEGORY_BROWSABLEやCATEGORY_LAUNCHERなどがあります。例えば下記の例だと、遷移先のActivityは、ウェブブラウザから開始してリンクで参照されているデータを表示することが出来ます。

intent.addCategory(Intent.CATEGORY_BROWSABLE)

　カテゴリもIntentクラス内に多数のカテゴリが定義されていますので、興味がある方は見てみてください。

Intent  |  API reference  |  Android Developers

developer.android.com

エクストラ

　続いてエクストラについてですが、こちらはキーバリュ型で様々データを含めることが可能です。例えば遷移先のActivtiyに5という数値を渡したい場合には、下記のように渡します。

intent.putExtra("NUMBER",5)

　NUMBERというのはキーのことで、このキーを元に遷移先のActivityで受け取るときは下記のようにして受け取ることが出来ます。

getIntent().getIntExtra("NUMBER",0)

　第2引数の0というのはデフォルト値のことで、NUMBERというキーが存在しなかった場合は0を返すという処理になります。

　その他にも、文字列や浮動小数点、論理型など様々なデータを含めることが可能です。

フラグ

　最後がフラグになります。フラグはインテントのメタデータとして機能させることが出来るもので、こちらもIntentクラス内に多数の定義があります。例えば下記の例だと、Activityを新しいタスクとして定義することができるメタデータになります。

intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK)

まとめ

　今回はAndroidアプリ開発におけるIntentの概要から、実際の使い方を説明しました。またデータを送る際のコードと、受け取る時のコードなどを解説しました。
　Intentはアプリ開発では画面遷移時やServiceを使うときなどに必ず使うものですので、ぜひ覚えておきましょう。

　本記事ではAndroidアプリ開発における、パーミッション(権限）についての説明と一覧を紹介したいと思います。

パーミッション(権限)とは

　Androidアプリ開発における、パーミッション（権限）とは、アプリを利用するユーザーを保護するために、特定の機能に対してアクセス保護を行うためのものです。例えば、ユーザーの連絡先情報やカメラやBluetoothなど該当します。これらをユーザーの許可なしに勝手にアプリが利用してはプライバシーに影響が出ると同時に、犯罪に繋がる恐れがあります。以下パーミッションを権限と呼びます。

　Android 6.0まではGoogle Playのインストール時に、取得したい権限を表示すればよかったのですが、Android 6.0以降は特定の権限に関しては、アプリ内で同意を取る必要があります。皆さんも下記画面は見たことがあるのではないでしょうか。こちらが同意されると、アプリに対して権限が付与されるという仕組みになります。

　また、権限は好き放題つけていいわけではなく、使うものだけにしましょう。例えば位置情報を利用しないアプリなのに、位置情報の権限をしてはいけません。セキュリティの面やユーザーを守るためにも必要な権限のみをつけましょう。

パーミッション(権限）の使い方

　続いて、権限を実際にどうやって使っていくのかを説明します。まず記載する場所ですが、AndroidManifest.xmlに記載していきます。下記がAndroidManifest.xmlの画面ですが、
<uses-permission>というタグが見えるかと思います。こちらを利用して権限の宣言をしていきます。また、その他にも設定できるオプションがありますので、合わせて説明します。

<uses-permission>

　まず先ほども紹介した、<uses-permission>タグについてです。こちらは利用したい権限を宣言することで、アプリに該当の権限を付与できるタグです。例えばインターネットを利用する場合は、以下のように宣言します。

<uses-permission android:name="android.permission.INTERNET" />

　また、外部ストレージに書き込み権限を付与するためには以下のように記載します。

 <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

　見てみるとおわかりになると思いますが、INTERNETというキーワードと、WRITE_EXTERNAL_STORAGEの名前が違うだけですよね。これが該当の権限のキーワードということになります。

<uses-feature>

　続いて、<uses-feature>タグについてです。こちらはハードウェアやソフトウェアの機能要件を満たさない端末からアプリをフィルタします。例えば、Bluetoothを利用するアプリが、Bluetoothが搭載されていない端末（最近はあまりありませんが）に対してダウンロードされても利用することが出来ませんので、このような場合、Google Playの配信端末から排除することが出来ます。

　具体的に利用する場合は、下記のようにAndroidManifest.xmlに記述します。

<uses-feature android:name="android.hardware.bluetooth" />

保護レベル

　権限には保護レベルという考え方が存在します。保護レベルとは各権限に対してGoogleが危険性を判断し、定義づけているものです。具体的には各権限は“normal” , “dangerous”, “signature”, に振り分けられています。それぞれについて説明します。
　※signatureOrSystemというレベルもありますが、今回は省きます。

normal

　normalとはその名の通り、低リスクとみなされている権限につけられています。これが付けられている権限はユーザに対して同意を取得する必要はなく、インストール時に表示しておくだけで、アプリは権限を取得することが可能になります。
　例えばACCESS_NETWORK_STATEという権限は、アプリケーションがネットワークの状態を取得するための権限になりますが、これを取得されてもユーザーは大きなリスクを追わないため、normalとなります。

dangerous

　dangerousとは、危険という意味ですが、こちらは該当権限を利用するとユーザーに悪影響があると考えられる権限に対して付けられています。例えば、CAMERAという権限はアプリがカメラにアクセスできるようになる権限ですが、カメラ機能はユーザーのプライバシーに大きな影響を与えるものになるため、ユーザーの同意がなければ利用しようしてはいけないと考えれられ、dangerousに指定されています。

signature

　signatureは通常の権限ではなく、システム権限と呼ばれる端末を製造しているメーカーが作成した権限で特定の機能を利用できるようにした権限です。例えばDELETE_PACKAGESという、他のアプリを消すことができる権限は、かなり強力ですよね。この権限を持ったアプリが、他のアプリを勝手に削除してしまっては大変なことになるので、signatureが付けられています。
　基本的には端末を製造しているメーカーが作るアプリなどに、特定の機能が必要な場合のみメーカー署名が使われて、権限が使われることや、ルート化されている端末に対しては利用することが可能になります。（一般に売られている端末はルート化されていませんが、脱獄という方法が使える場合があります）

パーミッション(権限）一覧

　続いて、権限はたくさんありますので、覚えられない方も多くいると思います（私もあまりお覚えていません）。ここに主要な権限の一覧を記載しておきますので、お気に入りなどに入れ必要な時に見て頂ければと思います。

カスタム権限について

　カスタム権限とは、アプリ開発者自身が権限を作成し、機能を制限できる機能のことです。カスタム権限を定義すると、他のアプリとリソースや機能の共有をすることが可能になります。
　例えば、通常アプリは他のアプリを起動させることが可能なのですが、他のアプリから自分のアプリを起動されたくないような場合に、カスタム権限を持っている他のアプリのみ自分のアプリを起動することが出来るような権限を作ることが出来ます。以下が例になります。

    <permission
        android:name="com.example.myapplication.MY_PERMISSION"
        android:label="@string/permissoion_label"
        android:description="@string/permission_description"
        android:permissionGroup="android.permission-group.COST_MONEY"
        android:protectionLevel="normal" />

　これで定義が完成しましたので、これを利用したい場合には、他のアプリから以下のようにりようすることで、カスタム権限を利用することができるようになります。

    <uses-permission android:name="com.example.myapplication.MY_PERMISSION" />

まとめ

　本記事ではAndroidアプリ開発における、パーミッション（権限）の概要や、使い方、主要なパーミッション一覧、カスタム権限について説明しました。
　Androidアプリ開発では昨今のプライバシーの規制も相まって、必ず権限については確認し、適切に利用することが必要ですので、ぜひ覚えましょう。

　本記事では、Androidアプリ開発における重要な知識として、apk,aab,obbファイルの概要について説明します。また、Google Play配布時における注意点や、ビルド方法についても説明しています。

apkとは　

　apkとは「Android Application Package」の略称で、.apkの拡張子を持ち、Androidスマホや端末にアプリとしてインストールできるファイルのことです。分かりやすい例でいうと、Windowsだとソフトをインストールする時に、.exeファイルというものをインストールすると思います。.apkファイルも同様にAndroid内でアプリケーションをインストールするためのものです。
　apkの中身としてはzip形式のファイルのようなもので、apkを開くと中にアプリケーションを構築するためのファイルなどが格納されています。一般的にはGoogle Playで配布されていることが多く、ユーザーがGoogle Playからapkファイルをダウンロードし、インストールしています。一方あまり知られていはいないですが、Google Driveのようなファイル管理ツールでも、apkをインストールすることも可能です。

aabとは

　aabとは「Android App Bundle」の略称で、.aabの拡張子を持ち、多種多様なAndroid端末にapkを配布できるようにしたパッケージの形です。昨今では端末メーカも様々なAndroid端末を出しており、apkファイルをそれぞれの端末に合わせて作っていくのは骨が折れる作業になってしまうので、Googleが「aabの場合は、Google Playで端末に合わせて最適なapkを提供するよ」ということをしてくれます。
　aabファイルのメリットとしては下記があげられます。

• ファイルサイズを縮小化できる
• 複数の端末に適したapkを配布してくれる
• 署名の生成・管理はGoogle Playがしてくれる（これは会社によってはダメな場合もあります）

obbとは

　obbとは、「Opaque Binary Blob」の略称で、apkファイルを拡張するためのものです。Google Playではapkの場合は100MB、aabの場合は150MB以下のサイズにしないとユーザーへアプリを配布できません。大抵のTwitter,Facebook,Lineなどのアプリでは大きなサイズにならないため気にする必要はありません。一方ゲームやARアプリなど、アプリ単体で大きな容量が必要になるアプリはそのまま配布することは出来ません。このような場合に上限2GBまでのファイルをobbファイルとしてGoogle Playに添付することが出来ます。
　※ちなみに以前にはGoogle Playからアプリをダウンロードした後、ユーザーはアプリ内で「追加コンテンツをダウンロード」のような、せっかくアプリをダウンロードしたのに追加コンテンツのダウンロードに時間がかかるといった、操作性の悪い状況が起こっていました。obbはこれを解消したものです。

　obbを活用することで、ユーザーはGoogle Playからのダウンロード時に、apkファイルと同時にobbファイルもまとめてダウンロードすることになります。こうすることダウンロード完了と同時に、アプリを開けば必要なファイルが揃っているのですぐにアプリやゲームを始めることが可能になります。

アプリ署名とは

　アプリ署名とは、apkファイルに対して証明書としてサインをすることです。例えばクレジットカードなどを利用する時に名前を求められることがあると思います。これは本人確認を筆跡で鑑定できるように手書き文字を証明書として代用しています。これと同様に、apkを配布するときも、そのアプリが誰のものなのか明確にする必要があります。

　実際に署名する際には、２つのパターンがあります。１つ目がAndroid Studioによって手動で署名を作成し、アプリに付与する方法です。こちらの場合には署名の管理や作成の手間はかかりますが、信頼性が最も高く自らが無くさなければ安全ということになります。

　２つ目はGoogle Play側で作成・管理を行うものです。apkファイルを一般のユーザー向けに配布する際、apkをGoogle Playにアップロードしますが、その際に署名を同時に行ってくれ、後の管理も全てGoogleに任せることが可能になります。大企業の場合ですとセキュリティ面やコンプライアンスの懸念もあるため迷う部分もあると思いますが、小規模や個人レベルであればGoogle に任せる方法が最も良い方法可と思います。

Android Studioのビルド方法

　最後に実際にapkファイルや、aabファイルをどうやってビルドするのか説明したいと思います。apk,aabファイルを作成するにはAndroid Studioでビルドを行うことが出来ます。Android Studioタブの[Build]→[Build Bundle(s)/APK(s)]→[Build Bundle(s)] or [Build APK(s)]を選択することで、そのプロジェクト内のソースコードを、apkファイルもしくはaabファイルにビルドすることが出来ます。

　また、同様の[Build]タブから[Generate Signed Bundle/APK]を押すことで、アプリ署名の作成やビルドしたアプリに署名を付与することが可能になります。

　ちなみに作成したapk,aabファイルの中身もAndroid Studioで確認することが可能です。今回はapkファイルの中身を見てみましょう。作成されたapkファイルをAndroid Studioにドラッグアンドドロップすると下記のような画像が表示されます。

　冒頭にも説明しましが、apkファイルそのものはzipファイルのようなパッケージになっているだけなので、中身を見ることが可能です。様々なファイルやフォルダがありますが、例えばAndroidManifest.xmlはアプリの設定が記載されているファイルですが、これらも実際に開くことでソースコードを見ることが可能です。

　逆に言うと、このようなAndroidManifestファイルなどのアプリ情報は一般公開されていると認識してもらえればと思います。更にclasses2.dexというファイルがあると思いますが、こちらに実際のソースコードが入っていますので、ソースコードを「難読化」という処理を行わないと、セキュリティ要素の高いソースコードまで一般の誰でも見れるようになってしまうので注意してください。
　※難読化については、また別の記事で説明します。

まとめ

　今回はAndroidアプリ開発における、apk,aab,obb、署名とは何かについて説明しました。これらはアプリをGoogle Playやお客様に配布する際や自分の端末にインストールして確認するときなどには大事なものなので、しっかりと覚えておきましょう。

　実際にAndroidアプリを作ってみたい方は下記から始めてみてください！

Android Studioをインストールする手順(Mac)

Android Studioのインストール手順です。Android Studioインストーラーのダウンロードから各種セットアップ、Android AVD(エミュレータ)の設定などを画像つきで確認することが出来ます。

techgrowup.net

　本記事では、BottomNavigationViewを利用してタブを実装し、タブごとのページをFragmentを利用して実装します。
　※説明をみながらソースコードを見たいという方がいれば、下記Githubからソースをダウンロードしてください

GitHub - daichi-mizuno-tech/BottomNavigationApp: BottomNavigationViewを利用したタブアプリケーション

BottomNavigationViewを利用したタブアプリケーション. Contribute to daichi-mizuno-tech/BottomNavigationApp development by creating an acc...

github.com

タブアプリについて

最終的なゴール

　今回作るものは下記のような動画のアプリケーションになります。シンプルですが、タブを配置し、タブの切替、Webページ、Webページの設定などをFragment間で切り替えられる仕様になっています。

アプリのUI構成

　アプリのUI構成については、画面下部にタブを2つ配置し、それぞれ「ホーム」「設定」というタブを作りたいと思います。
　また、それぞれのタブを押すとFragmentが切り替わり、「ホーム」タブでは本サイトの記事が表示されるWebViewを使い、「設定」画面ではWebviewの設定を変更できるようにします。ホーム画面と設定画面のデータのやりとりはSharedPreferencesというクラスを利用して受け渡しています。

利用するライブラリ(クラス)の説明

Webview

　WebViewとはViewというクラスの拡張で、ウェブページを表示するためのものです。通常みなさんがウェブページを開くときは、SafariやChromeなどのブラウザを利用すると思いますが、自分のアプリなのに毎回ユーザーにChromeなどを開かせると、利便性が悪くなってしまいます。
　そこでWebViewをアプリ内に組み込むことで、自分のアプリ内でウェブページを開くことができます。Chromeのようにブックマーク、ナビゲーション、アドレスバー等はないためシンプルなものにはなりますが、とても使いやすいです。

BottomNavigationView

　BottomNavigationViewとは画面下部にボタンを配置し、ナビゲーションを実装するためのクラスで、ユーザーが画面を切り替えるために利用されています。
　このBottomNavigationViewを利用すると、タブ切り替えの実装やボタンの配置などを自由に簡単にカスタマイズできたり、Fragmentとの相性がいいためコンポーネント単位で実装が用意になります。

SharedPreferences

　SharedPreferencesはアプリ内のデータを追加/保存/修正/削除などをxml形式で簡単に保存できるようにしたクラスです。通常データを保存する際にはAndroidのSQLiteというDBを使うこともありますが、データ量が少ないのであればDBを作るのは高機能すぎるため、大きなデータを扱わない限りは、SharedPreferencesで十分と言えます。
　余談ですが、Androidアプリではデータを保存するためにxml以外にもjsonファイルなどもよく利用されます。

アプリの実装

実装の流れを考える

　アプリを開発するときは、どのような流れで実装を行っていくか考えましょう。今回の場合だとタブを切り替えて各画面を表示し、Webview画面と設定画面の中身が表示されるという流れになりますので、流れとしては下記で行っていきます。

1. BottomNavigationViewでタブの実装
2. タブを押した時に表示するFragment(ホームと設定）の実装
3. ホーム画面のWebviewの実装
4. 設定画面の設定項目の実装
5. 設定を保存するためのSharedPreferencesの実装
6. 細かい部分の調整

　また、ここからは流れに沿ってソースコードを記載しますが、ソースコードを記述する場所や関数名、レイアウトの中身などは細かく説明しませんので、少しずつ自分で調整してみてください。

1.BottomNavigationViewでタブの実装

　まずBottomNavigationViewを利用するためにタブを作成するための/resフォルダの下に、/menu/my_nav_item.xmlを作成します。これをBottomNavigationViewにつけることで、タブが作成できます。

<?xml version="1.0" encoding="utf-8"?>
<menu xmlns:android="http://schemas.android.com/apk/res/android">
    <item android:id="@+id/action_home"
        android:title="ホーム"
        android:icon="@drawable/ic_baseline_home_24" />
    <item android:id="@+id/action_setting"
        android:title="設定"
        android:icon="@drawable/ic_baseline_settings_24" />
</menu>

　次にmain_activity.xmlのレイアウトにBottomNavigationViewを下位置に配置します。そして、MainActivity.ktにBottomNavigationView.OnNavigatiojnItemSelectedListenerを継承させ、タブが押されたときのコールバック関数を定義します。
　続いて、レイアウトに配置したBottomNavigationViewをfindViewByIdで参照し、onNavigationItemSelectedを加えます。最後にonNavigationItemSelectedのコールバック関数内で各タブ(アイテム）が選択された時にFragmentを参照するような処理にします。参照するときのレイアウトはFrameLayoutを使ってcontainerというidを使っています。

class MainActivity : AppCompatActivity() ,BottomNavigationView.OnNavigationItemSelectedListener{


	override fun onCreate(savedInstanceState: Bundle?) {
		super.onCreate(savedInstanceState)
		setContentView(R.layout.activity_main)

		initializeResource()
	}

	fun initializeResource(){
//		BottomNavigationViewを設定
		val bottomNavigationView = findViewById<BottomNavigationView>(R.id.bottom_navigation_view)
		bottomNavigationView.setOnNavigationItemSelectedListener(this)
		bottomNavigationView.itemIconSize = 70
		bottomNavigationView.scaleX = 1.2f
		bottomNavigationView.scaleY = 1.2f

	}

	override fun onNavigationItemSelected(item: MenuItem): Boolean {
		Log.d(TAG,"Selected item: " + item)

		when(item.itemId){
//			ホームボタンが押された時
			R.id.action_home -> {
				supportFragmentManager.beginTransaction()
						.replace(R.id.container,HomeFragment())
						.setReorderingAllowed(true)
						.commit()
			}
//			設定ボタンが押された時
			R.id.action_setting -> {
				supportFragmentManager.beginTransaction()
						.replace(R.id.container,SettingFragment())
						.setReorderingAllowed(true)
						.commit()
			}

		}

		return true
	}

	companion object{
		const val TAG : String = "MainActivity"
	}
}

2.タブを押した時に表示するFragment(ホームと設定）の作成

　タブの設定が終わったので、次にタブを押した時にcontainerのidに表示するFragmentを作成します。作成方法はAndroid Studioのメニューから右クリックをし、[New]->[Fragment]->[Fragment(Blank)]で作成することができます。
　今回は「HomeFragment」と「SettingFragment」という名前のFragmentを作りました。

3.ホーム画面のWebviewの実装

　続いて、HomeFragmentにWebViewを実装します。Fragment作成時に、fragment_home.xmlというレイアウトファイルができていると思いますので、そちらにWebViewを全体に配置します。

4.設定画面の設定項目の実装

　続いて、SettingFragment作成時にも、fragment_setting.xmlというレイアウトファイルができていると思いますので、こちらに「Webviewで読み込むURL」，「キャッシュ方法」、「ズーム倍率」をユーザーが入力するためのビューと、「保存」ボタンを配置します。
　※配置方法がよくわからない場合は、とりあえずUIが崩れていても問題ないので配置してみてください。

5.設定を保存するためのSharedPreferencesの実装

　続いて、SettingFragmentで修正や保存したデータをHomeFragmentでも利用したいので、MySharedPrefsというクラスを作成し、SharedPreferencesを利用します。
　※クラスの作成方法は、プロジェクト内のパッケージ名で右クリックし、[New]->[Kotlin Class/File]で作成できます。

　MySharedPrefesの中身としては、url、キャッシュ方法、ズーム倍率を保存/取得したいので、下記のように記述します。

class MySharedPrefs (context: Context){
	private val preferences = context.getSharedPreferences("MyPrefs", Context.MODE_PRIVATE)
	private val urlKey = "url"
	private val cacheKey = "cache"
	private val zoomKey = "zoom"

	fun getUrl() : String?{
		return preferences.getString(urlKey,"https://techgrowup.net/")
	}

	fun setUrl(value : String){
		val editor = preferences.edit()
		editor.putString(urlKey,value)
		editor.apply()
	}

	fun getCache() :  Int{
		return preferences.getInt(cacheKey, CACHE_DEFAULT)
	}

	fun setCache(value: Int){
		val editor = preferences.edit()
		editor.putInt(cacheKey,value)
		editor.apply()
	}

	fun getZoom() :  Int{
		return preferences.getInt(zoomKey, ZOOM_DEFAULT)
	}

	fun setZoom(value: Int){
		val editor = preferences.edit()
		editor.putInt(zoomKey,value)
		editor.apply()
	}

	companion object{
		const val CACHE_DEFAULT= 1
		const val NO_CACHE = 2
		const val CACHE_ONLY = 3

		const val ZOOM_DEFAULT = 100
	}
}

6.細かい部分の調整

　ここまでできたら、大枠がほとんど完成しましたので、ActivityとFragment同士を繋げます。初めに、SettingFragmentでMySharedPrefsにデータを保存する部分を作成します。下記がSettingFragment.ktの全体像です。

class SettingFragment : Fragment() {
    lateinit var  mySharedPrefs : MySharedPrefs

    lateinit var saveButton: Button
    lateinit var urlText : TextView
    lateinit var cacheRadioGroup : RadioGroup
    lateinit var zoomText: TextView


    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
    }

    override fun onCreateView(
        inflater: LayoutInflater, container: ViewGroup?,
        savedInstanceState: Bundle?
    ): View? {
        val view = inflater.inflate(R.layout.fragment_setting, container, false)
        initializeResource(view)

        return view
    }

    fun initializeResource(view : View){
//        SharedPreferenceのインスタンス生成
        mySharedPrefs = MySharedPrefs(context!!)

//        保存ボタンの初期設定
        saveButton = view.findViewById<Button>(R.id.save_button)
        saveButton.setOnClickListener {
            saveData(saveButton)
        }

//        埋め込みURLの初期設定
        urlText = view.findViewById<TextView>(R.id.url_plaintext)
        urlText.text = mySharedPrefs.getUrl()

//        キャッシュタイプラジオボタンの初期設定
        cacheRadioGroup = view.findViewById<RadioGroup>(R.id.cache_radiogroup)
        when (mySharedPrefs.getCache()){
            MySharedPrefs.CACHE_DEFAULT -> cacheRadioGroup.check(R.id.cache_default_radiobutton)
            MySharedPrefs.NO_CACHE -> cacheRadioGroup.check(R.id.nocache_radiobutton)
            MySharedPrefs.CACHE_ONLY -> cacheRadioGroup.check(R.id.cacheonly_radiobutton)
        }

//        ズーム倍率の初期設定
        zoomText = view.findViewById<TextView>(R.id.textzoom_plaintext)
        zoomText.text = mySharedPrefs.getZoom().toString()
    }


    fun saveData(view : View){
//        データの取得
        Log.d(TAG,"save datas")
        val url = urlText.text.toString()
        val checkedRadioButton = cacheRadioGroup.checkedRadioButtonId
        var cacheType = MySharedPrefs.CACHE_DEFAULT
        when(checkedRadioButton){
            R.id.cache_default_radiobutton -> cacheType = MySharedPrefs.CACHE_DEFAULT
            R.id.nocache_radiobutton -> cacheType = MySharedPrefs.NO_CACHE
            R.id.cacheonly_radiobutton -> cacheType = MySharedPrefs.CACHE_ONLY
        }
        val zoom = Integer.parseInt(zoomText.text.toString())

//        データの保存
        mySharedPrefs.setUrl(url)
        mySharedPrefs.setCache(cacheType)
        mySharedPrefs.setZoom(zoom)

        Toast.makeText(context,"データが更新されました。",Toast.LENGTH_LONG).show()
    }

    companion object {
       const val TAG : String = "SettingFragment"
    }
}

　これで設定画面でデータを保存することができるようになりましたので、続いてはHomeFragmentでMySharedPrefsから受け取る処理を作りたいと思います。以下がHomeFragmentの全コードです。

class HomeFragment : Fragment() {
    lateinit var  mySharedPrefs : MySharedPrefs

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

    }

    override fun onCreateView(
        inflater: LayoutInflater, container: ViewGroup?,
        savedInstanceState: Bundle?
    ): View? {
        val view = inflater.inflate(R.layout.fragment_home, container, false)
        initializeResource(view)

        return view
    }

    fun initializeResource(view : View){
//        SharedPreferenceのインスタンス生成
        mySharedPrefs = MySharedPrefs(context!!)

//        データの取得
        val url = mySharedPrefs.getUrl()
        val cacheType = mySharedPrefs.getCache()
        val zoom = mySharedPrefs.getZoom()

//        WebViewの設定
        val webView = view.findViewById<WebView>(R.id.webview)
        webView.webViewClient = WebViewClient()
        webView.settings.javaScriptEnabled = true

        when(cacheType){
            MySharedPrefs.CACHE_DEFAULT -> webView.settings.cacheMode = WebSettings.LOAD_DEFAULT
            MySharedPrefs.NO_CACHE -> webView.settings.cacheMode = WebSettings.LOAD_NO_CACHE
            MySharedPrefs.CACHE_ONLY -> webView.settings.cacheMode = WebSettings.LOAD_CACHE_ONLY
        }

        webView.settings.textZoom = zoom
        webView.loadUrl(url!!)
    }

    companion object {
        const val TAG : String = "HomeFragment"
    }
}

　これで設定画面でデータを変更し、タブ切り替えでホーム画面でウェブページが変更されることが確認できると思います。実装の流れとしては以上になります。最後にできたアプリを確認してみましょう。

まとめ

　今回はタブを利用して画面を切り替えるアプリの実装をしてみました。BottomNavigationViewやWebView、SharedPreferencese、Fragmentなどは今後もよく利用するものですので、ぜひ覚えておきましょう。
　プロジェクト一式は下記に配置してありますので、参考にしてください。

GitHub - daichi-mizuno-tech/BottomNavigationApp: BottomNavigationViewを利用したタブアプリケーション

BottomNavigationViewを利用したタブアプリケーション. Contribute to daichi-mizuno-tech/BottomNavigationApp development by creating an acc...

github.com

本記事ではAndroidアプリ開発におけるフラグメント(Fragment)の概念と、アプリ開発に重要なライフサイクル、実際にどうやって使うのか等を説明しています。

フラグメント(Fragment)

フラグメント(Fragment)とは

　フラグメント(Fragment)とはアプリUIの再利用可能な部分を作ることが出来るビューです。Activityと比較すると、フラグメント(Fragment)はそれぞれの細かな単位でのレイアウトを定義して管理することができます。以下Fragmentと呼びます。
　また、ライフサイクルも持ち合わせているため、様々な制御が可能であったり、入力イベントの処理も行うことができます。

　Fragmentの位置付けとしてはUIの部品なので、常にActivityの子ビューとして構成する必要があり、Fragment単体では表示することはありません。良く使われる例としては、以下の図の構成があげられます。

　この例では、Activityという大きな枠に、「ホーム」ボタンと「設定」ボタンを配置しています。
「ホーム」ボタンと「設定」ボタンを押すと同時に、上部の「ホームFragment」と「設定Fragment」を切り替えるようなUIで、各FragmentがActivityからは独立しているので、Fragmentという1つのUI部品を再利用したり、修正したりすることが容易になります。
　また、Activityに依存していないため、複数のActivityから呼び出すことができます。そのため、再利用可能なコンポーネントにすることができます。Activityで画面を作成した場合には、その画面は別のActivityでは利用できませんので、Fragmentを利用するほうが汎用性が高まります。

Fragmentのライフサイクル

　続いてライフサイクルについて説明します。
前回Activityのライフサイクルについて説明しましたが、Activityと同様にFragmentもライフサイクルを持っており、ライフサイクルを意識した開発をする必要があります。
　※Activityのライフサイクルがわからない方は下記をご覧ください。

【Androidアプリ開発】アクティビティとライフサイクルの重要性

Androidアプリ開発におけるActivityとライフサイクルの概念を説明しています。Androidアプリ開発ではライフサイクルを意識することで、高品質なアプリを作ることが出来ますので、必ず学んでください。

techgrowup.net

　下記画像はGoogleが出している、Fragmentの公式ライフサイクル。詳しく見てみましょう。

　Activityと同じ部分コールバック関数は省略しますが、Fragmentのライフサイクルで重要な点としてはonAttach(),onCreateView(),onActivityCreated(),onDestoyView(),onDetach()です。
　Fragmentは前項で説明したように、単体で動作することはなく常にActivityの子ビューとして動作するため、AttachとDetach、英語を翻訳すると「付いた」「取り外された」という概念が存在します。

　Fragment自身からしてみれば、Activityに付けられた時点でUIが作成され、取り外された時点でUIを破棄しなければいけないので、破棄された時点でデータの保存や消去をしておく必要があります。下記は各コールバック関数の説明になります。

　よく利用されるやり方としては、onCreate()でフラグメントのコンポーネントの初期化や設定値の初期化を行い、onCreateView()でUIを描画するためのViewを返します。その後、onPause()やonStop()でデータや設定値などを保存しておくのが良いです。

FragmentManagerとは

　FragmentManagerとはその名通り、Fragmentを管理するためのクラスで、ActivityからFragmentの追加/削除/置換/バックスタックなどを検知し制御を行うためのクラスです。

　応用例としては、Activityの子ビューとして Fragmentを使うだけでなく、Fragmentの子ビュー、つまり、Activity→Fragment→Fragmentのような構成も作ることが出来るため、この場合にはFragmentクラス内でFragmentManagerを呼び出すことが必要となります。

FragmentTransactionとは

　FragmentTransactionとは、FragmentManagerでは各Fragmentに対して管理が出来るのに対して、FragmentTransactionは実際にActivityにFragmentを追加するためにcommit(コミット）を実行したり、Fragmentの入れ替えを行ったりすることが出来るクラスです。

　使い方としてはFragmentTranasctionでFragmentを表示させたり、バックスタックに移動させたりして、FragmentManagerで状態を管理します。

Fragmentの利用例

Fragmentの呼び出し

　ここでは実際にActivityからどうやってFragmentを呼び出すかKotlinのソースコードを確認してみましょう。SampleFragmentというFragmentを作り、Activity内にcontainerというidのFrameLayoutを配置しています。

supportFragmentManager.beginTransaction()
	.replace(R.id.container,SampleFragment())
	.setReorderingAllowed(true)
	.addToBackStack("name")
	.commit()

　上記の例では、supportFragmentMangerでFragmentManagerクラスを呼び出し、beginTransaction()関数でFragmentTransactionを取得しています。その後、replace関数でcontainerというidのFrameLayoutにSampleFragmentを配置するという処理です。
　また、setReorderingAllowedはFragmentの状態変更を最適化するためのもので、addToBackStackではユーザーが「戻る」ボタンを押すことにより、1つ前のFragmentに戻ることができるようになる設定です。最後に、.commit()で上記の設定を実行しています。

拡張できるサブクラス(DialogFragment,ListFragment)

　Fragmentはそのものを拡張(extends)することができますが、既に色々な用途で利用するための拡張クラスが用意されています。今回はDialogFragmentとListFragmentを紹介します。
　ソースコードの無駄を減らしたり、開発期間を短縮するためには、できるだけ車輪の再発明はせず、既に利用できるものをどんどんつかっていきましょう！

DialogFragment

　DialogFragmentとは、よくあるアプリであるような警告画面やお知らせ画面などのダイアログを出すためのFragmentです。こちらを利用することダイアログのカスタマイズが簡単に行えるようになります。

ListFragment

　ListFragmentとは、例えば求人情報のリストや、動画リストなど様々なリストを作るためのFragmentで、リスト型のUIを利用するときは、このListFragmentをカスタマイズすると簡単に作れるようになります。

FragmentとActivity間での通信

　続いてFragmentとActivityの間でデータのやりとり（通信）を行う方法について説明します。例えばFragmentでユーザーが入力したユーザー情報を、Fragmentが破棄された後にもActivityでも利用したい場合などが挙げられます。
　このような場合に、データや情報を渡すためにインターフェース(interface)を作りましょう。インターフェース(interface)とはその名の通り、特定のコンポーネント同士の橋渡しになるような通り道/トンネルのようなものを作るための機能です。

　コードの書き方としては、FragmentとActivity側の両方に「データを送る処理」と「データを受け取る処理」を記述する必要があります。まずFragmentの方から見ていきましょう。

var listener: OnInputUserNameListener? = null

interface OnInputUserNameListener {
        fun onInputUserName(name: String)
}

　上記の例では、ユーザー名を入力する時をイメージしており、OnInputUserNameListenerというインターフェイスを作成しています。このインターフェースの中にはonInputedUserNameという関数が用意されており、この関数を実行することでインターフェースを通して情報を伝えることが可能になります。　
　続いてonInputedUserNameを実行するために、ユーザーの名前を入力するときに、この関数を実行させます。

listener?.onInputedUserName("なまえ")

　最後に、Activity側でFragment内に作成した、OnInputUserNameListenerのインターフェースを継承(implements)して、onInputedUserNameコールバック関数を作成します。。

override fun onInputedUserName(name: String) {
　　　　//Fragmentでユーザーの名前が入力されると、このコールバック関数が呼び出される
}

　このようにすると、Fragment側でユーザー名をが入力された時に、onInputedUserName関数が実行され、それと同時にActivity側のonInputedUserNameコールバック関数も実行され、FragmentのデータをActivityに受け渡すことが可能になります。
　

まとめ

　今回はFragmentの基本として、Fragmentの概念やライフサイクル、インターフェースを作成したデータの受け渡し方法などを説明しました。

　今までの知識を利用して、下記記事では実際にFragmentを利用したタブアプリケーションの実装を説明しています。、一般的によくあるタブ付きのアプリで画面の切り替えや、ライフサイクルを意識したアプリを作ってみたいと思います。

【Androidアプリ開発】タブで画面を切り替えるアプリの実装

Andriodアプリ開発におけるタブで画面を切り替えるアプリの実装方法を説明しています。タブを利用することで複数の画面を行き来し、ユーザーにとって分かりやすく使いやすいアプリを作ることが出来ますので、学んでみましょう。

techgrowup.net

　本記事ではAndroidアプリ開発における、重要な概念の一つであるライフサイクルについて、アクティビティ（Activity)を例にして説明していきます。

アクティビティ（Activity)とは

アクティビティ（Activity)について

　Androidアプリ開発におけるアクティビティ（以下Activity)とは、「Androidアプリの画面」のことを指しています。通常皆さんがアプリを開くときは、アプリアイコンなどを押した後に画面が開き、ボタンを押したり入力などを行うと思います。その時にボタンやテキストボックスが置かれている画面そのものを1つのActivityとして理解してください。
　多くのアプリでは画面は1つではなく複数の画面から成り立っていることが多く、その場合にはActivityも複数になります。
　※Androidアプリ開発では１つのActivityに対してFragment（フラグメント）を利用して複数画面を作成する方法もありますので、詳しくは以下を参照してください。

【Androidアプリ開発】タブで画面を切り替えるアプリの実装

Andriodアプリ開発におけるタブで画面を切り替えるアプリの実装方法を説明しています。タブを利用することで複数の画面を行き来し、ユーザーにとって分かりやすく使いやすいアプリを作ることが出来ますので、学んでみましょう。

techgrowup.net

2024.10.29

アプリ画面の構成

　ここで画面を作成する時の構成を見てみましょう。

　Activityは様々な要素を持っており、画像のステータスバーやアクションバーなどの制御も可能になります。また、アプリとして必要なボタンやテキストボックスなどの要素（ビュー）もActivity内部に配置することができるます。

　プロジェクト内でのActivityの作り方については下記ページを参考に作成してみてください。

【Androidアプリ開発】簡単な画面遷移アプリを作成する

Androidアプリ開発を始めて間もない方に向けて、簡単な画面遷移アプリを作成する記事となっています。アプリにおいて画面遷移は必ず必要な要素ですので、ぜひ学習しましょう。

techgrowup.net

2024.10.29

AndroidManifest.xmlへの宣言

　Activityを利用するときには、AndroidManifest.xmlへ宣言（定義）する必要があります。これはアプリがどんなActivityを持っていて、どんな設定がされているかを認識するためです。例としてデフォルトで作成されるMainActivityの<acitivty>タグを見てみましょう。

        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>

name属性として.MainActivityと記述されていますが、これはMainActivity.ktクラスを指しています。また、intent-filterというタグがあると思いますが、こちらはaction, category, dataという属性を追加することができます。各要素についての説明は下記です。

　Intentについての説明は下記にまとめてあります。

【Androidアプリ開発】Intentとは、Intentの使い方とは。

Androidアプリ開発における、Intentについての概要を説明し、実際の使い方についてコード例を交えながら解説しています。画面遷移やService,Broadcast配信などに利用される重要な概念ですので、ぜひ学びましょう。

techgrowup.net

2024.10.31

Activityのライフサイクル

ライフサイクルとは

　Androidアプリ開発ではライフサイクルを意識して開発することが特に重要で、例えば「アプリを利用している時に電話が掛かってきた場合」や「アプリ利用中に電源ボタンを押してスリープになった場合」などに、アプリがクラッシュするようでは良いアプリとは言えません。
　ライフサイクルとはActivityやFragment(フラグメント）がどのように生まれて、どのように破棄されるのかをサイクルとして定義しているものになります。ライフサイクルを考慮することによって、アプリが一時的に止まった時や再開した時に復帰できるように処理を作ることができます。

Activityのライフサイクルの種類

　Googleが公式で出している、Activityのライフサイクルの流れを見てみましょう。

　Activityが始まってから、終了するまでの一連の流れが示されています。続いて、たくさんの項目がありますが、各項目について表にまとめます。

ライフサイクルの動作確認

　実際にActivity内のライフサイクルがどのように動いているか、ソースコードを書いて確認してみましょう。今回はライフサイクルのonCreate、onStart()、onResume()、onPause()、onStop()、onDestroy()の6種類のコールバック関数に、ログを入れてアプリを動かしながら確認します。
　下記コードをMainActivityに記述しましょう。

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        Log.d("MainActivity","onCreate")
    }

    override fun onStart(){
        super.onStart()
        Log.d("MainActivity","onStart")
    }

    override fun onResume(){
        super.onResume()
        Log.d("MainActivity","onResume")
    }

    override fun onPause(){
        super.onPause()
        Log.d("MainActivity","onPause")
    }

    override fun onStop(){
        super.onStop()
        Log.d("MainActivity","onStop")
    }

    override fun onDestroy(){
        super.onDestroy()
        Log.d("MainActivity","onDestroy")
    }

　Log.dというのはログをデバッグとして出力するための関数です。
　※Android Studioでログを確認するにはLogcatウィンドウを開きます。詳しくは動画を御覧ください。

　いかがでしょうか。アプリが「開く」、「閉じる」、「バックグラウンドに移る」などの動作によって、Activityのライフサイクルが変わることがLogcatで確認できましたでしょうか。
　どのAndroid端末でも、Activityのライフサイクルは同じですので、必ず覚えてください。また、ActivityではなくFragment(フラグメント）の場合だとライフサイクルは変わりますので、Androidアプリ開発ではライフサイクルを意識することが大切ということを覚えておきましょう。
　Fragment(フラグメント）のライフサイクルについては下記を見てみてください。

【Android】フラグメント(Fragment)の基本とライフサイクル

Androidアプリ開発におけるフラグメント（Fragment)の概念やライフサイクルを意識した使い方を説明しています。フラグメント（Fragment)はUIを作る上で再利用可能に出来る有用なコンポーネントなので、ぜひ学びましょう。

techgrowup.net

2024.08.24

まとめ

　今回はActivity（アクティビティ）についてと、Activity(アクティビティ）におけるライフサイクルについて説明しました。Androidアプリ開発では特に重要な概念ですので、必ず覚えてください。