More than 5 years have passed since last update.

Androidのサポートライブラリに含まれるTargetApiとRequiresApiの違い

Posted at 2019-03-03

ターゲットSDKの警告対処のためにアノテーションが2つ用意されているので、違いをメモ

概要

TargetApiは、SDKバージョンの警告を単純に無視するアノテーション
RequiresApiは、SDKバージョンの責任を呼び出す側に転嫁させるアノテーション

具体的な挙動の違い

アノテーションを付与したメソッド内の挙動

Androidのアプリではしばしば、動作させる環境のSDKバージョンにより処理を分岐させる必要が生じる

例えば、minSdkVersionが21(=Android L=5.0)かつtargetSdkVersionが26(=Android O=8.0)のアプリに通知機能を搭載する場合、SDKバージョン26以上限定で「通知チャネル」を作成する必要がある
これを、以下のように実装する

MainActivity.kt

class MainActivity : AppCompatActivity() {

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

        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
            createNotificationChannel()
        }
    }

    private fun createNotificationChannel() {
        NotificationUtil.createNotificationChannel(this)
    }
}

NotificationUtil.kt

object NotificationUtil {

    fun createNotificationChannel(context: Context) {
        context.applicationContext.apply {
            val notificationManager = getSystemService(Context.NOTIFICATION_SERVICE) as NotificationManager
            val channel = NotificationChannel(
                    "channel_news",
                    getString(R.string.notification_channel_news_label),
                    NotificationManager.IMPORTANCE_DEFAULT
            )
            notificationManager.createNotificationChannel(channel)
        }
    }
}

NotificationUtilオブジェクトのcreateNotificationChannelメソッド内に存在するNotificationChannelのインスタンス化は、SDKバージョン26以上を必要とするAndroidのAPIであるため注意する必要があるが、呼び出し元であるMainActivityのonCreateメソッド内で「SDKバージョン26(=O)以上」と分岐しているため、構造上問題ない
しかし、Android Studioでこのコードを入力すると、以下のように赤警告が出てしまう（エラーのように見えるが、ビルドは可能）