Lintとは？何に使うの？

Android開発者として、私たちは皆、アプリケーションを開発するためにAndroid Studioを使用しています。 Android アプリケーションの開発に使用できるエディターは他にもたくさんありますが、私が Android Studio を使う一番の魅力は、Android 開発者に提供されるサポートです。このサポートは、自動提案の形式であったり、コード (プロジェクトに存在するすべてのファイル) のエラーを表示する形式であったりします。

そこで、このブログでは、エラーなしのコードを書く方法を改善するのに役立つ Android Studio の最高の機能の 1 つである Lint を紹介したいと思います。このブログで説明するトピックは次のとおりです：

Lint とは何か？
Lintの設定
Lintを助ける
ベースラインの使用
手動での検査実行
結論

それでは、始めましょう。

Lintとは何か

Lintを助けるには？

Lint は、プロジェクトに存在する誤ったコードや危険なコードを特定、提案、修正するために Android Studio が提供するコードスキャンツールです。

Lint は、本格的なスタック解析フレームワークのようなものです

Android Studio はデフォルトですべてのプロジェクトで Lint をサポートしているので、私たちは皆 Lint を使用し始めてからずっと使ってきました。 Lint によってあなたのコードで検出された問題は、いくつかの提案と警告レベルとともに報告されます。あなたは、あなたのコードを修正するために提案を使用することができます。 Lintの最も優れた点は、あなたの必要に応じてLintを使えることです。もし、あなたのプロジェクトで特定のタイプのエラーを見たい場合、Lintはそのタイプのエラーだけを表示します。 Lintはカスタマイズ可能です。デフォルトでは、Android Studio はプロジェクトをビルドするたびに検査プロセスを実行しますが、これとは別に、Lint の助けを借りて手動またはコマンドラインからコードを検査することも可能です。 Android Developer website

Lint の全プロセスは、次の 3 つのステップにまとめることができます:

lint.xml ファイルを作成する。 lint.xmlファイルでLintのチェックをカスタマイズすることができます。このファイルには、含めたいチェックを書き、含めたくないチェックを無視することができます。例えば、未使用の変数の問題をチェックし、命名の問題はチェックしたくない場合、lint.xmlファイルでこれを行うことができます。これとは別に、Lintのチェックを手動でカスタマイズすることもできます。
アプリケーションのソースファイルです。次のステップでは、Lintチェックを実行するソースファイルを選択します。 .java ファイル、.kt ファイル、またはプロジェクトの任意の xml ファイルを使用できます。
Lint ツール。最後に、Lint ツールはソースファイルと lint.xml ファイルを取得し、コードの構造的な問題をチェックし、もしあればコードのいくつかの改善を提案します。アプリを公開する前に lint の提案を使用することが推奨されます。

When to use Lint?

プレイストアまたは任意のアプリケーションストアでアプリを公開したい場合、エラーのないアプリを持ちたいと思うことでしょう。この目的のために、アプリに対して非常に多くのテストを手動で実行する必要があります。しかし、あなたが手動テストのいくつかを取り除きたい場合は、プロジェクトでLintを使用することができます。あなたは、コードの各ファイルを検査して、いくつかのエラーを見つけることができ、Lintはエラーを識別して、いくつかの答えを提案します。エラーや警告は次のようなものがあります:

未使用の変数
未処理の例外
プロジェクトで使用されていないインポート、その他多数

したがって、アプリの公開前に、Lint でコードを完全に検査する必要があります。

また、プロジェクトのさまざまなレベルに対して Lint チェックを構成することができます。

グローバル (プロジェクト全体)
プロジェクトモジュール
プロダクションモジュール
テストモジュール
オープンファイル
Class 階層
Version Control System (VCS) スコープ

Lint の設定

プロジェクトで Lint または単に検査を実行するために、Lint を使用します。でLintインスペクションを追加することができます。xml ファイルに追加するか、Android Studio を使用してプロジェクトで lint によって設定する課題のリストを手動で選択します。

