asp.net core日志与异常处理小结

asp.net core的webApplicationBuilder中自带了一个日志组件,无需手动注册服务就能直接在控制器中构造注入，本文主要介绍了net core日志与异常处理小结，需要的朋友可以参考下

ILogger简单使用

asp.net core的webApplicationBuilder中自带了一个日志组件。无需手动注册服务就能直接在控制器中构造注入。

public HomeController(ILogger<HomeController> logger)
{
    _logger = logger;
}
_logger.LogTrace("trace{path}", HttpContext.Request.Path);
_logger.LogDebug("debug{path}", HttpContext.Request.Path);
_logger.LogInformation("info{path}", HttpContext.Request.Path);
_logger.LogWarning("warn{path}", HttpContext.Request.Path);
_logger.LogError("error{path}", HttpContext.Request.Path);
_logger.LogCritical("critical{path}", HttpContext.Request.Path);
_logger.Log(LogLevel.Information, "Log{path}", HttpContext.Request.Path);

打印效果如下

 

在一个日志输出中，日志的第一行输出是日志类别，来自泛型参数<HomeController>的完全限定类名。第二行是模板字符串输出，可以看到从info级别开始才有输出,这是因为在appsetting文件中配置了LogLevel为Information，过滤掉了该等级之下的输出。

MSDN推荐在方法中多次详细的打印日志，但打印方法使用Trace或Information。开发时将日志等级设置为Warn，避免过多信息显示。在排查故障时才将日志等级设置为Trace

打印异常信息

try
{
    throw new Exception("自定义异常");
}
catch (Exception e)
{
    _logger.LogTrace("trace{path}", e);
    _logger.LogDebug("debug{path}", e);
    _logger.LogInformation("info{path}", e);
    _logger.LogWarning("warn{path}", e);
    _logger.LogError("error{path}", e);
    _logger.LogCritical("critical{path}", e);
    _logger.Log(LogLevel.Information, "Log{path}", e.ToString());
}

打印效果如下

 

日志的第一行是泛型参数，第二行开始是字符串模板。其中有参数e的异常类型，异常信息e.Message。第三行开始时异常的调用堆栈e.StackTrace最后一个打印中调用了e.ToString()，结果是一样的。由此可见日志打印时，碰到了非字符串参数，就会调用其ToString()方法。那么我们可以通过重写这个方法来改变日志输出吗？

重写ToString

public class Person
{
    public int Id { get; set; }
    public string Name { get; set; }
    public int Age { get; set; }
    public override string ToString()
    {
        return JsonSerializer.Serialize(this);
    }
}
_logger.LogError("{path}", new Person() { Id=1,Name="张三",Age=19});
_logger.LogCritical("{path}", new Person() { Id = 2, Name = "王浩", Age = 20 });

这里我在重写中调用了序列化方法，打印结果是一个json数据

 

日志配置方式

配置日志文件介质，有三种方法，都是ILoggingBilder调用AddConsole。他们差不多，但有微小差别。第一种是配置容器中的日志服务，后面两种是配置服务主机上的日志。

主机生成器会初始化默认配置，然后在生成主机时将已配置的 ILoggerFactory 对象添加到主机的 DI 容器

所以效果是一样的

 

//第一种，配置应用程序级别的日志记录器
builder.Services.AddLogging(configure =>
{
    configure.AddConsole();
});
//第二种，配置应用程序主机级别的日志记录器。和第三种一样，但不推荐使用这个。
builder.Host.ConfigureLogging(configure =>
{
    configure.AddConsole();
});
//第三种，配置应用程序主机级别的日志记录器
builder.Logging.AddConsole();

Log等级

在asp.net core的日志默认扩展中，定义LogTrace LogDebug LogInformation LogWarning LogError LogCritical Log 7种常用方法。对应的日志有7个级别

// 定义日志严重性级别。
public enum LogLevel
{
    //包含最详细消息的日志。这些消息可能包含敏感的应用程序数据
    //默认情况下禁用这些消息，生产环境中永远不应启用
    Trace = 0,
    //用于开发过程中的交互式调查。这些日志主要包含调试有用的信息，没有长期价值
    Debug = 1,
    //跟踪应用程序的一般流程。这些日志应具有长期价值
    Information = 2,
    //强调应用程序流程中的异常或意外事件，但不会导致应用程序执行停止
    Warning = 3,
    //强调由于失败导致当前执行流程停止的日志。这些日志应指示当前活动中的失败，而不是应用程序范围的失败
    Error = 4,
    //描述不可恢复的应用程序或系统崩溃，或者需要立即关注的灾难性失败
    Critical = 5,
    //不用于编写日志消息。指定日志类别不应写入任何消息
    None = 6,
}

