C#开发BIMFACE系列36 服务端API回调机制

【已更新最新开发文章，点击查看详细】

　　在《C# 开发 BIMFACE 系列文章》中介绍了模型转换、模型对比接口。这2个功能接口比较特殊，发起请求后，逻辑处理是在BIMFACE云端进行的，通常需要5~10分钟。当逻辑处理完成后，BIMFACE通过回调机制通知对比结果。

　　BIMFACE支持回调机制。在调用方发起模型转换、模型集成、模型对比、生成离线数据包、图纸拆分等接口操作时，可以通过传入参数callback的方式来启用回调机制。在BIMFACE处理完相应操作后，根据调用方传入的回调地址通知调用方相应操作的结果。

C#开发BIMFACE系列36 服务端API回调机制

URL参数：

signature（签名）：为了确保回调消息是由BIMFACE发出的，调用方在收到回调消息后，须验证签名。签名的计算方式：MD5(``appKey:appSecret:compareId:status:nonce'')，如果调用方计算的签名与BIMFACE返回的签名一致，则证明该消息是安全可靠的。

应用收到回调后，须向BIMFace发送回执，回执消息：HTTP STATUS 200

Callbak示例：

* 调用方对文件1685236328506848发起了模型转换，并且传入的回调地址是：https://my.app.com/callback。

* BIMFACE在模型转换任务处理完成后，会发送一个get请求到调用方的callback地址：
 https://my.app.com/callback?fileId=1685236328506848&status=success&thumbnail=38044a282f55cb26e3704643dccd2b55/thumbnail/96.png,38044a282f55cb26e3704643dccd2b55/thumbnail/256.png&reason=&signature=99a6fccb1894dfdb4cce48fd5ec58110&nonce=123abc

* 调用方接收到这条请求后，可以进行signature的验证，并发送回执消息。

特别说明

　　BIMFACE的回调机制与微信公众号或者小程序开发类似，需要开发者提供开发者服务器，且有正式合法域名或者外网IP，对外公布一个地址，BIMFACE服务器能访问到该地址才可以。

　　如果无法提供有效的回调地址，则只能通过手动调用模型转换、模型集成、模型对比、生成离线数据包等操作的其他API来获取对应的处理结果。

　　在.NET平台下实现该功能可以使用 WebService、一般处理程序、WebAPI等技术方式实现。下面介绍在一般处理程序中实现的思路与步骤。

1、配置BIMACE开发者账号信息。

　　在web.config 或者 app.config 文件中配置开发者账号信息，供验证消息签名时使用。

C#开发BIMFACE系列36 服务端API回调机制

2、获取BIMFace服务器发送的回调请求参数。

1 long fileId = context.Request.QueryString["fileId"].ToLong();  // 文件ID
2 string status = context.Request.QueryString["status"];         // 转换的结果
3 string reason = context.Request.QueryString["reason"];         // 若转换失败，则返回失败原因
4 string thumbnail = context.Request.QueryString["thumbnail"];   // 缩略图地址
5 string nonce = context.Request.QueryString["nonce"];           // 回调随机数
6 string signature = context.Request.QueryString["signature"];   // BIMFACE的加密签名

3、根据请求参数计算签名。

　　签名的计算方式：MD5(``appKey:appSecret:compareId:status:nonce'')

 1 /// <summary>
 2 ///  根据回调的参数计算签名
 3 /// </summary>
 4 /// <param name="appKey">开发者秘钥</param>
 5 /// <param name="appSecret">开发者密码</param>
 6 /// <param name="fileId">BIMFace发出的回调信息：文件ID</param>
 7 /// <param name="status">BIMFace发出的回调信息：转换的结果</param>
 8 /// <param name="nonce">BIMFace发出的回调信息：回调随机数</param>
 9 /// <returns></returns>
10 public static string GetCallbackSignature(string appKey, string appSecret, long fileId, string status, string nonce)
11 {
12     return string.Format("{0}:{1}:{2}:{3}:{4}", appKey, appSecret, fileId, status, nonce).EncryptByMD5();
13 }

其中使用到的扩展方法 EncryptByMD5() 实现如下：

 1 /// <summary>
 2 ///  自定义扩展方法：使用 MD5(不可逆加密) 算法加密字符串。返回二进制形式的字符串。字符串的编码方式为UTF8。
 3 /// </summary>
 4 /// <param name="this">扩展对象。字符串。编码方式为UTF8</param>
 5 /// <param name="caseType">字符串大小写。默认小写</param>
 6 /// <returns></returns>
 7 public static string EncryptByMD5(this string @this, CaseType caseType = CaseType.Lower)
 8 {
 9     using (MD5 md5 = MD5.Create())
10     {
11         var sb = new StringBuilder();
12         byte[] hashBytes = md5.ComputeHash(Encoding.UTF8.GetBytes(@this));
13         foreach (byte bytes in hashBytes)
14         {
15             sb.Append(bytes.ToString("X2"));//X2 表示二进制
16         }
17 
18         return caseType == CaseType.Upper ? sb.ToString() : sb.ToString().ToLower();
19     }
20 }

View Code