web-dev-qa-db-ja.com

静的ファクトリクラスからASP.NET Core DIコンテナーにアクセスする

James Stillのブログ記事 Real-World PubSub Messaging with RabbitMQ に基づいたRabbitMQサブスクライバーを持つASP.NET Core MVC/WebApiサイトを作成しました。

彼の記事では、静的クラスを使用してキューサブスクライバーを開始し、キューイベントのイベントハンドラーを定義しています。この静的メソッドは、静的ファクトリクラスを介してイベントハンドラクラスをインスタンス化します。

using RabbitMQ.Client;
using RabbitMQ.Client.Events;
using System;
using System.Text;

namespace NST.Web.MessageProcessing
{
    public static class MessageListener
    {
        private static IConnection _connection;
        private static IModel _channel;

        public static void Start(string hostName, string userName, string password, int port)
        {
            var factory = new ConnectionFactory
            {
                HostName = hostName,
                Port = port,
                UserName = userName,
                Password = password,
                VirtualHost = "/",
                AutomaticRecoveryEnabled = true,
                NetworkRecoveryInterval = TimeSpan.FromSeconds(15)
            };

            _connection = factory.CreateConnection();
            _channel = _connection.CreateModel();
            _channel.ExchangeDeclare(exchange: "myExchange", type: "direct", durable: true);

            var queueName = "myQueue";

            QueueDeclareOk ok = _channel.QueueDeclare(queueName, true, false, false, null);

            _channel.QueueBind(queue: queueName, exchange: "myExchange", routingKey: "myRoutingKey");

            var consumer = new EventingBasicConsumer(_channel);
            consumer.Received += ConsumerOnReceived;

            _channel.BasicConsume(queue: queueName, noAck: false, consumer: consumer);

        }

        public static void Stop()
        {
            _channel.Close(200, "Goodbye");
            _connection.Close();
        }

        private static void ConsumerOnReceived(object sender, BasicDeliverEventArgs ea)
        {
            // get the details from the event
            var body = ea.Body;
            var message = Encoding.UTF8.GetString(body);
            var messageType = "endpoint";  // hardcoding the message type while we dev...

            // instantiate the appropriate handler based on the message type
            IMessageProcessor processor = MessageHandlerFactory.Create(messageType);
            processor.Process(message);

            // Ack the event on the queue
            IBasicConsumer consumer = (IBasicConsumer)sender;
            consumer.Model.BasicAck(ea.DeliveryTag, false);
        }

    }
}

コンソールに書き込むだけでなく、メッセージプロセッサフ​​ァクトリでサービスを解決する必要がある時点まで、これは非常に機能します。

using NST.Web.Services;
using System;

namespace NST.Web.MessageProcessing
{
    public static class MessageHandlerFactory
    {
        public static IMessageProcessor Create(string messageType)
        {
            switch (messageType.ToLower())
            {
                case "ipset":
                    // need to resolve IIpSetService here...
                    IIpSetService ipService = ???????

                    return new IpSetMessageProcessor(ipService);

                case "endpoint":
                    // need to resolve IEndpointService here...
                    IEndpointService epService = ???????

                    // create new message processor
                    return new EndpointMessageProcessor(epService);

                default:
                    throw new Exception("Unknown message type");
            }
        }
    }
}