异常

在开发环境，builder默认会为应用配置这个异常中间件app.UseDeveloperExceptionPage()，这个配置是写在源码中的，所以不需要我们显式配置。如果我们不想显示这个页面，那可以配置中间件UseExceptionHandler。这个中间件要配置在UseDeveloperExceptionPage后面，因为中间件调用是递归的，异常发生在终结点中间件中，之后就是请求处理管道递归跳出阶段，所以异常捕获也在这个阶段。调用顺序和配置顺序是相反的。

或者根据环境app.Environment.IsDevelopment()来判断使用是否使用UseExceptionHandler。至于UseDeveloperExceptionPage则不用担心，只要不是显示配置，开发环境中不会进入这个中间件。不知道是由于条件编译，还是做了环境判断。

还还有一种方法是在这两个中间件后面自定义中间件捕获异常，短路管道。

我注意到，不管使用UseDeveloperExceptionPage还是UseExceptionHandler中间件，控制台中都会出现异常日志，这是为什么？这是因为这两个中间件中都调用了日志打印。所以我们可以自己实现一个异常处理中间件，这样就不会打印日志了。

app.UseDeveloperExceptionPage();
app.UseExceptionHandler("/Home/Error");
app.Use(async (context, next) =>
{
    try
    {
        await next(context);
    }
    catch (Exception e)
    {
        await context.Response.WriteAsync("Custom Exception MiddleWare");
    }
});

碰到异常打印日志是正常操作，所以这不需要我们去关心。但是，在前面的截图中，UseExceptionHandler中间件的异常打印的问题在于，没有打印请求路径、请求参数等信息。我们只知道哪里出错了，却不知道是什么原因引起的，怎么复现，这是很不完善的。不知道当初为什么这样设计。所以最好是自己重新写个异常处理中间件，设置响应内容以及控制日志打印。

自定义异常中间件打印请求和异常日志

public class ExceptionMiddleware
{
    private readonly RequestDelegate next;
    public ExceptionMiddleware(RequestDelegate next)
    {
        this.next = next;
    }
    public async Task InvokeAsync(HttpContext context)
    {
        try
        {
            await next(context);
        }
        catch (Exception e)
        {
            var _logger=context.RequestServices.GetService<ILogger<ExceptionMiddleware>>();
            var bodystring="";
            if (context.Request.ContentType==null || !context.Request.ContentType.Contains("multipart/form-data"))
            {
                using (StreamReader reader = new StreamReader(context.Request.Body, Encoding.UTF8))
                {
                    bodystring = await reader.ReadToEndAsync();
                }
            }
            else
            {
                //不包含文件实际内容
                foreach (var formField in context.Request.Form)
                {
                    bodystring += formField.Key + " " + formField.Value+",";
                }
            }
            _logger.LogError("堆栈:{e}\n\t路径:{c}\n\t查询字符串:{p}\n\t内容:{f}", e,context.Request.Path,context.Request.QueryString,bodystring);
            await context.Response.WriteAsync("Custom Exception MiddleWare");
        }
    }
}

使用Serilog输出日志到文件介质

由于asp.net core自己没有提供文件介质的提供程序，所以我转到使用Serilog。仅仅注册了一个服务，其他的一切不变。
引入包Serilog.AspNetCore。并不需要引入Serilog.Sinks.File，因为Serilog.AspNetCore已经引入了文件介质的提供程序

日志管线配置Serilog提供程序

日志系统包括如下几个概念：日志管线、提供程序、介质。严格来说介质不算。
日志系统又叫日志管线logging pipeline。日志管线中的每个提供程序都会处理一次日志，并输出到自己的介质中。

  • 配置serilog子管线

 

Log.Logger = new LoggerConfiguration()
    //最小输出等级
    .MinimumLevel.Warning()
    //增加介质
    .WriteTo.Console()
    .WriteTo.File("logs/log-.txt", rollingInterval: RollingInterval.Day)
    .CreateLogger();
//注册serilog服务
builder.Services.AddSerilog();

配置完整的日志管线这里默认的控制台介质得到了两个提供程序，一个是默认的AddConsole，一个是Serilog的WriteTo.Console。按照管线中配置的顺序，这两个提供程序都会向控制台打印一次。而Serilog还向管线中添加了一个到文件介质的提供程序，所以还会产生一个日志文件。

