在軟件設(shè)計(jì)中日志模塊是必不可少的一部分，可以幫助開發(fā)人員更好的了解程序的運(yùn)行情況，提高軟件的可靠性，安全性和性能，日志通常能幫我們解決如下問題：
(資料圖片僅供參考)
.net6有自帶的logging組件，還有很多優(yōu)秀的開源log組件，如NLog，serilog，這里我們使用serilog組件來構(gòu)建日志模塊。
新建.net6，asp net web api項(xiàng)目之后，為其添加如下四個(gè)包
dotnet add package Serilog.AspNetCore//核心包dotnet add package Serilog.Formatting.Compactdotnet add Serilog.Sinks.File//提供記錄到文件dotnet add Serilog.Sinks.MSSqlServer//提供記錄到sqlserver2.新建SeriLogExtend擴(kuò)展類型，配置日志格式并注入
public static class SeriLogExtend { public static void AddSerilLog(this ConfigureHostBuilder configureHostBuilder) { //輸出模板 string outputTemplate = "{NewLine}【{Level:u3}】{Timestamp:yyyy-MM-dd HH:mm:ss.fff}" + "{NewLine}#Msg#{Message:lj}" + "{NewLine}#Pro #{Properties:j}" + "{NewLine}#Exc#{Exception}" + new string("-", 50); // 配置Serilog Log.Logger = new LoggerConfiguration() .MinimumLevel.Override("Microsoft", LogEventLevel.Warning) // 排除Microsoft的日志 .Enrich.FromLogContext() // 注冊(cè)日志上下文 .WriteTo.Console(outputTemplate: outputTemplate) // 輸出到控制臺(tái) .WriteTo.MSSqlServer("Server=.;Database=testdb;User ID=sa;Password=123;TrustServerCertificate=true", sinkOptions: GetSqlServerSinkOptions(), columnOptions: GetColumnOptions()) .WriteTo.Logger(configure => configure // 輸出到文件 .MinimumLevel.Debug() .WriteTo.File( //單個(gè)日志文件，總?cè)罩荆腥罩敬娴竭@里面 $"logs\\log.txt", rollingInterval: RollingInterval.Day, outputTemplate: outputTemplate) .WriteTo.File( //每天生成一個(gè)新的日志，按天來存日志 "logs\\{Date}-log.txt", //定輸出到滾動(dòng)日志文件中，每天會(huì)創(chuàng)建一個(gè)新的日志，按天來存日志 retainedFileCountLimit: 7, outputTemplate: outputTemplate )) .CreateLogger(); configureHostBuilder.UseSerilog(Log.Logger); // 注冊(cè)serilog /// /// 設(shè)置日志sqlserver配置 /// /// /// 設(shè)置日志sqlserver 列配置 /// /// (); columlist.Add(new SqlColumn("RequestJson", SqlDbType.NVarChar, true, 2000));//添加一列，用于記錄請(qǐng)求參數(shù)string columlist.Add(new SqlColumn("ResponseJson", SqlDbType.NVarChar, true, 2000));//添加一列，用于記錄響應(yīng)數(shù)據(jù) customColumnOptions.AdditionalColumns = columlist; return customColumnOptions; } } } 然后再program.cs中調(diào)用這個(gè)擴(kuò)展方法
var builder = WebApplication.CreateBuilder(args);// Add services to the container.builder.Services.AddControllers(options =>{ options.Filters.Add(typeof(RequestLoggingFilter));});// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbucklebuilder.Services.AddEndpointsApiExplorer();builder.Services.AddSwaggerGen();builder.Host.AddSerilLog();var app = builder.Build();// Configure the HTTP request pipeline.if (app.Environment.IsDevelopment()){ app.UseSwagger(); app.UseSwaggerUI();}app.UseHttpsRedirection();app.UseAuthorization();app.MapControllers();app.Run();這里我設(shè)計(jì)的日志信息只包括了
Message：日志信息Level：等級(jí)TimeStamp：記錄日志時(shí)間Exception：異常信息RequestJson：請(qǐng)求參數(shù)jsonResponseJson：響應(yīng)結(jié)果json其中前面四種為日志默認(rèn)，后兩種為我主動(dòng)添加，在實(shí)際的設(shè)計(jì)中還有可能有不同的信息，如：
IP：請(qǐng)求日志Action：請(qǐng)求方法Token：請(qǐng)求tokenUser：請(qǐng)求的用戶日志的設(shè)計(jì)應(yīng)該根據(jù)實(shí)際的情況而來，其應(yīng)做到足夠詳盡，能幫助開發(fā)者定位，解決問題，而又不能過于重復(fù)臃腫，白白占用系統(tǒng)空間，我這邊的示例僅供大家參考
3.添加RequestLoggingFilter過濾器，用以記錄每次請(qǐng)求的日志public class RequestLoggingFilter : IActionFilter { private readonly Serilog.ILogger _logger;//注入serilog private Stopwatch _stopwatch;//統(tǒng)計(jì)程序耗時(shí) public RequestLoggingFilter(Serilog.ILogger logger) { _logger = logger; _stopwatch = Stopwatch.StartNew(); } public void OnActionExecuted(ActionExecutedContext context) { _stopwatch.Stop(); var request = context.HttpContext.Request; var response = context.HttpContext.Response; _logger .ForContext("RequestJson",request.QueryString)//請(qǐng)求字符串 .ForContext("ResponseJson", JsonConvert.SerializeObject(context.Result))//響應(yīng)數(shù)據(jù)json .Information("Request {Method} {Path} responded {StatusCode} in {Elapsed:0.0000} ms",//message request.Method, request.Path, response.StatusCode, _stopwatch.Elapsed.TotalMilliseconds); } public void OnActionExecuting(ActionExecutingContext context) { } }在program.cs中將該過濾器添加進(jìn)所有控制器之中
builder.Services.AddControllers(options =>{ options.Filters.Add(typeof(RequestLoggingFilter));});// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbucklebuilder.Services.AddEndpointsApiExplorer();builder.Services.AddSwaggerGen();builder.Host.AddSerilLog();var app = builder.Build();// Configure the HTTP request pipeline.if (app.Environment.IsDevelopment()){ app.UseSwagger(); app.UseSwaggerUI();}app.UseHttpsRedirection();app.UseAuthorization();app.MapControllers();app.Run();測(cè)試效果在控制器添加一個(gè)測(cè)試方法并將其調(diào)用一次
[HttpGet]public dynamic Get123(string model){ return new { name = "123", id = 2 };}控制臺(tái)輸出
數(shù)據(jù)庫記錄
項(xiàng)目根目錄下logs文件夾中日志文件記錄