ASP.NET Core IoCコンテナーにアクセスして依存関係を解決する方法はありますか？依存関係のスタック全体を手動でスピンアップする必要は本当にありません:(

または、ASP.NET CoreアプリケーションからRabbitMQを購読するより良い方法はありますか？ RestBus が見つかりましたが、Core 1.x用に更新されていません

c#asp.net-coredependency-injectionrabbitmqservice-locator
27
Nick

静的クラスを回避し、次の方法と組み合わせてずっと依存性注入を使用できます。

  • IApplicationLifetime を使用して、アプリケーションが開始/停止するたびにリスナーを開始/停止します。
  • IServiceProviderを使用して、メッセージプロセッサのインスタンスを作成します。

最初に、appsettings.jsonから生成できる独自のクラスに構成を移動しましょう。

public class RabbitOptions
{
    public string HostName { get; set; }
    public string UserName { get; set; }
    public string Password { get; set; }
    public int Port { get; set; }
}

// In appsettings.json:
{
  "Rabbit": {
    "hostName": "192.168.99.100",
    "username": "guest",
    "password": "guest",
    "port": 5672
  }
}

次に、MessageHandlerFactoryを依存関係としてIServiceProviderを受け取る非静的クラスに変換します。サービスプロバイダーを使用して、メッセージプロセッサインスタンスを解決します。

public class MessageHandlerFactory
{
    private readonly IServiceProvider services;
    public MessageHandlerFactory(IServiceProvider services)
    {
        this.services = services;
    }

    public IMessageProcessor Create(string messageType)
    {
        switch (messageType.ToLower())
        {
            case "ipset":
                return services.GetService<IpSetMessageProcessor>();                
            case "endpoint":
                return services.GetService<EndpointMessageProcessor>();
            default:
                throw new Exception("Unknown message type");
        }
    }
}

このようにして、メッセージプロセッサクラスはコンストラクタで必要な依存関係を受け取ることができます（Startup.ConfigureServicesで設定する限り）。たとえば、サンプルプロセッサの1つにILoggerを注入しています。

public class IpSetMessageProcessor : IMessageProcessor
{
    private ILogger<IpSetMessageProcessor> logger;
    public IpSetMessageProcessor(ILogger<IpSetMessageProcessor> logger)
    {
        this.logger = logger;
    }

    public void Process(string message)
    {
        logger.LogInformation("Received message: {0}", message);
    }
}

MessageListenerをIOptions<RabbitOptions>およびMessageHandlerFactoryに依存する非静的クラスに変換します。元のクラスと非常によく似ています。Startメソッドのパラメーターをオプションに置き換えただけです依存関係とハンドラファクトリは、静的クラスではなく依存関係になりました。

public class MessageListener
{
    private readonly RabbitOptions opts;
    private readonly MessageHandlerFactory handlerFactory;
    private IConnection _connection;
    private IModel _channel;

    public MessageListener(IOptions<RabbitOptions> opts, MessageHandlerFactory handlerFactory)
    {
        this.opts = opts.Value;
        this.handlerFactory = handlerFactory;
    }

    public void Start()
    {
        var factory = new ConnectionFactory
        {
            HostName = opts.HostName,
            Port = opts.Port,
            UserName = opts.UserName,
            Password = opts.Password,
            VirtualHost = "/",
            AutomaticRecoveryEnabled = true,
            NetworkRecoveryInterval = TimeSpan.FromSeconds(15)
        };

        _connection = factory.CreateConnection();
        _channel = _connection.CreateModel();
        _channel.ExchangeDeclare(exchange: "myExchange", type: "direct", durable: true);

        var queueName = "myQueue";

        QueueDeclareOk ok = _channel.QueueDeclare(queueName, true, false, false, null);

        _channel.QueueBind(queue: queueName, exchange: "myExchange", routingKey: "myRoutingKey");

        var consumer = new EventingBasicConsumer(_channel);
        consumer.Received += ConsumerOnReceived;

        _channel.BasicConsume(queue: queueName, noAck: false, consumer: consumer);

    }

    public void Stop()
    {
        _channel.Close(200, "Goodbye");
        _connection.Close();
    }

    private void ConsumerOnReceived(object sender, BasicDeliverEventArgs ea)
    {
        // get the details from the event
        var body = ea.Body;
        var message = Encoding.UTF8.GetString(body);
        var messageType = "endpoint";  // hardcoding the message type while we dev...
        //var messageType = Encoding.UTF8.GetString(ea.BasicProperties.Headers["message-type"] as byte[]);

        // instantiate the appropriate handler based on the message type
        IMessageProcessor processor = handlerFactory.Create(messageType);
        processor.Process(message);

        // Ack the event on the queue
        IBasicConsumer consumer = (IBasicConsumer)sender;
        consumer.Model.BasicAck(ea.DeliveryTag, false);
    }
}

ほぼそこに、Startup.ConfigureServicesメソッドを更新して、サービスとオプションがわかるようにする必要があります（必要に応じて、リスナーとハンドラーファクトリのインターフェイスを作成できます）。

public void ConfigureServices(IServiceCollection services)
{            
    // ...

    // Add RabbitMQ services
    services.Configure<RabbitOptions>(Configuration.GetSection("rabbit"));
    services.AddTransient<MessageListener>();
    services.AddTransient<MessageHandlerFactory>();
    services.AddTransient<IpSetMessageProcessor>();
    services.AddTransient<EndpointMessageProcessor>();
}

最後に、Startup.Configureメソッドを更新して、追加のIApplicationLifetimeパラメーターを取得し、ApplicationStarted/ApplicationStoppedイベントでメッセージリスナーを開始/停止します（しばらく気づきましたが この質問 ）のように、IISExpressを使用したApplicationStoppingイベントに関するいくつかの問題：

public MessageListener MessageListener { get; private set; }
public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory, IApplicationLifetime appLifetime)
{
    appLifetime.ApplicationStarted.Register(() =>
    {
        MessageListener = app.ApplicationServices.GetService<MessageListener>();
        MessageListener.Start();
    });
    appLifetime.ApplicationStopping.Register(() =>
    {
        MessageListener.Stop();
    });

    // ...
}
27
Daniel J.G.

依存性注入を使用する方が優れたソリューションですが、場合によっては静的メソッド（拡張メソッドなど）を使用する必要があります。

そのような場合、静的クラスに静的プロパティを追加し、ConfigureServicesメソッドで初期化できます。

例えば：

public static class EnumExtentions
{
    static public IStringLocalizerFactory StringLocalizerFactory { set; get; }

    public static string GetDisplayName(this Enum e)
    {
        var resourceManager = StringLocalizerFactory.Create(e.GetType());
        var key = e.ToString();
        var resourceDisplayName = resourceManager.GetString(key);

        return resourceDisplayName;
    }
}