lint ファイルを設定する。アプリで手動チェックを指定するには、lint.xml ファイルに設定する問題のリストを追加します。

以下は lint.xml ファイルの例です:

<?xml version="1.0" encoding="UTF-8"?><lint> <!-- Disable the given check in this project --> <issue severity="ignore" /> <!-- Ignore the ObsoleteLayoutParam issue in the specified files --> <issue> <ignore path="res/layout/activation.xml" /> <ignore path="res/layout-xlarge/activation.xml" /> </issue> <!-- Ignore the UselessLeaf issue in the specified file --> <issue> <ignore path="res/layout/main.xml" /> </issue> <!-- Change the severity of hardcoded strings to "error" --> <issue severity="error" /></lint>

lint を手動で設定する。デフォルトでは、lint はいくつかの問題をチェックしますが、すべての問題をチェックするわけではありません。これは、lint がチェックできるすべての問題チェックを実行すると、Android Studio のパフォーマンスが低下するためです。そのため、Android Studioでは、デフォルトで限られた数のlintチェックしか使用されません。

ファイル > 設定 > エディター > 検査に移動し、lint が実行したい問題チェックをチェックします

Helping Lint

危険なコードやエラーが多いコードを書いているのに lint がコードにエラーや警告を示していないことがよくあります。たとえば、Android Studio で次のコードを記述します。

fun updateUi() { // code goes here networkRequest()}fun networkRequest() { // code goes here }

上記のコードの行はエラーを表示しませんが、論理的には、UI の更新中にネットワーク要求を呼び出してはならないため、何らかのエラーが表示されるはずです。

Help Lint helps you

そうです、もしあなたが Lint を助けるなら、Lint もあなたを助けるでしょう。ですから、lint がコードをより正確に理解するのを助けるために、あなたのプロジェクトでは常に注釈を使用するようにしてください。

@UiThreadfun updateUi() { // code goes here networkRequest()}@WorkerThreadfun networkRequest() { // code goes here}

ですから、コードにアノテーションを使うことでLintを助けてください。

ベースラインを使う

もしあなたが非常に大きなプロジェクトで働いていて、プロジェクトにいくつかのコードを追加しながら、将来発生するかもしれないエラーを見つけたいなら、プロジェクトにベースラインを追加して、そうすることでLintはそのベースラインの後に発生したエラーを生成することができます。

プロジェクトにベースラインを追加するには、プロジェクトの build.gradle ファイルに次の行を追加します:

android { lintOptions { baseline file("lint-baseline.xml") }}

これで、プロジェクトのベースラインを確立する lint-baseline.xml が作成されます。別のベースラインを追加するには、このファイルを削除して、再度 lint を作成します。

ここでできるもう 1 つのことは、任意のタイプの問題チェックをここだけで有効にできることです。たとえば、Kotlin 相互運用性チェックを有効にするには、次のコードを記述します。

android { lintOptions { baseline file("lint-baseline.xml") }}

enable "Interoperability"

Manually run inspections

Androidスタジオでファイルを手動で検査するには、次の手順に従います：

Step 1: 検査するファイルに移動します。以下のウィンドウが表示されます：

画像提供: Android Developer の Web サイト

ここで、プロジェクト全体、モジュール、または単にファイルなど、検査範囲を選択できます。範囲を選択した後、[OK] をクリックします。

次のウィンドウが表示されます：

画像提供:Picture courtesy: Android Developer Web サイト

エラーのカテゴリ、タイプ、および問題のリストが表示されます。

他のペイン (右ペイン) には、選択したエラーの検査レポートが表示されます。

まとめ

このブログでは、Android Studio で Lint を使用する方法について学びました。コードを分析する場合、手動で行う必要はないことがわかりました。 Android Studio にはコードチェックツールの Lint があり、コードをきれいにして、アプリケーション開発に必要な正しいコードを使用するのに役立ちます。

ですから、プロジェクト内のさまざまな種類のエラーを取り除くために Lint を使用し、Lint があなたを手助けするのを助けましょう。