android 8.0 Autofill Framework (自動填充框架)

maweiliang發表於2018-06-19

android 8 時 增加了一個自動填充框架,它是可以是我們在填寫表單是更加容易減少出錯,還可以我們減少填寫表單的時間,填寫表單是一項耗時且容易出錯的任務,使用者可能很容易對需要這些型別任務的應用感到沮喪,自動填充框架通過提供以下優勢來改善使用者體驗:

  • 更少的時間用於填充欄位 自動填充功能可以幫助使用者避免重新輸入資訊
  • 最大限度地減少使用者輸入錯誤 打字很容易出錯,特別是在移動裝置中刪除輸入資訊的必要性也可以消除隨之而來的錯誤

所以自動填充框架可以是我的操作變得簡單容易,提升使用者在使用時的方便。下面帶大家看看如何實現自動填充框架,我們建立一個登陸的demo,loginDemo,下面看一下登陸頁面的佈局

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical"
    android:padding="16dp">

    <android.support.design.widget.TextInputLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content">
        <EditText
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:id="@+id/username"
            android:hint="Your primary email address"
            android:inputType="textEmailAddress"
            android:importantForAutofill="yes"/>
    </android.support.design.widget.TextInputLayout>

    <android.support.design.widget.TextInputLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content">
        <EditText
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:id="@+id/password"
            android:hint="numberPassword"
            android:importantForAutofill="yes"
            android:inputType="numberPassword"/>
    </android.support.design.widget.TextInputLayout>

    <Button
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:id="@+id/save_button"
        style="@style/Widget.AppCompat.Button.Colored"
        android:text="登陸"
        android:onClick="userLogin"/>
</LinearLayout>
複製程式碼

佈局很簡單,裡面只有一個android:importantForAutofill屬性,它是重點。為了是android系統可以識別某個控制元件是否支援自動填充服務,我們首先需要對支援此服務的控制元件新增一個標識,這個標識用來啟發自動填充框架。

1. 為控制元件新增自動填充標識

android:importantForAutofill
複製程式碼

這個屬性的取值有一下幾種

  • auto 系統預設值,這個標識有系統決定是否觸發自動填充服務
  • no 此控制元件不支援自動填充服務
  • noExcludeDescendants 此控制元件及其子控制元件都不支援自動填充服務
  • yes 次檢視支援自動填充服務
  • yesExcludeDescendants 此控制元件支援,但是它的子控制元件不支援 然後我們在看看MainActivity的邏輯
public class MainActivity extends AppCompatActivity {
   
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        mAutofillManager = this.getSystemService(AutofillManager.class);
        mAutofillCallback = new MyAutofillCallback();
    }

    public void userLogin(View view) {
        String uName = ((EditText) findViewById(R.id.username)).getText().toString();
        String pw = ((EditText) findViewById(R.id.password)).getText().toString();
        SharedPreferences.Editor editor = getSharedPreferences("EMAIL_STORAGE", MODE_PRIVATE)
                .edit();
        editor.putString("PRIMARY_EMAIL", uName);
        editor.putString("USER_PW", pw);
        editor.commit();
    }
}
複製程式碼

這個沒啥,就是獲取使用者名稱密碼儲存在SharedPreferences裡,看到這大家就得沒啥乾貨呀,別急現在我們只是為之後的是做個資料準備。

2 AutofillService 服務

寫程式碼之前先介紹一下這個類,AutofillService是一個能幫助我們實現自動填充螢幕內容的服務類,它裡面兩個方法需要我們進行重寫。

@Override
    public void onFillRequest(@NonNull FillRequest request, @NonNull CancellationSignal cancellationSignal,
    @NonNull FillCallback fillCallback) {
    }
    
     public void onSaveRequest(@NonNull SaveRequest request, @NonNull SaveCallback callback) {
         
     }
複製程式碼
  • onFillRequest 當頁面內容有可用自動填充時系統呼叫該方法

    FillRequest引數 自動填充服務的請求物件,使用它我們可以獲取螢幕上檢視

    FillCallback引數 處理正在填充的服務,可以顯示自動填充的資料

  • onSaveRequest 當使用者請求服務儲存螢幕欄位時呼叫

    它的引數和第一個基本一樣的

大致了一下AutofullService這個類的作用,我們在建立一個類MyAutofillService讓它繼承AutofillService這個類

public class MyAutofillService extends AutofillService {

    public void traverseStructure(AssistStructure structure, List<AssistStructure.ViewNode> emailFields) {
        int nodes = structure.getWindowNodeCount();

        for (int i = 0; i < nodes; i++) {
            AssistStructure.WindowNode windowNode = structure.getWindowNodeAt(i);
            AssistStructure.ViewNode viewNode = windowNode.getRootViewNode();
            traverseNode(viewNode, emailFields);
        }
    }

    public void traverseNode(AssistStructure.ViewNode viewNode, List<AssistStructure.ViewNode> emailFields) {
        if (viewNode == null || viewNode.getClassName() == null)
            return;
        if (viewNode.getClassName().contains("EditText")) {
            String viewId = viewNode.getIdEntry();
            if (viewId != null && (viewId.contains("email") || viewId.contains("username") || viewId.contains("password"))) {
                emailFields.add(viewNode);
                return;
            }
        }
        for (int i = 0; i < viewNode.getChildCount(); i++) {
            AssistStructure.ViewNode childNode = viewNode.getChildAt(i);
            traverseNode(childNode, emailFields);
        }
    }

