徐昊 · TDD 项目实战 70 讲
徐昊
Thoughtworks 中国区 CTO
18159 人已学习
新⼈⾸单¥98
登录后,你可以任选4讲全文学习
课程目录
已完结/共 88 讲
实战项目二|RESTful开发框架:依赖注入容器 (24讲)
实战项目三|RESTful Web Services (44讲)
徐昊 · TDD 项目实战 70 讲
15
15
1.0x
00:00/00:00
登录|注册

29|DI Container(17):如何重构ContextConfig内部的实现?

你好,我是徐昊。今天我们继续使用 TDD 的方式实现注入依赖容器。

回顾代码与任务列表

到目前为止,我们的代码是这样的:
InjectProvider.java:
package geektime.tdd.di;
import jakarta.inject.Inject;
import java.lang.reflect.*;
import java.util.*;
import java.util.function.BiFunction;
import java.util.stream.Stream;
import static java.util.Arrays.stream;
import static java.util.stream.Stream.concat;
class InjectionProvider<T> implements ContextConfig.ComponentProvider<T> {
private Constructor<T> injectConstructor;
private List<Field> injectFields;
private List<Method> injectMethods;
public InjectionProvider(Class<T> component) {
if (Modifier.isAbstract(component.getModifiers())) throw new IllegalComponentException();
this.injectConstructor = getInjectConstructor(component);
this.injectFields = getInjectFields(component);
this.injectMethods = getInjectMethods(component);
if (injectFields.stream().anyMatch(f -> Modifier.isFinal(f.getModifiers())))
throw new IllegalComponentException();
if (injectMethods.stream().anyMatch(m -> m.getTypeParameters().length != 0))
throw new IllegalComponentException();
}
@Override
public T get(Context context) {
try {
T instance = injectConstructor.newInstance(toDependencies(context, injectConstructor));
for (Field field : injectFields) field.set(instance, toDependency(context, field));
for (Method method : injectMethods) method.invoke(instance, toDependencies(context, method));
return instance;
} catch (InvocationTargetException | InstantiationException | IllegalAccessException e) {
throw new RuntimeException(e);
}
}
@Override
public List<Context.Ref> getDependencies() {
return concat(concat(stream(injectConstructor.getParameters()).map(Parameter::getParameterizedType),
injectFields.stream().map(Field::getGenericType)),
injectMethods.stream().flatMap(m -> stream(m.getParameters()).map(Parameter::getParameterizedType)))
.map(Context.Ref::of).toList();
}
private static <T> List<Method> getInjectMethods(Class<T> component) {
List<Method> injectMethods = traverse(component, (methods, current) -> injectable(current.getDeclaredMethods())
.filter(m -> isOverrideByInjectMethod(methods, m))
.filter(m -> isOverrideByNoInjectMethod(component, m)).toList());
Collections.reverse(injectMethods);
return injectMethods;
}
private static <T> List<Field> getInjectFields(Class<T> component) {
return traverse(component, (fields, current) -> injectable(current.getDeclaredFields()).toList());
}
private static <Type> Constructor<Type> getInjectConstructor(Class<Type> implementation) {
List<Constructor<?>> injectConstructors = injectable(implementation.getConstructors()).toList();
if (injectConstructors.size() > 1) throw new IllegalComponentException();
return (Constructor<Type>) injectConstructors.stream().findFirst().orElseGet(() -> defaultConstructor(implementation));
}
private static <Type> Constructor<Type> defaultConstructor(Class<Type> implementation) {
try {
return implementation.getDeclaredConstructor();
} catch (NoSuchMethodException e) {
throw new IllegalComponentException();
}
}
private static <T> List<T> traverse(Class<?> component, BiFunction<List<T>, Class<?>, List<T>> finder) {
List<T> members = new ArrayList<>();
Class<?> current = component;
while (current != Object.class) {
members.addAll(finder.apply(members, current));
current = current.getSuperclass();
}
return members;
}
private static <T extends AnnotatedElement> Stream<T> injectable(T[] declaredFields) {
return stream(declaredFields).filter(f -> f.isAnnotationPresent(Inject.class));
}
private static boolean isOverride(Method m, Method o) {
return o.getName().equals(m.getName()) && Arrays.equals(o.getParameterTypes(), m.getParameterTypes());
}
private static <T> boolean isOverrideByNoInjectMethod(Class<T> component, Method m) {
return stream(component.getDeclaredMethods()).filter(m1 -> !m1.isAnnotationPresent(Inject.class)).noneMatch(o -> isOverride(m, o));
}
private static boolean isOverrideByInjectMethod(List<Method> injectMethods, Method m) {
return injectMethods.stream().noneMatch(o -> isOverride(m, o));
}
private static Object[] toDependencies(Context context, Executable executable) {
return stream(executable.getParameters()).map(p -> toDependency(context, p.getParameterizedType())).toArray(Object[]::new);
}
private static Object toDependency(Context context, Field field) {
return toDependency(context, field.getGenericType());
}
private static Object toDependency(Context context, Type type) {
return context.get(Context.Ref.of(type)).get();
}
}
Context.java:
package geektime.tdd.di;
import java.lang.annotation.Annotation;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.Objects;
import java.util.Optional;
public interface Context {
<ComponentType> Optional<ComponentType> get(Ref<ComponentType> ref);
class Ref<ComponentType> {
public static <ComponentType> Ref<ComponentType> of(Class<ComponentType> component) {
return new Ref(component, null);
}
public static <ComponentType> Ref<ComponentType> of(Class<ComponentType> component, Annotation qualifier) {
return new Ref(component, qualifier);
}
public static Ref of(Type type) {
return new Ref(type, null);
}
private Type container;
private Class<ComponentType> component;
private Annotation qualifier;
Ref(Type type, Annotation qualifier) {
init(type);
this.qualifier = qualifier;
}
protected Ref() {
Type type = ((ParameterizedType) getClass().getGenericSuperclass()).getActualTypeArguments()[0];
init(type);
}
private void init(Type type) {
if (type instanceof ParameterizedType container) {
this.container = container.getRawType();
this.component = (Class<ComponentType>) container.getActualTypeArguments()[0];
} else
this.component = (Class<ComponentType>) type;
}
public Type getContainer() {
return container;
}
public Class<?> getComponent() {
return component;
}
public boolean isContainer() {
return container != null;
}
public Annotation getQualifier() {
return qualifier;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
Ref ref = (Ref) o;
return Objects.equals(container, ref.container) && component.equals(ref.component);
}
@Override
public int hashCode() {
return Objects.hash(container, component);
}
}
}
ContextConfig.java:
package geektime.tdd.di;
import jakarta.inject.Provider;
import java.lang.annotation.Annotation;
import java.util.*;
public class ContextConfig {
private Map<Class<?>, ComponentProvider<?>> providers = new HashMap<>();
private Map<Component, ComponentProvider<?>> components = new HashMap<>();
public <Type> void bind(Class<Type> type, Type instance) {
providers.put(type, (ComponentProvider<Type>) context -> instance);
}
public <Type> void bind(Class<Type> type, Type instance, Annotation... qualifiers) {
for (Annotation qualifier : qualifiers)
components.put(new Component(type, qualifier), context -> instance);
}
record Component(Class<?> type, Annotation qualifiers) {
}
public <Type, Implementation extends Type>
void bind(Class<Type> type, Class<Implementation> implementation) {
providers.put(type, new InjectionProvider<>(implementation));
}
public <Type, Implementation extends Type>
void bind(Class<Type> type, Class<Implementation> implementation, Annotation... qualifiers) {
for (Annotation qualifier : qualifiers)
components.put(new Component(type, qualifier), new InjectionProvider<>(implementation));
}
public Context getContext() {
providers.keySet().forEach(component -> checkDependencies(component, new Stack<>()));
return new Context() {
@Override
public <ComponentType> Optional<ComponentType> get(Ref<ComponentType> ref) {
if (ref.getQualifier() != null) {
return Optional.ofNullable(components.get(new Component(ref.getComponent(), ref.getQualifier()))).map(provider -> (ComponentType) provider.get(this));
}
if (ref.isContainer()) {
if (ref.getContainer() != Provider.class) return Optional.empty();
return (Optional<ComponentType>) Optional.ofNullable(providers.get(ref.getComponent()))
.map(provider -> (Provider<Object>) () -> provider.get(this));
}
return Optional.ofNullable(providers.get(ref.getComponent())).map(provider -> (ComponentType) provider.get(this));
}
};
}
private void checkDependencies(Class<?> component, Stack<Class<?>> visiting) {
for (Context.Ref dependency : providers.get(component).getDependencies()) {
if (!providers.containsKey(dependency.getComponent()))
throw new DependencyNotFoundException(component, dependency.getComponent());
if (!dependency.isContainer()) {
if (visiting.contains(dependency.getComponent())) throw new CyclicDependenciesFoundException(visiting);
visiting.push(dependency.getComponent());
checkDependencies(dependency.getComponent(), visiting);
visiting.pop();
}
}
}
interface ComponentProvider<T> {
T get(Context context);
default List<Context.Ref> getDependencies() {
return List.of();
}
}
}
任务列表的状态为:
无需构造的组件——组件实例
如果注册的组件不可实例化,则抛出异常
抽象类
接口
构造函数注入
无依赖的组件应该通过默认构造函数生成组件实例
有依赖的组件,通过 Inject 标注的构造函数生成组件实例
如果所依赖的组件也存在依赖,那么需要对所依赖的组件也完成依赖注入
如果组件有多于一个 Inject 标注的构造函数,则抛出异常
如果组件没有 Inject 标注的构造函数,也没有默认构造函数(新增任务)
如果组件需要的依赖不存在,则抛出异常
如果组件间存在循环依赖,则抛出异常
字段注入
通过 Inject 标注将字段声明为依赖组件
如果字段为 final 则抛出异常
依赖中应包含 Inject Field 声明的依赖
方法注入
通过 Inject 标注的方法,其参数为依赖组件
通过 Inject 标注的无参数方法,会被调用
按照子类中的规则,覆盖父类中的 Inject 方法
如果方法定义类型参数,则抛出异常
依赖中应包含 Inject Method 声明的依赖
对 Provider 类型的依赖
从容器中取得组件的 Provider(新增任务)
注入构造函数中可以声明对于 Provider 的依赖
注入字段中可以声明对于 Provider 的依赖
注入方法中可声明对于 Provider 的依赖
将构造函数中的 Provider 加入依赖(新增任务)
将字段中的 Provider 加入依赖(新增任务)
将方法中的 Provider 加入依赖(新增任务)
自定义 Qualifier 的依赖
注册组件时,可额外指定 Qualifier
针对 instance 指定一个 Qualifieri(新增任务)
针对组件指定一个 Qualiifer(新增任务)
针对 instance 指定多个 Qualifieri(新增任务)
针对组件指定多个 Qualiifer(新增任务)
注册组件时,如果不是合法的 Qualifier,则不接受组件注册(新增任务)
寻找依赖时,需同时满足类型与自定义 Qualifier 标注
在检查依赖时使用 Qualifier(新增任务)
在检查循环依赖时使用 Qualifier(新增任务)
构造函数注入可以使用 Qualifier 声明依赖(新增任务)
如果不是合法的 Qualifier,则组件非法
字段注入可以使用 Qualifier 声明依赖(新增任务)
如果不是合法的 Qualifier,则组件非法
函数注入可以使用 Qualifier 声明依赖(新增任务)
如果不是合法的 Qualifier,则组件非法
支持默认 Qualifier——Named(不需要)
注册组件时,可从类对象上提取 Qualifier(不需要)
Singleton 生命周期
注册组件时,可额外指定是否为 Singleton
注册组件时,可从类对象上提取 Singleton 标注
对于包含 Singleton 标注的组件,在容器范围内提供唯一实例
容器组件默认不是 Single 生命周期
自定义 Scope 标注
可向容器注册自定义 Scope 标注的回调
确认放弃笔记?
放弃后所记笔记将不保留。
新功能上线,你的历史笔记已初始化为私密笔记,是否一键批量公开?
批量公开的笔记不会为你同步至部落
公开
同步至部落
取消
完成
0/2000
荧光笔
直线
曲线
笔记
复制
AI
  • 深入了解
  • 翻译
    • 英语
    • 中文简体
    • 中文繁体
    • 法语
    • 德语
    • 日语
    • 韩语
    • 俄语
    • 西班牙语
    • 阿拉伯语
  • 解释
  • 总结

