如何分析调用Web API，字段值没有赋值成功？

需求背景：
调用Web API保存单据时，常常出现在参数中，明明已经设置了字段值，但是却没有效果，返回结果还是提示该字段必录。

发生此问题的原因，通常有如下几个方面：
1. 字段Key值弄错：字段Key是大小写敏感的，必须严格按照BOS设计器中设定的字段标识属性设置参数；
2. 字段值不被认可：如给基础资料字段赋值，填写的编码不存在，或未分配到目标组织，或未审核、已禁用等；
3. 字段赋值顺序不对：某些字段有依赖字段，必须在依赖字段赋值后，才能赋值，需要调整Web API中字段参数顺序；
4. 字段值被其他字段的值更新事件覆盖：此点最难确认，本帖提供一个插件代码来解决。

案例说明：
本帖提供一个插件代码，挂到单据表单插件上，捕获字段改变DataChanged事件，输出字段及其字段值。
最终效果，会按顺序输出全部字段的赋值过程，据此可以追查出，整个Web API调用过程：
1. 字段有没有被赋值？
2. 字段赋值是否正确？
3. 字段有没有多次赋值，值由正确值变为无效值，即被其他字段覆盖了？

此插件也适合调用WebService接口保存单据。

日志输出效果：
如何分析调用Web API，字段值没有赋值成功？

示例代码：

本插件代码，需要编译后，挂到单据的表单插件上，本地验证OK。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ComponentModel;

using Kingdee.BOS;
using Kingdee.BOS.Util;
using Kingdee.BOS.Core;
using Kingdee.BOS.Core.DynamicForm.PlugIn;
using Kingdee.BOS.Core.DynamicForm.PlugIn.Args;
using Kingdee.BOS.Core.Bill;
using Kingdee.BOS.Core.Bill.PlugIn;
using Kingdee.BOS.Core.Bill.PlugIn.Args;
using Kingdee.BOS.Core.Metadata.FieldElement;
using Kingdee.BOS.Orm.DataEntity;
namespace JDSample.WatchImport
{
    /// <summary>
    /// 监控调用Web API接口保存单据时，给字段赋值过程
    /// </summary>
    /// <remarks>
    /// 背景说明：
    /// 调用Web API或者WebService接口，保存单据；
    /// 经常发生参数中已经设置了字段值，但是保存结果，却提示字段必录；
    /// 发生此现象时，非常难以排查问题；
    /// 
    /// 解决方案：
    /// 发生此现象时，可以把本插件，挂在单据表单插件上；
    /// 本插件监控到单据被Web API接口，设置单据字段值时，
    /// 会即时把字段的历史数值、新数据输出到K/3 Cloud日志文件中，
    /// 通过日志文件，就可以了解字段赋值的顺序、所填写的值，
    /// 确认出字段为何没有填写上：
    /// 1. 字段未接收到值：字段Key错误，或字段值不合法
    /// 2. 被其他字段覆盖了：字段录入顺序需要调整
    /// </remarks>
    [Description("Web API接口赋值监控")]
    public class Watch : AbstractBillPlugIn
    {
        /// <summary>
        /// 当前进程，是否为WebService、Web API方式调用；
        /// 只有WebService调用，才输出日志
        /// </summary>
        bool _isWebService = false;
        /// <summary>
        /// 界面初始化事件：判断当前进程是否为WebService调用
        /// </summary>
        /// <param name="e"></param>
        public override void OnInitialize(InitializeEventArgs e)
        {
            if (this.Context.ServiceType == WebType.WebService)
            {
                this._isWebService = true;
            }
        }
        /// <summary>
        /// 单据数据包创建、加载完毕：在日志中，输出一个开始语句，以便阅读
        /// </summary>
        /// <param name="e"></param>
        public override void AfterCreateNewData(EventArgs e)
        {
            if (this._isWebService == false)
            {
                return;
            }
            string message = string.Format("现在开始创建单据{0}的新数据包",
                this.View.BillBusinessInfo.GetForm().Name.ToString());
            Kingdee.BOS.Log.Logger.Info("WebService", message);
        }
        /// <summary>
        /// 值改变事件：监控字段值修改顺序及值
        /// </summary>
        /// <param name="e"></param>
        public override void DataChanged(DataChangedEventArgs e)
        {
            if (this._isWebService)
            {
                string message = this.BuildFldChangedLog(e.Field, e.NewValue, e.OldValue);
                Kingdee.BOS.Log.Logger.Info("WebService", message);
            }
        }
        /// <summary>
        /// 保存前调用此事件：可以通过此事件，观察单据数据包中的字段值
        /// </summary>
        /// <param name="e"></param>
        public override void BeforeSave(BeforeSaveEventArgs e)
        {
            base.BeforeSave(e);
        }
        /// <summary>
        /// 构建字段的修改日志
        /// </summary>
        /// <param name="field"></param>
        /// <param name="newValue"></param>
        /// <param name="oldValue"></param>
        /// <returns></returns>
        private string BuildFldChangedLog(Field field, object newValue, object oldValue)
        {
            string newValueString = Convert.ToString(newValue);
            string oldValueString = Convert.ToString(oldValue);
            string logMessage = string.Format("给字段【{0}({1})】赋值为 \"{2}\"；旧值为\"{3}\"{4}",
                field.Name.ToString(),
                field.Key,
                string.IsNullOrWhiteSpace(newValueString) ? "(空值)" : newValueString,
                string.IsNullOrWhiteSpace(oldValueString) ? "(空值)" : oldValueString,
                string.IsNullOrWhiteSpace(newValueString) ? "【有异常，清空了字段值！】" : string.Empty);
            return logMessage;
        }
    }
}

Python版：

#LogWatch 实现值更新事件赋值过程记录日志监控
#by wanghl 2016-1-13
clr.AddReference('System')
clr.AddReference('Kingdee.BOS')
clr.AddReference('Kingdee.BOS.Core')
from Kingdee.BOS import *
from Kingdee.BOS.Log import *
from Kingdee.BOS.Core.DynamicForm.PlugIn import *
#from Kingdee.BOS.Core.Metadata.EntityElement import *
from System import *


def AfterCreateNewData(e):
        if this.Context.ServiceType == WebType.WebService:
                Logger.Info("系统集成", "【"+this.View.BillBusinessInfo.GetForm().Name.ToString()+"】");


def DataChanged(e):
        newValueString = "(空)";
        oldValueString = "(空)";
        if not e.NewValue is None:
                newValueString = Convert.ToString(e.NewValue);
        if not e.OldValue is None:
                oldValueString = Convert.ToString(e.OldValue);

        if this.Context.ServiceType == WebType.WebService:
#                Logger.Info("系统集成 DataChanged ", "["+e.Field.Key+"]-"+e.Field.Name.ToString()+ ":{OldValue->NewValue}"+oldValueString+"->"+newValueString);
                Logger.Info("系统集成 DataChanged ", "["+e.Field.Key+"]-"+e.Field.Name.ToString()+ ":"+oldValueString+"->"+newValueString);

秒客网

如何分析调用Web API，字段值没有赋值成功？

相关文章