    @Override
    public void onFillRequest(@NonNull FillRequest request, @NonNull CancellationSignal cancellationSignal, @NonNull FillCallback fillCallback) {
        // Get the structure from the request
        //1 獲取自動填充的上下文
        List<FillContext> context = request.getFillContexts();
        //獲取螢幕快照資料
        AssistStructure structure = context.get(context.size() - 1).getStructure();
        //儲存自動填充的節點
        List<AssistStructure.ViewNode> emailFields = new ArrayList<>();
        //遍歷獲取目標空間
        traverseStructure(structure, emailFields);
        if (emailFields.size() < 2) {
            fillCallback.onSuccess(null);
            return;
        }
        SharedPreferences sharedPreferences = getSharedPreferences("EMAIL_STORAGE", MODE_PRIVATE);
        String primaryEmail = sharedPreferences.getString("PRIMARY_EMAIL", "");
        String secondaryEmail = sharedPreferences.getString("SECONDARY_EMAIL", "");

        //建立自動提示的view
        RemoteViews rvPrimaryEmail = new RemoteViews(getPackageName(), R.layout.user_suggestion);
        rvPrimaryEmail.setTextViewText(R.id.email_suggestion_item, primaryEmail);
        rvPrimaryEmail.setImageViewResource(R.id.icon, R.mipmap.user);
        RemoteViews rvSecondaryEmail = new RemoteViews(getPackageName(), R.layout.user_suggestion);
        rvSecondaryEmail.setTextViewText(R.id.user_suggestion_item, primaryEmail);
        rvSecondaryEmail.setImageViewResource(R.id.icon, R.mipmap.pw);

        AssistStructure.ViewNode userField = emailFields.get(0);
        AssistStructure.ViewNode passField = emailFields.get(1);
        //為自動填充檢視構造資料
        Dataset primaryEmailDataSet = new Dataset.Builder(rvPrimaryEmail)
                .setValue(userField.getAutofillId(), AutofillValue.forText(primaryEmail)
                ).build();
        Dataset secondaryEmailDataSet = new Dataset.Builder(rvSecondaryEmail)
                .setValue(passField.getAutofillId(), AutofillValue.forText(secondaryEmail)
                ).build();

        //封裝響應資料
        FillResponse response = new FillResponse.Builder()
                .addDataset(primaryEmailDataSet)
                .addDataset(secondaryEmailDataSet)
                //  .addDataset(msecondaryEmailDataSet)
//                .setSaveInfo(new SaveInfo.Builder(//只有新增SaveInfo物件才會回撥onSaveRequest
//                        SaveInfo.SAVE_DATA_TYPE_USERNAME | SaveInfo.SAVE_DATA_TYPE_EMAIL_ADDRESS,
//                        new AutofillId[]{emailField.getAutofillId(), emailField.getAutofillId()})
//                        .build())
                .build();
        //通知自動填充框架
        fillCallback.onSuccess(response);
    }

    // 儲存需要自動填入記錄。
    @Override
    public void onSaveRequest(@NonNull SaveRequest request, @NonNull SaveCallback callback) {
        List<FillContext> context = request.getFillContexts();
        AssistStructure structure = context.get(context.size() - 1).getStructure();
        List<AssistStructure.ViewNode> emailFields = new ArrayList<>();
        traverseStructure(structure, emailFields);
        callback.onSuccess();
    }
}
複製程式碼

我們在onFillRequest方法裡獲取當前介面的空間資訊,之後遍歷判斷是否還有我們目標的空間,將它儲存在一個list中,程式碼中已將詳細註釋了, 下面是user_suggestion佈局檔案

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="horizontal"
    xmlns:android="http://schemas.android.com/apk/res/android">

    <TextView xmlns:android="http://schemas.android.com/apk/res/android"
        android:id="@+id/user_suggestion_item"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:padding="5dp"
        android:textSize="18sp"
        android:textStyle="bold"></TextView>

    <ImageView
        android:id="@+id/icon"
        android:layout_gravity="center"
        android:layout_height="wrap_content"
        android:layout_marginEnd="?android:attr/listPreferredItemPaddingEnd"
        android:layout_width="wrap_content"
        android:src="@mipmap/ic_launcher" />
</LinearLayout>

複製程式碼

這個服務類完了之後,我們需要配置一個它

<service android:name=".MyAutofillService"
            android:label="Mtx Autofill Service"
            android:permission="android.permission.BIND_AUTOFILL_SERVICE">

            <meta-data android:name="android.autofill"
                android:resource="@xml/login_filler"/>
            <intent-filter>
                <action android:name="android.service.autofill.AutofillService"/>
            </intent-filter>
        </service>
複製程式碼

android:label=“XXX”這個服務的名稱,隨便起,宣告命一個android.permission.BIND_AUTOFILL_SERVICE許可權, 下面是login_filler

<?xml version="1.0" encoding="utf-8"?>
<autofill-service
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:settingsActivity="com.mtx.login.MainActivity"/>
複製程式碼

最後手機中設定一下:設定 > 系統 > 語言和輸入 > 高階 > 輸入幫助 > 自動填充服務>Mtx Autofill Service

android 8.0 Autofill Framework (自動填充框架)

android 8.0 Autofill Framework (自動填充框架)

android 8.0 Autofill Framework (自動填充框架)

相關文章