Android6.0許可權適配及相容庫的實現

看書的小蝸牛發表於2017-01-13

從6.0 MarshMallow開始,Android支援動態許可權管理,即有些許可權需要在使用到的時候動態申請,根據使用者的選擇需要有不同的處理,具體表現可以看下圖:

Android6.0許可權適配及相容庫的實現
許可權申請

本文並不關心許可權適配的原理,原理可以參考Android許可權管理原理 ,這裡只是針對6.0中的表現做適配,先思考以下幾個問題:

  • 為什麼6.0許可權需要適配
  • 什麼許可權需要動態適配
  • 怎樣動態適配許可權
  • 怎麼樣實現第三方庫,簡化程式碼及適配流程 許可權相容庫 PermissionCompat
  • 對於國產ROM的影響

為什麼6.0需要許可權適配

6.0之前Android的許可權都是在安裝的時候授予的,6.0之後,為了簡化安裝流程,並且方便使用者控制許可權,Android允許在執行的時候動態控制許可權。對於開發而言就是將targetSdkVersion設定為23,當執行在Android 6.0 +的手機上時,就會呼叫6.0相關的API,達到動態控制許可權的目的。但是,如果僅僅是將targetSdkVersion設定為23,而在程式碼層面沒有針對Android 6.0做適配,就可能在申請系統服務的時候,由於許可權不足,引發崩潰。

  • targetSDKVersion:該屬性用於通知系統,您已針對目標版本進行測試,標識App能夠適配的系統版本,有些新的API是隻有新的系統才有的。

什麼許可權需要動態適配

並非所有的許可權都需要動態申請,Android6.0將許可權分為兩種,普通許可權跟敏感(危險)許可權,普通許可權是不需要動態申請的,但是敏感許可權需要動態申請。

  • 1、普通許可權(Normal permissions):不會洩露使用者隱私,同時也不會導致手機安全問題。如網路請求許可權、WIFI狀態等,這類許可權只需要在Manifest列出來,之後,系統會自動賦給APP許可權:

    • ACCESS_NETWORK_STATE
    • ACCESS_NOTIFICATION_POLICY
    • ACCESS_WIFI_STATE
    • BLUETOOTH
    • BLUETOOTH_ADMIN
  • 2、敏感許可權(Dangerous permissions):與普通許可權對應,可能會影響使用者的隱私,儲存資料等,比如拍照、儲存、通訊錄、地理GPS等,這類許可權需要在Manifest列出來,在需要的的時候,顯示的請求使用者准許。

    • CALENDAR
    • CAMERA
    • CONTACTS
    • LOCATION
    • PHONE
    • SENSORS
    • SMS
    • STORAGE

敏感許可權的請求是按照分組進行提醒的,並非僅僅針對一條,比如通訊錄的讀取許可權與寫許可權,只要一個許可權獲到,下次請求許可權的時候會自動提供,當然也要請求。否則還是有問題。

  • 3、特殊許可權(Special Permissions) --不在本文分析範圍

    There are a couple of permissions that don't behave like normal and dangerous permissions. SYSTEM_ALERT_WINDOW and WRITE_SETTINGS

怎樣動態適配許可權

對於敏感許可權的適配有一個原則,那就是實時檢查,因為許可權隨時可能被回收,比如使用者可以在設定裡面把許可權給取消,但是APP並不一定知道,因此每次都需要檢查,一旦沒有,就需要請求,之後,根據返回結果處理後續邏輯。

實現步驟

  • 1、在Manifest中列出來

    無論普通許可權還是敏感許可權,都需要在Manifest中列出來,同時也是對6.0之前的版本的一種相容。

      <manifest xmlns:android="http://schemas.android.com/apk/res/android"
            package="com.snail.labaffinity">
      <uses-permission android:name="android.permission.CAMERA"/>
      <uses-permission android:name="android.permission.CALL_PHONE"/>複製程式碼
  • 2、需要時,顯示的請求

在許可權沒被授予前提下,系統會顯示授權對話方塊,讓使用者操作,目前授權對話方塊不可定製,不過可以在申請之前新增一些解釋,告訴使用者為什麼需要該許可權,但是Google提醒,不要做過多的解釋,可能會使使用者感到厭煩,具體就是使用ActivityCompat的requestPermissions函式:

public static void requestPermissions(final @NonNull Activity activity,
        final @NonNull String[] permissions, final int requestCode) {
    if (Build.VERSION.SDK_INT >= 23) {
        ActivityCompatApi23.requestPermissions(activity, permissions, requestCode);
    } else if (activity instanceof OnRequestPermissionsResultCallback) {
        Handler handler = new Handler(Looper.getMainLooper());
        handler.post(new Runnable() {
            @Override
            public void run() {
                final int[] grantResults = new int[permissions.length];

                PackageManager packageManager = activity.getPackageManager();
                String packageName = activity.getPackageName();

                final int permissionCount = permissions.length;
                for (int i = 0; i < permissionCount; i++) {
                    grantResults[i] = packageManager.checkPermission(
                            permissions[i], packageName);
                }

                ((OnRequestPermissionsResultCallback) activity).onRequestPermissionsResult(
                        requestCode, permissions, grantResults);
            }
        });
    }
}複製程式碼
  • 3、處理授權回撥

    • 相容6.0之前的處理:在這裡只需要處理獲得許可權即可,因為6.0之前只存在Install許可權,一旦安裝,所有許可權都是預設授予的,雖然國內ROM對許可權管理做了自己的一些定製,但基本都是相容的。
    • 需要對6.0的授權成功、失敗、永不詢問做處理

      public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {

        super.onRequestPermissionsResult(requestCode, permissions, grantResults);
        if(this.mOnGrantedListener != null) {
        <!--6.0之前-->
            if(PermissionUtils.getTargetSdkVersion(this) < 23 && !PermissionUtils.hasSelfPermissions(this, permissions)) {
                this.mOnGrantedListener.onGranted(this, permissions);
                return;
            }             
            //<!--6.0之後-->  需要根據結果進行驗證
            if(PermissionUtils.verifyPermissions(grantResults)) {
                this.mOnGrantedListener.onGranted(this, permissions);
            } else if(!PermissionUtils.shouldShowRequestPermissionRationale(this, permissions)) {
                this.mOnGrantedListener.onNeverAsk(this, permissions);
            } else {
                this.mOnGrantedListener.onDenied(this, permissions);
            }
        }複製程式碼

      }

具體APP中不同的實現方案

  • 1、簡單的封裝回撥
  • 2、基於APT,採用註解方式簡化編碼邏輯,自動封封回撥

先看一下直接回撥的方式

採用最直接的回撥

首先在基類Activity或者Fragment中統一設定授權回撥監聽,這裡我們用一個

 public class BasePermissionCompatActivity extends AppCompatActivity {

    private SparseArray<OnGrantedListener<BasePermissionCompatActivity>> mOnGrantedListeners = new SparseArray<>();

    @Override
    public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
        super.onRequestPermissionsResult(requestCode, permissions, grantResults);
        OnGrantedListener<BasePermissionCompatActivity> listener = mOnGrantedListeners.get(requestCode);
        if (listener == null)
            return;
        if (PermissionUtils.verifyPermissions(grantResults)) {
            listener.onGranted(this, permissions);
        } else {
            if (PermissionUtils.shouldShowRequestPermissionRationale(this, permissions)) {
                listener.onDenied(this, permissions);
            } else {
                listener.onNeverAsk(this, permissions);
            }
        }
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        mOnGrantedListeners.clear();
        mOnGrantedListeners = null;
    }

    public void requestPermissions(final @NonNull String[] permissions, OnGrantedListener<BasePermissionCompatActivity> onGrantedListener) {
        int requestCode = getNextRequestCode();
        ActivityCompat.requestPermissions(this, permissions, requestCode);
        mOnGrantedListeners.put(requestCode, onGrantedListener);
    }

    private static int sNextCode;

    private static int getNextRequestCode() {
        return sNextCode++;
    }
}複製程式碼