configureServicesで：

EnumExtentions.StringLocalizerFactory = services.BuildServiceProvider().GetService<IStringLocalizerFactory>();
14
HamedH

あなたのケースについての私の意見は次のとおりです。

可能であれば、解決されたサービスをパラメーターとして送信します

public static IMessageProcessor Create(string messageType, IIpSetService ipService)
{
    //
}

それ以外サービスの有効期間が重要になります。

サービスがシングルトンの場合、configureメソッドに依存関係を設定するだけです：

 // configure method
public IApplicationBuilder Configure(IApplicationBuilder app)
{
    var ipService = app.ApplicationServices.GetService<IIpSetService>();
    MessageHandlerFactory.IIpSetService = ipService;
}

// static class
public static IIpSetService IpSetService;

public static IMessageProcessor Create(string messageType)
{
    // use IpSetService
}

サービスの有効期間がスコープされている場合、HttpContextAccessorを使用します。

//Startup.cs
public void ConfigureServices(IServiceCollection services)
{
    services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();
}

public IApplicationBuilder Configure(IApplicationBuilder app)
{
    var httpContextAccessor= app.ApplicationServices.GetService<IHttpContextAccessor>();
    MessageHandlerFactory.HttpContextAccessor = httpContextAccessor;
}

// static class
public static IHttpContextAccessor HttpContextAccessor;

public static IMessageProcessor Create(string messageType)
{
    var ipSetService = HttpContextAccessor.HttpContext.RequestServices.GetService<IIpSetService>();
    // use it
}
4
adem caglin

私の答えが遅れていることは知っていますが、どうやってやったかを共有したかったです。

まず第一に：使用するのは アンチパターンServiceLocatorできる限り使用しないようにしてください。私の場合、DomainModelsの内部で MediatR を呼び出して DomainEvents ロジックを実装する必要がありました。

ただし、、DomainModelで静的クラスを呼び出して、DIから登録済みサービスのインスタンスを取得する方法を見つける必要がありました。

したがって、HttpContextを使用してIServiceProviderにアクセスすることにしましたが、ドメインモデルでは言及せずに静的メソッドからアクセスする必要がありました。

やってみましょう：

1- IServiceProviderをラップするインターフェイスを作成しました

public interface IServiceProviderProxy
{
    T GetService<T>();
    IEnumerable<T> GetServices<T>();
    object GetService(Type type);
    IEnumerable<object> GetServices(Type type);
}

2-次に、ServiceLocatorアクセス​​ポイントとなる静的クラスを作成しました

public static class ServiceLocator
{
    private static IServiceProviderProxy diProxy;

    public static IServiceProviderProxy ServiceProvider => diProxy ?? throw new Exception("You should Initialize the ServiceProvider before using it.");

    public static void Initialize(IServiceProviderProxy proxy)
    {
        diProxy = proxy;
    }
}

3-内部的にIServiceProviderProxyを使用するIHttpContextAccessorの実装を作成しました

public class HttpContextServiceProviderProxy : IServiceProviderProxy
{
    private readonly IHttpContextAccessor contextAccessor;

    public HttpContextServiceProviderProxy(IHttpContextAccessor contextAccessor)
    {
        this.contextAccessor = contextAccessor;
    }

    public T GetService<T>()
    {
        return contextAccessor.HttpContext.RequestServices.GetService<T>();
    }

    public IEnumerable<T> GetServices<T>()
    {
        return contextAccessor.HttpContext.RequestServices.GetServices<T>();
    }

    public object GetService(Type type)
    {
        return contextAccessor.HttpContext.RequestServices.GetService(type);
    }

    public IEnumerable<object> GetServices(Type type)
    {
        return contextAccessor.HttpContext.RequestServices.GetServices(type);
    }
}

4- IServiceProviderProxyをこのようにDIに登録する必要があります

public void ConfigureServices(IServiceCollection services)
{
    services.AddHttpContextAccessor();
    services.AddSingleton<IServiceProviderProxy, HttpContextServiceProviderProxy>();
    .......
}

5-最後のステップは、アプリケーション起動時にServiceLocatorのインスタンスでIServiceProviderProxyを初期化することです

public void Configure(IApplicationBuilder app, IHostingEnvironment env,IServiceProvider sp)
{
    ServiceLocator.Initialize(sp.GetService<IServiceProviderProxy>());
}

その結果、DomainModelクラスのServiceLocatorを「または必要な場所」と呼び、必要な依存関係を解決できます。

public class FakeModel
{
    public FakeModel(Guid id, string value)
    {
        Id = id;
        Value = value;
    }

    public Guid Id { get; }
    public string Value { get; private set; }

    public async Task UpdateAsync(string value)
    {
        Value = value;
        var mediator = ServiceLocator.ServiceProvider.GetService<IMediator>();
        await mediator.Send(new FakeModelUpdated(this));
    }
}
1
Wahid Bitar