android 接口增加权限校验

原创

mob64ca12e58adb 2025-01-09 04:45:36 ©著作权

文章标签 拦截器 Android java 文章分类 Android 移动开发

©著作权归作者所有：来自51CTO博客作者mob64ca12e58adb的原创作品，请联系作者获取转载授权，否则将追究法律责任

Android 接口增加权限校验的实现指南

作为一名刚入行的开发者，你可能会遇到需要在 Android 应用中增加接口权限校验的情况。权限校验可以确保只有授权用户才能访问某些敏感数据或执行特定操作。本文将为你提供一个清晰的流程图、类图，以及实际的代码实现步骤，帮助你实现这一目标。

流程概览

步骤顺序	步骤描述	详细说明
1	确定需要保护的接口	识别出哪些接口需要进行权限校验
2	创建权限校验拦截器	编写拦截器类，用于处理权限校验逻辑
3	实现权限校验逻辑	在拦截器内实现具体的权限判断逻辑
4	注入拦截器到接口	将拦截器应用到需要校验的接口上
5	测试和验证	进行测试，确保权限校验的正确性

流程图

以下是实现流程的旅行图，用于描述整个过程中的关键步骤：

journey
    title Android 接口增加权限校验的实现
    section 权限校验开始
      确定需要保护的接口: 5: 橙色
      创建权限校验拦截器: 4: 橙色
    section 权限校验逻辑实现
      实现权限校验逻辑: 3: 橙色
      注入拦截器到接口: 2: 橙色
    section 测试与验证
      测试和验证: 1: 橙色

实现步骤详解

1. 确定需要保护的接口

在开始之前，首先要明确哪些接口需要进行权限校验。例如，可以使用 RESTful API 的方法，如果你需要重新保护 GET 和 POST 方法，可以在后续步骤中加以实现。

2. 创建权限校验拦截器

创建一个拦截器类，以便可以在接口请求被处理之前进行权限校验。我们将创建一个名为 PermissionInterceptor 的类。

import okhttp3.Interceptor;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class PermissionInterceptor implements Interceptor {
    // 拦截器的方法
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();
        
        // 获取用户的权限
        String userRole = getUserRole();
        
        // 检查请求的 URL，以决定是否有权限
        if (!hasPermission(userRole, request.url().encodedPath())) {
            throw new RuntimeException("权限不足！");
        }
        
        // 如果有权限，继续执行下一个处理器
        return chain.proceed(request);
    }
    
    // 获取用户角色的逻辑可以根据你的应用相应实现
    private String getUserRole() {
        // 模拟获取用户角色
        return "USER"; // 或 "ADMIN"
    }
    
    // 权限判断逻辑
    private boolean hasPermission(String role, String path) {
        // 根据角色和请求路径判断权限
        if (role.equals("ADMIN")) {
            return true; // ADMIN有所有权限
        }
        return path.startsWith("/user"); // USER 只能访问以 '/user' 开头的接口
    }
}

intercept 方法是拦截器的核心逻辑，所有请求都会经过此处。
getUserRole 方法模拟从某种身份验证服务获取当前用户的角色。
hasPermission 方法根据用户角色和请求的路径进行权限判断。

3. 实现权限校验逻辑

在 PermissionInterceptor 中，已经实现了权限校验的逻辑。在需要保护的接口调用之前先经过此拦截器。

4. 注入拦截器到接口

要将拦截器应用到网络请求中，例如使用 OkHttp 进行网络请求。

import okhttp3.OkHttpClient;

public class NetworkClient {
    private static OkHttpClient client;

    public static OkHttpClient getClient() {
        if (client == null) {
            client = new OkHttpClient.Builder()
                    .addInterceptor(new PermissionInterceptor()) // 添加权限拦截器
                    .build();
        }
        return client;
    }
}

OkHttpClient.Builder().addInterceptor(new PermissionInterceptor()) 一行代码将之前创建的拦截器添加到 OkHttp 客户端。

5. 测试和验证

在进行完上述步骤后，确保进行充分的测试。可以使用不同角色的用户进行请求，验证权限校验是否生效。

public class ApiService {
    
    public void fetchUserData() {
        // 使用网络客户端进行网络请求
        OkHttpClient client = NetworkClient.getClient();
        // 构建请求体并发送请求
    }
}

在 ApiService 中调用 fetchUserData 方法来发起 API 请求，从而进入到权限校验逻辑。

类图

下面是应用的类图，描述了类之间的关系。

classDiagram
    class PermissionInterceptor {
        +Response intercept(Chain chain)
        -String getUserRole()
        -boolean hasPermission(String role, String path)
    }

    class NetworkClient {
        +static OkHttpClient getClient()
    }

    class ApiService {
        +void fetchUserData()
    }

    PermissionInterceptor --> NetworkClient : 依赖
    NetworkClient --> ApiService : 依赖