如何追踪每一笔记录的来龙去脉：一个完整的Audit Logging解决方案[下篇]

通过第一部分的介绍，我们对这个Audit Logging解决方案的原理有了较为全面的了解，接下来我们将通过一个简单的Sample来进一步介绍如何在一个具体的应用中如何实现这样一个Audit Logging。

我们沿用在Part I提出的Order management 场景，为了简单起见，我们通过一个Console application来模拟。在这个Application中，你将会看到如何以一种离线的模式操作数据库，如何Log这些操作。

我们首先来介绍Sample程序的结构（如下图）。整个Solution
一共包括两个Project，一个Console application，另一个是用以管理和定义Stored
Procedure和Trigger的Database project。我们现在就来一步步实现这样一个Order
management的简单的应用。Source Code从Artech.WCFService.zip下载。


一．定义一个轻型的Data access 的Helper class。

在Part I中我提到过这样一个Helper class，虽然这不是本篇所要介绍的重点，但是为了让读者能够较为全面地了解整个处理流程，在这里我对她作一个简单的介绍。

我在前一阵子，写过一篇叫做[原创]我的ORM: 开发自己的Data Access Application Block的文章，在这片文章中我开发了一个自定义的DAB。我这个Data
access helper便是采用里面提出的思想，实现了其中一小部分功能：Data retrieval， Update
Dataset和Transaction。力求简洁，我剔出掉其中可配置的data mapping部分采用hard
coding的方式实现Dataset和Stored procedure的Mapping。

通过这个Helper
class，你可以调用UpdateData方法把对一个Table作的修改向数据库提交。这个方法的思路是这样的：我们对该Table的增加、修改和删除均定义了一个Stored
procedure，我们假设Table name和Stored procedure name之间，Stored
procedure的每个Parameter 的名称和Table中的Field
name和DataRowVersion存在一个Mapping。比如T_ORDER对应的增加、修改和删除stored
procedure分别为sp_order_i，sp_order_u和sp_order_d；stored
procedure的参数@p_order_id对应的Source column为ORDER_ID,
SourceVersion为DataRowVersion.Current，而参数@o_order_id对应的SourceVersion为DataRowVersion.Original。有了这样一个Mapping为前提，相信大家对Helper
class的实现原理应该想象得到。当然要使我们的Stored
procedure满足这样一个Mapping，靠我们手工的方式来定义每个stored
procedure在一个真正的application是不现实的，一般地这些都是通过我们根据具体的Mapping关系开发的生成器生成的。像本Sample的所有stored
procedure和trigger也都是通过Generator生成的。

下面是整个Helper class的实现，不算太复杂，有兴趣的话可以看看。否则敬请略过。

using System;
using System.Collections.Generic;
using System.Text;
using System.Configuration;
using System.Data;
using System.Data.Common;
using System.Data.SqlClient;

namespace Artech.AuditLogging.ConsoleApp
{
    public class DataAccessHelper:IDisposable
    {
        Private Fields

        Public Properties

        Transaction Operations

        Data Mapping

        Discovery Parameter

        Public Methods

        IDisposable Members
    }
}

二．定义Dataset

我们根据数据库中Table的结构定义一个具有相同结构的strongly typed dataset：OrderDataSet.


为了保证数据的完整性，我们必须为两表的relation做出如下的设置：


同时我们为Log的数据定义下面的一个strongly typed
dataset：AuditLoggingDataSet。该Dataset中只包含一个Table:
T_AUDIT_LOG。我们之所以没有定义T_AUDIT_LOG_DETAIL是因为T_AUDIT_LOG_DETAIL中的数据是通过trigger添加的，我们同过程序只需要在主表中添加总体信息就可以了。


三、定义用于Audit log的helper class：AuditLoggingHelper

下面是所有AuditLoggingHelper所有的Code，很简单。我分别定义了一个public的property：AuditLoggingData。其类型为我们上面定义的strongly
typed dataset：AuditLoggingDataSet。还定义了一个Public
的方法AuditLog向AuditLoggingData中添加Log信息，并返回一个Guid用以标识将要执行的transaction。我管这个Guid为Transaction
no。

