如需自动验证电话号码,您必须同时实现验证流程的客户端和服务器部分。本文档介绍了如何在 Android 应用中实现客户端部分。
如需在 Android 应用中启动电话号码验证流程,您需要将电话号码发送到验证服务器,并调用 SMS Retriever API 以开始监听包含应用专用一次性验证码的短信。收到短信后,您需要将一次性验证码发回服务器,以完成验证流程。
准备工作
为了让您的应用做好准备,请完成以下部分中的步骤。
应用要满足的前提条件
确保您应用的 build 文件使用以下值:
- minSdkVersion 19 或更高版本
- compileSdkVersion 28 或更高版本
配置您的应用
在项目级 build.gradle 文件中,同时在 buildscript
和 allprojects
两个部分中添加 Google 的 Maven 制品库和 Maven 中央制品库:
buildscript {
repositories {
google()
mavenCentral()
}
}
allprojects {
repositories {
google()
mavenCentral()
}
}
将 SMS Retriever API 的 Google Play 服务依赖项添加到模块的 Gradle build 文件(通常为 app/build.gradle
)中:
dependencies {
implementation 'com.google.android.gms:play-services-auth:21.3.0'
implementation 'com.google.android.gms:play-services-auth-api-phone:18.1.0'
}
1. 获取用户的电话号码
您可以使用适合您应用的任何方式获取用户的电话号码。通常,使用提示选择器提示用户从设备上存储的电话号码中进行选择,从而避免用户手动输入电话号码,是提供最佳用户体验的做法。如需使用提示选择器,请执行以下操作:
// Construct a request for phone numbers and show the picker
private void requestHint() {
HintRequest hintRequest = new HintRequest.Builder()
.setPhoneNumberIdentifierSupported(true)
.build();
PendingIntent intent = Auth.CredentialsApi.getHintPickerIntent(
apiClient, hintRequest);
startIntentSenderForResult(intent.getIntentSender(),
RESOLVE_HINT, null, 0, 0, 0);
}
// Obtain the phone number from the result
@Override
public void onActivityResult(int requestCode, int resultCode, Intent data) {
super.onActivityResult(requestCode, resultCode, data);
if (requestCode == RESOLVE_HINT) {
if (resultCode == RESULT_OK) {
Credential credential = data.getParcelableExtra(Credential.EXTRA_KEY);
// credential.getId(); <-- will need to process phone number string
}
}
}
2. 启动短信提取器
准备好验证用户的电话号码后,获取 SmsRetrieverClient
对象的实例,调用 startSmsRetriever
,并将成功和失败监听器附加到短信检索任务:
// Get an instance of SmsRetrieverClient, used to start listening for a matching
// SMS message.
SmsRetrieverClient client = SmsRetriever.getClient(this /* context */);
// Starts SmsRetriever, which waits for ONE matching SMS message until timeout
// (5 minutes). The matching SMS message will be sent via a Broadcast Intent with
// action SmsRetriever#SMS_RETRIEVED_ACTION.
Task<Void> task = client.startSmsRetriever();
// Listen for success/failure of the start Task. If in a background thread, this
// can be made blocking using Tasks.await(task, [timeout]);
task.addOnSuccessListener(new OnSuccessListener<Void>() {
@Override
public void onSuccess(Void aVoid) {
// Successfully started retriever, expect broadcast intent
// ...
}
});
task.addOnFailureListener(new OnFailureListener() {
@Override
public void onFailure(@NonNull Exception e) {
// Failed to start retriever, inspect Exception for more details
// ...
}
});
短信检索任务最多会监听五分钟,以便接收包含用于标识应用的唯一字符串的短信。
3. 将电话号码发送到您的服务器
获取用户的电话号码并开始监听短信后,请使用任何方法(通常使用 HTTPS POST 请求)将用户的电话号码发送到您的验证服务器。
您的服务器会生成一条验证消息,并通过短信将其发送到您指定的电话号码。请参阅在服务器上执行短信验证。
4. 接收验证消息
当用户设备上收到验证消息时,Play 服务会向您的应用明确广播包含消息文本的 SmsRetriever.SMS_RETRIEVED_ACTION
intent。使用 BroadcastReceiver
接收此验证消息。
在 BroadcastReceiver
的 onReceive
处理程序中,从 intent 的 extra 中获取验证消息的文本(以及可选的发件人地址):
/**
* BroadcastReceiver to wait for SMS messages. This can be registered either
* in the AndroidManifest or at runtime. Should filter Intents on
* SmsRetriever.SMS_RETRIEVED_ACTION.
*/
public class MySMSBroadcastReceiver extends BroadcastReceiver {
@Override
public void onReceive(Context context, Intent intent) {
if (SmsRetriever.SMS_RETRIEVED_ACTION.equals(intent.getAction())) {
Bundle extras = intent.getExtras();
Status status = (Status) extras.get(SmsRetriever.EXTRA_STATUS);
switch(status.getStatusCode()) {
case CommonStatusCodes.SUCCESS:
// (Optional) Get SMS Sender address - only available in
// GMS version 24.20 onwards, else it will return null
String senderAddress = extras.getString(SmsRetriever.EXTRA_SMS_ORIGINATING_ADDRESS);
// Get SMS message contents
String message = extras.getString(SmsRetriever.EXTRA_SMS_MESSAGE);
// Extract one-time code from the message and complete verification
// by sending the code back to your server.
break;
case CommonStatusCodes.TIMEOUT:
// Waiting for SMS timed out (5 minutes)
// Handle the error ...
break;
}
}
}
}
在应用的 AndroidManifest.xml
文件中,使用 intent 过滤器 com.google.android.gms.auth.api.phone.SMS_RETRIEVED
(SmsRetriever.SMS_RETRIEVED_ACTION
常量的值)和权限 com.google.android.gms.auth.api.phone.permission.SEND
(SmsRetriever.SEND_PERMISSION
常量的值)注册此 BroadcastReceiver
,如以下示例所示,或动态使用 Context.registerReceiver
。
<receiver android:name=".MySMSBroadcastReceiver" android:exported="true"
android:permission="com.google.android.gms.auth.api.phone.permission.SEND">
<intent-filter>
<action android:name="com.google.android.gms.auth.api.phone.SMS_RETRIEVED"/>
</intent-filter>
</receiver>
5. 将验证消息中的动态验证码发送到您的服务器
现在,您已经有了验证消息的文本,接下来使用正则表达式或其他逻辑从消息中获取动态密码。一次性代码的格式取决于您在服务器中实现这些代码的方式。
最后,通过安全连接将一次性验证码发送到您的服务器。当您的服务器收到一次性验证码时,会记录电话号码已通过验证。