Californium开源框架之源码分析（三）

内容简介：Californium开源框架之源码分析（三）

项目源码地址： https://github.com/eclipse/californium

摘要

物联网时代，为了在设备监控的数据发生变化时平台能第一时间获取到，频繁地定时地向设备获取其数据是不现实的。一是会消耗设备的电量、二是会浪费不必要的带宽。其解决方案是：平台作为一个客户端向设备（服务端）的数据发起一个订阅请求，在设备数据发生变化时主动推送给平台。交互图如下：

Californium开源框架之源码分析（三）

observe包

observe包就是上面讲到的订阅功能模块，实现客户端对服务端资源的订阅。其过程为：客户端发起一个订阅请求；服务端接收请求，找到对应的资源来处理请求，并保存该订阅关系；当服务端的资源发生变化时，服务端主动发送响应给客户端；客户端根据之前的订阅接收该响应。observe包图如下：

Californium开源框架之源码分析（三）

客户端相关

Observation类

该类表示一个观察，内部封装了Request请求和CorrelationContext上下文。

ObservationStore接口

该接口声明了对Observation对象进行存储，并对外提供了增删改查的公共方法。现在开发一个系统，为提高可靠性，通常都设计为多节点。框架提供该接口，就是希望开发者能够自己实现存储方式。例如，将Observation对象存储到数据库而不是内存，这样当系统中一个节点崩溃时，其他节点还能从数据库获取到Observation对象，即客户端还能处理之前订阅服务端后，服务端发来的响应消息。

当客户端发送请求消息并携带observe字段时，框架会保存该订阅请求。具体实现在 Matcher.sendRequest() 方法中，源码如下：

public void sendRequest(Exchange exchange,final Request request) {

    // 忽略非关键代码
    ...
    
    // 处理订阅请求
    if (request.getOptions().hasObserve() && request.getOptions().getObserve() == 0 && ...) {
        // 保存订阅请求到observationStore对象中
        observationStore.add(new Observation(request, null));
        // 监听请求，当请求取消、被拒绝、超时时，从observationStore对象中移除订阅请求
        request.addMessageObserver(new MessageObserverAdapter() {
            @Override
            public void onCancel() {
                observationStore.remove(request.getToken());
            }
            @Override
            public void onReject() {
                observationStore.remove(request.getToken());
            }
            @Override
            public void onTimeout() {
                observationStore.remove(request.getToken());
            }
        });
    }
    
    // 忽略非关键代码
    ...
    
}

当服务端接收订阅请求，会先发送一个订阅成功的响应。而后续的响应消息将由客户端的 Matcher.receiveResponse() 方法进行匹配检查，并通知NotificationListener。具体代码如下：

public Exchange receiveResponse(final Response response, final CorrelationContext responseContext) {

    // 忽略非关键操作
    ...
    
    // 根据响应消息中的token查找对应的订阅
    final Observation obs = observationStore.get(response.getToken());
    if (obs != null) {
        // 获取之前发起的订阅请求消息
        final Request request = obs.getRequest();
        request.setDestination(response.getSource());
        request.setDestinationPort(response.getSourcePort());
        exchange = new Exchange(request, Origin.LOCAL, obs.getContext());
        exchange.setRequest(request);
        exchange.setObserver(exchangeObserver);
        request.addMessageObserver(new MessageObserverAdapter() {

            @Override
            public void onResponse(Response response) {
                // 通知订阅监听器
                notificationListener.onNotification(request, response);
            }

            // 其他情况从observationStore对象中移除订阅请求
            ...

        });
    }
    
    // 忽略非关键操作
    ...

}