大疆上云API源码解析（远程日志）

功能概述

远程日志支持机场日志与飞行器日志的上传。云端服务器向设备请求获取日志文件列表，设备响应并上传列表。

实现步骤

1. 前端调用：GET：/workspaces/{workspace_id}/devices/{device_sn}/logs请求后端日志文件列表，下发请求设备日志文件列表的mqtt消息给机场，机场收到后，在回复的消息中返回设备的日志文件列表

@GetMapping("/{workspace_id}/devices/{device_sn}/logs")
    public HttpResultResponse getLogsBySn(@PathVariable("workspace_id") String workspaceId,
                                          @PathVariable("device_sn") String deviceSn,
                                          DeviceLogsGetParam param) {
        return deviceLogsService.getRealTimeLogs(deviceSn, param.getDomainList());
    }
// service
  @Override
    public HttpResultResponse getRealTimeLogs(String deviceSn, List<LogModuleEnum> domainList) {
        // 获取上线设备
        boolean exist = deviceRedisService.checkDeviceOnline(deviceSn);
        if (!exist) {
            return HttpResultResponse.error("Device is offline.");
        }
        // 推送消息
        TopicServicesResponse<ServicesReplyData<FileUploadListResponse>> response = abstractLogService
                .fileuploadList(SDKManager.getDeviceSDK(deviceSn), new FileUploadListRequest().setModuleList(domainList));
        for (FileUploadListFile file : response.getData().getOutput().getFiles()) {
            if (file.getDeviceSn().isBlank()) {
                file.setDeviceSn(deviceSn);
            }
        }
        return HttpResultResponse.success(response.getData().getOutput());
    }
    //发送mqtt消息
      public TopicServicesResponse<ServicesReplyData<FileUploadListResponse>> fileuploadList(GatewayManager gateway, FileUploadListRequest request) {
        return servicesPublish.publish(
                new TypeReference<FileUploadListResponse>() {},
                gateway.getGatewaySn(),
                LogMethodEnum.FILE_UPLOAD_LIST.getMethod(),
                request);
    }

2. 选中需要上传的远程日志，发起日志上传的请求发送到后端，POST：/workspaces/{workspace_id}/devices/{device_sn}/logs 后端收到请求后，调用开启日志文件上传的mqtt消息给机场；机场收到消息后，返回调用结果。

// controller
@PostMapping("/{workspace_id}/devices/{device_sn}/logs")
    public HttpResultResponse uploadLogs(@PathVariable("workspace_id") String workspaceId,
                                         @PathVariable("device_sn") String deviceSn,
                                         HttpServletRequest request, @RequestBody DeviceLogsCreateParam param) {

        CustomClaim customClaim = (CustomClaim)request.getAttribute(TOKEN_CLAIM);

        return deviceLogsService.pushFileUpload(customClaim.getUsername(), deviceSn, param);
    }
    // service
      @Override
    public HttpResultResponse pushFileUpload(String username, String deviceSn, DeviceLogsCreateParam param) {
        // 获取上传凭证
        StsCredentialsResponse stsCredentials = storageService.getSTSCredentials();
        // 设置过期时间
        stsCredentials.getCredentials().setExpire(System.currentTimeMillis() + (stsCredentials.getCredentials().getExpire() - 60) * 1000);
        LogsUploadCredentialsDTO credentialsDTO = new LogsUploadCredentialsDTO(stsCredentials);
        // Set the storage name of the file.
        List<FileUploadStartFile> files = param.getFiles();
        files.forEach(file -> file.setObjectKey(credentialsDTO.getObjectKeyPrefix() + "/" + UUID.randomUUID().toString() + LOGS_FILE_SUFFIX));

        credentialsDTO.setParams(new FileUploadStartParam().setFiles(files));
        // mqtt发布消息 开始上传
        TopicServicesResponse<ServicesReplyData> response = abstractLogService.fileuploadStart(
                SDKManager.getDeviceSDK(deviceSn), new FileUploadStartRequest()
                        .setCredentials(stsCredentials.getCredentials())
                        .setBucket(stsCredentials.getBucket())
                        .setEndpoint(stsCredentials.getEndpoint())
                        .setFileStoreDir(stsCredentials.getObjectKeyPrefix())
                        .setProvider(stsCredentials.getProvider())
                        .setRegion(stsCredentials.getRegion())
                        .setParams(new FileUploadStartParam().setFiles(files)));

        if (!response.getData().getResult().isSuccess()) {
            return HttpResultResponse.error(response.getData().getResult());
        }
        // 插入设备日志
        String id = this.insertDeviceLogs(response.getBid(), username, deviceSn, param);
        
        // 保存日志文件上传状态
        RedisOpsUtils.hashSet(RedisConst.LOGS_FILE_PREFIX + deviceSn, id, LogsOutputProgressDTO.builder().logsId(id).build());
        return HttpResultResponse.success();

    }
    //mqtt 
     public TopicServicesResponse<ServicesReplyData> fileuploadStart(GatewayManager gateway, FileUploadStartRequest request) {
        return servicesPublish.publish(
                gateway.getGatewaySn(),
                LogMethodEnum.FILE_UPLOAD_START.getMethod(),
                request);
    }