using System;
using System.Collections.Generic;
using System.Text;

namespace Artech.AuditLogging.ConsoleApp
{
    public class AuditLoggingHelper
    {
        private AuditLoggingDataSet _auditLoggingData;

        /// <summary>
        /// A strongly typed dataset to used to store the general auditoing inforamtion. 
        /// </summary>
        public AuditLoggingDataSet AuditLoggingData
        {
            get { return _auditLoggingData; }
            set { _auditLoggingData = value; }
        }

        /// <summary>
        /// Log the general auditoing information according with the current transaction.
        /// </summary>
        /// <returns>A guid which identifies uniquely a transaction</returns>
        public Guid AuditLog()
        {
            if (this._auditLoggingData == null)
            {
                this._auditLoggingData = new AuditLoggingDataSet();
            }

            Guid transactionNo = Guid.NewGuid();
            AuditLoggingDataSet.T_AUDIT_LOGRow auditRow= this._auditLoggingData.T_AUDIT_LOG.NewT_AUDIT_LOGRow();

            auditRow.BeginEdit();
            auditRow.TRANSACTION_NO = transactionNo.ToString();
            //TODO: The user id is generally the account of the current login user.
            auditRow.USER_ID = "testUser";
            auditRow.OPERATION_DATE = DateTime.Now;
            auditRow.EndEdit();

            this._auditLoggingData.T_AUDIT_LOG.AddT_AUDIT_LOGRow(auditRow);

            return transactionNo;
        }
    }
}

四、定义stored procedure和trigger

为了较为真实地贴近我们现实的开发，
本Sample的所有Data access操作（除了data retrieval外）均采用stored
procedure。通过所有需要进行Log的详细地信息都是通过Trigger来添加的。所有的stored procedure通过这里来查看，所有的trigger通过这里查看。

五：模拟Insert操作

我们先清空所有的Log数据，通过下面的方法添加一个新的Order。

using System;
using System.Collections.Generic;
using System.Text;
using System.Data;

namespace Artech.AuditLogging.ConsoleApp
{
    class Program
    {
        static string USER_ID = "testUser";

        static void Main(string[] args)
        {
            AddOrderData();
            Console.WriteLine("Operation completes!");
            Console.Read();
        }

        static void UpdateCommonField(DataRow row)
        {
            row["LAST_UPDATED_BY"] = USER_ID;
            row["LAST_UPDATED_ON"] = DateTime.Now;
            if (row.RowState == DataRowState.Detached || row.RowState == DataRowState.Added)
            {
                row["CREATED_BY"] = USER_ID;
                row["CREATED_ON"] = DateTime.Now;
            }
        }  

        
        static void AddOrderData()
        {
            AuditLoggingHelper auditLoggingHelper = new AuditLoggingHelper();
            Guid transactionNo = auditLoggingHelper.AuditLog();

            //Add an order item
            OrderDataSet orderData = new OrderDataSet();
            OrderDataSet.T_ORDERRow orderRow = orderData.T_ORDER.NewT_ORDERRow();
            orderRow.BeginEdit();
            orderRow.ORDER_DATE = DateTime.Today;
            orderRow.SUPPLIER = "HP Corporation";
            UpdateCommonField(orderRow);
            orderRow.TRANSACTION_NO = transactionNo.ToString();
            orderRow.EndEdit();
            orderData.T_ORDER.AddT_ORDERRow(orderRow);

            //Add two order detail items.
            OrderDataSet.T_ORDER_DETAILRow orderDetailRow = orderData.T_ORDER_DETAIL.NewT_ORDER_DETAILRow();
            orderDetailRow.BeginEdit();
            orderDetailRow.ORDER_ID = orderRow.ORDER_ID;
            orderDetailRow.PRODUCT_ID = 1;
            orderDetailRow.PRODUCT_NAME = "HP Printer";
            orderDetailRow.UNIT_PRICE = 3000;
            orderDetailRow.QUANTITY = 2;
            UpdateCommonField(orderDetailRow);
            orderDetailRow.TRANSACTION_NO = transactionNo.ToString();
            orderDetailRow.EndEdit();
            orderData.T_ORDER_DETAIL.AddT_ORDER_DETAILRow(orderDetailRow);

            orderDetailRow = orderData.T_ORDER_DETAIL.NewT_ORDER_DETAILRow();
            orderDetailRow.BeginEdit();
            orderDetailRow.ORDER_ID = orderRow.ORDER_ID;
            orderDetailRow.PRODUCT_ID = 2;
            orderDetailRow.PRODUCT_NAME = "HP PC";
            orderDetailRow.UNIT_PRICE = 3400;
            orderDetailRow.QUANTITY = 22;
            UpdateCommonField(orderDetailRow);
            orderDetailRow.TRANSACTION_NO = transactionNo.ToString();
            orderDetailRow.EndEdit();
            orderData.T_ORDER_DETAIL.AddT_ORDER_DETAILRow(orderDetailRow);

            using (DataAccessHelper dataAccessHelper = new DataAccessHelper())
            {
                dataAccessHelper.BeginTransaction();
                try
                {
                    dataAccessHelper.UpdateData(auditLoggingHelper.AuditLoggingData.T_AUDIT_LOG);
                    dataAccessHelper.UpdateData(orderData.T_ORDER);
                    dataAccessHelper.UpdateData(orderData.T_ORDER_DETAIL);
                    dataAccessHelper.Commit();
                }
                catch(Exception ex)
                {
                    dataAccessHelper.Rollback();
                    Console.WriteLine(ex.Message);
                }
            }
        }
    }
}

