Kotlinのreturn文に付いている@について現役エンジニアが解説【初心者向け】

初心者向けにKotlinのreturn文に付いている@について現役エンジニアが解説しています。Kotlinのreturn文についている@(アットマーク)とは、returnする対象を明示する仕組みです。forEach文ではbreak文は使えず、returnを使ってしまうと直近の親の関数をreturnしてしまうからです。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事が4,000以上あります。現役エンジニアの方はこちらをご覧ください。

Kotlinのreturn文に付いている@について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して初心者向けに解説します。

初心者向けにKotlinの入門向けサイトをまとめた記事もありますので読んでみてください。

なお本記事は、TechAcademyのオンラインブートキャンプ、Androidアプリ開発講座の内容をもとに作成しています。

田島悠介

今回は、Androidアプリ開発に関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

Kotlinのreturn文に付いている@について詳しく説明していくね!

大石ゆかり

お願いします!

 

目次

 

ラベルとは

ラベルとはreturnする対象を明示する仕組みです。アットマーク「@」を使用して記述します。

[PR] Androidアプリの開発で挫折しない学習方法を動画で公開中

ラベルの作成例

ラベルは以下のように作成します。以下はforEachに対してラベル「myloop」を作成し、returnで対象を指定した例です。

(1..5).forEach myloop@ {
  if (it > 3) return@myloop
  println(it)
}

 

ラベル付きreturnの活用シーン

Kotlinの繰り返し関数であるforEachは正確には「高階関数」と呼ばれる「関数を引数として受け取ることができる」関数です。forEachはfor文と異なりbreakで繰り返し処理を中断することができません。以下はエラーとなります。

(1..5).forEach {
  if (it > 3) break
  println(it)
}

しかし、関数だからと言ってbreakの代わりにreturnを記述すると、直近の親の関数をreturnしてしまいます。このような場合にラベル付きreturnを活用すると便利です。例で確認してみましょう。ソースコードの入力と実行はKotlin Playgroundで行います。

Kotlin Playground

はじめはfor文です。

for (i in 1..5) {
  if (i > 3) break
  println(i)
}
println("end of function main.")

実行結果は以下のとおりです。

1
2
3
end of function main.

次はforEachです。はじめは何も付けずにreturnしてみます。

(1..5).forEach {
  if (it > 3) return
  println(it)
}
println("end of function main.")

実行結果は以下のとおりです。「end of function main.」が出力されず、直近の親の関数をreturnしてしまっていることが分かります。

1
2
3

続いてラベル付きreturnで行ってみます。

(1..5).forEach myloop@ {
  if (it > 3) return@myloop
  println(it)
}
println("end of function main.")

実行結果は以下のとおりです。for 文と同等の結果を得ることができました。

1
2
3
end of function main.

ラベルを付与しなくても、関数名を暗黙のラベルとして使用することも可能です。

(1..5).forEach {
  if (it > 3) return@forEach
  println(it)
}
println("end of function main.")

実行結果は同じになります。

1
2
3
end of function main.

 

まとめ

今回の記事ではラベルの使い方について学習しました。

監修してくれたメンター

太田和樹(おおたかずき)

ITベンチャー企業のPM兼エンジニア。

普段は主に、Web系アプリケーション開発のプロジェクトマネージャーとプログラミング講師を行っている。守備範囲はフロントエンド、モバイル、サーバサイド、データサイエンティストと幅広い。その幅広い知見を生かして、複数の領域を組み合わせた新しい提案をするのが得意。

開発実績:画像認識技術を活用した駐車場混雑状況把握(実証実験)、音声認識を活用したヘルプデスク支援システム、Pepperを遠隔操作するアプリの開発、大規模基幹系システムの開発・導入マネジメント。

地方在住。仕事のほとんどをリモートオフィスで行う。通勤で消耗する代わりに趣味のDIYや家庭菜園、家族との時間を楽しんでいる。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でも最短4週間で、Kotlinの技術を使ってAndroidアプリ開発を習得できる、オンラインブートキャンプを開催しています。

また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。