C#开发BIMFACE系列46 服务端API之离线数据包下载及结构详解

BIMFACE二次开发系列目录     【已更新最新开发文章，点击查看详细】

在前一篇博客《C#开发BIMFACE系列45 服务端API之创建离线数据包》中通过调用接口成功的创建一个离线数据包

离线数据包是存储在BIMFACE公有云服务器上的，所以使用之前需要将其下载到本地。本文将介绍通过接口下载离线数据包的操作过程。

获取离线数据包下载地址

调用接口的实现代码

/// <summary>
///  获取数据包下载地址
/// </summary>
/// <param name="accessToken">【必填】令牌</param>
/// <param name="objectId">【必填】模型Id 或 模型集成Id 或 模型对比Id</param>
/// <param name="modelType">【必填】模型类别</param>
/// <param name="databagVersion">数据包版本；对于offline、vr数据包，如果只有一个，则下载唯一的数据包，如果多个，则必须指定数据包版本</param>
/// <param name="type">数据包类型，如offline、vr、igms</param>
/// <returns></returns>
private GetUrlSwaggerDisplay GetDatabagDownloadUrl(string accessToken, long objectId, ModelType modelType, string databagVersion = "", string type = "offline")
{
    //GET https://api.bimface.com/data/databag/downloadUrl
    string url = BIMFaceConstants.API_HOST + "/data/databag/downloadUrl?" + modelType.ToString() + "=" + objectId;
    if (databagVersion.IsNotNullAndWhiteSpace())
    {
        url += "&databagVersion=" + databagVersion;
    }
    if (type.IsNotNullAndWhiteSpace())
    {
        url += "&type=" + type;
    }

    BIMFaceHttpHeaders headers = new BIMFaceHttpHeaders();
    headers.AddOAuth2Header(accessToken);

    try
    {
        GetUrlSwaggerDisplay response;
        HttpManager httpManager = new HttpManager(headers);
        HttpResult httpResult = httpManager.Get(url);
        if (httpResult.Status == HttpResult.STATUS_SUCCESS)
        {
            response = httpResult.Text.DeserializeJsonToObject<GetUrlSwaggerDisplay>();
        }
        else
        {
            response = new GetUrlSwaggerDisplay
            {
                Message = httpResult.RefText
            };
        }

        return response;
    }
    catch (Exception ex)
    {
        throw new BIMFaceException("[获取数据包下载地址]发生异常！", ex);
    }
}

接口返回的data参数值即为离线数据包的下载地址

https://bf-prod-databag.oss-cn-beijing.aliyuncs.com/4ab9f2df0a8fa218e8ecec619c7090df/4ab9f2df0a8fa218e8ecec619c7090df.zip?Expires=1634202927&OSSAccessKeyId=LTAI4FeTn1BWYhirPskmAUWm&Signature=OE4TZwfjTMZfKvLUbx%2FORkpTxvk%3D

可以看出离线数据库是一个.zip压缩包文件，

Expires：地址的有效时间。

OSSAccessKeyId：BIMFACE在阿里云开发者账号key值。

Signature：签名，已加密。

获取到下载地址后即可下载文件即可，三个参数都不用处理。

下载离线数据包

两种方式下载

• 编程下载
• 手动在浏览器中下载

一般来说离线数据包应用在模型/图纸数量不多，且内容不变的场景中，所以手动下载即可。即使使用编程下载到本地电脑指定位置之后还是要手动解压缩、部署等动作，所以推荐手动下载的方式。

将上述url复制并粘贴到浏览器的地址栏中，按下回车键

下载到本地的文件是一个.zip压缩包

压缩包的名称是随机命名的Guid值，并无实际意义。手动解压缩后，目录结构如下

压缩包内部文件结构解析

离线数据包是一组静态资源文件，并不需要特定的云端程序提供运行时环境，因此可以像部署网页的css、js、image一样部署在静态Web服务器上。 注意：在部署前，必须把压缩文件解压。为了加速访问，离线数据包中的很多文件都进行了gzip压缩。

1、584e7191686a5f8307cdd973b77a1520 目录

目录名称是随机命名的Guid值，并无实际意义。子目录结构如下

• data
  • drawingsheets.json 存储模型中集成的图纸信息
  • spaces 存储模型的空间结构信息
  • tree 存储模型的树状展现结构信息

　　

• metadata

　　存储了模型/图纸的所有元数据信息，大多是Json格式文件

　　

• property

　　包含模型的盒子、元素、元素属性、元素类、族新、族类型、模型架构、数据库文件等。

　　

　　其中数据库文件

　　

• resource

　　包含了模型的资源信息，如：模型构建的线条、地图、标记、场景、质感等

　　

　　

　　

• thumbnail

　　存储了模型/图纸默认视角的3张缩略图，尺寸分别为96x96、256x256、512x512

　　