我们来看看T_AUDIT_LOG的记录：


T_AUDIT_LOG_DETAIL的记录


DATA_CHANGE的data分别为下面3段XML。

<dataChange>
  <after order_id="33" order_date="Apr 23 2007 12:00AM" supplier="HP Corporation" />
</dataChange>

<dataChange>
  <after order_id="33" product_id="1" product_name="HP Printer" unit_price="3000.00" quantity="2" />
</dataChange>

<dataChange>
  <after order_id="33" product_id="2" product_name="HP PC" unit_price="3400.00" quantity="22" />
</dataChange>

六、模拟Update操作

定义新的方法UpdateOrderData修改我们刚刚添加的Order记录：

    static void UpdateOrderData()
        {
            OrderDataSet orderData = GetAllOrderData();
            AuditLoggingHelper auditLoggingHelper = new AuditLoggingHelper();
            Guid transactionNo = auditLoggingHelper.AuditLog();

            OrderDataSet.T_ORDERRow orderRow = orderData.T_ORDER[0];
            orderRow.ORDER_DATE = new DateTime(2005, 1, 1);
            orderRow.SUPPLIER = "Dell Corporation";
            orderRow.TRANSACTION_NO  = transactionNo.ToString();
            UpdateCommonField(orderRow);

            OrderDataSet.T_ORDER_DETAILRow orderDetailRow = orderData.T_ORDER_DETAIL[0];
            orderDetailRow.PRODUCT_ID = 3;
            orderDetailRow.PRODUCT_NAME = "Workstation";
            orderDetailRow.UNIT_PRICE = 10000;
            orderDetailRow.QUANTITY = 1;
            orderDetailRow.TRANSACTION_NO  = transactionNo.ToString();
            UpdateCommonField(orderDetailRow);

            using (DataAccessHelper dataAccessHelper = new DataAccessHelper())
            {                
                dataAccessHelper.BeginTransaction();
                try
                {
                    dataAccessHelper.UpdateData(auditLoggingHelper.AuditLoggingData.T_AUDIT_LOG);
                    dataAccessHelper.UpdateData(orderData.T_ORDER);
                    dataAccessHelper.UpdateData(orderData.T_ORDER_DETAIL);
                    dataAccessHelper.Commit();
                }
                catch (Exception ex)
                {
                    dataAccessHelper.Rollback();
                    Console.WriteLine(ex.Message);
                }
            }            
        }

执行上面的方法，然后查看我们Log表的记录。

 


两条Update记录对应的DATA_CHANGE字段的XML分别为：

<dataChange>
  <before order_id="33" order_date="Apr 23 2007 12:00AM" supplier="HP Corporation" />
  <after order_id="33" order_date="Jan  1 2005 12:00AM" supplier="Dell Corporation" />
