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#實現方法：

 1 /// <summary>
 2 ///   根據文件ID獲取文件詳細信息
 3 /// </summary>
 4 /// <param name="accessToken">令牌</param>
 5 /// <param name="fileId">文件ID</param>
 6 /// <returns></returns>
 7 public virtual FileInfoGetResponse GetFileInfo(string accessToken, string fileId)
 8 {
 9     //GET https://file.bimface.com/files/{fileId}
10     string url = string.Format(BimfaceConstants.FILE_HOST + "/files/{0}", fileId);
11 
12     BimFaceHttpHeaders headers = new BimFaceHttpHeaders();
13     headers.AddOAuth2Header(accessToken);
14 
15     try
16     {
17         FileInfoGetResponse response;
18 
19         HttpManager httpManager = new HttpManager(headers);
20         HttpResult httpResult = httpManager.Get(url);
21         if (httpResult.Status == HttpResult.STATUS_SUCCESS)
22         {
23             response = httpResult.Text.DeserializeJsonToObject<FileInfoGetResponse>();
24         }
25         else
26         {
27             response = new FileInfoGetResponse
28             {
29                 Message = httpResult.RefText
30             };
31         }
32 
33         return response;
34     }
35     catch (Exception ex)
36     {
37         throw new Exception("[根據文件ID獲取文件詳細信息]發生異常！", ex);
38     }
39 }

其中引用的 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);
}

 1 /// <summary>
 2 ///  HTTP請求(包含文本的body數據)
 3 /// </summary>
 4 /// <param name="url">請求目標URL</param>
 5 /// <param name="data">主體數據(普通文本或者JSON文本)。若是參數中有中文，請使用合適的編碼方式進行編碼，例如：gb2312或者utf-8</param>
 6 /// <param name="method">請求的方法。請使用 HttpMethod 的枚舉值</param>
 7 /// <param name="contentType"><see langword="Content-type" /> HTTP 標頭的值。請使用 ContentType 類的常量來獲取</param>
 8 /// <returns></returns>
 9 private HttpResult RequestString(string url, string data, string method, string contentType)
10 {
11     HttpResult httpResult = new HttpResult();
12     HttpWebRequest httpWebRequest = null;
13 
14     try
15     {
16         httpWebRequest = WebRequest.Create(url) as HttpWebRequest;
17         httpWebRequest.Method = method;
18         httpWebRequest.Headers = HeaderCollection;
19         httpWebRequest.CookieContainer = CookieContainer;
20         if (!string.IsNullOrWhiteSpace(contentType))
21         {
22             httpWebRequest.ContentType = contentType;// 此屬性的值存儲在WebHeaderCollection中。若是設置了WebHeaderCollection，則屬性值將丟失。因此放置在Headers 屬性以後設置
23         }
24         httpWebRequest.UserAgent = _userAgent;
25         httpWebRequest.AllowAutoRedirect = _allowAutoRedirect;
26         httpWebRequest.ServicePoint.Expect100Continue = false;
27 
28         if (data != null)
29         {
30             httpWebRequest.AllowWriteStreamBuffering = true;
31             using (Stream requestStream = httpWebRequest.GetRequestStream())
32             {
33                 requestStream.Write(EncodingType.GetBytes(data), 0, data.Length);//將請求參數寫入請求流中
34                 requestStream.Flush();
35             }
36         }
37 
38         HttpWebResponse httpWebResponse = httpWebRequest.GetResponse() as HttpWebResponse;
39         if (httpWebResponse != null)
40         {
41             GetResponse(ref httpResult, httpWebResponse);
42             httpWebResponse.Close();
43         }
44     }
45     catch (WebException webException)
46     {
47         GetWebExceptionResponse(ref httpResult, webException);
48     }
49     catch (Exception ex)
50     {
51         GetExceptionResponse(ref httpResult, ex, method, contentType);
52     }
53     finally
54     {
55         if (httpWebRequest != null)
56         {
57             httpWebRequest.Abort();
58         }
59     }
60 
61     return httpResult;
62 }

測試

 在BIMFACE的控制檯中能夠看到咱們上傳的文件列表

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

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

 1 // 獲取文件信息
 2 protected void btnGetFileInfo_Click(object sender, EventArgs e)
 3 {
 4     txtFileInfo.Text = string.Empty;
 5 
 6     string token = txtAccessToken.Text;
 7     string fileId = txtFileId.Text;
 8 
 9     FileApi api = new FileApi();
10     FileInfoGetResponse response = api.GetFileInfo(token, fileId);
11 
12     txtFileInfo.Text = response.Code
13                      + Environment.NewLine
14                      + response.Message
15                      + Environment.NewLine
16                      + response.Data.ToString();
17 }

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