介绍
在Castle Windsor Ioc 一个接口多个实现解决方案中,介绍了三种解决一个接口多个实现的方案,在方案三种,在注册服务组件的时候,使用到了Named
,此篇文章主要介绍如何使用Attribute
解决快速注册Named
的问题
代码实现
特性类IocNamedAttribute
此类主要是为了给实现类添加Ioc Named说明,包括两个属性
- Name : 将要注册到Ioc中别称的名称
- UseFullName: 是否使用类的全名称,默认为false,如果为true,表示注册到ioc的别称是包括命名空间的全类名,false表示使用类名(不包括命名空间)
///
/// 指定IocNamed
///
[AttributeUsage(AttributeTargets.Class)]
public class IocNamedAttribute : Attribute
{
///
/// 名称
///
public string Name { get; set; }
///
/// 是否使用全类名
///
public bool UseFullName { get; set; }
public IocNamedAttribute()
{
}
public IocNamedAttribute(string name="",bool useFullName=false)
{
this.Name = name;
this.UseFullName = useFullName;
}
public bool NameIsNotNull()
{
return !string.IsNullOrEmpty(this.Name);
}
}
类型扩展方法
此扩展方法主要是为了方便从Type
中获取Ioc Name的名称
///
/// 类型扩展方法
///
public static class TypeExtention
{
///
/// 获取Ioc Named名称
///
///
///
public static string GetIocNamed(this Type type)
{
var attr = type.GetCustomAttribute();
if (attr.NameIsNotNull())
{
return attr.Name;
}
if (attr.UseFullName)
{
return type.FullName;
}
return type.Name;
}
}
注册方式
为了能够让Named正确注入,需要调整注册方式,主要内容有以下几点
- BasedOn
() // 表示是信息集中继承自 IHello
的所有类- ConfigureIf // 第一个参数时判断实现类型是否使用
IocNamedAttribute
进行标识,第二个参数设置Named的值
// AsFactory方法必须要加这句
_container.AddFacility();
_container.Register(Component.For().AsFactory());
_container.Register(
Classes.FromAssembly(typeof(IHello).Assembly)
.IncludeNonPublicTypes()
.BasedOn() // 基类是 IHello的
.WithService.Self()
.WithService.DefaultInterfaces()
.ConfigureIf(
c=> Attribute.IsDefined(c.Implementation,typeof(IocNamedAttribute)), // 使用 IocNamedAttribute的
c =>
{
// 获取 ioc named 的名称
var iocName = c.Implementation.GetCustomAttribute().Name;
c.Named(iocName);
})
.LifestyleTransient()
);
实现类型,使用IocNamed
进行标识
在类上使用IocNamed
进行标识并传入name参数
调用方式
我们仍然通过工厂调用
var factory2 = _container.Resolve();
var shanghaiHello2 = factory2.GetShanghai();
shanghaiHello2.SayHello("刘皇叔");
var wuxiHello2 = factory2.GetWuxi();
wuxiHello2.SayHello("刘皇叔");
var beijingHello2 = factory2.GetBeijing();
beijingHello2.SayHello("刘皇叔");
通过运行结果发现程序是正常运行的,并且正确从ioc中解析到具体的实现类型
扩展工厂方法
使用Named之后,需要IHelloFactory
方法提供相关Named的获取方法,格式是Get[Named名称]()
,这样在新增一个实现类的时候,需要在IHelloFactory
中新增一个方法,能不能在IHelloFactory
中提供一个方法,传入Named
得到实例呢?答案是可以得。
自定义DefaultTypedFactoryComponentSelector
我们继承DefaultTypedFactoryComponentSelector
实现IocNamedTypeFactoryComponentSelector
,重写GetComponentName
方法,修改返回组件名称
的规则,在这个规则中,工厂方法必须满足一下内容
- 方法名必须是
Create
- 方法的参数
不能为null
- 方法的参数个数必须
大于0
- 方法的第一参数类型必须是
string
public class IocNamedTypeFactoryComponentSelector : DefaultTypedFactoryComponentSelector
{
protected override string GetComponentName(MethodInfo method, object[] arguments)
{
string componentName = null;
// 工厂的方法是Create,并且Create方法参数至少为1个,并且第一个参数必须是string类型
if (method.Name == "Create" && arguments!= null && arguments.Length > 0 && arguments[0] is string)
{
componentName = arguments[0] as string;
}
if (string.IsNullOrEmpty(componentName))
componentName = base.GetComponentName(method, arguments);
return componentName;
}
}
修改注册方法
主要在AsFactory
中使用IocNamedTypeFactoryComponentSelector
即可
_container.Register(Component.For().AsFactory(
c=>c.SelectedWith(new IocNamedTypeFactoryComponentSelector())));
修改IHelloFactory,添加Create方法
新增IHello Create(string name);
方法签名
public interface IHelloFactory
{
IHello Create() where T : IHello;
///
/// 根据Named获取实例
///
///
///
IHello Create(string name);
///
/// 方法名必须是 Get[Named]格式
///
///
IHello GetShanghai();
///
/// 方法名必须是 Get[Named]格式
///
///
IHello GetWuxi();
///
/// 方法名必须是 Get[Named]格式
///
///
IHello GetBeijing();
}
使用方式
调用工厂的Create
方法,并传入Named
var factory3 = _container.Resolve();
var shanghaiHello3 = factory3.Create("Shanghai");
shanghaiHello3.SayHello("赵子龙");
var wuxiHello3 = factory3.Create("Wuxi");
wuxiHello3.SayHello("赵子龙");
var beijingHello3 = factory3.Create("Beijing");
beijingHello3.SayHello("赵子龙");
总结
此篇文章主要是解决Named
注册问题,避免了一个一个实现类注册,并且通过使用Attribute
动态的给实现类标识注册的Named
值。
这里还扩展了工厂方法,使得传入Named
值即可获取到相关实例。
为什么这里不直接通过IWindsorContainer
Ioc容器传入Named
获取实例呢?而是要通过工厂方法呢?
其实通过Ioc容器传入Named
获取实例是可行的,但是这种方式是官方不推荐的方式。
参考文献
- https://github.com/castleproject/Windsor/blob/master/docs/typed-factory-facility-interface-based.md
- https://stackoverflow.com/questions/21752389/castle-windsor-how-to-resolve-by-name
- https://gist.github.com/ZhaoRd/4eb2ee68a669552e39831a85b28da198
- https://github.com/castleproject/Windsor/blob/master/docs/registering-components-by-conventions.md
- http://kozmic.net/2009/12/23/castle-typed-factory-facility-reborn/