C#開發BIMFACE系列6 服務端API之獲取文件信息

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

在《C#開發BIMFACE系列4 服務端API之源上傳文件》、《C#開發BIMFACE系列5 服務端API之文件直傳》兩篇文章中詳細介紹了如何將本地文件上傳到BIMFACE服務器及BIMFACE后台的分布式存儲系統中。文件上傳成功后，BIMFACE的服務會返回與該文件相關的信息，如下圖：

 開發者在成功上傳了文件並獲得相關文件信息后，可以將信息保存到數據庫中供后續的業務開發使用。

除此之外，BIMFACE平台還提供了單獨的服務用於獲取文件信息、獲取文件信息列表、獲取文件上傳的狀態信息、獲取應用支持的文件類型。

下面分別介紹各種服務的使用方法。

獲取文件信息

請求地址： GET https://file.bimface.com/files/{fileId}

說明：根據文件ID獲取文件詳細信息

參數：

 

請求 path(示例)：https://file.bimface.com/files/1419273043501216

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

HTTP響應示例(200)：

{
  "code" : "success",
  "data" : {
    "createTime" : "2017-11-09 13:25:03", // 文件的上傳時間
    "etag" : "19349858cjs98ericu989",     // 存儲文件的額外屬性
    "fileId" : 1216113551663296,          // 文件編號
    "length" : 39044,                     // 文件的大小
    "name" : "-1F.rvt",                   // 文件的名稱
    "status" : "success",                 // 文件的上傳狀態
    "suffix" : "rvt"                      // 文件的后綴名
  },
  "message" : ""
}

C#實現方法：

/// <summary>
///   根據文件ID獲取文件詳細信息
/// </summary>
/// <param name="accessToken">令牌</param>
/// <param name="fileId">文件ID</param>
/// <returns></returns>
public virtual FileInfoGetResponse GetFileInfo(string accessToken, string fileId)
{
    //GET https://file.bimface.com/files/{fileId}
    string url = string.Format(BimfaceConstants.FILE_HOST + "/files/{0}", fileId);

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

    try
    {
        FileInfoGetResponse response;

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

        return response;
    }
    catch (Exception ex)
    {
        throw new Exception("[根據文件ID獲取文件詳細信息]發生異常！", ex);
    }
}

其中引用的 httpManager.Get() 方法如下：

/// <summary>
/// HTTP-GET方法，(不包含body數據)。
/// 發送 HTTP 請求並返回來自 Internet 資源的響應(HTML代碼)
/// </summary>
/// <param name="url">請求目標URL</param>
/// <returns>HTTP-GET的響應結果</returns>
public HttpResult Get(string url)
{
    return RequestString(url, null, HttpMethod.GET, null);
}

/// <summary>
///  HTTP請求(包含文本的body數據)
/// </summary>
/// <param name="url">請求目標URL</param>
/// <param name="data">主體數據(普通文本或者JSON文本)。如果參數中有中文，請使用合適的編碼方式進行編碼，例如：gb2312或者utf-8</param>
/// <param name="method">請求的方法。請使用 HttpMethod 的枚舉值</param>
/// <param name="contentType"><see langword="Content-type" /> HTTP 標頭的值。請使用 ContentType 類的常量來獲取</param>
/// <returns></returns>
private HttpResult RequestString(string url, string data, string method, string contentType)
{
    HttpResult httpResult = new HttpResult();
    HttpWebRequest httpWebRequest = null;

    try
    {
        httpWebRequest = WebRequest.Create(url) as HttpWebRequest;
        httpWebRequest.Method = method;
        httpWebRequest.Headers = HeaderCollection;
        httpWebRequest.CookieContainer = CookieContainer;
        if (!string.IsNullOrWhiteSpace(contentType))
        {
            httpWebRequest.ContentType = contentType;// 此屬性的值存儲在WebHeaderCollection中。如果設置了WebHeaderCollection，則屬性值將丟失。所以放置在Headers 屬性之后設置
        }
        httpWebRequest.UserAgent = _userAgent;
        httpWebRequest.AllowAutoRedirect = _allowAutoRedirect;
        httpWebRequest.ServicePoint.Expect100Continue = false;

        if (data != null)
        {
            httpWebRequest.AllowWriteStreamBuffering = true;
            using (Stream requestStream = httpWebRequest.GetRequestStream())
            {
                requestStream.Write(EncodingType.GetBytes(data), 0, data.Length);//將請求參數寫入請求流中
                requestStream.Flush();
            }
        }

        HttpWebResponse httpWebResponse = httpWebRequest.GetResponse() as HttpWebResponse;
        if (httpWebResponse != null)
        {
            GetResponse(ref httpResult, httpWebResponse);
            httpWebResponse.Close();
        }
    }
    catch (WebException webException)
    {
        GetWebExceptionResponse(ref httpResult, webException);
    }
    catch (Exception ex)
    {
        GetExceptionResponse(ref httpResult, ex, method, contentType);
    }
    finally
    {
        if (httpWebRequest != null)
        {
            httpWebRequest.Abort();
        }
    }

    return httpResult;
}

測試

 在BIMFACE的控制台中可以看到我們上傳的文件列表

選擇任意一個文件的ID來做測試

可以看到獲取文件信息成功，返回了以下信息：文件的上傳時間、存儲文件的額外屬性、文件編號、文件的大小、文件的名稱、文件的上傳狀態、文件的后綴名。
測試程序如下：

// 獲取文件信息
protected void btnGetFileInfo_Click(object sender, EventArgs e)
{
    txtFileInfo.Text = string.Empty;

    string token = txtAccessToken.Text;
    string fileId = txtFileId.Text;

    FileApi api = new FileApi();
    FileInfoGetResponse response = api.GetFileInfo(token, fileId);

    txtFileInfo.Text = response.Code
                     + Environment.NewLine
                     + response.Message
                     + Environment.NewLine
                     + response.Data.ToString();
}

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