使用TDD的方式实现注入依赖容器的过程是本文的重点。文章以徐昊的DI Container系列为例,详细介绍了DI容器的实现原理和功能特点。通过代码示例和任务列表,讲解了构造函数注入、字段注入、方法注入、对Provider类型的依赖、自定义Qualifier的依赖、Singleton生命周期等多个方面。读者可以通过本文深入了解DI容器的设计思想和实现细节,对于理解和应用依赖注入技术具有重要的参考意义。同时,文章还提到了徐老师发起的“TDD·代码评点”活动,为读者提供了更多实践和学习的机会。

仅可试看部分内容,如需阅读全部内容,请付费购买文章所属专栏
《徐昊 · TDD 项目实战 70 讲》
新⼈⾸单¥98
立即购买
登录 后留言

全部留言(3)

  • 最新
  • 精选
  • 枫中的刀剑
    当对未来重构后的代码结构有清楚的认识同时又有足够的测试覆盖时,可以不比严格按照TDD的节奏来进行重构。 好处是可以节省大量的平行实现。 这相当于你对这块代码有足够的信心,可以加大前进步伐。即使出问题也在可控范围之内。 因此我们在使用TDD时并不是始终保持一个不变的节奏,实际情况下根据你对当前情况的认知会做出相应的调整,信心充分就可以加大步伐,信心不足就严格执行,小步前进。这是非常灵活的。
    2022-05-29
    3
  • aoe
    少了30多个测试项目链接 https://github.com/wyyl1/geektime-tdd-di-container/branches
    2022-05-22
  • 张铁林
    跟着做了2小时,已经完成,在master分支上有代码。
    2022-05-17
收起评论
显示
设置
留言
3
收藏
沉浸
阅读
分享
手机端
快捷键
回顶部