【Android】InputFilterを使ってEditTextの入力文字数を制限する方法

InputFilterでEditTextに入力できる文字数を制限する

この記事では、Androidアプリ開発においてInputFilterを使用して、EditTextに入力できる文字数を制限する方法を解説します。ユーザー名や検索キーワードなど、文字数に上限を設けたい入力フィールドがある場合に非常に便利なテクニックです。

InputFilterは、ユーザーが入力したテキストがEditTextに反映される前に処理を挟むことができる仕組みで、文字数制限以外にも大文字への自動変換や特定の文字の除外など、さまざまなカスタマイズが可能です。

実装手順

ステップ1：新規プロジェクトを作成する

Android Studioで新しいプロジェクトを作成します。メニューから「File」→「New Project」を選択し、必要な情報を入力してプロジェクトを作成しましょう。

ステップ2：レイアウトファイル（activity_main.xml）を編集する

res/layout/activity_main.xmlに以下のコードを追加します。ここでは、画面中央上にEditTextを配置するシンプルなレイアウトを定義しています。

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="https://schemas.android.com/apk/res/android"
    xmlns:tools="https://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">
    <EditText
        android:id="@+id/editText"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_centerHorizontal="true"
        android:layout_marginTop="40dp" />
</RelativeLayout>

ステップ3：MainActivity.javaに入力制限のコードを追加する

src/MainActivity.javaに以下のコードを追加します。setFilters()メソッドにInputFilter.LengthFilterを渡すことで、最大15文字までしか入力できないように設定しています。

import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.text.InputFilter;
import android.widget.EditText;
import android.widget.Toast;
public class MainActivity extends AppCompatActivity {
    EditText editText;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        editText = findViewById(R.id.editText);
        int maxTextLength = 15;
        editText.setFilters(new InputFilter[]{new InputFilter.LengthFilter(maxTextLength)});
        Toast.makeText(this, "EditText limit set to 15 characters", Toast.LENGTH_SHORT).show();
    }
}

ステップ4：AndroidManifest.xmlを確認・編集する

androidManifest.xmlに以下のコードを追加します。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="https://schemas.android.com/apk/res/android" package="app.com.sample">
    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>
</manifest>

アプリを実行して動作を確認する

それでは、実際にアプリを実行してみましょう。Android端末をパソコンに接続した状態で、Android Studioからプロジェクトのアクティビティファイルを開き、ツールバーの「Run」アイコンをクリックします。接続したモバイルデバイスを選択して実行すると、以下のようにEditTextの入力が15文字に制限されていることが確認できます。

まとめ

このように、InputFilter.LengthFilterを使えば、わずか数行のコードでEditTextの入力文字数を簡単に制限できます。XMLレイアウト側でandroid:maxLength="15"属性を指定する方法もありますが、コード側で動的に制御したい場合や、複数のフィルターを組み合わせたい場合には、今回紹介したsetFilters()を使う方法が柔軟でおすすめです。