SAP OpenUI5中ODataModel v2的sap-cancel-on-close头值类型问题解析

问题背景

在SAP OpenUI5框架的ODataModel v2实现中，开发人员发现了一个关于HTTP请求头值的类型问题。具体表现为当使用ODataModel发送请求时，框架会自动添加一个名为"sap-cancel-on-close"的自定义请求头，但该头的值被设置为布尔类型(true)而非字符串类型("true")。

技术细节

根据HTTP/1.1规范(RFC7230)第3.2.4节的规定，HTTP头的值必须是字符串类型。这一规范要求在现代前端测试工具如Sinon.js中得到了严格执行。当Sinon.js的FakeXHR实现检测到非字符串类型的头值时，会抛出类型错误。

在OpenUI5的源代码中，这个问题源于ODataMetadata.js文件中的_createRequest方法。该方法在创建默认请求头时，直接将"sap-cancel-on-close"头的值设置为布尔值true：

var oDefaultHeaders = {
    "sap-cancel-on-close": true
};

影响范围

这一问题主要影响以下场景：

1. 使用Sinon.js进行单元测试时，会因头值类型不符合规范而抛出错误
2. 任何严格遵循HTTP头值规范的HTTP客户端实现
3. 使用ODataModel v2版本的应用（v4版本不存在此问题）

临时解决方案

在官方修复发布前，开发者可以采用以下临时解决方案：

// 在测试代码中拦截并修正头值类型
this.requestDatajsStub = sinon.stub(sap.ui.require("sap/ui/thirdparty/datajs"), "request");
this.requestDatajsStub.callsFake((oRequest, handleSuccess, handleError, metadataHandler) => {
    if (typeof oRequest.headers["sap-cancel-on-close"] === "boolean") {
        oRequest.headers["sap-cancel-on-close"] = String(oRequest.headers["sap-cancel-on-close"]);
    }
    return this.requestDatajsStub.wrappedMethod(oRequest, handleSuccess, handleError, metadataHandler);
});

官方修复

SAP开发团队已确认此问题并在主分支和1.120版本中进行了修复。修复方案是将布尔值转换为字符串形式：

var oDefaultHeaders = {
    "sap-cancel-on-close": "true"
};

最佳实践建议

1. 在自定义HTTP头时，始终使用字符串作为值类型
2. 升级到已修复此问题的OpenUI5版本（1.120或更高）
3. 在测试代码中考虑添加对非规范头值的防御性处理
4. 对于新项目，优先考虑使用ODataModel v4，它不存在此问题且具有更多现代特性

此问题的修复体现了SAP对Web标准合规性的重视，也提醒开发者在实现HTTP相关功能时需要严格遵循相关规范。