builder.Services.AddLogging(logbuilder =>
{
    logbuilder
	//删除管线上默认的提供程序
    .ClearProviders()
	//serilog子管线上的提供程序合并进来
	.AddSerilog()
    .AddConsole();
});

控制台介质两个提供程序均处理了日志打印

  • 文件介质

输出模板

回想默认日志提供程序和serilog日志提供程序，都会在我们的消息之外附加信息，比如等级、类名。这是怎么配置的？

  • 默认日志提供程序的格式是 [LogLevel]: [EventId] [Category] Message。可以通过继承ConsoleFormatter改写模板。但是很麻烦。而且颜色，字体还不知道怎么控制。
public class CustomConsoleFormatter : ConsoleFormatter
{
    private readonly string _formatTemplate;
    public CustomConsoleFormatter(IOptions<TemplatedConsoleFormatterOptions> options) : base(name: "Custom")
    {
        _formatTemplate = options.Value.Template ?? "[{Timestamp:HH:mm:ss} {Level}] [{EventId}] {Message}{NewLine}{Exception}";
    }
    public override void Write<TState>(in LogEntry<TState> logEntry, IExternalScopeProvider scopeProvider, TextWriter textWriter)
    {
        var timestamp = DateTime.UtcNow;
        var level = logEntry.LogLevel.ToString();
        var eventId = logEntry.EventId.Id;
        var message = logEntry.Formatter(logEntry.State, logEntry.Exception);
        var exception = logEntry.Exception != null ? logEntry.Exception.ToString() : "";
        var newLine = Environment.NewLine;
        var logOutput = ReplaceTemplateValues(_formatTemplate, timestamp, level, eventId, message, exception, newLine);
        textWriter.Write(logOutput);
    }
    private string ReplaceTemplateValues(string template, DateTime timestamp, string level, int eventId, string message, string exception, string newLine)
    {
        return Regex.Replace(template, @"{(\w+)(?::([^}]+))?}", match =>
        {
            var key = match.Groups[1].Value;
            var format = match.Groups[2].Value;
            switch (key)
            {
                case "Timestamp":
                    return timestamp.ToString(format);
                case "Level":
                    return level;
                case "EventId":
                    return eventId.ToString();
                case "Message":
                    return message;
                case "NewLine":
                    return newLine;
                case "Exception":
                    return exception;
                default:
                    return match.Value;
            }
        });
    }
}
public class TemplatedConsoleFormatterOptions : ConsoleFormatterOptions
{
    public string? Template { get; set; }
}
//使用模板
builder.Services.AddLogging(logbuilder =>
{
    logbuilder
    .ClearProviders()
   //.AddSerilog()
   .AddConsole(option =>
   {
       //使用名为Custom的模板配置
       option.FormatterName = "Custom";
   })
   //添加一个控制台模板配置
   .AddConsoleFormatter<CustomConsoleFormatter, TemplatedConsoleFormatterOptions>(foption =>
   {
       foption.Template = "[{Timestamp:HH:mm:ss} {Level}] [{EventId}] {Message:lj}{NewLine}{Exception}";
   });
});

 

 

Serilog输出模板相比之下Serilog就简单得多，直接指定模板就行 

