提高WCF服务质量（第4部分——日志记录）

目录

介绍

使用代码

介绍

我们已经在前面的部分讨论了如何添加身份验证/授权。这部分解释了我如何将日志记录添加到WCF服务。

使用代码

在上一部分中，我们在执行身份验证和授权时将面向方面的编程概念引入了我们的项目。现在我们将使用相同的概念来记录执行细节。基本上，我们将记录3点。错误（特别是异常）、执行时间和请求。

要记录数据，我们必须定义两个类来保存日志数据，分别位于WCFServices.Shared类库项目的Objects文件夹下的PerfLog和ErrorLog。

public class PerfLog
{
    public string Path { get; set; }
    public string InData { get; set; }
    public string OutData { get; set; }
    public long ExecutionTime { get; set; }
}

public class ErrorLog
{
    public string Path { get; set; }
    public bool IsException { get; set; }
    public string Messages { get; set; }
    public string ErrorContent { get; set; }
    public string InData { get; set; }
    public DateTime ErrorDate { get; set; }
}

public async void CreateErrorLog(ErrorLog logItem)
{
    // Save data to database
}
public async void CreatePerfLog(PerfLog logItem)
{
    // Save data to database
}

关于日志记录属性的一点解释。Path属性将保存服务的名称和调用的服务方法。InData将保存提供给服务方法的输入参数，同时OutData将保存服务方法的响应。ExecutionTime将保存Service方法请求和响应之间的时间差（以毫秒为单位）。IsException属性将保存错误的类型。错误可能是由抛出的异常引起的，也可能是由任何其他因素（如验证）引起的。如果错误是由抛出的异常引起的，则此属性为true，如果错误不是由抛出的异常引起的，则是false。Messages属性保存有关错误的任何信息。这可以是Exception的Message属性，如果抛出了一个Exception，或者将验证返回的字符串数组中的字符串串联起来。ErrorContent属性是可选的，但通常如果抛出Exception，它可能包含Exception的StackTrace属性，该属性保存了修复错误的非常敏感和有用的信息。最后，ErrorDate属性保存错误的日期和时间信息。 

现在是实现日志记录过程的时候了。首先测量执行时间，让我们把一个Stopwatch放到ServiceMethodAspect类：

private static readonly Stopwatch sw = new Stopwatch();

if (sw.IsRunning)
    sw.Stop();
sw.Start();

我们的OnExit方法如下：

public override void OnExit(MethodExecutionArgs args)
{
    PerfLog item = new PerfLog
    {
        Path = $"{args.Method.DeclaringType.FullName}.{args.Method.Name}",
        InData = JsonConvert.SerializeObject(args.Arguments),
        OutData = JsonConvert.SerializeObject(args.ReturnValue),
        ExecutionTime = sw.ElapsedMilliseconds
    };
    sw.Stop();
    LogManager mgr = new LogManager();
    mgr.CreatePerfLog(item);
    base.OnExit(args);
}

public override void OnException(MethodExecutionArgs args)
{
    ErrorLog item = new ErrorLog
    {
        Path = $"{args.Method.DeclaringType.FullName}.{args.Method.Name}",
        InData = JsonConvert.SerializeObject(args.Arguments),
        IsException = true,
        Message = args.Exception.Message,
        ErrorContent = JsonConvert.SerializeObject(args.Exception),
        ErrorDate = DateTime.Now
    };
    sw.Stop();
    LogManager mgr = new LogManager();
    mgr.CreateErrorLog(item);
    args.FlowBehavior = FlowBehavior.Return;
    args.ReturnValue = new BaseResponse
    {
        IsException = true,
        IsSuccess = false,
        Messages = new string[] { args.Exception.Message }
    };
    base.OnException(args);
}

如果我们也想记录验证错误，我们也应该将相同的记录过程添加到我们的服务方法中。例如，这将仅在CreatePlayer服务方法中进行演示。

[ServiceMethodAspect]
public CreatePlayerResponse CreatePlayer(CreatePlayerRequest request)
{
    try
    {
        CreatePlayerValidator validator = new CreatePlayerValidator();
        ValidationResult valResult = validator.Validate(request);
        if (!valResult.IsValidated)
        {
            ErrorLog item = new ErrorLog
            {
                Path = $"{System.Reflection.MethodBase.GetCurrentMethod().DeclaringType.
                          FullName}.{System.Reflection.MethodBase.GetCurrentMethod().Name}",
                InData = JsonConvert.SerializeObject(request),
                IsException = false,
                Message = "Validation failed",
                ErrorContent = JsonConvert.SerializeObject(valResult.Messages),
                ErrorDate = DateTime.Now
            };
            LogManager mgr = new LogManager();
            mgr.CreateErrorLog(item);
            return new CreatePlayerResponse
            {
                IsException = false,
                IsSuccess = false,
                Messages = valResult.Messages.ToArray()
            };
        }
        return new CreatePlayerResponse
        {
            PlayerId = PlayerRepository.CreateNewPlayer
            (request.Name, request.DateOfBirth, request.Height, request.Weight, request.Club),
            IsException = false,
            IsSuccess = true,
            Messages = new string[] { "Operation successful" }
        };
    }
    catch (Exception ex)
    {
        return new CreatePlayerResponse
        {
            IsException = true,
            IsSuccess = false,
            Messages = new string[] { ex.Message }
        };
    }
}

https://www.codeproject.com/Articles/5326223/Improving-WCF-Service-Quality-Part-4-Logging