You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
244 lines
11 KiB
244 lines
11 KiB
// Author: simon.gockner
|
|
// Created: 2019-05-20
|
|
// Copyright(c) 2019 SimonG. All Rights Reserved.
|
|
|
|
using LightweightIocContainer.Exceptions;
|
|
using LightweightIocContainer.Factories;
|
|
using LightweightIocContainer.Interfaces.Factories;
|
|
using LightweightIocContainer.Interfaces.Installers;
|
|
using LightweightIocContainer.Interfaces.Registrations;
|
|
using LightweightIocContainer.Interfaces.Registrations.Fluent;
|
|
using LightweightIocContainer.ResolvePlaceholders;
|
|
|
|
namespace LightweightIocContainer.Registrations;
|
|
|
|
/// <summary>
|
|
/// The <see cref="RegistrationBase"/> that is used to register an Interface
|
|
/// </summary>
|
|
internal abstract class RegistrationBase : IRegistrationBase, IWithFactoryInternal, IWithParametersInternal, ILifestyleProvider, IWithDisposeStrategyInternal, IInternalValidationProvider
|
|
{
|
|
private readonly IocContainer _container;
|
|
|
|
/// <summary>
|
|
/// The <see cref="RegistrationBase"/> that is used to register an Interface
|
|
/// </summary>
|
|
/// <param name="interfaceType">The <see cref="Type"/> of the Interface</param>
|
|
/// <param name="lifestyle">The <see cref="LightweightIocContainer.Lifestyle"/> of the registration</param>
|
|
/// <param name="container">The current instance of the <see cref="IocContainer"/></param>
|
|
protected RegistrationBase(Type interfaceType, Lifestyle lifestyle, IocContainer container)
|
|
{
|
|
InterfaceType = interfaceType;
|
|
Lifestyle = lifestyle;
|
|
_container = container;
|
|
}
|
|
|
|
/// <summary>
|
|
/// The <see cref="Type"/> of the Interface that is registered with this <see cref="RegistrationBase"/>
|
|
/// </summary>
|
|
public Type InterfaceType { get; }
|
|
|
|
/// <summary>
|
|
/// The <see cref="LightweightIocContainer.Lifestyle"/> of Instances that are created with this <see cref="RegistrationBase"/>
|
|
/// </summary>
|
|
public Lifestyle Lifestyle { get; }
|
|
|
|
/// <summary>
|
|
/// The <see cref="LightweightIocContainer.DisposeStrategy"/> of singletons/multitons that implement <see cref="IDisposable"/> and are created with this <see cref="RegistrationBase"/>
|
|
/// </summary>
|
|
public DisposeStrategy DisposeStrategy { get; private set; }
|
|
|
|
/// <summary>
|
|
/// An <see cref="Array"/> of parameters that are used to <see cref="IocContainer.Resolve{T}()"/> an instance of this <see cref="IRegistration.InterfaceType"/>
|
|
/// <para>Can be set in the <see cref="IIocInstaller"/> by calling <see cref="WithParameters(object[])"/></para>
|
|
/// </summary>
|
|
public object[]? Parameters { get; private set; }
|
|
|
|
/// <summary>
|
|
/// The Factory added with the <see cref="WithFactory{TFactory}"/> method
|
|
/// </summary>
|
|
public ITypedFactory? Factory { get; private set; }
|
|
|
|
/// <summary>
|
|
/// Pass parameters that will be used to <see cref="IocContainer.Resolve{T}()"/> an instance of this <see cref="IRegistration.InterfaceType"/>
|
|
/// <para>Parameters set with this method are always inserted at the beginning of the argument list if more parameters are given when resolving</para>
|
|
/// </summary>
|
|
/// <param name="parameters">The parameters</param>
|
|
/// <returns>The current instance of this <see cref="IRegistration"/></returns>
|
|
/// <exception cref="InvalidRegistrationException"><see cref="Parameters"/> are already set or no parameters given</exception>
|
|
public virtual IRegistrationBase WithParameters(params object[] parameters)
|
|
{
|
|
if (Parameters != null)
|
|
throw new InvalidRegistrationException($"Don't use `WithParameters()` method twice (Type: {InterfaceType}).");
|
|
|
|
if (parameters == null || !parameters.Any())
|
|
throw new InvalidRegistrationException($"No parameters given to `WithParameters()` method (Type: {InterfaceType}).");
|
|
|
|
Parameters = parameters;
|
|
return this;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Pass parameters that will be used to<see cref="IocContainer.Resolve{T}()"/> an instance of this <see cref="IRegistration.InterfaceType"/>
|
|
/// <para>Parameters set with this method are inserted at the position in the argument list that is passed with the parameter if more parameters are given when resolving</para>
|
|
/// </summary>
|
|
/// <param name="parameters">The parameters with their position</param>
|
|
/// <returns>The current instance of this <see cref="IRegistration"/></returns>
|
|
/// <exception cref="InvalidRegistrationException"><see cref="Parameters"/> are already set or no parameters given</exception>
|
|
public virtual IRegistrationBase WithParameters(params (int index, object parameter)[] parameters)
|
|
{
|
|
if (Parameters != null)
|
|
throw new InvalidRegistrationException($"Don't use `WithParameters()` method twice (Type: {InterfaceType}).");
|
|
|
|
if (parameters == null || !parameters.Any())
|
|
throw new InvalidRegistrationException($"No parameters given to `WithParameters()` method (Type: {InterfaceType}).");
|
|
|
|
int lastIndex = parameters.Max(p => p.index);
|
|
Parameters = new object[lastIndex + 1];
|
|
|
|
for (int i = 0; i < Parameters.Length; i++)
|
|
{
|
|
if (parameters.Any(p => p.index == i))
|
|
Parameters[i] = parameters.First(p => p.index == i).parameter;
|
|
else
|
|
Parameters[i] = new InternalResolvePlaceholder();
|
|
}
|
|
|
|
return this;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Register an abstract typed factory for the <see cref="IRegistrationBase"/>
|
|
/// </summary>
|
|
/// <typeparam name="TFactory">The type of the abstract typed factory</typeparam>
|
|
/// <returns>The current instance of this <see cref="IRegistrationBase"/></returns>
|
|
public IRegistrationBase WithFactory<TFactory>()
|
|
{
|
|
TypedFactory<TFactory> factory = new(_container);
|
|
Factory = factory;
|
|
|
|
_container.RegisterFactory(factory);
|
|
|
|
return this;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Register a custom implemented factory for the <see cref="IRegistrationBase"/>
|
|
/// </summary>
|
|
/// <typeparam name="TFactoryInterface">The type of the interface for the custom factory</typeparam>
|
|
/// <typeparam name="TFactoryImplementation">The type of the implementation for the custom factory</typeparam>
|
|
/// <returns>The current instance of this <see cref="IRegistrationBase"/></returns>
|
|
public IRegistrationBase WithFactory<TFactoryInterface, TFactoryImplementation>() where TFactoryImplementation : TFactoryInterface
|
|
{
|
|
Factory = new CustomTypedFactory<TFactoryInterface>();
|
|
_container.Register(r => r.Add<TFactoryInterface, TFactoryImplementation>());
|
|
|
|
return this;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Add a <see cref="DisposeStrategy"/> for the <see cref="IRegistrationBase"/>
|
|
/// </summary>
|
|
/// <param name="disposeStrategy">The <see cref="DisposeStrategy"/></param>
|
|
/// <returns>The current instance of this <see cref="RegistrationBase"/></returns>
|
|
public IRegistrationBase WithDisposeStrategy(DisposeStrategy disposeStrategy)
|
|
{
|
|
DisposeStrategy = disposeStrategy;
|
|
return this;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Validate this <see cref="RegistrationBase"/>
|
|
/// </summary>
|
|
public virtual void Validate()
|
|
{
|
|
ValidateMultiton();
|
|
ValidateFactory();
|
|
ValidateDisposeStrategy();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Validate that no registration that isn't derived from <see cref="IMultitonRegistration"/> has <see cref="LightweightIocContainer.Lifestyle.Multiton"/>
|
|
/// </summary>
|
|
/// <exception cref="InvalidRegistrationException">Can't register a type as Lifestyle.Multiton without a scope (Registration is not of type IMultitonRegistration)</exception>
|
|
private void ValidateMultiton()
|
|
{
|
|
//don't allow lifestyle.multiton without iMultitonRegistration
|
|
if (Lifestyle == Lifestyle.Multiton && this is not IMultitonRegistration)
|
|
throw new InvalidRegistrationException("Can't register a type as Lifestyle.Multiton without a scope (Registration is not of type IMultitonRegistration).");
|
|
}
|
|
|
|
/// <summary>
|
|
/// Validate the <see cref="Factory"/>
|
|
/// </summary>
|
|
/// <exception cref="InvalidFactoryRegistrationException">No create method that can create the <see cref="InterfaceType"/></exception>
|
|
protected virtual void ValidateFactory()
|
|
{
|
|
if (Factory == null)
|
|
return;
|
|
|
|
if (Factory.CreateMethods.All(c => c.ReturnType != InterfaceType) && Factory.CreateMethods.All(c => c.ReturnType.GetAsyncReturnType() != InterfaceType))
|
|
throw new InvalidFactoryRegistrationException($"No create method that can create {InterfaceType}.");
|
|
}
|
|
|
|
/// <summary>
|
|
/// Validate the <see cref="DisposeStrategy"/> for the <see cref="InterfaceType"/> and <see cref="Lifestyle"/>
|
|
/// </summary>
|
|
protected virtual void ValidateDisposeStrategy() => ValidateDisposeStrategy(InterfaceType);
|
|
|
|
/// <summary>
|
|
/// Validate the <see cref="DisposeStrategy"/> for the given <see cref="Type"/> and <see cref="Lifestyle"/>
|
|
/// </summary>
|
|
/// <param name="type">The given <see cref="Type"/></param>
|
|
/// <exception cref="InvalidDisposeStrategyException">Dispose strategy is invalid for this <see cref="InterfaceType"/> and <see cref="Lifestyle"/></exception>
|
|
protected void ValidateDisposeStrategy(Type type)
|
|
{
|
|
if (Lifestyle == Lifestyle.Transient)
|
|
{
|
|
if (DisposeStrategy != DisposeStrategy.None)
|
|
throw new InvalidDisposeStrategyException(DisposeStrategy, type, Lifestyle);
|
|
}
|
|
else
|
|
{
|
|
if (type.IsAssignableTo(typeof(IDisposable)))
|
|
{
|
|
if (DisposeStrategy == DisposeStrategy.None)
|
|
throw new InvalidDisposeStrategyException(DisposeStrategy, type, Lifestyle);
|
|
}
|
|
else
|
|
{
|
|
if (DisposeStrategy != DisposeStrategy.None)
|
|
throw new InvalidDisposeStrategyException(DisposeStrategy, type, Lifestyle);
|
|
}
|
|
}
|
|
}
|
|
|
|
public override bool Equals(object? obj)
|
|
{
|
|
if (obj is not RegistrationBase registrationBase)
|
|
return false;
|
|
|
|
if (Parameters == null && registrationBase.Parameters != null)
|
|
return false;
|
|
|
|
if (Parameters != null && registrationBase.Parameters == null)
|
|
return false;
|
|
|
|
if (Parameters?.Length != registrationBase.Parameters?.Length)
|
|
return false;
|
|
|
|
if (Factory == null && registrationBase.Factory != null)
|
|
return false;
|
|
|
|
if (Factory != null && registrationBase.Factory == null)
|
|
return false;
|
|
|
|
if (Factory?.CreateMethods.Count != registrationBase.Factory?.CreateMethods.Count)
|
|
return false;
|
|
|
|
return InterfaceType == registrationBase.InterfaceType &&
|
|
Lifestyle == registrationBase.Lifestyle &&
|
|
DisposeStrategy == registrationBase.DisposeStrategy;
|
|
}
|
|
|
|
public override int GetHashCode() => HashCode.Combine(InterfaceType, (int) Lifestyle);
|
|
} |