2、2231874221895488.txt

日志文件，记录了从调用生成离线数据包接口开始到完成的过程中所有步骤信息。如果生成失败，则可以通过该日志排查具体原因。

2021-10-14 16:15:26,342 INFO  - -------------Starting Job 2231874221895488 Logger-------------
2021-10-14 16:15:26,342 INFO  - Notice sended, jobId = 2231874221895488, status = download, code = null, message = null, usage = null
2021-10-14 16:15:26,545 INFO  - File downloaded, size = -1, cost = 188
2021-10-14 16:15:26,545 INFO  - Notice sended, jobId = 2231874221895488, status = execute, code = null, message = null, usage = null
2021-10-14 16:15:26,545 INFO  - worker command = [python -u C:Jobworkerlocal-databag20210511-5ff76eframework/worker.py --workflow localpack/localpack.json --input "C:Jobwd2231874221895488input584e7191686a5f8307cdd973b77a1520.zip" --config "C:Jobwd2231874221895488inputconfig.json" --output "C:Jobwd22318742218954884ab9f2df0a8fa218e8ecec619c7090df"], job id = 2231874221895488
2021-10-14 16:15:26,717 INFO  - WORKER OUTPUT: 3.6.1 (v3.6.1:69c0db5, Mar 21 2017, 18:41:36) [MSC v.1900 64 bit (AMD64)]
2021-10-14 16:15:26,717 INFO  - WORKER OUTPUT: sys.version_info(major=3, minor=6, micro=1, releaselevel='final', serial=0)
2021-10-14 16:15:26,717 INFO  - WORKER OUTPUT: C:Jobwd2231874221895488inputconfig.json
2021-10-14 16:15:26,717 INFO  - WORKER OUTPUT: Namespace(config=<__main__.CustomConfig object at 0x000001E99F701AC8>, configPath='C:\Job\wd\2231874221895488\input\config.json', input='C:\Job\wd\2231874221895488\input\584e7191686a5f8307cdd973b77a1520.zip', links=None, maxLevel=None, maxTime=None, model='', output='C:\Job\wd\2231874221895488\4ab9f2df0a8fa218e8ecec619c7090df', rule=None, workflow='localpack/localpack.json')
2021-10-14 16:15:26,717 INFO  - WORKER OUTPUT: {'keepModel': 'true', 'keepDB': 'true'}
2021-10-14 16:15:26,717 INFO  - WORKER OUTPUT: >> WORKFLOW: localpack/localpack.json
2021-10-14 16:15:26,717 INFO  - WORKER OUTPUT: C:Jobworkerlocal-databag20210511-5ff76e7zip
2021-10-14 16:15:26,717 INFO  - WORKER OUTPUT: C:Jobworkerlocal-databag20210511-5ff76elocalpack
2021-10-14 16:15:26,795 INFO  - WORKER OUTPUT: C:Jobworkerlocal-databag20210511-5ff76emisc
2021-10-14 16:15:26,811 INFO  - WORKER OUTPUT: ___________________________________________
2021-10-14 16:15:26,812 INFO  - WORKER OUTPUT: >> TASK START: prepare 2021-10-14 16:15:26.811123
2021-10-14 16:15:26,812 INFO  - WORKER OUTPUT: Unzip: C:Jobwd2231874221895488input584e7191686a5f8307cdd973b77a1520.zip -> C:Jobwd22318742218954884ab9f2df0a8fa218e8ecec619c7090df
2021-10-14 16:15:26,826 INFO  - WORKER OUTPUT: 
2021-10-14 16:15:26,826 INFO  - WORKER OUTPUT: 7-Zip [32] 16.02 : Copyright (c) 1999-2016 Igor Pavlov : 2016-05-21
2021-10-14 16:15:26,826 INFO  - WORKER OUTPUT: 
2021-10-14 16:15:26,826 INFO  - WORKER OUTPUT: Scanning the drive for archives:
2021-10-14 16:15:26,826 INFO  - WORKER OUTPUT: 1 file, 1497163 bytes (1463 KiB)
2021-10-14 16:15:26,826 INFO  - WORKER OUTPUT: 
2021-10-14 16:15:26,826 INFO  - WORKER OUTPUT: Extracting archive: C:Jobwd2231874221895488input584e7191686a5f8307cdd973b77a1520.zip
2021-10-14 16:15:27,014 INFO  - WORKER OUTPUT: --
2021-10-14 16:15:27,014 INFO  - WORKER OUTPUT: Path = C:Jobwd2231874221895488input584e7191686a5f8307cdd973b77a1520.zip
2021-10-14 16:15:27,014 INFO  - WORKER OUTPUT: Type = zip
2021-10-14 16:15:27,014 INFO  - WORKER OUTPUT: Physical Size = 1497163
2021-10-14 16:15:27,014 INFO  - WORKER OUTPUT: 
2021-10-14 16:15:27,014 INFO  - WORKER OUTPUT: Everything is Ok
2021-10-14 16:15:27,014 INFO  - WORKER OUTPUT: 
2021-10-14 16:15:27,014 INFO  - WORKER OUTPUT: Folders: 32
2021-10-14 16:15:27,014 INFO  - WORKER OUTPUT: Files: 172
2021-10-14 16:15:27,014 INFO  - WORKER OUTPUT: Size:       2578287
2021-10-14 16:15:27,014 INFO  - WORKER OUTPUT: Compressed: 1497163
2021-10-14 16:15:27,014 INFO  - WORKER OUTPUT: >> TASK END: prepare 0:00:00.203097
2021-10-14 16:15:27,014 INFO  - WORKER OUTPUT: JOB_PROGRESS: [ 33.333333333333336 ]
2021-10-14 16:15:27,014 INFO  - WORKER OUTPUT: ___________________________________________
2021-10-14 16:15:27,014 INFO  - WORKER OUTPUT: >> TASK START: mdb2Json 2021-10-14 16:15:27.014220
2021-10-14 16:15:27,014 INFO  - WORKER OUTPUT: C:Jobworkerlocal-databag20210511-5ff76elocalpackin/mdb2json.exe --input "C:Jobwd22318742218954884ab9f2df0a8fa218e8ecec619c7090df584e7191686a5f8307cdd973b77a1520propertymodeldrive.db" --output "C:Jobwd22318742218954884ab9f2df0a8fa218e8ecec619c7090df584e7191686a5f8307cdd973b77a1520property"
2021-10-14 16:15:27,642 INFO  - WORKER OUTPUT: Write to the Value.json.gz successfully!
2021-10-14 16:15:27,648 INFO  - WORKER OUTPUT: Write to the Schema.json.gz successfully!
2021-10-14 16:15:27,670 INFO  - WORKER OUTPUT: Missing family type: 0
2021-10-14 16:15:27,670 INFO  - WORKER OUTPUT: Missing family type: 0
2021-10-14 16:15:27,670 INFO  - WORKER OUTPUT: write to the Families.json.gz successfully!
2021-10-14 16:15:27,670 INFO  - WORKER OUTPUT: write to the FamilyTypeProperties.json.gz successfully!
2021-10-14 16:15:27,670 INFO  - WORKER OUTPUT: write to the Elements.json.gz successfully!
2021-10-14 16:15:27,670 INFO  - WORKER OUTPUT: write to the ElementProperties.json.gz successfully!
2021-10-14 16:15:27,670 INFO  - WORKER OUTPUT: write to the BoundingBox.json.gz successfully!
2021-10-14 16:15:27,686 INFO  - WORKER OUTPUT: db to json done!
2021-10-14 16:15:27,701 INFO  - WORKER OUTPUT: >> TASK END: mdb2Json 0:00:00.687467
2021-10-14 16:15:27,701 INFO  - WORKER OUTPUT: JOB_PROGRESS: [ 66.66666666666667 ]
2021-10-14 16:15:27,701 INFO  - WORKER OUTPUT: ___________________________________________
2021-10-14 16:15:27,701 INFO  - WORKER OUTPUT: >> TASK START: localpack 2021-10-14 16:15:27.701687
2021-10-14 16:15:27,701 INFO  - WORKER OUTPUT: Download: https://api.bimface.com/data/internal/files/10000709359577/floors?includeArea=true&includeRoom=true -> C:Jobwd22318742218954884ab9f2df0a8fa218e8ecec619c7090df584e7191686a5f8307cdd973b77a1520dataspaces.json
2021-10-14 16:15:27,967 INFO  - WORKER OUTPUT: Download: https://api.bimface.com/data/internal/files/10000709359577/drawingsheets -> C:Jobwd22318742218954884ab9f2df0a8fa218e8ecec619c7090df584e7191686a5f8307cdd973b77a1520datadrawingsheets.json
2021-10-14 16:15:28,029 INFO  - WORKER OUTPUT: Clean up models...
2021-10-14 16:15:28,029 INFO  - WORKER OUTPUT: Create viewToken.json
2021-10-14 16:15:28,029 INFO  - WORKER OUTPUT: >> TASK END: localpack 0:00:00.328082
2021-10-14 16:15:28,029 INFO  - WORKER OUTPUT: JOB_PROGRESS: [ 100.0 ]
2021-10-14 16:15:28,029 INFO  - WORKER OUTPUT: Worker finished with code 0
2021-10-14 16:15:28,092 INFO  - Notice sended, jobId = 2231874221895488, status = upload, code = null, message = null, usage = null

