在Android应用中使用Google reCAPTCHA
在本教程中,我们将学习Google reCaptcha的工作流程,并将其集成到我们的Android应用中。Google的reCaptcha可以保护我们的应用免受恶意流量的侵害。它是使用SafetyNet API实现的。
Google reCaptcha的工作原理:
Google reCAPTCHA通过Android应用程序、SafetyNet服务器和您的服务器之间的网络调用来进行验证。
- Android应用程序使用 站点密钥 向 SafetyNet 服务器发出reCAPTCHA验证请求。
- SafetyNet 服务器使用站点 密钥 生成验证码令牌的响应,并将其发送给Android应用程序。
- 验证码令牌通过 密钥 发送到您的服务器进行验证。
- 您的Android服务器使用 SafetyNet 服务器发送请求,使用Secret 密钥 验证验证码令牌。
- SafetyNet 验证令牌响应,并将结果返回为成功或失败。
- 您的Android服务器通过验证令牌将结果返回给Android应用程序,并返回结果为成功或失败。
生成reCAPTCHA网站密钥和秘密密钥:
在创建API密钥之前,请仔细阅读API服务条款 https://developers.google.com/terms/ 。
- 注册Android reCAPTCHA网站 https://g.co/recaptcha/androidsignup 。
- 提供标签、包名和接受reCAPTCHA条款和服务的输入详细信息。
标签 :这是您的密钥的唯一标签。您可以使用您公司或组织的名称。 包名 :这是您的安卓应用程序的包名。
- 网站密钥、密钥、客户端集成代码和服务器端代码在下一页生成。
Android集成Google reCAPTCHA示例
让我们创建一个在Android应用程序中集成Google reCAPTCHA的示例。
build.gradle
在build.gradle文件中添加以下SafetyNet和Volley依赖项。
dependencies {
implementation 'com.google.android.gms:play-services-safetynet:15.0.1'
implementation 'com.android.volley:volley:1.0.0'
}
AndroidManifest.xml
在AndroidManifest.xml文件中添加互联网权限
<uses-permission android:name="android.permission.INTERNET" />
activity_main.xml
将以下代码添加到activity_main.xml文件中。
<?xml version="1.0" encoding="utf-8"?>
<android.support.constraint.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context="example.javatpoint.com.googlerecaptcha.MainActivity">
<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginBottom="8dp"
android:layout_marginEnd="8dp"
android:layout_marginStart="8dp"
android:layout_marginTop="8dp"
android:text="Google Recaptcha"
android:textAppearance="@style/Base.TextAppearance.AppCompat.Large"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintEnd_toEndOf="parent"
app:layout_constraintHorizontal_bias="0.436"
app:layout_constraintLeft_toLeftOf="parent"
app:layout_constraintRight_toRightOf="parent"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toTopOf="parent"
app:layout_constraintVertical_bias="0.017" />
<Button
android:id="@+id/button"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginBottom="52dp"
android:layout_marginEnd="8dp"
android:layout_marginStart="8dp"
android:text="Verify captcha"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintEnd_toEndOf="parent"
app:layout_constraintStart_toStartOf="parent" />
</android.support.constraint.ConstraintLayout>
MainActivity.java
将以下代码添加到MainActivity.java类文件中。在这个类中,我们与SafetyNet服务器进行客户端集成,并以JSON字符串形式获取响应。
将SITE_KEY和SECRET_KEY的值替换为您实际的Site Key和Secret Key。点击按钮时,它调用SafetyNet.getClient()方法获取Site Key,如果返回成功,则调用handleSiteVerify()进行令牌验证。
Volley库用于以下目的:
- Volley库的RequestQueue维护了服务器调用队列。
- StringRequest用于从您的服务器获取响应的JSON字符串。
- setRetryPolicy()方法在时间限制内如果服务器调用失败则重试。
package example.javatpoint.com.googlerecaptcha;
import android.support.annotation.NonNull;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.View;
import android.widget.Button;
import android.widget.Toast;
import com.android.volley.DefaultRetryPolicy;
import com.android.volley.Request;
import com.android.volley.RequestQueue;
import com.android.volley.Response;
import com.android.volley.VolleyError;
import com.android.volley.toolbox.StringRequest;
import com.android.volley.toolbox.Volley;
import com.google.android.gms.common.api.ApiException;
import com.google.android.gms.common.api.CommonStatusCodes;
import com.google.android.gms.safetynet.SafetyNet;
import com.google.android.gms.safetynet.SafetyNetApi;
import com.google.android.gms.tasks.OnFailureListener;
import com.google.android.gms.tasks.OnSuccessListener;
import org.json.JSONObject;
import java.util.HashMap;
import java.util.Map;
public class MainActivity extends AppCompatActivity implements View.OnClickListener{
String TAG = MainActivity.class.getSimpleName();
Button btnverifyCaptcha;
String SITE_KEY = "6LeaN24UAxxxxx_YOUR_SITE_KEY";
String SECRET_KEY = "6LeaN24UAxxxxx_YOUR_SECRET_KEY";
RequestQueue queue;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
btnverifyCaptcha = findViewById(R.id.button);
btnverifyCaptcha.setOnClickListener(this);
queue = Volley.newRequestQueue(getApplicationContext());
}
@Override
public void onClick(View view) {
SafetyNet.getClient(this).verifyWithRecaptcha(SITE_KEY)
.addOnSuccessListener(this, new OnSuccessListener<SafetyNetApi.RecaptchaTokenResponse>() {
@Override
public void onSuccess(SafetyNetApi.RecaptchaTokenResponse response) {
if (!response.getTokenResult().isEmpty()) {
handleSiteVerify(response.getTokenResult());
}
}
})
.addOnFailureListener(this, new OnFailureListener() {
@Override
public void onFailure(@NonNull Exception e) {
if (e instanceof ApiException) {
ApiException apiException = (ApiException) e;
Log.d(TAG, "Error message: " +
CommonStatusCodes.getStatusCodeString(apiException.getStatusCode()));
} else {
Log.d(TAG, "Unknown type of error: " + e.getMessage());
}
}
});
}
protected void handleSiteVerify(final String responseToken){
//it is google recaptcha siteverify server
//you can place your server url
String url = "https://www.google.com/recaptcha/api/siteverify";
StringRequest request = new StringRequest(Request.Method.POST, url,
new Response.Listener<String>() {
@Override
public void onResponse(String response) {
try {
JSONObject jsonObject = new JSONObject(response);
if(jsonObject.getBoolean("success")){
//code logic when captcha returns true Toast.makeText(getApplicationContext(),String.valueOf(jsonObject.getBoolean("success")),Toast.LENGTH_LONG).show();
}
else{
Toast.makeText(getApplicationContext(),String.valueOf(jsonObject.getString("error-codes")),Toast.LENGTH_LONG).show();
}
} catch (Exception ex) {
Log.d(TAG, "JSON exception: " + ex.getMessage());
}
}
},
new Response.ErrorListener() {
@Override
public void onErrorResponse(VolleyError error) {
Log.d(TAG, "Error message: " + error.getMessage());
}
}) {
@Override
protected Map<String, String> getParams() {
Map<String, String> params = new HashMap<>();
params.put("secret", SECRET_KEY);
params.put("response", responseToken);
return params;
}
};
request.setRetryPolicy(new DefaultRetryPolicy(
50000,
DefaultRetryPolicy.DEFAULT_MAX_RETRIES,
DefaultRetryPolicy.DEFAULT_BACKOFF_MULT));
queue.add(request);
}
}
输出: