WeihanLi.Common 开源项目教程

1. 项目介绍

WeihanLi.Common 是一个 .NET 常用工具类库，提供了丰富的公共方法、扩展方法和基础类库。该项目旨在帮助开发者更高效地进行 .NET 开发，提供了诸如依赖注入、AOP（面向切面编程）、事件处理、日志记录、数据库扩展等功能。

主要特性

• 依赖注入：类比微软依赖注入框架自定义实现的依赖注入框架。
• AOP 实现：基于动态代理实现的 AOP 框架。
• 事件相关：包括 EventBus、EventQueue、EventStore 等。
• 日志框架：结合 Serilog 和微软日志框架实现的日志框架。
• 数据库扩展：类似 Dapper 的 Ado.Net 扩展。
• TOTP 实现：TOTP 算法实现。

2. 项目快速启动

安装 NuGet 包

首先，通过 NuGet 安装 WeihanLi.Common 包：

dotnet add package WeihanLi.Common

基本使用示例

以下是一个简单的示例，展示如何使用 WeihanLi.Common 进行依赖注入和日志记录。

using WeihanLi.Common;
using WeihanLi.Common.Logging;
using Microsoft.Extensions.DependencyInjection;

class Program
{
    static void Main(string[] args)
    {
        // 初始化依赖注入容器
        var services = new ServiceCollection();
        services.AddWeihanLiCommon();

        // 获取服务提供者
        var serviceProvider = services.BuildServiceProvider();

        // 获取日志记录器
        var logger = serviceProvider.GetRequiredService<ILogger>();

        // 记录日志
        logger.Information("Hello, WeihanLi.Common!");
    }
}

3. 应用案例和最佳实践

应用案例

案例一：使用 AOP 进行日志记录

在实际开发中，我们经常需要在方法调用前后记录日志。使用 WeihanLi.Common 的 AOP 功能可以轻松实现这一点。

using WeihanLi.Common.Aspect;

public class LoggingAspect : IInterceptor
{
    private readonly ILogger _logger;

    public LoggingAspect(ILogger logger)
    {
        _logger = logger;
    }

    public void Intercept(IInvocation invocation)
    {
        _logger.Information($"Before method {invocation.Method.Name}");
        invocation.Proceed();
        _logger.Information($"After method {invocation.Method.Name}");
    }
}

案例二：使用 EventBus 进行事件处理

WeihanLi.Common 提供了 EventBus 功能，可以方便地进行事件发布和订阅。

using WeihanLi.Common.Event;

public class MyEventHandler : IEventHandler<MyEvent>
{
    public Task Handle(MyEvent @event)
    {
        Console.WriteLine($"Event handled: {@event.Message}");
        return Task.CompletedTask;
    }
}

public class MyEvent
{
    public string Message { get; set; }
}

最佳实践

• 依赖注入：尽量使用依赖注入来管理对象的生命周期，避免手动创建对象。
• AOP 使用：合理使用 AOP 功能，避免过度使用导致代码难以维护。
• 日志记录：在关键业务逻辑中添加日志记录，便于问题排查。

4. 典型生态项目

WeihanLi.Common 作为一个基础类库，可以与其他 .NET 生态项目结合使用，提升开发效率。

结合 Serilog 进行日志记录

WeihanLi.Common 提供了与 Serilog 的集成，可以方便地进行日志记录。

using WeihanLi.Common.Logging.Serilog;

services.AddSerilogLogging();

结合 Dapper 进行数据库操作

WeihanLi.Common 提供了类似 Dapper 的 Ado.Net 扩展，可以方便地进行数据库操作。

using WeihanLi.Common.Data;

var connection = new SqlConnection("your_connection_string");
var result = connection.ExecuteScalar<int>("SELECT COUNT(*) FROM YourTable");

通过以上模块的介绍和示例，您可以快速上手 WeihanLi.Common 项目，并将其应用于实际开发中。