3、index.html

模型/图纸浏览时呈现的网页

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <meta http-equiv="X-UA-Compatible" content="ie=edge">
  <title>BimfaceApplication</title>
  <style media="screen">
    html,
    body{
      margin: 0;
      padding: 0;
      width: 100%;
      height: 100%;
    }
    #view{
      width: 100%;
      height: 100%;
    }
  </style>
  <script src="./jssdk/BimfaceSDKLoader@latest-release.js" charset="utf-8"></script>
  <script src="http://apps.bdimg.com/libs/jquery/2.1.1/jquery.min.js"></script>
</head>
<body>
  <div id="view"></div>
  <script type="text/javascript">
    function downloadLatestSDK(){
        $.ajax({
            url: 'https://bimface.com/api/console/offlineJsSDK/latest',
            success: function(result){
                console.log(result);
                window.location.href = result["data"];
            }
        });
    }
  var viewer;
  try {
    var BimfaceLoaderConfig = new BimfaceSDKLoaderConfig();
  } catch (error) {
    var message = window.confirm("没有找到JSSDK，点击确定下载最新的JSSDK。");
    if(message) {
      downloadLatestSDK();
    }
  }
  BimfaceLoaderConfig.dataEnvType = BimfaceEnvOption.Local;
  BimfaceLoaderConfig.sdkPath = './jssdk';
  BimfaceLoaderConfig.path = './viewToken.json';
  
    
  BimfaceSDKLoader.load(BimfaceLoaderConfig,onSDKLoadSucceeded,onSDKLoadFailed);

  function onSDKLoadSucceeded(viewMetaData){

    if(viewMetaData.viewType == "drawingView"){
       var view = document.getElementById('view');   
        var WebAppConfig = new Glodon.Bimface.Application.WebApplicationDrawingConfig();
        WebAppConfig.domElement = view;
        var app = new Glodon.Bimface.Application.WebApplicationDrawing(WebAppConfig);
       
        viewer = app.getViewer();
        viewer.addModel(viewMetaData);
        
    }else if(viewMetaData.viewType == "3DView"){
      var view = document.getElementById('view')
      var config = new Glodon.Bimface.Application.WebApplication3DConfig();
      config.domElement = view;
      var eventManager = Glodon.Bimface.Application.WebApplication3DEvent;
      app = new Glodon.Bimface.Application.WebApplication3D(config);
      viewer = app.getViewer();
      viewer.addModel(viewMetaData);
    }else if(viewMetaData.viewType =="rfaView"){
      var view = document.getElementById('view')
      var config = new Glodon.Bimface.Application.WebApplicationRfaConfig();
      config.domElement = view;
      var eventManager = Glodon.Bimface.Application.WebApplicationRfaEvent;
      app = new Glodon.Bimface.Application.WebApplicationRfa(config);
      viewer = app.getViewer();
      viewer.addModel(viewMetaData);
    }
  };

  function onSDKLoadFailed(error){
    console.log("Failed to load SDK!");
  };
  </script>