Log.Logger = new LoggerConfiguration()
    //最小输出等级
    .MinimumLevel.Warning()
    //增加介质
    .WriteTo.Console(outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {Message:lj}{NewLine}{Exception}")
    .WriteTo.File("logs/log-.txt", rollingInterval: RollingInterval.Day, outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {Message:lj}{NewLine}{Exception}")
    .CreateLogger();

Serilog还能向模板中增加字段，使用Enrichers

Log.Logger = new LoggerConfiguraition()  
     .Enrich.FromLogContext()
	 .Enrich.WithProperty("Application", "Demo")
	  .WriteTo.File("logs/log-.txt", rollingInterval: RollingInterval.Day, outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {Message:lj}{Properties:j}{NewLine}{Exception}")
// 设置 ThreadContext 或 CallContext 的属性
ThreadContext.Properties["UserId"] = 42;
CallContext.LogicalSetData("UserName", "John Doe");
Log.Information("User {UserId} logged in as {UserName}", ThreadContext.Properties["UserId"], CallContext.LogicalGetData("UserName"));

 

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mfbz.cn/a/882754.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

Redis的一些数据类型（一）

Redis的一些数据类型（一）

&#xff08;一&#xff09;数据类型 我们说redis是key value键值对的方式存储数据&#xff0c;key是字符串&#xff0c;而value是一些数据结构,那今天就来说一下value存储的数据。 我们数据结构包含&#xff0c;String&#xff0c;hash&#xff0c;list&#xff0c;set和zest但…
阅读更多...
新手卖家做跨境电商，选择Shopee还是亚马逊？

新手卖家做跨境电商，选择Shopee还是亚马逊？

对于刚刚涉足跨境电商领域的新人来说&#xff0c;选择合适的电商平台是迈出成功第一步的关键。目前最主流的跨境平台一定是亚马逊&#xff0c;平台覆盖全球各个市场&#xff0c;利润高&#xff0c;但门槛也高。Shopee主要面向的是东南亚市场&#xff0c;商品一般更有性价比&…
阅读更多...
LabVIEW界面输入值设为默认值

LabVIEW界面输入值设为默认值

在LabVIEW中&#xff0c;将前面板上所有控件的当前输入值设为默认值&#xff0c;可以通过以下步骤实现&#xff1a; 使用控件属性节点&#xff1a;你可以创建一个属性节点来获取所有控件的引用。 右键点击控件&#xff0c;选择“创建” > “属性节点”。 设置属性节点为“D…
阅读更多...
Unity开发绘画板——02.创建项目

Unity开发绘画板——02.创建项目

1.创建Unity工程 我们创建一个名为 DrawingBoard 的工程&#xff0c;然后先把必要的工程目录都创建一下&#xff1a; 主要包含了一下几个文件夹&#xff1a; Scripts &#xff1a;存放我们的代码文件 Scenes &#xff1a;工程默认会创建的&#xff0c;存放场景文件 Shaders &…
阅读更多...
加固与脱壳01 - 环境搭建

加固与脱壳01 - 环境搭建

虚拟机 VMWare 多平台可用&#xff0c;而且可以直接激活&#xff0c;需要先注册一个账号 https://support.broadcom.com/group/ecx/productdownloads?subfamilyVMwareWorkstationPro KALI 类Ubuntu系统&#xff0c;官方提供了 vmware 版本&#xff0c;直接下载就可以使用。…
阅读更多...
关于安卓App自动化测试的一些想法

关于安卓App自动化测试的一些想法

安卓App自动化一般使用PythonAppium。页面元素通常是使用AndroidStudio中的UI Automator Viewer工具来进行页面元素的追踪。但是这里涉及到一个问题就是&#xff0c;安卓apk在每次打包的时候&#xff0c;会进行页面的混淆以及加固&#xff0c;所以导致每次apk打包之后会出现页面…
阅读更多...
[Linux]用户管理指令

[Linux]用户管理指令

开机/重启/登录/注销 进入xhsell 或者虚拟系统中, 右键桌面打开终端, 在终端执行命令, 重启或关机linux系统 建议使用普通账号登录, 如果权限不够时, 使用 su - 用户名 命令切换到超管, 然后再使用 logout命令退回到普通账号, logout 不能在图形界面的终端中使用 用户管理 Li…
阅读更多...
网络信息传输安全

网络信息传输安全

目录 机密性-加密 对称加密 非对称加密 身份认证 摘要算法和数据完整性 数字签名 签名验签 数字证书 申请数字证书所需信息 数字证书的生成 数字证书的应用 https协议 数字证书的申请 数据在网络中传输过程中&#xff0c;怎么做到 数据没有被篡改&#xff1f;hash算…
阅读更多...
基于PHP的新闻管理系统

基于PHP的新闻管理系统

作者&#xff1a;计算机学姐 开发技术&#xff1a;SpringBoot、SSM、Vue、MySQL、JSP、ElementUI、Python、小程序等&#xff0c;“文末源码”。 专栏推荐&#xff1a;前后端分离项目源码、SpringBoot项目源码、SSM项目源码 系统展示 【2025最新】基于phpMySQL的新闻管理系统。…
阅读更多...
[js逆向学习] fastmoss电商网站——店铺排名

[js逆向学习] fastmoss电商网站——店铺排名

逆向目标 网站&#xff1a;https://www.fastmoss.com/shop-marketing/tiktok接口&#xff1a;https://www.fastmoss.com/api/shop/shopList/参数&#xff1a;fm-sign 逆向分析 我们今天要分析的是店铺排名&#xff0c;先分析网络请求&#xff0c;找到目标接口 按照上图操作…
阅读更多...
JUC高并发编程2：Lock接口

JUC高并发编程2：Lock接口

1 synchronized 1.1 synchronized关键字回顾 synchronized 是 Java 中的一个关键字&#xff0c;用于实现线程间的同步。它提供了一种简单而有效的方式来控制对共享资源的访问&#xff0c;从而避免多个线程同时访问同一资源时可能出现的竞态条件&#xff08;race condition&am…
阅读更多...
.net core8 使用JWT鉴权（附当前源码）

.net core8 使用JWT鉴权（附当前源码）

说明 该文章是属于OverallAuth2.0系列文章&#xff0c;每周更新一篇该系列文章&#xff08;从0到1完成系统开发&#xff09;。 该系统文章&#xff0c;我会尽量说的非常详细&#xff0c;做到不管新手、老手都能看懂。 说明&#xff1a;OverallAuth2.0 是一个简单、易懂、功能强…
阅读更多...
LeetcodeTop100 刷题总结（二）

LeetcodeTop100 刷题总结（二）

LeetCode 热题 100&#xff1a;https://leetcode.cn/studyplan/top-100-liked/ 文章目录 八、二叉树94. 二叉树的中序遍历&#xff08;递归与非递归&#xff09;补充&#xff1a;144. 二叉树的前序遍历&#xff08;递归与非递归&#xff09;补充&#xff1a;145. 二叉树的后序遍…
阅读更多...
你的提交信息还在拖后腿？看这里，提升代码质量的绝招！

你的提交信息还在拖后腿？看这里，提升代码质量的绝招！

文章目录 前言一、什么是约定式提交&#xff1f;二、创建新仓库三、将代码推送到远程仓库的步骤1.检查当前远程仓库2.添加代码到暂存区3. 进行约定式提交4. 推送代码到远程仓库5. 完成推送 总结 前言 在当今软件开发领域&#xff0c;Git已经成为最广泛使用的版本控制系统之一。…
阅读更多...
java算法OJ（1）位运算

java算法OJ（1）位运算

目录 1.前言 2.正文 2.1位运算符号 2.1俩数相除 2.1.1题目 2.1.2示例 2.1.3题解 2.2二进制求和 2.2.1题目 2.2.2示例 2.2.3题解 2.3只出现一次的数字 2.3.1题目 2.3.2示例 2.3.3题解 2.4只出现一次的数字&#xff08;进阶版&#xff09; 2.4.1题目 2.4.2示例…
阅读更多...
【ComfyUI】控制光照节点——ComfyUI-IC-Light-Native

【ComfyUI】控制光照节点——ComfyUI-IC-Light-Native

原始代码&#xff08;非comfyui&#xff09;&#xff1a;https://github.com/lllyasviel/IC-Light comfyui实现1&#xff08;600星&#xff09;&#xff1a;https://github.com/kijai/ComfyUI-IC-Light comfyui实现2&#xff08;500星&#xff09;&#xff1a;https://github.c…
阅读更多...
cobbler自动批量安装多版本操作系统

cobbler自动批量安装多版本操作系统

本次虚拟化环境为VMware Workstation Pro&#xff0c;cobbler服务端为CentOS7.9&#xff0c;需要自动安装的版本为CentOS7.9和CentOS8.1 目录 一、安装cobbler服务端1、修改YUM源2、关闭防火墙3、安装软件包4、cobbler环境配置5、解决语法问题6、启动服务7、导入镜像8、自定义…
阅读更多...
Spring自定义参数解析器

Spring自定义参数解析器

在这篇文章中&#xff0c;我们认识了参数解析器和消息转换器&#xff0c;今天我们来自定义一个参数解析器。 自定义参数解析器 实现HandlerMethodArgumentResolver的类&#xff0c;并注册到Spring容器。 Component&#xff0f;&#xff0f;注册到Spring public class UserAr…
阅读更多...
统信服务器操作系统【Cron定时任务服务】

统信服务器操作系统【Cron定时任务服务】

Cron定时任务服务服务介绍、服务管理、服务配置 文章目录 一、功能概述二、功能介绍1. Cron 服务管理2.Cron 服务管理3.Cron 服务配置run-parts一、功能概述 cron是一个可以用来根据时间、日期、月份、星期的组合来 调度对周期性任务执行的守护进程。利用 cron 所提供的功能，可…
阅读更多...
第十四届蓝桥杯嵌入式国赛

第十四届蓝桥杯嵌入式国赛

一. 前言 本篇博客主要讲述十四届蓝桥杯嵌入式的国赛题目&#xff0c;包括STM32CubeMx的相关配置以及相关功能实现代码以及我在做题过程中所遇到的一些问题和总结收获。如果有兴趣的伙伴还可以去做做其它届的真题&#xff0c;可去 蓝桥云课 上搜索历届真题即可。 二. 题目概述 …
阅读更多...
最新文章

Copyright @ 2022~2023