Android App添加指纹锁

前言

在Android6.0（Api23）的时候，Android系统加入了指纹识别的api接口，即FingerprintManager，定义了最基础的指纹识别接口。不过，在AndroidP（Api28）的时候，官方不再推荐使用，做了@Deprecated处理。

后来，在support v4库中添加了FingerprintManagerCompat类，其实就是对FingerprintManager做了一定的封装，本质还是在用FingerprintManager来实现指纹识别功能。

最近也是在项目中遇到了这个需要，需要添加类似支付宝的每次打开APP时的应用锁，下面来介绍一下我的使用

1.版本判断

if (Build.VERSION.SDK_INT >= 23 && Build.VERSION.SDK_INT < 28)

在api23的时候使用旧的FingerprintManager，api28之后使用FingerprintManagerCompat，因为我在使用过程中FingerprintManagerCompat的版本判断中有点问题

2.创建实例

FingerprintManagerCompat mFingerprintManagerCompat = FingerprintManagerCompat.from(context);
CancellationSignal mCancellationSignal = new CancellationSignal();

FingerprintManagerCompat是我们要使用的实例，CancellationSignal是用来关闭指纹验证的

3.开启验证

  mFingerprintManagerCompat.authenticate(null, 0, mCancellationSignal, new FingerprintManagerCompat.AuthenticationCallback() {
                @Override
                public void onAuthenticationError(int errorCode, CharSequence errString) {
                    super.onAuthenticationError(errorCode, errString);
                    if (errorCode == FingerprintManager.FINGERPRINT_ERROR_LOCKOUT) {
                        fpResult.error(FingerprintManager.FINGERPRINT_ERROR_LOCKOUT, errString);
                }

                @Override
                public void onAuthenticationHelp(int helpCode, CharSequence helpString) {
                    super.onAuthenticationHelp(helpCode, helpString);

                }

                @Override
                public void onAuthenticationSucceeded(FingerprintManagerCompat.AuthenticationResult result) {
                    super.onAuthenticationSucceeded(result);

                    fpResult.success();
                }

                @Override
                public void onAuthenticationFailed() {
                    super.onAuthenticationFailed();

                    fpResult.retry(0, "authentication failed");
                }
            }, null);

authenticate()这个是关键方法，上图是所需参数，我们会一一介绍

CryptoObject：是一个加密的对象，指纹扫描器会使用这个对象来判断扫描结果的合法性，正常使用来说传null即可，感兴趣的朋友可以去官  网查看详细解释

flags：暂时为0，目前没有其他介绍

CancellationSignal：这个是我们上边介绍到的用来取消当前扫描操作

AuthenticationCallback：回调，这个是最关键的，回调中会有四个方法

onAuthenticationError：失败多次会执行，Android端如果认证失败五次会有30s的不可操作期，可以在这里给出提示，判断code等于7

onAuthenticationSucceeded：成功

onAuthenticationFailed：认证失败

onAuthenticationHelp：有一些错误会回调这个方法，可酌情处理

Handler：不用处理，有操作在上边回调中执行即可

到这里基本就ok了，下边我贴出我的工具类供参考

import android.app.KeyguardManager;
import android.content.Context;
import android.hardware.fingerprint.FingerprintManager;
import android.os.Build;
import android.support.v4.hardware.fingerprint.FingerprintManagerCompat;
import android.support.v4.os.CancellationSignal;
import android.util.Log;
import android.widget.Toast;

import cn.com.goldwind.eis.R;

public class FingerPrintUtils {

    private FingerprintManagerCompat mFingerprintManagerCompat;
    private CancellationSignal mCancellationSignal;
    private Context context;

    public FingerPrintUtils(Context context) {
        this.context = context;
        if (mFingerprintManagerCompat == null || mCancellationSignal == null) {
            mFingerprintManagerCompat = FingerprintManagerCompat.from(context);
            mCancellationSignal = new CancellationSignal();
        }
    }

    public interface FingerPrintResult {
        void success();

        void error(int code, CharSequence info);

        void retry(int code, CharSequence info);
    }

    /**
     * 关闭
     *
     * @return
     */
    public boolean cancelCallback() {
        if (mCancellationSignal != null && !mCancellationSignal.isCanceled()) {
            mCancellationSignal.cancel();
            mCancellationSignal = null;
            return true;
        } else {
            return false;
        }
    }

    /**
     * 开始
     */
    public void start(final FingerPrintResult fpResult) {
        if (fpResult == null) {
            throw new RuntimeException("FingerPrintUtils.init()参数Context或者FingerPrintResult为null");
        }
        if (mFingerprintManagerCompat.isHardwareDetected() && mFingerprintManagerCompat.hasEnrolledFingerprints()) {
            mFingerprintManagerCompat.authenticate(null, 0, mCancellationSignal, new FingerprintManagerCompat.AuthenticationCallback() {
                @Override
                public void onAuthenticationError(int errorCode, CharSequence errString) {
                    Log.d("-=-", "onAuthenticationError" + errString);
                    super.onAuthenticationError(errorCode, errString);
                    if (errorCode == FingerprintManager.FINGERPRINT_ERROR_LOCKOUT) {
                        fpResult.error(FingerprintManager.FINGERPRINT_ERROR_LOCKOUT, errString);
                    }// else {
//                        fpResult.retry(errorCode, errString);
//                    }
                }

                @Override
                public void onAuthenticationHelp(int helpCode, CharSequence helpString) {
                    super.onAuthenticationHelp(helpCode, helpString);
                    Log.d("-=-", "onAuthenticationHelp" + helpString);
//                    fpResult.retry(helpCode, helpString);
                }

                @Override
                public void onAuthenticationSucceeded(FingerprintManagerCompat.AuthenticationResult result) {
                    super.onAuthenticationSucceeded(result);
                    Log.d("-=-", "onAuthenticationSucceeded" + result);
                    fpResult.success();
                }

                @Override
                public void onAuthenticationFailed() {
                    super.onAuthenticationFailed();
                    Log.d("-=-", "onAuthenticationFailed");
                    fpResult.retry(0, "authentication failed");
                }
            }, null);
        } else {
            fpResult.error(-1, context.getString(R.string.fingerprint_recognition_not_support));
        }
    }

    /**
     * 判断是否支持指纹识别
     */
    public boolean supportFingerprint() {
        if (Build.VERSION.SDK_INT < 23) {
            Toast.makeText(context, context.getString(R.string.fingerprint_recognition_not_support), Toast.LENGTH_SHORT).show();
            return false;
        } else {
            KeyguardManager keyguardManager = context.getSystemService(KeyguardManager.class);
            FingerprintManagerCompat fingerprintManager = FingerprintManagerCompat.from(context);
            if (!fingerprintManager.isHardwareDetected()) {
                Toast.makeText(context, context.getString(R.string.fingerprint_recognition_not_support), Toast.LENGTH_SHORT).show();
                return false;
            } else if (keyguardManager != null && !keyguardManager.isKeyguardSecure()) {
                Toast.makeText(context, context.getString(R.string.fingerprint_recognition_not_support), Toast.LENGTH_SHORT).show();
                return false;
            } else if (!fingerprintManager.hasEnrolledFingerprints()) {
                Toast.makeText(context, context.getString(R.string.fingerprint_recognition_not_enrolled), Toast.LENGTH_SHORT).show();
                return false;
            }
        }
        return true;
    }
}

我上面给出的是FingerprintManagerCompat，可以自己写一个FingerprintManager，api基本一致，调用方法也都一样