Review the documentation: Getting Started Tutorial

[mpostol]

Getting Started Tutorial.

[mpostol]

part of #394

[210342]

I think it is worth to mention that IEncodingFactory implementation can be found in NuGet package UAOOI.Networking.Encoding. I have used it in my application. Also it would be helpful to provide an example of schema for a producer/consumer configuration file.

[mpostol]

@210342 thanks for comments. I understand that the proposals can be recognized as future requests and are not a blocker for your work.

[mpostol]

Add information about dependency on commonservicelocator. It is used to ger parts required to compose the application.

[mpostol]

There must be added that each instance of the DataManagementSetup creates a new instance of selected Roles. The DataManagementSetup can create consumer, producer of both depending on the configuration.

[mpostol]

commonservicelocator research on

commonservicelocator see also:

• Microsoft.Practices.ServiceLocation
  • solution in concern
  • don't require a concrete container
  • can be easily implemented for any container
• Martin Fowler; Inversion of Control Containers and the Dependency Injection pattern
  • describes the ServiceLocator as an embedded part of the DI - I agree
• Service Locator is an Anti-Pattern by Mark Seemann
  • don't agree - there are a lot of errors and misunderstandings
• Dependency injection in .NET Core console applications
  • in not .NET API Browser
  • depends on Microsoft.Extensions.DependencyInjection
  • implements container ServiceCollection

Decision

Using commonservicelocator the following assumptions are hold

• the library doesn't depend on a concrete container - it is only client-side
• the footprint is small
• lack of service locator is mitigated by the default implementation of the services
• it can be easily implemented for any kind of container.

We will keep using it inside the library. End-user may select any framework that is compliant with this.

[Drutol]

Hmm...

in not .NET API Browser

Neither Microsoft.Practices.ServiceLocation is there.

depends on Microsoft.Extensions.DependencyInjection

Not sure why would you want to use the whole package.
https://www.nuget.org/packages/Microsoft.Extensions.DependencyInjection.Abstractions/

On top of it the library itself would need no dependency altogether.

implements container ServiceCollection

Abstractions do not implement this class.

don't agree - there are a lot of errors and misunderstandings

Well, the main point made there is that it obscures dependencies required by the components. The API of the library is not self descriptive and requires digging through the documentation to find out what's up. In my opinion that's very valid point, class is requesting something at random instead of getting the thing from its constructor.

don't require a concrete container
can be easily implemented for any container

These apply to the IServiceCollection too.

Just wanted to comment on that, I'm not really hung up on removing ServiceLocator but wanted to clarify a few things.