3. 机场会通过 thing/product/{gateway_sn}/events 主题持续上报文件上传进度。进度上报的消息处理通道最后会进入ChannelName.INBOUND_EVENTS_FILEUPLOAD_PROGRESS中。

// 消息处理
@Override
   public TopicEventsResponse<MqttReply> fileuploadProgress(TopicEventsRequest<EventsDataRequest<FileUploadProgress>> request, MessageHeaders headers) {
       EventsReceiver<LogsOutputProgressDTO> webSocketData = new EventsReceiver<>();
       webSocketData.setBid(request.getBid());
       webSocketData.setSn(request.getGateway());
       // 获取网关设备
       Optional<DeviceDTO> deviceOpt = deviceRedisService.getDeviceOnline(request.getGateway());
       if (deviceOpt.isEmpty()) {
           return null;
       }

       DeviceDTO device = deviceOpt.get();
       String key = RedisConst.LOGS_FILE_PREFIX + request.getGateway();

       try {
           FileUploadProgress output = request.getData().getOutput();
           log.info("Logs upload progress: {}", output.toString());

           LogsOutputProgressDTO progress;
           // redis 中是否存在
           boolean exist = RedisOpsUtils.checkExist(key);
           if (!exist && !output.getStatus().isEnd()) {
               progress = LogsOutputProgressDTO.builder().logsId(request.getBid()).build();
               RedisOpsUtils.hashSet(key, request.getBid(), progress);
           } else if (exist) {
               progress = (LogsOutputProgressDTO) RedisOpsUtils.hashGet(key, request.getBid());
           } else {
               progress = LogsOutputProgressDTO.builder().build();
           }
           progress.setStatus(output.getStatus());

           // 如果日志文件为空，删除此任务的缓存
           List<FileUploadProgressFile> fileReceivers = output.getExt().getFiles();
           if (CollectionUtils.isEmpty(fileReceivers)) {
               RedisOpsUtils.del(key);
           }

           // 刷新redis中的进度
           List<LogsProgressDTO> fileProgressList = new ArrayList<>();
           fileReceivers.forEach(file -> {
               LogFileProgress logsProgress = file.getProgress();
               if (!StringUtils.hasText(file.getDeviceSn())) {
                   if (LogModuleEnum.DOCK == file.getModule()) {
                       file.setDeviceSn(request.getGateway());
                   } else if (LogModuleEnum.DRONE == file.getModule()) {
                       file.setDeviceSn(device.getChildDeviceSn());
                   }
               }

               fileProgressList.add(LogsProgressDTO.builder()
                       .deviceSn(file.getDeviceSn())
                       .deviceModelDomain(file.getModule().getDomain())
                       .result(logsProgress.getResult())
                       .status(logsProgress.getStatus().getStatus())
                       .uploadRate(logsProgress.getUploadRate())
                       .progress(((logsProgress.getCurrentStep() - 1) * 100 + logsProgress.getProgress()) / logsProgress.getTotalStep())
                       .build());
           });
           progress.setFiles(fileProgressList);
           webSocketData.setOutput(progress);
           RedisOpsUtils.hashSet(RedisConst.LOGS_FILE_PREFIX + request.getGateway(), request.getBid(), progress);
           // 任务结束后 删除redis
           if (output.getStatus().isEnd()) {
               RedisOpsUtils.del(key);
               updateLogsStatus(request.getBid(), DeviceLogsStatusEnum.find(output.getStatus()).getVal());
               fileReceivers.forEach(file -> logsFileService.updateFile(request.getBid(), file));
           }
       } catch (NullPointerException e) {
           this.updateLogsStatus(request.getBid(), DeviceLogsStatusEnum.FAILED.getVal());
           RedisOpsUtils.del(key);
       }
       // websocket 通知上传进度
       webSocketMessageService.sendBatch(device.getWorkspaceId(), UserTypeEnum.WEB.getVal(),
               BizCodeEnum.FILE_UPLOAD_PROGRESS.getCode(), webSocketData);

       return new TopicEventsResponse<MqttReply>().setData(MqttReply.success());
   }

4. 上传过程中，可随时取消上传，调用Delete：/workspaces/{workspace_id}/devices/{device_sn}/logs

//service
@Override
   public HttpResultResponse pushUpdateFile(String deviceSn, FileUploadUpdateRequest param) {
   // 此时param中的status 为CANCEL
       TopicServicesResponse<ServicesReplyData> response = abstractLogService.fileuploadUpdate(SDKManager.getDeviceSDK(deviceSn), param);

       if (!response.getData().getResult().isSuccess()) {
           return HttpResultResponse.error(response.getData().getResult());
       }
       return HttpResultResponse.success();
   }
   // 推送消息
   public TopicServicesResponse<ServicesReplyData> fileuploadUpdate(GatewayManager gateway, FileUploadUpdateRequest request) {
       return servicesPublish.publish(
               gateway.getGatewaySn(),
               LogMethodEnum.FILE_UPLOAD_UPDATE.getMethod(),
               request);
   }