</body>
</html>

4、viewToken.json

记录了模型/图纸转化成功后用于浏览时的基本参数信息。

{
    "workerType": "rvt-translate",
    "databagId": "584e7191686a5f8307cdd973b77a1520",
    "modelId": 10000709359577,
    "jsSDKVersion": "3.6.160",
    "modelType": "singleModel",
    "subRenders": [{
            "isSupportModelTree": false,
            "isSupportFamilyTypeList": false,
            "renderVersion": "1.0",
            "jsSDKVersion": "Drawing@1.6.95",
            "isSupportComponentProperty": false,
            "isSupportMiniMap": false,
            "renderType": "drawingView"
        }, {
            "isSupportModelTree": false,
            "isSupportFamilyTypeList": false,
            "renderVersion": "3.0",
            "jsSDKVersion": "3.6.160",
            "isSupportComponentProperty": false,
            "isSupportMiniMap": false,
            "renderType": "drawingView"
        }
    ],
    "isSupportModelTree": true,
    "isSupportWalk": true,
    "isSupportFamilyTypeList": false,
    "renderVersion": "3.0",
    "isSupportRoomArea": true,
    "isSupportMaterialProperty": true,
    "isSupportDrawing": true,
    "name": "01_BIMFACEu793au4f8bu6587u4ef6-Revitu6a21u578b.rvt",
    "databagVersion": "3.7",
    "isSupportComponentProperty": true,
    "isSupportMiniMap": true,
    "renderType": "bimView",
    "config": {
        "texture": "false",
        "modelClassification": "architecture"
    }
}

离线数据包下载到本地之后，需要手动部署之后才能正常访问，下一篇博客详解介绍几种不同的部署方式。

上述测试程序使用了 《BIMFace.SDK.CSharp》开源SDK。欢迎大家下载使用。

BIMFACE二次开发系列目录     【已更新最新开发文章，点击查看详细】