如何从 typeElement 获取实际类型?
How to get Actual Type from typeElement?
我正在编写自定义注释处理器。虽然我能够处理没有通用类型的 class 类型,但无法获取通用类型的实际类型。
MyBase 界面
interface MyBase<T, S> {
void method1(S, T);
}
示例类 1
public class KpA{
...
}
示例类 2
public class KpB{
...
}
目标注释class
@MyAnnotation
interface MyHandler extends MyBase<KpA, KpB>{
}
处理代码片段
TypeElement[] getActualTypes(ProcessingEnvironment pEnv, TypeElement element){
List<TypeElement> myBaseElement = element.getInterfaces().stream().map(v-> (TypeElement) pEnv.getTypeUtils().asElement(v)).collect(Collectors.toList());
myBaseElement.get(0).getTypeParameters().stream().forEach(System.out::println);
return null;
}
当我 Sysout
getTypeParameters 时,我得到的输出是 S and T
;我怎样才能得到 KpA and KpB
.
当您处理类型系统时,重要的是要准确地了解您想要什么。您是否想要那些类型参数,因为它们的类型变量用于某些 field/method 的基本类型?例如。您的参数化基本类型类似于 Collection<SomeItem>
,您想知道 add
的 return 类型吗?或者 MyBase
是某种标记界面,例如 Clonable
而您想要 恰好是 它的参数?
随便;假设您的情况与问题中描述的完全一样:MyBase
是一些接口,您只是出于未知原因想要它的参数。这是一种不灵活、愚蠢的方法来实现这一点:
// instance of javax.lang.model.util.Types
protected final Types types;
// instance of javax.lang.model.util.Elements
protected final Elements el;
// TypeMirror for java.lang.Object
protected final TypeMirror theObject = ...
private static final TYPE_REFINER = new DeclaredTypeRefiner();
private class DeclaredTypeRefiner extends TypeKindVisitor6<DeclaredType, TypeMirror> {
@Override
public DeclaredType visitDeclared(DeclaredType type, TypeMirror desirableParent) {
if (types.isSameType(types.erasure(type), desirableParent)) {
return type;
}
return null;
}
@Override
public DeclaredType visitUnknown(TypeMirror typeMirror, TypeMirror typeMirror2) {
return defaultAction(typeMirror, typeMirror2);
}
@Override
protected DeclaredType defaultAction(TypeMirror type, TypeMirror desirableParent) {
if (types.isSameType(type, theObject)) {
return null;
}
final List<? extends TypeMirror> superTypes = types.directSupertypes(type);
for (TypeMirror parent : superTypes) {
final DeclaredType discovered = visit(parent, desirableParent);
if (discovered != null) {
return discovered;
}
}
return null;
}
}
public TypeMirror getTypeArg(TypeMirror actual, TypeMirror base, int idx) {
DeclaredType found = TYPE_REFINER.visit(actual, types.erasure(base));
return found.getTypeArguments().get(idx);
}
获取第二个参数的类型(如KpB
):
// type mirror of MyHandler goes here
TypeMirror concrete = ...
// your base type goes here. Real code should cache it
TypeMirror base = types.getDeclaredType(el.getTypeElement("com.example.MyBase"));
// boom
TypeMirror arg = typeHelper.getTypeArg(concrete, base, 1);
这是这里发生的事情:
- 遍历寻找
DeclaredType
的父类型(例如 类 和接口)
- 检查声明的类型是否是我们的基接口
- 如果我们找到它,return它给调用者,所以它可以检查类型 args
诀窍在于调用 directSupertypes
:如其文档中所述,该方法会自动为您解析类型参数。
我们比较类型擦除(又名原始类型),因为它们应该以有意义的方式进行比较(它或多或少与比较 TypeElements 相同)。请不要尝试将泛型类型与 isSameType
进行比较——由于类型系统的工作方式,这肯定会产生令人惊讶的结果。
请注意,由于多重继承,上面的代码可能并不总是提供正确的结果:MyHandler
可能从多个父代继承 MyBase
,导致对 T
的真实身份的混淆和 S
。如果这些变量没有在任何地方使用(例如,我们正在谈论一个纯标记接口),它将仍然是一个谜:编译器不关心,所以没有人知道(我想,你不想手动计算upper/lower 边界,是吗?)如果这些变量在某些 methods/fields 中使用,您应该能够通过检查 MyHandler
上的那些 methods/fields 来获取它们的类型(如何做这是一个有点棘手的问题,值得另一个问题。
我正在编写自定义注释处理器。虽然我能够处理没有通用类型的 class 类型,但无法获取通用类型的实际类型。
MyBase 界面
interface MyBase<T, S> {
void method1(S, T);
}
示例类 1
public class KpA{
...
}
示例类 2
public class KpB{
...
}
目标注释class
@MyAnnotation
interface MyHandler extends MyBase<KpA, KpB>{
}
处理代码片段
TypeElement[] getActualTypes(ProcessingEnvironment pEnv, TypeElement element){
List<TypeElement> myBaseElement = element.getInterfaces().stream().map(v-> (TypeElement) pEnv.getTypeUtils().asElement(v)).collect(Collectors.toList());
myBaseElement.get(0).getTypeParameters().stream().forEach(System.out::println);
return null;
}
当我 Sysout
getTypeParameters 时,我得到的输出是 S and T
;我怎样才能得到 KpA and KpB
.
当您处理类型系统时,重要的是要准确地了解您想要什么。您是否想要那些类型参数,因为它们的类型变量用于某些 field/method 的基本类型?例如。您的参数化基本类型类似于 Collection<SomeItem>
,您想知道 add
的 return 类型吗?或者 MyBase
是某种标记界面,例如 Clonable
而您想要 恰好是 它的参数?
随便;假设您的情况与问题中描述的完全一样:MyBase
是一些接口,您只是出于未知原因想要它的参数。这是一种不灵活、愚蠢的方法来实现这一点:
// instance of javax.lang.model.util.Types
protected final Types types;
// instance of javax.lang.model.util.Elements
protected final Elements el;
// TypeMirror for java.lang.Object
protected final TypeMirror theObject = ...
private static final TYPE_REFINER = new DeclaredTypeRefiner();
private class DeclaredTypeRefiner extends TypeKindVisitor6<DeclaredType, TypeMirror> {
@Override
public DeclaredType visitDeclared(DeclaredType type, TypeMirror desirableParent) {
if (types.isSameType(types.erasure(type), desirableParent)) {
return type;
}
return null;
}
@Override
public DeclaredType visitUnknown(TypeMirror typeMirror, TypeMirror typeMirror2) {
return defaultAction(typeMirror, typeMirror2);
}
@Override
protected DeclaredType defaultAction(TypeMirror type, TypeMirror desirableParent) {
if (types.isSameType(type, theObject)) {
return null;
}
final List<? extends TypeMirror> superTypes = types.directSupertypes(type);
for (TypeMirror parent : superTypes) {
final DeclaredType discovered = visit(parent, desirableParent);
if (discovered != null) {
return discovered;
}
}
return null;
}
}
public TypeMirror getTypeArg(TypeMirror actual, TypeMirror base, int idx) {
DeclaredType found = TYPE_REFINER.visit(actual, types.erasure(base));
return found.getTypeArguments().get(idx);
}
获取第二个参数的类型(如KpB
):
// type mirror of MyHandler goes here
TypeMirror concrete = ...
// your base type goes here. Real code should cache it
TypeMirror base = types.getDeclaredType(el.getTypeElement("com.example.MyBase"));
// boom
TypeMirror arg = typeHelper.getTypeArg(concrete, base, 1);
这是这里发生的事情:
- 遍历寻找
DeclaredType
的父类型(例如 类 和接口) - 检查声明的类型是否是我们的基接口
- 如果我们找到它,return它给调用者,所以它可以检查类型 args
诀窍在于调用 directSupertypes
:如其文档中所述,该方法会自动为您解析类型参数。
我们比较类型擦除(又名原始类型),因为它们应该以有意义的方式进行比较(它或多或少与比较 TypeElements 相同)。请不要尝试将泛型类型与 isSameType
进行比较——由于类型系统的工作方式,这肯定会产生令人惊讶的结果。
请注意,由于多重继承,上面的代码可能并不总是提供正确的结果:MyHandler
可能从多个父代继承 MyBase
,导致对 T
的真实身份的混淆和 S
。如果这些变量没有在任何地方使用(例如,我们正在谈论一个纯标记接口),它将仍然是一个谜:编译器不关心,所以没有人知道(我想,你不想手动计算upper/lower 边界,是吗?)如果这些变量在某些 methods/fields 中使用,您应该能够通过检查 MyHandler
上的那些 methods/fields 来获取它们的类型(如何做这是一个有点棘手的问题,值得另一个问题。