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:\Job\worker\local-databag\20210511-5ff76e\framework/worker.py --workflow localpack/localpack.json --input "C:\Job\wd\2231874221895488\input\584e7191686a5f8307cdd973b77a1520.zip" --config "C:\Job\wd\2231874221895488\input\config.json" --output "C:\Job\wd\2231874221895488\4ab9f2df0a8fa218e8ecec619c7090df"], 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:\Job\wd\2231874221895488\input\config.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:\Job\worker\local-databag\20210511-5ff76e\7zip
2021-10-14 16:15:26,717 INFO  - WORKER OUTPUT: C:\Job\worker\local-databag\20210511-5ff76e\localpack
2021-10-14 16:15:26,795 INFO  - WORKER OUTPUT: C:\Job\worker\local-databag\20210511-5ff76e\misc
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:\Job\wd\2231874221895488\input\584e7191686a5f8307cdd973b77a1520.zip -> C:\Job\wd\2231874221895488\4ab9f2df0a8fa218e8ecec619c7090df
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:\Job\wd\2231874221895488\input\584e7191686a5f8307cdd973b77a1520.zip
2021-10-14 16:15:27,014 INFO  - WORKER OUTPUT: --
2021-10-14 16:15:27,014 INFO  - WORKER OUTPUT: Path = C:\Job\wd\2231874221895488\input\584e7191686a5f8307cdd973b77a1520.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:\Job\worker\local-databag\20210511-5ff76e\localpack\bin/mdb2json.exe --input "C:\Job\wd\2231874221895488\4ab9f2df0a8fa218e8ecec619c7090df\584e7191686a5f8307cdd973b77a1520\property\modeldrive.db" --output "C:\Job\wd\2231874221895488\4ab9f2df0a8fa218e8ecec619c7090df\584e7191686a5f8307cdd973b77a1520\property"
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:\Job\wd\2231874221895488\4ab9f2df0a8fa218e8ecec619c7090df\584e7191686a5f8307cdd973b77a1520\data\spaces.json
2021-10-14 16:15:27,967 INFO  - WORKER OUTPUT: Download: https://api.bimface.com/data/internal/files/10000709359577/drawingsheets -> C:\Job\wd\2231874221895488\4ab9f2df0a8fa218e8ecec619c7090df\584e7191686a5f8307cdd973b77a1520\data\drawingsheets.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/[e-mail]" 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_BIMFACE\u793a\u4f8b\u6587\u4ef6-Revit\u6a21\u578b.rvt",
    "databagVersion": "3.7",
    "isSupportComponentProperty": true,
    "isSupportMiniMap": true,
    "renderType": "bimView",
    "config": {
        "texture": "false",
        "modelClassification": "architecture"
    }
}

離線數據包下載到本地之后，需要手動部署之后才能正常訪問，下一篇博客詳解介紹幾種不同的部署方式。

 

上述測試程序使用了 《BIMFace.SDK.CSharp》開源SDK。歡迎大家下載使用。

BIMFACE二次開發系列目錄     【已更新最新開發文章，點擊查看詳細】