C#開發BIMFACE系列45 服務端API之建立離線資料包

BIMFACE二次開發系列目錄     【已更新最新開發文章，點選檢視詳細】

BIMFACE的常規應用方式有公有云與私有化部署兩種方式，並且瀏覽模型或者圖紙需要使用ViewToken，ViewToken 有效期為12小時，過期後需要呼叫介面重新生成。該過程稍微有點麻煩且效能可能受到網路等環境的影響。本文介紹第三種更加便捷高效的方式。

由於使用者所在環境以及應用開發自身的需求，BIMFACE的使用者可能想在如下兩個場景下還能瀏覽上傳的BIMFACE的模型：

• 由於內容保護等原因，有些BIMFACE的使用者所在的網路環境不一定允許訪問公網的BIMFACE服務。
• 使用者自己的應用服務不想依賴於BIMFACE的服務來瀏覽已經在BIMFACE轉換過的模型。尤其適用於運維場景，模型數量不多，且內容不會變更。

離線資料包功能就是為這種需求量身設計的，每一個使用者上傳的模型在轉換後都可以生成對應的離線資料包， 該離線資料包可以下載到本地，獨立部署到使用者的環境內，具體操作流程以及部署細節可以參考伺服器端部署離線資料包、JS端呼叫離線資料包。

生成方式

BIMFACE提供了兩種方式生成離線資料包：

• 在控制檯中手動生成

• 呼叫API自動生成

企業級整合應用開發一般都使用第二種方式，靈活方便。

BIMFACE支援三種型別的檔案生成離線資料包，檔案轉換、模型整合、圖對比成功後，即可建立該檔案的離線資料包。 在建立離線資料包完成以後，通過Callback機制通知呼叫方(請參考這裡)；另外，呼叫方也可以通過介面查詢離線資料包狀態。 

通過檔案ID建立離線資料包

請求地址：PUT https://api.bimface.com/files/{fileId}/offlineDatabag

引數：

其中DatabagDerivativeRequest.cs 類如下

namespace BIMFace.SDK.CSharp.Entity.Request
{
    /// <summary>
    ///  為檔案建立bake資料包或者離線資料包的請求類
    /// </summary>
    [Serializable]
    public class DatabagDerivativeRequest
    {
        /// <summary>
        /// 設定引數，請參考官方具體API需要配置的相關引數
        /// </summary>
        [JsonProperty("config", NullValueHandling = NullValueHandling.Ignore)]
        public Config Config { get; set; }
    }

    [Serializable]
    public class Config
    {
        public Config()
        {
            KeepModel = true;
            KeepDB = true;
        }

        /// <summary>
        /// 預設值為 true
        /// </summary>
        [JsonProperty("keepModel", NullValueHandling = NullValueHandling.Ignore)]
        public bool KeepModel { get; set; }

        /// <summary>
        /// 預設值為 true
        /// </summary>
        [JsonProperty("keepDB", NullValueHandling = NullValueHandling.Ignore)]
        public bool KeepDB { get; set; }
    }

}

請求 path(示例)：https://api.bimface.com/files/1199714943746080/offlineDatabag

請求 header(示例)："Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"

請求 body(示例)：

{
  "config": {
    "keepModel": true,
    "keepDB": true
  }
}

新增上述引數後，生成的資料包中包含一個名為 modeldrive.db 的 SQLite 檔案，資料庫檔案中包含了模型轉換後的所有屬性資料，方便儲存到業務系統資料庫中並使用。

測試程式

（1）建立檔案離線資料包

呼叫介面的實現程式碼：

private DatabagDerivativeCreateResponse CreateDatabag(string accessToken, long objectId, ModelType modelType, string callback = null, DatabagDerivativeRequest request = null)
{
    /* 通過傳入相應的ID建立對應離線資料包:
       檔案轉換ID：PUT  https://api.bimface.com/files/{fileId}/offlineDatabag
       整合模型ID：PUT  https://api.bimface.com/integrations/{integrateId}/offlineDatabag
       模型對比ID：PUT  https://api.bimface.com/comparisions/{compareId}/offlineDatabag
     */

    string actionType = string.Empty;
    if (modelType == ModelType.fileId)
    {
        actionType = "files";
    }
    else if (modelType == ModelType.integrateId)
    {
        actionType = "integrations";
    }
    else if (modelType == ModelType.compareId)
    {
        actionType = "comparisions";
    }

    string url = BIMFaceConstants.API_HOST + string.Format("/{0}/{1}/offlineDatabag", actionType, objectId);
    if (callback.IsNotNullAndWhiteSpace())
    {
        url += "?callback=" + callback;
    }

    if (request == null)
    {
        request = new DatabagDerivativeRequest();
        request.Config = new Config();
    }

    string data = request.SerializeToJson();

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

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

        return response;
    }
    catch (Exception ex)
    {
        throw new BIMFaceException("[建立離線資料包]發生異常！", ex);
    }
}

（2）查詢檔案離線資料包狀態

呼叫介面的實現程式碼

private DatabagDerivativeQueryResponse QueryDatabag(string accessToken, long objectId, ModelType modelType)
{
    /* 通過傳入相應的ID建立對應離線資料包:
       檔案轉換ID：GET https://api.bimface.com/files/{fileId}/offlineDatabag
       整合模型ID：GET https://api.bimface.com/comparisions/{compareId}/offlineDatabag
       模型對比ID：GET https://api.bimface.com/integrations/{integrateId}/offlineDatabag
     */

    string actionType = string.Empty;
    if (modelType == ModelType.fileId)
    {
        actionType = "files";
    }
    else if (modelType == ModelType.integrateId)
    {
        actionType = "integrations";
    }
    else if (modelType == ModelType.compareId)
    {
        actionType = "comparisions";
    }

    string url = BIMFaceConstants.API_HOST + string.Format("/{0}/{1}/offlineDatabag", actionType, objectId);

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

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

        return response;
    }
    catch (Exception ex)
    {
        throw new BIMFaceException("[查詢離線資料包]發生異常！", ex);
    }
}

檢視控制檯

（3）獲取資料包下載地址

呼叫介面的實現程式碼

/// <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);
    }
}

通過檔案整合ID建立離線資料包

請求地址：PUT https://api.bimface.com/integrations/{integrateId}/offlineDatabag。

其他操作與【通過檔案ID建立離線資料包】的操作方式完全相同。

通過模型對比ID建立離線資料包

請求地址：PUT https://api.bimface.com/comparisions/{compareId}/offlineDatabag。

其他操作與【通過檔案ID建立離線資料包】的操作方式完全相同。

 

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

BIMFACE二次開發系列目錄     【已更新最新開發文章，點選檢視詳細】