如何在ASP.NET Web API中配置Ninject与log4net集成？

Got it, let's get your Ninject-powered ASP.NET Web API set up with logging (info, error, debug levels) using log4net—since the article you referenced uses Unity and MVC, here's a tailored solution for your stack:

Step 1: Install Required NuGet Packages #

First, grab the necessary packages via Package Manager Console or NuGet Package Manager:

Install-Package log4net
Install-Package Ninject.Web.WebApi // Skip if you already have this installed
// Optional: For Elasticsearch integration (matching the article's focus)
Install-Package log4net.Elasticsearch

Step 2: Configure log4net #

Create a new log4net.config file in your project (set its "Copy to Output Directory" property to "Copy if newer") with this base configuration—adjust appenders (console, file, Elasticsearch) as needed:

<?xml version="1.0" encoding="utf-8" ?>
<log4net>
  <!-- Console appender for quick local testing -->
  <appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">
    <layout type="log4net.Layout.PatternLayout">
      <conversionPattern value="%date [%thread] %-5level %logger - %message%newline" />
    </layout>
  </appender>

  <!-- Optional: Elasticsearch appender to push logs to ES -->
  <appender name="ElasticSearchAppender" type="log4net.Appender.ElasticsearchAppender, log4net.Elasticsearch">
    <server>localhost</server>
    <port>9200</port>
    <indexNamePrefix>webapi-logs</indexNamePrefix>
    <indexType>logevent</indexType>
    <bufferSize>100</bufferSize>
    <lossy>false</lossy>
  </appender>

  <root>
    <level value="ALL" /> <!-- Adjust to DEBUG/INFO/ERROR based on your needs -->
    <appender-ref ref="ConsoleAppender" />
    <!-- Uncomment below if using Elasticsearch -->
    <!-- <appender-ref ref="ElasticSearchAppender" /> -->
  </root>
</log4net>

Initialize log4net by adding this line to your AssemblyInfo.cs:

[assembly: log4net.Config.XmlConfigurator(ConfigFile = "log4net.config", Watch = true)]

Step 3: Create a Logger Interface (For Decoupling) #

Define an ILogger interface to keep your code independent of log4net (makes testing easier):

public interface ILogger
{
    void Info(string message);
    void Error(string message, Exception exception = null);
    void Debug(string message);
}

Step 4: Implement the Logger with log4net #

Create a concrete implementation that wraps log4net's logging logic:

public class Log4NetLogger : ILogger
{
    private readonly log4net.ILog _internalLogger;

    public Log4NetLogger(Type loggerType)
    {
        _internalLogger = log4net.LogManager.GetLogger(loggerType);
    }

    public void Info(string message) => _internalLogger.Info(message);

    public void Error(string message, Exception exception = null)
    {
        if (exception != null)
            _internalLogger.Error(message, exception);
        else
            _internalLogger.Error(message);
    }

    public void Debug(string message) => _internalLogger.Debug(message);
}

Step 5: Bind the Logger in Ninject #

Update your Ninject module to bind ILogger to Log4NetLogger—we'll use a method binding to inject the correct logger type for each controller/service:

public class WebApiNinjectModule : NinjectModule
{
    public override void Load()
    {
        // Bind ILogger to Log4NetLogger, passing the declaring type of the injected target
        Bind<ILogger>().ToMethod(context => 
            new Log4NetLogger(context.Request.Target.Member.DeclaringType));
    }
}

Step 6: Use the Logger in Your Controllers #

Inject ILogger into your controllers via constructor injection, then log as needed—replacing your existing error handling with logged errors:

public class ProductsController : ApiController
{
    private readonly ILogger _logger;

    // Constructor injection of ILogger
    public ProductsController(ILogger logger)
    {
        _logger = logger;
    }

    public IHttpActionResult Get(int id)
    {
        _logger.Info($"Processing GET request for Product ID: {id}");
        
        try
        {
            // Your existing business logic here
            var product = FetchProductFromDatabase(id);
            
            if (product == null)
            {
                _logger.Debug($"Product with ID {id} not found");
                return NotFound();
            }

            _logger.Debug($"Successfully retrieved Product ID: {id}");
            return Ok(product);
        }
        catch (Exception ex)
        {
            _logger.Error($"Failed to process GET request for Product ID: {id}", ex);
            return BadRequest("An error occurred while processing your request.");
        }
    }
}

Step 7: Add Global Exception Logging (Optional but Recommended) #

Catch unhandled exceptions across your API with a custom exception filter. First, create the filter:

public class GlobalLoggingExceptionFilter : ExceptionFilterAttribute
{
    private readonly ILogger _logger;

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

    public override void OnException(HttpActionExecutedContext context)
    {
        _logger.Error("Unhandled Web API Exception", context.Exception);
        base.OnException(context);
    }
}

Then register it globally in WebApiConfig.cs:

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // Your existing route configuration here
        
        // Add the global logging filter
        config.Filters.Add(new GlobalLoggingExceptionFilter(
            config.DependencyResolver.GetService<ILogger>()));
    }
}

That's it! Now your API will log info, debug, and error messages using log4net, integrated smoothly with Ninject. You can adjust the log levels, appenders, and logging logic to fit your exact needs.

内容的提问来源于stack exchange，提问作者Subrato M