XXPermissions框架详细技术文档

XXPermissions框架详细技术文档

XXPermissions Android 权限请求框架，已适配 Android 14 项目地址: https://gitcode.com/gh_mirrors/xx/XXPermissions

安装指南

添加远程仓库

• 对于Gradle配置低于7.0的项目，在build.gradle(项目级别)文件中加入JitPack仓库：

allprojects {
    repositories {
        maven { url 'https://jitpack.io' }
    }
}

• 若Gradle配置为7.0及以上，应在settings.gradle文件添加：

dependencyResolutionManagement {
    repositories {
        maven { url 'https://jitpack.io' }
    }
}

添加依赖

在app模块的build.gradle文件中添加XXPermissions的依赖项：

dependencies {
    implementation 'com.github.getActivity:XXPermissions:18.68'
}

确保Java编译版本为1.8或更高：

compileOptions {
    targetCompatibility JavaVersion.VERSION_1_8
    sourceCompatibility JavaVersion.VERSION_1_8
}

AndroidX兼容性

对于基于AndroidX的项目，在gradle.properties中启用Jetifier:

android.enableJetifier = true

非AndroidX项目无需此步骤。

针对Android 10分区存储的配置

若应用已适配Android 10的分区存储，更新AndroidManifest.xml:

<manifest>
    <application>
        <meta-data
            android:name="ScopedStorage"
            android:value="true" />
    </application>
</manifest>

若未适配分区存储，直接使用特定API来处理权限。

项目使用说明

XXPermissions提供了简洁的API来处理复杂的权限申请逻辑。

请求权限示例

Java 示例

XXPermissions.with(this)
    .permission(Permission.RECORD_AUDIO)
    .permission(Permission.Group.CALENDAR)
    .request(new OnPermissionCallback() {
        @Override
        public void onGranted(List<String> permissions, boolean allGranted) {
            if (allGranted) {
                // 所有权限都被授予
                toast("权限请求成功");
            } else {
                // 部分权限未被授予
                toast("部分权限未被授予");
            }
        }

        @Override
        public void onDenied(List<String> permissions, boolean doNotAskAgain) {
            if (doNotAskAgain) {
                // 权限被永久拒绝，引导用户开启权限
                XXPermissions.startPermissionActivity(context, permissions);
            } else {
                // 权限申请被临时拒绝
                toast("权限请求被拒绝");
            }
        }
    });

Kotlin 示例

XXPermissions.with(this)
    .permission(Permission.RECORD_AUDIO)
    .permission(Permission.Group.CALENDAR)
    .request { _, allGranted ->
        if (allGranted) {
            // 所有权限已被授予
            toast("权限请求成功")
        } else {
            // 部分权限未被授予
            toast("部分权限未被授予")
        }
    }

API使用文档

• 检查权限:

  XXPermissions.isGranted(Context context, String... permissions);
  

• 获取拒绝的权限列表:

  XXPermissions.getDenied(Context context, String... permissions);
  

• 判断权限类型:

  XXPermissions.isSpecial(String permission);
  

• 检查是否勾选了“不再提示”:

  XXPermissions.isDoNotAskAgainPermissions(Activity activity, String... permissions);
  

• 跳转至应用权限设置界面:

  XXPermissions.startPermissionActivity(Context context, String... permissions);
  

混淆规则

保护XXPermissions不受混淆影响：

-dontwarn com.hjq.permissions.**
-keep class com.hjq.permissions.**{*;}

结论

XXPermissions以其简化的API设计和全面的权限管理功能，为开发者提供了一个高效、易用的权限请求解决方案，尤其适合快速集成至任何Android项目之中，确保应用能够流畅地请求所需权限，同时照顾到了不同Android版本的兼容性和最新的隐私政策调整。无论是新手还是经验丰富的开发者，都能迅速掌握并应用于实践。

XXPermissions Android 权限请求框架，已适配 Android 14 项目地址: https://gitcode.com/gh_mirrors/xx/XXPermissions