Skip to content

Commit 4b66550

Browse files
AlianBlankAlianBlank
committed
style: 统一代码格式和风格
- Directory.Build.props: 统一缩进为4空格 - Logger 模块: 移除不必要的括号，添加 private 修饰符 - 使用 target-typed new 表达式简化代码 - README 文档表格格式统一
1 parent 92004cd commit 4b66550

8 files changed

Lines changed: 95 additions & 94 deletions

File tree

‎Directory.Build.props‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
11
<Project>
2-
<PropertyGroup>
3-
<!-- 多目标框架支持: net8.0, net9.0，net10.0 -->
4-
<TargetFrameworks>net8.0;net9.0;net10.0;</TargetFrameworks>
2+
<PropertyGroup>
3+
<!-- 多目标框架支持: net8.0, net9.0，net10.0 -->
4+
<TargetFrameworks>net8.0;net9.0;net10.0;</TargetFrameworks>
55

6-
<!-- 语言版本配置 -->
7-
<LangVersion>12.0</LangVersion>
8-
<ImplicitUsings>enable</ImplicitUsings>
9-
<Nullable>disable</Nullable>
6+
<!-- 语言版本配置 -->
7+
<LangVersion>12.0</LangVersion>
8+
<ImplicitUsings>enable</ImplicitUsings>
9+
<Nullable>disable</Nullable>
1010

11-
<!-- 程序集签名配置 -->
12-
<PublicSign>true</PublicSign>
13-
<SignAssembly>true</SignAssembly>
14-
<PackageId>$(AssemblyName)</PackageId>
11+
<!-- 程序集签名配置 -->
12+
<PublicSign>true</PublicSign>
13+
<SignAssembly>true</SignAssembly>
14+
<PackageId>$(AssemblyName)</PackageId>
1515

16-
<!-- NuGet 包配置 -->
17-
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
18-
<GenerateDocumentationFile>true</GenerateDocumentationFile>
19-
<IncludeSymbols>true</IncludeSymbols>
20-
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
21-
<PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
16+
<!-- NuGet 包配置 -->
17+
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
18+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
19+
<IncludeSymbols>true</IncludeSymbols>
20+
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
21+
<PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
2222

23-
<!-- 通用元数据 -->
24-
<Title>$(AssemblyName)</Title>
25-
<Copyright>AlianBlank;GameFrameX;Blank</Copyright>
26-
<PackageProjectUrl>https://github.com/GameFrameX/GameFrameX.Foundation</PackageProjectUrl>
27-
<RepositoryUrl>https://github.com/GameFrameX/GameFrameX.Foundation</RepositoryUrl>
28-
<RepositoryType>git</RepositoryType>
29-
<PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
30-
<PackageReleaseNotes>https://gameframex.doc.alianblank.com/</PackageReleaseNotes>
31-
<PackageIcon>logo.png</PackageIcon>
32-
<Authors>AlianBlank;GameFrameX;Blank</Authors>
33-
<PackageReadmeFile>README.md</PackageReadmeFile>
23+
<!-- 通用元数据 -->
24+
<Title>$(AssemblyName)</Title>
25+
<Copyright>AlianBlank;GameFrameX;Blank</Copyright>
26+
<PackageProjectUrl>https://github.com/GameFrameX/GameFrameX.Foundation</PackageProjectUrl>
27+
<RepositoryUrl>https://github.com/GameFrameX/GameFrameX.Foundation</RepositoryUrl>
28+
<RepositoryType>git</RepositoryType>
29+
<PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
30+
<PackageReleaseNotes>https://gameframex.doc.alianblank.com/</PackageReleaseNotes>
31+
<PackageIcon>logo.png</PackageIcon>
32+
<Authors>AlianBlank;GameFrameX;Blank</Authors>
33+
<PackageReadmeFile>README.md</PackageReadmeFile>
3434

35-
<!-- MSBuild 配置 -->
36-
<GenerateAssemblyInfo>true</GenerateAssemblyInfo>
37-
<TreatWarningsAsErrors>false</TreatWarningsAsErrors>
38-
</PropertyGroup>
35+
<!-- MSBuild 配置 -->
36+
<GenerateAssemblyInfo>true</GenerateAssemblyInfo>
37+
<TreatWarningsAsErrors>false</TreatWarningsAsErrors>
38+
</PropertyGroup>
3939
</Project>

‎GameFrameX.Foundation.Logger/LogConsole.cs‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ public void SetFrameLength(int length)
126126
public void ShowMaxTitle(string title, string title2 = "", string title3 = "")
127127
{
128128
// 生成顶部边框字符串，长度为框架宽度减去左右边框字符
129-
string character = '═'.RepeatChar(_frameLength - 2);
129+
var character = '═'.RepeatChar(_frameLength - 2);
130130
Console.WriteLine($"╔{character}╗");
131131
WriteTitle(title);
132132

@@ -181,7 +181,7 @@ private void WriteTitle(string title)
181181
}
182182

183183
remaining /= 2;
184-
string padding = ' '.RepeatChar(remaining);
184+
var padding = ' '.RepeatChar(remaining);
185185
Console.WriteLine($"║{padding}{title}{padding}║");
186186
}
187187

@@ -216,12 +216,12 @@ public void ShowOption(string title, object content)
216216
ArgumentNullException.ThrowIfNull(title, nameof(title));
217217
ArgumentNullException.ThrowIfNull(content, nameof(content));
218218
// 计算标题的显示宽度并生成居中的顶部边框
219-
int stringWidth = title.GetDisplayWidth();
220-
int remaining = _frameLength - stringWidth - 2;
219+
var stringWidth = title.GetDisplayWidth();
220+
var remaining = _frameLength - stringWidth - 2;
221221
remaining /= 2;
222-
string padding = '═'.RepeatChar(remaining);
222+
var padding = '═'.RepeatChar(remaining);
223223
// 生成底部边框，使用完整的等号字符填充
224-
string character = '═'.RepeatChar(_frameLength - 2);
224+
var character = '═'.RepeatChar(_frameLength - 2);
225225
Console.WriteLine($"╔{padding}{title}{padding}╗");
226226
Console.WriteLine(content);
227227
Console.WriteLine($"╚{character}╝");
@@ -280,7 +280,7 @@ public void ShowLineTitle(string title = "")
280280
remaining /= 2;
281281
var padding = '═'.RepeatChar(remaining);
282282
// 输出居中的分隔线，标题两侧用等号字符填充
283-
Console.WriteLine((padding + title + padding));
283+
Console.WriteLine(padding + title + padding);
284284
}
285285

286286
// 添加空行以便与后续内容分隔

‎GameFrameX.Foundation.Logger/LogHandler.cs‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -84,22 +84,22 @@ public static LoggerConfiguration CreateLoggerConfiguration()
8484
/// <summary>
8585
/// 控制台输出模板，用于格式化控制台日志输出。
8686
/// </summary>
87-
const string ConsoleOutputTemplate = "[{Timestamp:HH:mm:ss} {Level:u3}][{LogType}]{Message:lj}{NewLine}{Exception}";
87+
private const string ConsoleOutputTemplate = "[{Timestamp:HH:mm:ss} {Level:u3}][{LogType}]{Message:lj}{NewLine}{Exception}";
8888

8989
/// <summary>
9090
/// 控制台输出模板，用于格式化控制台日志输出，包含标签名称。
9191
/// </summary>
92-
const string ConsoleOutputTagNameTemplate = "[{Timestamp:HH:mm:ss} {Level:u3}][{LogType}-{TagName}]{Message:lj}{NewLine}{Exception}";
92+
private const string ConsoleOutputTagNameTemplate = "[{Timestamp:HH:mm:ss} {Level:u3}][{LogType}-{TagName}]{Message:lj}{NewLine}{Exception}";
9393

9494
/// <summary>
9595
/// 文件输出模板，用于格式化文件日志输出。
9696
/// </summary>
97-
const string FileOutputTemplate = "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}][{LogType}]{Message:lj}{NewLine}{Exception}";
97+
private const string FileOutputTemplate = "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}][{LogType}]{Message:lj}{NewLine}{Exception}";
9898

9999
/// <summary>
100100
/// 文件输出模板，用于格式化文件日志输出，包含标签名称。
101101
/// </summary>
102-
const string FileOutputTagNameTemplate = "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}][{LogType}-{TagName}]{Message:lj}{NewLine}{Exception}";
102+
private const string FileOutputTagNameTemplate = "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}][{LogType}-{TagName}]{Message:lj}{NewLine}{Exception}";
103103

104104
/// <summary>
105105
/// 启动并配置日志系统。
@@ -210,7 +210,7 @@ public static ILogger Create(LogOptions logOptions, bool isDefault = true, Actio
210210
lokiGzipHttpClient.SetCredentials(lokiCredentials);
211211
lokiGzipHttpClient.SetTenant(null);
212212
// 根据源码的实际参数配置 GrafanaLoki
213-
logger.WriteTo.GrafanaLoki(uri: logOptions.GrafanaLokiUrl, grafanaLokiLabels, null, lokiCredentials, null, LogEventLevel.Verbose, 1000, null, TimeSpan.FromSeconds(2), null, lokiGzipHttpClient);
213+
logger.WriteTo.GrafanaLoki(logOptions.GrafanaLokiUrl, grafanaLokiLabels, null, lokiCredentials, null, LogEventLevel.Verbose, 1000, null, TimeSpan.FromSeconds(2), null, lokiGzipHttpClient);
214214
}
215215
else
216216
{
@@ -219,8 +219,8 @@ public static ILogger Create(LogOptions logOptions, bool isDefault = true, Actio
219219
}
220220

221221
configurationAction?.Invoke(logger);
222-
string consoleOutputTemplate = ConsoleOutputTemplate;
223-
string fileOutputTemplate = FileOutputTemplate;
222+
var consoleOutputTemplate = ConsoleOutputTemplate;
223+
var fileOutputTemplate = FileOutputTemplate;
224224
if (logOptions.LogTagName.IsNotNullOrEmptyOrWhiteSpace())
225225
{
226226
consoleOutputTemplate = ConsoleOutputTagNameTemplate;
@@ -230,8 +230,8 @@ public static ILogger Create(LogOptions logOptions, bool isDefault = true, Actio
230230
if (logOptions.IsWriteToMongoDb)
231231
{
232232
logger.WriteTo.MongoDBBson(
233-
databaseUrl: logOptions.MongoDbDatabaseUrl,
234-
collectionName: logOptions.LogSavePath,
233+
logOptions.MongoDbDatabaseUrl,
234+
logOptions.LogSavePath,
235235
cappedMaxSizeMb: logOptions.MongoDbCappedMaxSizeMb,
236236
cappedMaxDocuments: logOptions.MongoDbCappedMaxDocuments,
237237
rollingInterval: (Serilog.Sinks.MongoDB.RollingInterval)logOptions.RollingInterval,

‎GameFrameX.Foundation.Logger/LogHelper.Error.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,7 @@ public static void Error(ILogger logger, string tag, Exception exception)
456456
public static void Error(string tag, string message, params object[] args)
457457
{
458458
var st = new StackTrace(1, true);
459-
var newMessage = ($"[{tag}] {string.Format(message, args)}\n{st}");
459+
var newMessage = $"[{tag}] {string.Format(message, args)}\n{st}";
460460

461461
GetLogger().Error(newMessage);
462462
}
@@ -473,7 +473,7 @@ public static void Error(ILogger logger, string tag, string message, params obje
473473
{
474474
ArgumentNullException.ThrowIfNull(logger);
475475
var st = new StackTrace(1, true);
476-
var newMessage = ($"[{tag}] {string.Format(message, args)}\n{st}");
476+
var newMessage = $"[{tag}] {string.Format(message, args)}\n{st}";
477477
logger.Error(newMessage);
478478
}
479479

‎GameFrameX.Foundation.Logger/LogHelper.Fatal.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public static partial class LogHelper
4747
/// </remarks>
4848
public static void Fatal(string message)
4949
{
50-
var newMessage = ($"{message}\n{new StackTrace(1, true)}");
50+
var newMessage = $"{message}\n{new StackTrace(1, true)}";
5151

5252
GetLogger().Fatal(newMessage);
5353
}
@@ -175,7 +175,7 @@ public static void Fatal(Exception exception, string messageTemplate, params obj
175175
public static void Fatal(ILogger logger, string message)
176176
{
177177
ArgumentNullException.ThrowIfNull(logger);
178-
var newMessage = ($"{message}\n{new StackTrace(1, true)}");
178+
var newMessage = $"{message}\n{new StackTrace(1, true)}";
179179
logger.Fatal(newMessage);
180180
}
181181

@@ -338,7 +338,7 @@ public static void Fatal(ILogger logger, Exception exception, string messageTemp
338338
/// </remarks>
339339
public static void Fatal(Exception exception)
340340
{
341-
var newMessage = ($"{exception}\n{new StackTrace(1, true)}");
341+
var newMessage = $"{exception}\n{new StackTrace(1, true)}";
342342

343343
GetLogger().Fatal(newMessage);
344344
}
@@ -352,7 +352,7 @@ public static void Fatal(Exception exception)
352352
public static void Fatal(ILogger logger, Exception exception)
353353
{
354354
ArgumentNullException.ThrowIfNull(logger);
355-
var newMessage = ($"{exception}\n{new StackTrace(1, true)}");
355+
var newMessage = $"{exception}\n{new StackTrace(1, true)}";
356356
logger.Fatal(newMessage);
357357
}
358358

‎GameFrameX.Foundation.Logger/LogOptions.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ public LogOptions(string logPathName = "logs")
6565
/// <remarks>
6666
/// 使用此静态实例可以快速获取一个包含默认设置的日志配置对象。
6767
/// </remarks>
68-
public static readonly LogOptions Default = new LogOptions();
68+
public static readonly LogOptions Default = new();
6969

7070
/// <summary>
7171
/// 是否写入文件，默认为 true。
@@ -164,12 +164,12 @@ public LogOptions(string logPathName = "logs")
164164
/// <summary>
165165
/// GrafanaLoki 标签
166166
/// </summary>
167-
public Dictionary<string, string> GrafanaLokiLabels { get; set; } = new Dictionary<string, string>();
167+
public Dictionary<string, string> GrafanaLokiLabels { get; set; } = new();
168168

169169
/// <summary>
170170
/// GrafanaLoki 其他属性
171171
/// </summary>
172-
public Dictionary<string, string> GrafanaLokiProperty { get; set; } = new Dictionary<string, string>();
172+
public Dictionary<string, string> GrafanaLokiProperty { get; set; } = new();
173173

174174
/// <summary>
175175
/// GrafanaLoki 用户名

‎GameFrameX.Foundation.Logger/README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -373,18 +373,18 @@ var logOptions = Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT") ==
373373
### 常见问题
374374

375375
1. **日志文件未创建**
376-
- 检查日志目录权限
377-
- 确认LogSavePath路径正确
378-
- 查看控制台是否有Serilog自诊断信息
376+
- 检查日志目录权限
377+
- 确认LogSavePath路径正确
378+
- 查看控制台是否有Serilog自诊断信息
379379

380380
2. **日志级别过滤不生效**
381-
- 确认LogEventLevel设置正确
382-
- 检查是否有多个Logger实例冲突
381+
- 确认LogEventLevel设置正确
382+
- 检查是否有多个Logger实例冲突
383383

384384
3. **Grafana Loki连接失败**
385-
- 验证GrafanaLokiUrl地址和端口
386-
- 检查网络连接和防火墙设置
387-
- 确认用户名密码正确
385+
- 验证GrafanaLokiUrl地址和端口
386+
- 检查网络连接和防火墙设置
387+
- 确认用户名密码正确
388388

389389
### 调试信息
390390

0 commit comments

Comments
 (0)