Androidでパスワードの表示・非表示を切り替える方法を解説

はじめに

ログインフォームや登録フォームでは、入力中のパスワードを確認したい場面が多くあります。ユーザーの入力ミスを防ぐためにも、パスワードの表示・非表示をワンタップで切り替えられる機能があると便利です。本記事では、Androidアプリでパスワードの表示と非表示を切り替える実装方法を、サンプルコード付きでわかりやすく解説します。

ステップ1: Android Studioで新規プロジェクトを作成

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

ステップ2: レイアウトファイル(activity_main.xml)の編集

res/layout/activity_main.xmlに、以下のコードを追加します。

<?xml version = "1.0" encoding = "utf-8"?>
<LinearLayout 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"
   android:background = "#dde4dd"
   android:orientation = "vertical">
   <android.support.design.widget.TextInputLayout
      android:layout_width = "match_parent"
      android:layout_height = "wrap_content"
      android:id = "@+id/layoutEmail"
      android:layout_marginTop = "8dp"
      android:layout_marginStart = "8dp"
      android:layout_marginEnd = "8dp"
      style = "@style/Widget.MaterialComponents.TextInputLayout.FilledBox">
      <android.support.design.widget.TextInputEditText
         android:layout_width = "match_parent"
         android:layout_height = "wrap_content"
         android:id = "@+id/email"
         android:hint = "Enter Email id"
         android:inputType = "textEmailAddress"/>
   </android.support.design.widget.TextInputLayout>
   <android.support.design.widget.TextInputLayout
      android:layout_width = "match_parent"
      android:layout_height = "wrap_content"
      android:id = "@+id/layoutPassword"
      android:layout_marginTop = "8dp"
      android:layout_marginStart = "8dp"
      android:layout_marginEnd = "8dp"
      style = "@style/Widget.MaterialComponents.TextInputLayout.FilledBox">
      <android.support.design.widget.TextInputEditText
         android:layout_width = "match_parent"
         android:layout_height = "wrap_content"
         android:id = "@+id/password"
         android:hint = "Password"
         android:inputType = "textPassword"/>
   </android.support.design.widget.TextInputLayout>
   <LinearLayout
      android:layout_width = "match_parent"
      android:gravity = "center"
      android:layout_height = "wrap_content">
      <Button
         android:id = "@+id/passwordVisible"
         android:layout_width = "wrap_content"
         android:layout_height = "wrap_content"
         android:text = "Show"></Button>
      <Button
         android:id = "@+id/click"
         android:layout_width = "wrap_content"
         android:layout_height = "wrap_content"
         android:text = "Click"></Button>
   </LinearLayout>
</LinearLayout>

このコードでは、メールアドレス用とパスワード用の2つのTextInputEditText、および「Show」と「Click」の2つのButtonを配置しています。「Click」ボタンをタップするとEditTextに入力された内容を取得してToastで表示し、「Show」ボタンをタップするとパスワードの表示・非表示が切り替わる仕組みです。

ステップ3: MainActivity.javaの実装

src/MainActivity.javaに、以下のコードを記述します。

package com.example.andy.myapplication;

import android.graphics.Point;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.text.method.PasswordTransformationMethod;
import android.view.TextureView;
import android.view.View;
import android.widget.Button;
import android.widget.EditText;
import android.widget.TextView;
import android.widget.Toast;