</dataChange>

<dataChange>
  <before order_id="33" product_id="1" product_name="HP Printer" unit_price="3000.00" quantity="2" />
  <after order_id="33" product_id="1" product_name="Workstation" unit_price="10000.00" quantity="1" />
</dataChange>

七、模拟Delete操作

定于DeleteOrderData方法delete掉我们添加的Order记录：

static void DeleteOrderData()
        {
            OrderDataSet orderData = GetAllOrderData();
            AuditLoggingHelper auditLoggingHelper = new AuditLoggingHelper();
            Guid transactionNo = auditLoggingHelper.AuditLog();

            //Delete two order detail items.
            OrderDataSet.T_ORDER_DETAILRow orderDetailRow = orderData.T_ORDER_DETAIL[0];
            orderDetailRow.TRANSACTION_NO = transactionNo.ToString();
            orderDetailRow.AcceptChanges();
            orderDetailRow.Delete();

            orderDetailRow = orderData.T_ORDER_DETAIL[1];
            orderDetailRow.TRANSACTION_NO = transactionNo.ToString();
            orderDetailRow.AcceptChanges();
            orderDetailRow.Delete();

            //Delete the order item.
            OrderDataSet.T_ORDERRow orderRow = orderData.T_ORDER[0];
            orderRow.TRANSACTION_NO = transactionNo.ToString();
            orderRow.AcceptChanges();
            orderRow.Delete();

            using (DataAccessHelper dataAccessHelper = new DataAccessHelper())
            {
                dataAccessHelper.BeginTransaction();
                try
                {
                    dataAccessHelper.UpdateData(auditLoggingHelper.AuditLoggingData.T_AUDIT_LOG);
                    dataAccessHelper.UpdateData(orderData.T_ORDER_DETAIL);
                    dataAccessHelper.UpdateData(orderData.T_ORDER);

                    dataAccessHelper.Commit();
                }
                catch (Exception ex)
                {
                    dataAccessHelper.Rollback();
                    Console.WriteLine(ex.Message);
                }
            }
        }

执行上面的方法，然后查看我们Log表的记录。


三条Delete记录对应的DATA_CHANGE字段的XML分别为：

<dataChange>
  <before order_id="33" product_id="1" product_name="Workstation" unit_price="10000.00" quantity="1" />
</dataChange>

<dataChange>
  <before order_id="33" product_id="2" product_name="HP PC" unit_price="3400.00" quantity="22" />
</dataChange>

<dataChange>
  <before order_id="33" order_date="Jan  1 2005 12:00AM" supplier="Dell Corporation" />
</dataChange>

作者：蒋金楠
微信公众账号：大内老A
微博：www.weibo.com/artech
如果你想及时得到个人撰写文章以及著作的消息推送，或者想看看个人推荐的技术资料，可以扫描左边二维码（或者长按识别二维码）关注个人公众号（原来公众帐号蒋金楠的自媒体将会停用）。
本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。

原文链接

时间： 2024-02-26 14:58:38

如何追踪每一笔记录的来龙去脉：一个完整的Audit Logging解决方案[下篇]的相关文章

asp.net 怎么开发自动提醒功能啊,比如向表A添加了一笔记录,会出现一个窗口自动提示呢?

问题描述 asp.net怎么开发自动提醒功能啊,比如向表A添加了一笔记录,会出现一个窗口自动提示呢? 解决方案 解决方案二:我没有做过,但是上回我们是使用一个timer来实现的,就是不断的去读数据库,弄一个提醒表,添加一条就给提醒表加一条信息.用触发器这里.然后读提醒表解决方案三:首先建立观察者模式如果被观察者有动作,服务器标记观察者状态有更改.AJAX定期检查服务器是否有状态变更.-------------PS:目前没有什么好的方案.这个功能很累.解决方案四:哎,楼上的二位大哥能不能清楚一点.

一个完整的用于追踪数据改变的解决方案

