swagger常用配置+log4net实现txt文本日志记录

最新推荐文章于 2024-09-06 16:44:19 发布

�十一。

最新推荐文章于 2024-09-06 16:44:19 发布

阅读量275

点赞数 1

CC 4.0 BY-SA版权

文章标签： c# .netcore

本文链接：https://blog.csdn.net/qq_50449072/article/details/132811100

博客介绍了两项信息技术内容，一是在swagger文档中显示备注信息，需修改Program.cs配置；二是用log4net实现txt文本日志记录，包括创建文件夹、新建配置文件、增加配置项和添加日志信息等步骤，可实现swagger常用配置与日志记录。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

swagger文档中显示备注信息

修改Program.cs的配置

builder.Services.AddSwaggerGen(option =>
{
option.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo()
{
    Title = $"系统后端API接口文档",
    Version = "v1",
    Description = $"Core API版本v1"
});

var file = Path.Combine(AppContext.BaseDirectory, "WebApi.xml");//项目名.xml

option.IncludeXmlComments(file, true);

log4net实现txt文本日志记录

1.创建新文件夹CfgFile

2.新建XML配置文件为 log4net.Config

<?xml version="1.0" encoding="utf-8" ?>
<log4net>
	<!-- Define some output appenders -->
	<appender name="rollingAppender" type="log4net.Appender.RollingFileAppender">
		<file value="log4\log.txt" />

		<!--追加日志内容-->
		<appendToFile value="true" />

		<!--防止多线程时不能写Log,官方说线程非安全-->
		<lockingModel type="log4net.Appender.FileAppender+MinimalLock" />

		<!--可以为:Once|Size|Date|Composite-->
		<!--Composite为Size和Date的组合-->
		<rollingStyle value="Composite" />

		<!--当备份文件时,为文件名加的后缀,这里可以作为每一天的日志分别存储不同的文件-->
		<datePattern value="yyyyMMdd&quot;.txt&quot;" />
		<StaticLogFileName value="false"/>

		<!--日志最大个数,都是最新的-->
		<!--rollingStyle节点为Size时,只能有value个日志-->
		<!--rollingStyle节点为Composite时,每天有value个日志-->
		<maxSizeRollBackups value="20" />

		<!--可用的单位:KB|MB|GB-->
		<maximumFileSize value="3MB" />

		<!--置为true,当前最新日志文件名永远为file节中的名字-->
		<staticLogFileName value="true" />

		<!--输出级别在INFO和ERROR之间的日志-->
		<filter type="log4net.Filter.LevelRangeFilter">
			<param name="LevelMin" value="ALL" />
			<param name="LevelMax" value="FATAL" />
		</filter>

		<layout type="log4net.Layout.PatternLayout">
			<!--日志输出格式：时间  日志类型  日志内容-->
			<conversionPattern value="%date [%thread] %-5level %logger - %message%newline"/>
		</layout>
	</appender>

	<!-- levels: OFF > FATAL > ERROR > WARN > INFO > DEBUG  > ALL -->
	<root>
		<priority value="ALL"/>
		<level value="ALL"/>
		<appender-ref ref="rollingAppender" />
	</root>
</log4net>

3.增加Program.cs的配置项

//nuget引入：log4net
builder.Logging.AddLog4Net("CfgFile/log4net.Config");

4.添加日志信息

//默认读取App.config中的配置
XmlConfigurator.Configure();
//创建log对象
ILog ilog = LogManager.GetLogger(typeof(Program));
//打印日志
ilog.Debug("我打出了Log4Net日志！");

以上步骤就可以实现swagger常用配置+log4net实现txt文本日志记录。谢谢能对各位有所帮助！