本文首发于 vivo互联网技术 微信公众号
链接:mp.weixin.qq.com/s/EHomjBy4T…
作者:Sun Daxiang
Google 从 Android 6.0开始,提供了开放的指纹识别相关 API,通过此篇文章可以帮助开发者接入指纹验证的基础功能,并且提供了系统应用基于指纹验证的功能扩展,如指纹验证登录功能核心流程图和关键代码分析。
从Android 6.0开始,Android 系统支持指纹识别功能,指纹识别的API主要是FingerprintManager。
FingerprintManager提供的公共方法有,判断系统是否支持指纹,系统是否录入过指纹,发起指纹验证,取消验证,验证结果回调。
隐藏方法有,获取系统中指纹列表,获取指纹id等信息。然而 Android 9.0以后 Google官方不推荐使用FingerprintManager 接口, 推荐使用
BiometricPrompt代替, 因为BiometricPrompt接口不能够自定义弹框样式,各业务线还未统一使用,下面会介绍此接口接入方法:
因指纹功能有Android 6.0和 Android 9.0适配问题,所以使用FingerprintVersionM和FingerprintVersionP分别实现对不同 Android 版本的封装实现。
FingerprintManagerWrapper, FIngerpintVersionM,FingerprintVersionP都实现IFingerprintInterface接口,统一通过startAuth() cancelAuth方法。
调起指纹验证和取消指纹验证
核心类说明:
核心类的关系图:
通过下面的6步接入后,可以正常使用指纹验证功能,包括系统是否支持指纹,是否录入过指纹,拉起指纹验证,取消指纹验证,指纹验证结果回调,适配Android 6.0和Android 9.0。
第一步:在manifest文件中增加如下指纹权限功能 ,详细权限见2.1章节
第二步:组合判断,当前系统版本是否支持指纹功能,并且rom中已经录入过指纹 ,判断方法见2.5 和 2.6章节
第三步:使用FingerprintManagerWrapper对象调用IFingerprintInterface统一接口中startAuth方法,拉起指纹验证功能 方法见2.2章节
第四步:FingerprintVersionM和FingerprintVersionP分别实现IFingerprintInterface接口,分别实现 Android 6.0和 Android 9.0调起指纹验证功能
第五步:分别在FingerprintVersionM和FingerprintVersionP注册指纹验证成功的回调接口AuthenticationCallback 实现代码见 2.3章节
第六步:在activity生命周期onStop()调用取消验证接口,关闭指纹验证功能 见2.4章节
<!--android 9.0及以上系统使用指纹权限 --> <uses-permission android:name="android.permission.USE_BIOMETRIC"/> <!--android 6.0至8.0及以上系统使用指纹权限 --> <uses-permission android:name="android.permission.USE_FINGERPRINT"/> <!--android 6.0及以上,获取指纹信息权限,系统应用提升篇中会使用到 --> <uses-permission android:name="android.permission.MANAGE_FINGERPRINT"/>复制代码
FingerprintVersionP和FingerprintVersionM分别兼容 Android 6.0和 Android9.0指纹验证功能,FingerprintManagerWrapper,FingerprintVersionP,FingerprintVersionM统一实现IFingerprintInterface接口
public FingerprintManagerWrapper() { try { if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) { mFingerprintImp = new FingerprintVersionP(); } else if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) { mFingerprintImp = new FingerprintVersionM(); } } } /** * 先判断系统是否支持指纹,系统是否录入过指纹,再调用指纹认证统一方法 */ public void startAuth(FingerprintManagerWrapper.FingerVerifyResultListener listener) { Log.i(TAG, "------startFingerAuthenticate() enter --------"); //判断指纹设备当前是否可以使用 if (!isHardwareDetected()) { Log.e(TAG, "------hardware detected!!!--------"); return; } //判断当前是否有指纹 if (!hasEnrolledFingerprints()) { Log.e(TAG, "-----has no Fingerprints!!!--------"); return; } mFingerprintImp.startAuth(listener); } /** * android6.0android9.0统一验证和取消接口 */ interface IFingerprintInterface { public void startAuth(FingerprintManagerWrapper.FingerVerifyResultListener listener); public void canceAuth(); }复制代码
FingerprintVersionM中实现 Android 6.0指纹验证代码如下:
public class FingerprintVersionM implements IFingerprintInterface { @Override public void startAuth(FingerprintManagerWrapper.FingerVerifyResultListener listener) { //取消指纹验证类 CancellationSignal mCancellationSignal = new CancellationSignal(); MyAuthenticationCallback authenticationCallback = new MyAuthenticationCallback(); /** * 参数说明: * CryptoObject - 如果需要的话可以添加加密对象CryptoObject * CancellationSignal - 用来取消指纹验证,如果想手动取消验证,调用该参数的cancel方法 * int - 没意义,默认传0 * AuthenticationCallback - 回调验证的结果,成功、失败等 * Handler - 传null则默认创建一个在主线程上的Handler来传递消息 */ mFingerprintManager.authenticate(null, mCancellationSignal, 0, authenticationCallback, null); //调用识别接口 } }复制代码
FingerprintVersionP中实现 Android 9.0指纹验证代码如下:
public class FingerprintVersionP implements IFingerprintInterface { @Override public void startAuth(FingerprintManagerWrapper.FingerVerifyResultListener listener) { //用来取消指纹验证 CancellationSignal mCancellationSignal = new CancellationSignal(); //回调验证的结果,成功、失败等 AuthenticationCallback mAuthenticationCallback = new BiometricPrompt.AuthenticationCallback(){} //开始验证 mBiometricPrompt.authenticate(mCancellationSignal, mContext.getMainExecutor(), mAuthenticationCallback); } }复制代码
// 指纹验证失败回调方法 onAuthenticationFailed() //指纹验证成功回调方法 , 有系统权限可以通过AuthenticationResult 获取指纹的信息,指纹名称,指纹id等 onAuthenticationSucceeded(AuthenticationResult result) //指纹验证失败回调,helpMsgId=1006,helpString=6 手指移除太快 onAuthenticationHelp(int helpMsgId, CharSequence helpString) //指纹尝试多次后,指纹主动关闭。errMsgId=5,errString=指纹操作已取消。 onAuthenticationError(int errMsgId, CharSequence errString)复制代码
// android9.0以下使用 android.hardware.fingerprint.FingerprintManager.AuthenticationCallback //android 9.0以上使用 android.hardware.biometrics.BiometricPrompt.AuthenticationCallback private class MyAuthenticationCallback extends AuthenticationCallback { @Override public void onAuthenticationFailed() { //指纹验证失败回调方法 } @Override public void onAuthenticationSucceeded(AuthenticationResult result) { //指纹验证成功回调方法 , 有系统权限可以通过AuthenticationResult 获取指纹的信息,指纹名称,指纹id等 } @Override public void onAuthenticationHelp(int helpMsgId, CharSequence helpString) { //指纹验证失败回调,helpMsgId=1006,helpString=6 手指移除太快 } @Override public void onAuthenticationError(int errMsgId, CharSequence errString) { //指纹尝试多次后,指纹主动关闭。errMsgId=5,errString=指纹操作已取消。 } }复制代码
在activity的onStop方法中取消指纹验证功能
// 屏下指纹弹框home键或者被其他页面全部覆盖后,需要关闭,重新拉起 @Override protected void onStop() { super.onStop(); //上面调起指纹验证方法中,传入的CancellationSignal对象 mCancellationSignal.cancel(); }复制代码
FingerprintManager虽然在 Android 9.0以后不推荐使用,但是Google各系统版本都支持FingerprintManager,而且9.0及以上版本暂未提供判断是否支持指纹功能的 API
/** * 判断当前指纹功能是否可用 * * @return */ public boolean isHardwareDetected() { boolean isHardwareSupport = false; try { if (mFingerprintManager != null) { isHardwareSupport = mFingerprintManager.isHardwareDetected(); } } catch (Exception e) { Log.e(TAG, "isHardwareDetected err ", e); } Log.e(TAG, "isHardwareDetected(), isHardwareSupport= " + isHardwareSupport); return isHardwareSupport; }复制代码
同上使用FingerprintManager判断系统是否录入过指纹
/** * 判断是否录入过指纹 * * @return */ public boolean hasEnrolledFingerprints() { boolean hasEnrolledFinger = false; try { if (mFingerprintManager != null) { hasEnrolledFinger = mFingerprintManager.hasEnrolledFingerprints(); } } catch (Exception e) { Log.e(TAG, "hasEnrolledFingerprints err ", e); } Log.e(TAG, "hasEnrolledFingerprints(), hasEnrolledFinger= " + hasEnrolledFinger); return hasEnrolledFinger; }复制代码
以上基础篇介绍了 Google提供的公共 API , 基本满足指纹验证的功能。
下面介绍获取指纹id和指纹列表方法,可以满足其他业务需求,比如帐号登录,支付等功能。
1、获取到指纹id
指纹验证成功后,根据FingerprintManager.AuthenticationResult 对象可以通过反射方法获取到指纹id(指纹id是隐藏属性),需要添加权限
android.permission.MANAGE_FINGERPRINT, Android 6.0和 Android9.0中Fingerprint对象有差异:
Android 6.0中Fingerprint中包含有指纹id的属性mFingerprintId和public方法getFingerprintId
Android 9.0 中Fingerprint类继承BiometricAuthenticator.Identifer,并且指纹id也放入此类中,属性名为mBiometricId ,方法为getBiometricId
(Android 9.0 相关类依赖关系)
(Android6.0类图依赖关系)
因此使用反射获取Fingerprint对象和指纹id方法需要适配 Android 6.0和 Android 9.0,详细方法如下:
Android 6.0中AuthenticationResult反射获取Fingerprint对象,Fingerprint对象getFingerId获取到指纹id
Android 9.0以上指纹信息放在Fingerprint的父类中,所以需要通过clzz.getSuperclass()获取父类对象,在反射方法getBiometricId获取指纹 id
private static int getFingerId(AuthenticationResult result) { int fingerId = -1; try { Field field = result.getClass().getDeclaredField("mFingerprint"); field.setAccessible(true); Object fingerPrint = field.get(result); Class<?> clzz = Class.forName("android.hardware.fingerprint.Fingerprint"); if (Build.VERSION.SDK_INT > Build.VERSION_CODES.P) { Log.i(TAG, "-------ANDROID Q-------"); Class<?> supClass = clzz.getSuperclass(); Method getBiometricId = supClass.getDeclaredMethod("getBiometricId"); fingerId = (int) getBiometricId.invoke(fingerPrint); } else { Log.i(TAG, "------- ANDROID M-P-------"); Method getFingerId = clzz.getDeclaredMethod("getFingerId"); fingerId = (int) getFingerId.invoke(fingerPrint); } Log.d(TAG, "fingerId=" + fingerId); } catch (Exception e) { Log.e(TAG, "", e); } return fingerId; }复制代码
系统录入指纹,可以通过反射方法获取到指纹列表中,各指纹信息
通过反射后获取指纹列表json字符串:
android6.0:[{"mDeviceId":0,"mFingerId":1147763748,"mGroupId":0,"mName":"指纹 1"},{"mDeviceId":0,"mFingerId":412764029,"mGroupId":0,"mName":"指纹 2"}] android9.0: [{"mGroupId":0,"mBiometricId":-714471355,"mDeviceId":517254275456,"mName":"指纹 1"},{"mGroupId":0,"mBiometricId":-803114291,"mDeviceId":517254275456,"mName":"指纹 2"}]复制代码
详细的反射代码如下:
1: 将反射获取的指纹列表json字符串,使用gson转为AccountFingerprint对象(兼容android6.0-android10.0) Gson gson = new Gson(); Object object = getEnrolledFingerprints(mFingerprintManager); String fingerListString = gson.toJson(object) // android6.0-android9.0 [{"mDeviceId":0,"mFingerId":1147763748,"mGroupId":0,"mName":"指纹 1"},{"mDeviceId":0,"mFingerId":412764029,"mGroupId":0,"mName":"指纹 2"}] // android10.0 [{"mGroupId":0,"mBiometricId":-714471355,"mDeviceId":517254275456,"mName":"指纹 1"},{"mGroupId":0,"mBiometricId":-803114291,"mDeviceId":517254275456,"mName":"指纹 2"}] List<AccountFingerprint> list = gson.fromJson(fingerListString, new TypeToken<List<AccountFingerprint>>() {}.getType()); 2:反射FingerprintManager调用getEnrolledFingerprints方法获取已录入指纹列表 /** * 反射获取当前用户的所有指纹信息列表 * * @param fm FingerprintManagerWrapper * @return 指纹信息列表 */ public static Object getEnrolledFingerprints(FingerprintManager fm) { try { if (fm != null) { Object obj = invokeMethod(fm, "getEnrolledFingerprints"); return obj; } } catch (Exception e) { VLog.e(TAG, "getEnrolledFingerprints()", e); } return null; } 3: 自定义的AccountFingerprint bean,兼容android6-android10 //创建的指纹bean public class AccountFingerprint { @SerializedName("mBiometricId") private int mBiometricId; @SerializedName("mFingerId") private int mFingerId; @SerializedName("mGroupId") private int mGroupId; @SerializedName("mDeviceId") private long mDeviceId; @SerializedName("mName") private String mPrintName; }复制代码
举个栗子:获取指纹id和指纹列表后可以实现指纹登录功能
指纹登录效果
指纹登录交互时序图
更多内容敬请关注 vivo 互联网技术 微信公众号
注:转载文章请先与微信号:Labs2020 联系。