在 Android 应用中请求短信验证

要自动验证电话号码,您必须同时实现验证流程的客户端和服务器部分。本文档描述了如何在 Android 应用中实现客户端部分。

要在 Android 应用程序中启动电话号码验证流程,请将电话号码发送到验证服务器并调用 SMS Retriever API 以开始侦听包含应用程序一次性代码的 SMS 消息。收到消息后,您将一次性代码发送回您的服务器以完成验证过程。

在你开始之前

要准备您的应用程序,请完成以下部分中的步骤。

应用先决条件

确保您的应用的构建文件使用以下值:

  • minSdkVersion 为 19 或更高
  • 28 或更高的 compileSdkVersion

配置您的应用

在项目级的build.gradle文件,包括谷歌的Maven仓库Maven的中央存储库在这两个你buildscriptallprojects部分:

buildscript {
    repositories {
        google()
        mavenCentral()
    }
}

allprojects {
    repositories {
        google()
        mavenCentral()
    }
}

加入谷歌Play服务的依赖性为SMS猎犬API到你的模块的摇篮构建文件,这是常用app/build.gradle

dependencies {
  implementation 'com.google.android.gms:play-services-auth:19.2.0'
  implementation 'com.google.android.gms:play-services-auth-api-phone:17.5.1'
}

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
    // ...
  }
});

SMS 检索任务将侦听最多五分钟的 SMS 消息,该消息包含用于标识您的应用程序的唯一字符串。

3. 将电话号码发送到您的服务器

在您获得用户的电话号码并开始侦听 SMS 消息后,使用任何方法(通常使用 HTTPS POST 请求)将用户的电话号码发送到您的验证服务器。

您的服务器会生成一条验证消息,并通过 SMS 将其发送到您指定的电话号码。请参见在服务器上执行短信验证

4. 接收验证消息

当用户的设备上收到确认邮件,播放服务明确广播对您的应用SmsRetriever.SMS_RETRIEVED_ACTION意向,其中包含了消息的文本。使用BroadcastReceiver接收该验证邮件。

BroadcastReceiveronReceive的处理程序,您可以通过意向的额外验证消息的文本:

/**
 * 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:
          // Get SMS message contents
          String message = (String) extras.get(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;
      }
    }
  }
}

注册此BroadcastReceiver与意图过滤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在应用的常数) AndroidManifest.xml文件,如在以下示例中,或者动态使用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. 将验证消息中的一次性代码发送到您的服务器

现在您有了验证消息的文本,使用正则表达式或其他一些逻辑从消息中获取一次性代码。一次性代码的格式取决于您在服务器中实现它们的方式。

最后,通过安全连接将一次性代码发送到您的服务器。当您的服务器收到一次性代码时,它会记录电话号码已通过验证。

可选:使用 Smart Lock for Passwords 保存电话号码

或者,在用户验证其电话号码后,您可以提示用户使用 Smart Lock for Passwords 保存此电话号码帐户,以便它可以在其他应用程序和其他设备上自动使用,而无需再次键入或选择电话号码:

Credential credential = new Credential.Builder(phoneNumberString)
        .setAccountType("https://signin.example.com")  // a URL specific to the app
        .setName(displayName)  // optional: a display name if available
        .build();
Auth.CredentialsApi.save(apiClient, credential).setResultCallback(
            new ResultCallback() {
                public void onResult(Result result) {
                    Status status = result.getStatus();
                    if (status.isSuccess()) {
                        Log.d(TAG, "SAVE: OK");  // already saved
                    } else if (status.hasResolution()) {
                        // Prompt the user to save
                        status.startResolutionForResult(this, RC_SAVE);
                    }
                }
            });

然后,在用户重新安装应用程序或在新设备上安装应用程序后,您可以检索保存的电话号码,而无需再次询问用户的电话号码:

// On the next install, retrieve the phone number
mCredentialRequest = new CredentialRequest.Builder()
    .setAccountTypes("https://signin.example.com")  // the URL specific to the developer
    .build();
Auth.CredentialsApi.request(apiClient, mCredentialRequest).setResultCallback(
    new ResultCallback<CredentialRequestResult>() {
        public void onResult(CredentialRequestResult credentialRequestResult) {
            if (credentialRequestResult.getStatus().isSuccess()) {
                credentialRequestResult.getCredential().getId();  // this is the phone number
            }
        }
    });

// Then, initiate verification and sign the user in (same as original verification logic)