目录

开启文件变化通知

场景介绍

华为云空间服务提供当文件发生变化时推送通知的能力,从而保持云端与本地文件同步。使用Changes功能需要您的App可实时接收变化的服务器,该服务器可以接收变化并将变化信息实时推送给相应的客户端,客户端接收消息后可以及时刷新变化。

构建变化接收服务器

  1. 您的App可以接收文件变化的服务器,需要将该服务器的地址注册到Drive,Drive在发送变化消息时需要校验服务器地址的有效性。

    将服务器域名注册到Drive方法如下:

    1. 登录AppGallery Connect网站,点击“我的项目”。
    2. 找到“构建 > 云空间服务”。如果“构建”下无“云空间服务”,可点击左下角“全部功能”按钮,在“构建”中找到“云空间服务”,然后点击图标添加。

  2. 服务器需要能解析Drive发送的文件变化消息,Drive消息的消息头格式如下:

    参数

    类型

    必选/可选

    说明

    X-HW-Channel-ID

    varchar(255)

    必选

    您的App指定的,通过Changes.Subscribe接口上报给Drive服务器的用户唯一标识。

    X-HW-Channel-Token

    varchar(255)

    可选

    调用Changes.Subscribe接口时自定义的userToken,服务器需要对userToken进行校验。

    X-HW-Channel-Expiration

    varchar(255)

    可选

    Channel通知到期的日期和时间

    格式例如:Tue,18 Jun 2019 14:21:46 GMT。

    X-HW-Resource-ID

    varchar(255)

    必选

    资源ID,标识Channel正在监测的资源,当该资源变化时会推送通知。

    X-HW-Resource-URI

    varchar(255)

    必选

    资源版本标识符。

    X-HW-Resource-State

    varchar(255)

    必选

    资源状态,可选值:

    sync:订阅成功,Channel创建成功。

    add:资源增加。

    remove:资源被删除。

    update:资源属性被更新。

    recycle:资源移动到回收站。

    unrecycle:资源从回收站移出。

    change:资源变化。

    X-HW-Message-Number

    Int64

    必选

    消息号,后面的消息总是大于前面的,但是并不是连续的。Sync消息总是为1。

    X-HW-Changed

    varchar(255)

    可选

    Change的详细信息,state为update时有效,可选值。

    content: 资源内容更新。

    properties: 资源属性更新。

    parents: 资源的父目录变化,暂时不涉及。

    children: 资源的子文件变化。

  3. 业务服务器下发变化通知应用。

    业务服务器能够将Drive发送的变化消息下发通知到应用,让应用刷新变化内容;Drive不限制业务服务器下发变化通知的实现方式,但推荐开发者使用华为推送服务,华为推送服务已经实现了将服务器消息推送到指定应用的功能,使用华为推送服务需要对接HMS Core Push SDK,具体参见《消息推送服务》。若不使用华为推送服务,则不需要集成HMS Core Push SDK,但业务服务器需要自己实现消息推送的功能。

注册推送通知功能

获取StartCursor,通过subscribe注册推送通知功能。

应用调用Changes.GetStartCursor接口,获取Changes.Subscribe需要使用的cursor值,调用Changes.Subscribe接口注册文件变化时的推送通知功能,该接口会返回注册成功后的Channel对象。开发者需要将Channel中的channelToken回传给业务服务器,用于后续服务器接口消息的鉴权使用,同时开发者可以根据该Channel进行后续的刷新变化、停止推送通知等接口处理。

/**  
 * 注册文件变化通知  
* @param context 上下文环境
* @param id UUID或其他字符串,唯一标识channel
 */  
private void watchChanges(Context context, String id) {   
    try {   
        Drive drive = buildDrive();   
        StartCursor startCursor = drive.changes().getStartCursor().execute();   
        String cursor = startCursor.getStartCursor();   
        Channel content = new Channel();   
        // id可以自定义,注意和channels.stop接口保持一致   
        content.setId(id);   
        // 固定web_hook   
        content.setType("web_hook");   
        // 提供开发者用于接收变化的服务器地址   
        content.setUrl("https://addr.xxx.com:8086/path/to/webhook");   
        content.setExpirationTime(System.currentTimeMillis() + 300 * 1000L);   
        Channel channel = drive.changes().subscribe(cursor, content).execute();   
        // 需要将channelToken回传给业务服务器Url   
        String channelToken = channel.getUserToken(); 
         
        SharedPreferences prefs = context.getSharedPreferences("channel_config", Context.MODE_PRIVATE);  
        SharedPreferences.Editor editor = prefs.edit();  
        editor.putString("startPageVersion", cursor);  
        editor.putString("resourceId", channel.getResourceId());  
        editor.commit();  
    } catch (Exception e) {   
        Log.e(TAG, "watchChanges error: " + e.toString());   
    }   

获取StartCursor及Channel接口是联网耗时接口,需要放在子线程中调用。

获取用户文件变化

应用收到服务器下发的通知后,调用Changes.List接口,获取用户文件变化,注意cursor入参为之前subscribe时传入的cursor。

/** 
 * 获取文件变化 
 *  
 * @param cursor 之前调用Changes.Subscribe传入的cursor 
 */
private List<Change> getChangesList(String cursor) {
    List<Change> changes = null;
    try {
        Drive drive = buildDrive();
        Drive.Changes.List listRequest = drive.changes().list(cursor);
        listRequest.setFields("*");
        ChangeList changeList = listRequest.execute();
        changes = changeList.getChanges();
    } catch (Exception e) {
        Log.e(TAG, "doChangesList error: " + e.toString());
    }
    return changes;
}

获取用户文件变化是联网耗时接口,需要放在子线程中调用。