public class MainActivity extends AppCompatActivity {
   Button PasswordVisble;
   EditText email,password;
   @Override
   protected void onCreate(Bundle savedInstanceState) {
      super.onCreate(savedInstanceState);
      setContentView(R.layout.activity_main);
      email = findViewById(R.id.email);
      password = findViewById(R.id.password);
      PasswordVisble = findViewById(R.id.passwordVisible);
      PasswordVisble.setOnClickListener(new View.OnClickListener() {
         @Override
         public void onClick(View v) {
            if(password.getText().toString().isEmpty()){
               password.setError("Please Enter Pass word");
            } else {
               if(PasswordVisble.getText().toString().equals("Show")){
               PasswordVisble.setText("Hide");
               password.setTransformationMethod(null);
               } else {
                  PasswordVisble.setText("Show");
                  password.setTransformationMethod(new PasswordTransformationMethod());
               }
            }
         }
      });
      Button click = findViewById(R.id.click);
      click.setOnClickListener(new View.OnClickListener() {
         @Override
         public void onClick(View v) {
            if(!email.getText().toString().isEmpty()&&(!password.getText().toString().isEmpty())) {
            Toast.makeText(MainActivity.this, "you have entered email id " + email.getText().toString() + "Password " + password.getText().toString(), Toast.LENGTH_LONG).show();
            } else {
               email.setError("Please Enter Email id");
               password.setError("Please Enter Pass word");
            }
         }
      });
   }
}

パスワード表示切替の仕組み

パスワードの表示と非表示の切り替えには、PasswordTransformationMethodを使用します。ボタンのラベルが「Show」のときはパスワードを平文で表示し、「Hide」のときはマスク処理を行うことで、状態に応じた切替を実現しています。

if(PasswordVisble.getText().toString().equals("Show")) {
   PasswordVisble.setText("Hide");
   password.setTransformationMethod(null);
} else {
   PasswordVisble.setText("Show");
   password.setTransformationMethod(new PasswordTransformationMethod());
}

この処理を整理すると、次のようになります。

// パスワードを表示する場合
password.setTransformationMethod(null);

// パスワードを非表示(マスク)にする場合
password.setTransformationMethod(new PasswordTransformationMethod());

setTransformationMethod(null)を呼び出すと文字の変換処理が解除され、入力内容がそのまま表示されます。一方、PasswordTransformationMethodを設定すると、入力内容が「●」などの記号でマスクされ、通常のパスワード欄と同じ見た目になります。

ステップ4: build.gradleに依存関係を追加

build.gradleを開き、Design Support Libraryの依存関係を追加します。

apply plugin: 'com.android.application'

android {
   compileSdkVersion 28
   defaultConfig {
      applicationId "com.example.andy.myapplication"
      minSdkVersion 15
      targetSdkVersion 28
      compileSdkVersion 28
      versionCode 1
      versionName "1.0"
   testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
   }
   buildTypes {
      release {
         minifyEnabled false
         proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
      }
   }
}
dependencies {
   implementation fileTree(dir: 'libs', include: ['*.jar'])
   implementation 'com.android.support:appcompat-v7:28.0.0'
   implementation 'com.android.support:design:28.0.0'
   implementation 'com.android.support.constraint:constraint-layout:1.1.3'
   testImplementation 'junit:junit:4.12'
   androidTestImplementation 'com.android.support.test:runner:1.0.2'
   androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
}

ここではcom.android.support:designを追加することで、TextInputLayoutなどのMaterial Designコンポーネントが利用できるようになります。

アプリの実行と動作確認

それでは、アプリを実行してみましょう。Android端末をPCに接続した状態で、プロジェクト内のアクティビティファイルを開き、ツールバーのRunアイコンをクリックします。接続したモバイルデバイスを選択すると、端末に初期画面が表示されます。

これは初期画面です。パスワードを入力せずに「Show」ボタンをタップすると、上の画像のようにエラーメッセージが表示されます。

次に、パスワード欄に任意の文字列を入力してから「Show」ボタンをタップすると、下の画像のようにパスワードが平文で表示されます。

補足: より簡単な実装方法

なお、AndroidX / Material Components環境では、TextInputLayoutにapp:endIconMode="password_toggle"を指定するだけで、目のアイコンによるパスワード表示切替を自動的に実装できます。新規プロジェクトでAndroidXを使用している場合は、こちらの方法も検討するとよいでしょう。また、本記事のコードは旧supportライブラリ時代の実装例のため、新しいプロジェクトで利用する際はandroidxパッケージへの置き換えが必要になる点にご注意ください。