之後在需要時候的請求,並根據結果處理後續邏輯即可。

   requestPermissions(activity, P_CAMERA, new OnGrantedListener() {

        // 根據permissions自行處理,可合併,可分開
        @Override
        public void onGranted(SecondActivity target, String[] permissions,int requestCode) {
        }
        @Override
        public void onDenied(SecondActivity target, String[] permissions,int requestCode) {
        }
        @Override
        public void onNeverAsk(SecondActivity target, String[] permissions,int requestCode) {
        }
        @Override
        public void onShowRationale(SecondActivity target, String[] permissions,int requestCode) {
    });複製程式碼

上面的方法比較直接,靈活,不過每次都要自己實現回撥監聽Listener,接下來看第二種實現,基於APT,通過註解的方式,自動新增Listener,這種實現參考了ButterKnife的實現方式。

基於APT與註解,編譯過程中生成程式碼,自動新增回撥

  • 1、基於APT,定義一系列Annotation,並動態生成輔助Listener類
  • 2、新增Android支援庫,在基類統一處理回撥,
  • 3、新增工具類,連線繫結Listener與Activity(Fragment)

相應的實現分三個庫:

  • 註解庫
  • APT生成支援庫
  • Android支援庫

註解庫:

Android6.0許可權適配及相容庫的實現
註解庫

主要用來定義一些回撥方法註解、及請求實體的類註解

* ActivityPermission
* FragmentPermission
* OnDenied
* OnGranted
* OnGrantedListener
* OnNeverAsk
* OnShowRationale複製程式碼

APT生成支援庫

主要用來在編譯階段,動態生Listener類

PermissionProcessor.java複製程式碼

部分參考程式碼:

@AutoService(Processor.class)
public class PermissionProcessor extends AbstractProcessor {

    private Elements elementUtils;

    private Set<Class<? extends Annotation>> getSupportedAnnotations() {
        Set<Class<? extends Annotation>> annotations = new LinkedHashSet<>();
        annotations.add(OnDenied.class);
        annotations.add(OnGranted.class);
        annotations.add(OnNeverAsk.class);
        annotations.add(OnShowRationale.class);
        return annotations;
    }

    @Override
    public synchronized void init(ProcessingEnvironment env) {
        super.init(env);
        elementUtils = env.getElementUtils();
    }

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        if (!checkIntegrity(roundEnv))
            return false;
        Set<? extends Element> elementActivities = roundEnv.getElementsAnnotatedWith(ActivityPermission.class);
        Set<? extends Element> elementFragments = roundEnv.getElementsAnnotatedWith(FragmentPermission.class);
        return makeListenerJavaFile(elementActivities) && makeListenerJavaFile(elementFragments);
    }
   ...複製程式碼

Android支援庫

主要會封裝了一些工具類,基類以及對回撥的處理

* BasePermissionCompatActivity.java
* BasePermissionCompatFragment.java
* PermissionCompat.java
* PermissionUtils.java複製程式碼

參考程式碼:

public class PermissionCompat {

    private static int sNextRequestCode;
    static final Map<Class<?>, OnGrantedListener> BINDERS = new LinkedHashMap<>();

    // 分批次請求許可權
    public static void requestPermission(BasePermissionCompatActivity target, String[] permissions) {

        Class<?> targetClass = target.getClass();
        try {
           // 找到監聽Listener類,並例項一個
            OnGrantedListener<BasePermissionCompatActivity> listener = findOnGrantedListenerForClass(targetClass, permissions);
            if (PermissionUtils.hasSelfPermissions(target, permissions)) {
                listener.onGranted(target, permissions);
            } else if (PermissionUtils.shouldShowRequestPermissionRationale(target, permissions)) {
                // 拒絕過,再次請求的時候,這個函式是否有必要,不在詢問後,返回false,第一次返回false,
                //listener.onShowRationale(target, permissions);
                startRequest(target, listener, permissions);
            } else {
                startRequest(target, listener, permissions);
            }

        } catch (Exception e) {
            throw new RuntimeException("Unable to bind views for " + targetClass.getName(), e);
        }
    }

    private static void startRequest(BasePermissionCompatActivity target, OnGrantedListener listener, final @NonNull String[] permissions) {
        target.setOnGrantedListener(listener);
        ActivityCompat.requestPermissions(target, permissions, getNextRequestCode());
    }複製程式碼

使用

  • 1、Activity繼承BasePermissionCompatActivity
  • 2、用註解寫回撥函式,支援許可權分組,跟單獨處理,但是每個分組都要寫自己的回撥函式(目前回撥函式,不支援引數)
  • 3、回撥必需配套,也就是一個許可權必須對應四個函式,否則編譯不通過
  • 4、請求的許可權必須有回撥函式,不然報執行時錯誤--崩潰

      @ActivityPermission
      public class PermssionActivity extends BasePermissionCompatActivity {
    
           。。。
    
          @OnGranted(value = {Manifest.permission.CAMERA})
          void granted() {
              LogUtils.v("granted");
          }
    
          @OnDenied(value = {Manifest.permission.CAMERA})
          void onDenied() {
              LogUtils.v("onDenied");
          }
    
          @OnNeverAsk(value = {Manifest.permission.CAMERA})
          void OnNeverAsk() {
              LogUtils.v("OnNeverAsk");
    
          }
          @OnShowRationale(value = {Manifest.permission.CAMERA})
          void OnShowRationale() {
              LogUtils.v("OnShowRationale");
          }    
          <!--何時的時機呼叫-->
    
          @OnClick(R.id.get)
          void get() {
              PermissionCompat.requestPermission(this, new String[]{Manifest.permission.CAMERA});
          }
      }複製程式碼

國產ROM相容性

6.0之前許可權管理即不是原生功能又沒有制定相應標準,每個廠家的實現都是完全不同的,雖然4.3 Google官方試圖推出AppOpsManager來動態適配許可權管理,但由於不成熟,一直到6.0也沒走向前臺。不過,看6.0之前國內ROM的表現,基本是在每個服務內部觸發鑑權請求,對原生許可權的判斷並沒多大影響,所以相容沒太大問題。

最後附上GitHub Demo及第三方庫連結 許可權相容庫 PermissionCompat

參考文件

1、Requesting Permissions at Run Time
2、PermissionDispatcher
3、Android6.0許可權適配之WRITE_EXTERNAL_STORAGE(SD卡寫入)

相關文章