目录

获取鉴权信息

场景介绍

华为帐号是用户访问并使用个人云端文件的凭证,因此在使用Drive SDK时,需要先引导用户登录华为帐号。在登录成功后,将用户相关信息保存,在调用Drive SDK相关接口时使用。

业务流程

基本流程如下:

集成SDK

使用Drive SDK时,应用需要先通过HMS Core SDK获取用户信息,请参见集成Drive SDK和其他HMS Core SDK。

设置Drive Scope

通过HMS Core SDK登录时,需要通过HMS的HuaweiIdAuthParamsHelper.setScopeList接口设置Drive Scope,用于获取访问Drive接口的权限:

若需要查看和管理使用该应用打开或者创建的Drive文件和文件夹,则应设置SCOPE_DRIVE_FILE权限:

List<Scope> scopeList = new ArrayList<>();
// 允许查看和管理文件 
scopeList.add(new Scope(DriveScopes.SCOPE_DRIVE_FILE)); 
HuaweiIdAuthParams authParams = new HuaweiIdAuthParamsHelper(DEFAULT_AUTH_REQUEST_PARAM) 
        .setAccessToken() 
        .setIdToken() 
        .setScopeList(scopeList) 
        .createParams();
若需要支持应用内数据的上传和存储,则应设置SCOPE_DRIVE_APPDATA权限:
List<Scope> scopeList = new ArrayList<>(); 
// 支持App数据上传和存储
scopeList.add(new Scope(DriveScopes.SCOPE_DRIVE_APPDATA));  
HuaweiIdAuthParams authParams = new HuaweiIdAuthParamsHelper(DEFAULT_AUTH_REQUEST_PARAM) 
        .setAccessToken() 
        .setIdToken() 
        .setScopeList(scopeList) 
        .createParams();

其中,DEFAULT_AUTH_REQUEST_PARAM参考HuaweiIdAuthParams.DEFAULT_AUTH_REQUEST_PARAM

不同的Drive Scope对应不同的权限,详见下表:

Scope名称

权限描述

SCOPE_DRIVE_FILE

只允许访问由应用程序创建或打开的文件。

SCOPE_DRIVE_APPDATA

支持App数据上传和存储。

SCOPE_DRIVE

用户所有文件访问权限,应用数据文件夹除外。

SCOPE_DRIVE_READONLY

允许对文件元数据和文件内容的只读访问。

SCOPE_DRIVE_METADATA

允许对文件元数据进行读写访问,但不允许读取、下载、写入或上传文件内容。不支持文件的创建和删除。

SCOPE_DRIVE_METADATA_READONLY

允许对文件元数据进行只读访问,但不允许读取或下载文件内容。

存储鉴权信息

获取用户信息后,将用户的unionId和AccessToken(即AT)保存,后续调用Drive SDK相关使用。如下示例描述了一种实现方法,开发者也可自行实现。

示例代码:

创建Credential管理类:

/**
  * Credential管理类
  * <p>
  * since 1.0
  */
public class CredentialManager {

    /**
     * Drive鉴权信息
     */
    private DriveCredential mCredential;

    private CredentialManager() {
    }

    private static class InnerHolder {
        private static CredentialManager sInstance = new CredentialManager();
     }

    /**
     * 单例 CredentialManager 实例
     *
     * @return CredentialManager
     */
    public static CredentialManager getInstance() {
        return InnerHolder.sInstance;
    }

    /**
     * 通过上下文context和华为帐号信息(unionId,countrycode,accessToken)初始化drive。
     * 当accessToken失效时,注册一个AccessMethod去获取一个新的accessToken,传入的refreshAT不为null。
     *
     * @param unionID   HwID中的unionID
     * @param at        accessToken
     * @param refreshAT 刷新accessToken的回调函数,不能传入null
     */
    public int init(String unionID, String at, DriveCredential.AccessMethod refreshAT) {
        if (StringUtils.isNullOrEmpty(unionID) || StringUtils.isNullOrEmpty(at)) {
            return DriveCode.ERROR;
        }
        DriveCredential.Builder builder = new DriveCredential.Builder(unionID, refreshAT);
        mCredential = builder.build().setAccessToken(at);
        return DriveCode.SUCCESS;
    }

    /**
     * 获取DriveCredential
     *
     * @return DriveCredential
     */
    public DriveCredential getCredential() {
        return mCredential;
    }

    /**
     * 退出Drive,清理Drive使用过程中所有的缓存信息
     */
    public void exit(Context context) {
        // 清理缓存文件
        deleteFile(context.getCacheDir());
        deleteFile(context.getFilesDir());
    }

    /**
     * 删除缓存文件
     *
     * @param file 指定的缓存文件
     */
    private static void deleteFile(java.io.File file) {
        if (null == file || !file.exists()) {
            return;
        }

        if (file.isDirectory()) {
            java.io.File[] files = file.listFiles();
            if (files != null) {
                for (java.io.File f : files) {
                    deleteFile(f);
                }
            }
        }
    }
}
在登录成功onActivityResult回调中调用initDrive。
private static DriveCredential.AccessMethod refreshAT = new DriveCredential.AccessMethod() {
    @Override
    public String refreshToken() {
        // 自行实现刷新accessToken方法
        return refreshAccessToken();
    }
};
private void initDrive() {
    // signInHuaweiId为登录HMS后获取到的用户帐号信息,通过signInHuaweiId获取unionId及accessToken
    final String unionID = signInHuaweiId.getUnionId();
    final String accessToken = signInHuaweiId.getAccessToken();
    
    int returnCode = CredentialManager.getInstance().init(unionID, accessToken, refreshAT);
    if (DriveCode.SUCCESS == returnCode) {
        // 初始化成功后跳转到应用主页面
        jumpToMainActivity();
    }
}

获取鉴权信息成功后,开发者必须先检查用户安全策略是否需要更新,具体参见“获取用户信息”操作。