在之前一篇介绍CDC的文章中,我说Audit Trail(或者Audit Log)是大部分企业级应用不可以或缺的功能.本篇给你一个完整的Audit Trail解决方案,不仅可以记录每一笔业务操作的信息(比如操作时间.操作者等),并且可以追踪每一笔业务引起的说有数据的改变(如果需要). 目录 一.数据表的设计 二.数据变化的表示 三.AuditLog基本信息的写入 四.通过SQLCDC追踪源表数据变化 五.删除操作的TransactionId如何被记录? 六.通过SQL Job转储AuditLog

AspxGridView空行新增保存两笔记录只显示最后一笔记录

问题描述 AspxGridView初始数据绑定的时候,数据源的SQL为:select*fromtablenamewhere1=0,即不获取数据.本页面用于客户订单数据录入,单表结构.录入完订单数据后保存,不管录入多少条数据,只能显示最后的一条数据,在不使用Session的情况下,需要在用户操作画面显示本次录入的所有数据,即用户录入了5笔,就在画面上保留显示5笔数据. 解决方案 解决方案二:没懂到底想要一条还是五条可以考虑在保存的时候用一下ajax把保存成功的数据回传一下进行显示解决方案三:不用S

oracle 记录被另一个用户锁住

  oracle数据中删除数据时提示"记录被另一个用户锁住" 解决方法   1 查看数据库锁,诊断锁的来源及类型   select object_id,session_id,locked_mode from v$locked_object;     或者用以下命令:    select b.owner,b.object_name,l.session_id,l.locked_mode    from v$locked_object l, dba_objects b    where b.

sql 查询如何实现多个相同的记录合并成一个，举例如下，求指教。

问题描述 sql 查询如何实现多个相同的记录合并成一个,举例如下,求指教. 解决方案 sql 查询不能返回字表的吧, 你a列的A对应b列的三行肯定是不行的,如果你要取最大值可以 select a, max(b) from table group by a 解决方案二: 这不是sql的活,是你界面展现的事,你可以自己自定义表格,或者第三方的表格,比如dev系列 解决方案三: sql干不了,在html页面生成时,动态的设置即可(table colspan). 解决方案四: 数据库一条一记录的,这个的

java-新手求助：sql语句，从多个表中取出最新时间的记录，组成一个新表

问题描述 新手求助:sql语句,从多个表中取出最新时间的记录,组成一个新表 解决方案 mysql的实现: insert into zongbiao(id, name ,vd,co2,wendu,time) select t1.id,t1.name,t1.vd,t2.co2,t2.wendu,t2.time from biao1 t1 join biao2 t2 on(t1.id=t2.id) order by t2.time desc limit 1; 解决方案二: 1.mysql和oracle

trinidad &amp;amp;lt;tr:table&amp;amp;gt;的“记录导航(上一个10 显示全部 上一个 10 )”从左侧移到右侧

问题描述 trinidad<tr:table>的"记录导航(上一个10显示全部上一个10)"从左侧移到右侧怎么解决呢? 解决方案 解决方案二:从右侧移到左侧

J2ME怎么把两个RMS里的记录合并为一个？

问题描述 需要把两个RMS里的记录合并为一个,应该怎么做? 解决方案 解决方案二:现在问题是这样的:这两个RMS在建立的时候,使用的RecordStoreName是一样的,这样说吧,它们是用同一段语句生成的,现在需要把它们两个的记录合并起来,这该怎么做?解决方案三:引用1楼cm00001的回复: 现在问题是这样的:这两个RMS在建立的时候,使用的RecordStoreName是一样的,这样说吧,它们是用同一段语句生成的,现在需要把它们两个的记录合并起来,这该怎么做? RMS名字相同时,不管你建立

我的FreeBSD5.4安装配置过程笔记录(新手参考)第1/5页_unix linux

<第一章>  没装过之前,有闻freebsd在web服务器领域有快速稳定如"坚如磐石"的高性能,作为unix bsd家族中重要一员,有优良的网络和安全性能,软件丰富,简洁高效,完全免费的!在网上逛逛也发现在其之上的桌面系统也不逊色于linux.  以前玩过linux的发行版有redhat,mandrake,slackware,不过都在玩些初始的安装配置而又不常用linux,觉得linux版本有些多而不好选择,bug又相对比较多--于是跃跃欲试freebsd--  我是从今年