APT - 调用Annotation方法获取Class对象出现MirroredTypeException异常

  最近楼主在使用APT写一个DI框架,这个框架主要是用于楼主的毕设项目中。但是在开发这个框架时,遇到一个关键的问题,就是调用Annotation的方法来获取一个Class对象时,结果在编译时直接报错了,抛的异常就是MirroredTypeException异常。本文的目的是解决这个问题。
  本文参考资料:

  1. Getting Class values from Annotations in an AnnotationProcessor

1.提出问题

  楼主自定义了一个Annotation,这个Annotation需要传递一个Class对象。如下:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Container {
    Class<?> value();
}

  然后,我在这个注解来标记一个类,比如说MainActivity:

@Container(MainActivity.Context.class)
public class MainActivity extends AppCompatActivity {

    @Inject
    String string1;
    @Inject("string")
    String string2;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
    }

    public static class Context {
        @Provides
        String string1;

        @Provides("string")
        String string2;
    }
}

  最后,再通过APT来扫描注解,拿到Container注解的对象,进而获取它内部的Class对象,也就是MainActivity.Context的Class对象。一切都是那么的美好,但是现实的残酷给我们当头一棒。就在我们开心的build工程时,一个大大的异常出现我们的眼前--MirroredTypeException
  刚开始出现这个异常时,我是一脸懵逼的。当时简单百度了一下,说是该类还未编译,不能获取它的Class对象。说句实话,当时非常的沮丧,框架的大概结构都已经固定了,突然出现一个这个问题,就意味着当前这条路是不通的。
  不过好在天无绝人之路,我找到了解决方法。

1. 解决问题

  根据 Getting Class values from Annotations in an AnnotationProcessor这篇文章,可以找到两种解决办法。我们来看看,不过在看解决方法之前,我们还是先来看看之前,我们通过Annation怎么获取Class对象。

            Class<?> clazz = key.getAnnotation(Container.class).value();

  正常来说,这一句是没有毛病,可就是在编译时会抛MirroredTypeException异常,这也是本文需要解决的问题。现在我们来看一下解决方案,一共有两种。

(1). 通过AnnotationMirrors来获取

  从参看文章,我们首先可以找到第一种方法,就是通过AnnotationMirrors来获取。我们来看看代码:

    private String getClassFromAnnotation(Element key) {
        List<? extends AnnotationMirror> annotationMirrors = key.getAnnotationMirrors();
        for (AnnotationMirror annotationMirror : annotationMirrors) {
            if (Container.class.getName().equals(annotationMirror.getAnnotationType().toString())) {
                Set<? extends ExecutableElement> keySet = annotationMirror.getElementValues().keySet();
                for (ExecutableElement executableElement : keySet) {
                    if (Objects.equals(executableElement.getSimpleName().toString(), "value")) {
                        return annotationMirror.getElementValues().get(executableElement).getValue().toString();
                    }
                }
            }
        }
        return null;
    }

  上面的代码我们能够成功获取这个Class对象的name字段,更别说Class对象。其中annotationMirror.getElementValues().get(executableElement)返回的是一个Object对象,所以如果是Class<?>[]类型的话,可以直接进行强转。这里之所强调这一点,是跟第二种解决方案区别开来。

(2). 通过MirroredTypeException异常来获取

  当我们通过如上的方法获取Class对象时,会抛出MirroredTypeException异常,我们可以根据MirroredTypeException携带的相关信息来获取我们想要的Class对象。

    private String getClassFromAnnotationV2(Element key) {
        try {
            key.getAnnotation(Container.class).value();
        } catch (MirroredTypeException e) {
            TypeMirror typeMirror = e.getTypeMirror();
            return typeMirror.toString();
        }
        return null;
    }

  这种方法比较trick,但是不能否认,这也是一种解决方案,而且比第一种方法更加的简单。这里需要的注意的是:

MirroredTypeException 不能获取Class对象,只能获取相应的ClassName,其次它只能获取Class对象的ClassName,而不能获取Class数组对象的ClassName,如果想要获取Class数组对象的ClassName,可以通过MirroredTypesException来获取。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,198评论 4 359
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,663评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,985评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,673评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,994评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,399评论 1 211
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,717评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,407评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,112评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,371评论 2 241
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,891评论 1 256
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,255评论 2 250
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,881评论 3 233
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,010评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,764评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,412评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,299评论 2 260

推荐阅读更多精彩内容

  • ∝童心原创文学,心动只是偶然∝ 一张结婚证 文/倪峥&童心 我每天都是踩点上班,今天当我走到档案室门口的时候,一个...
    花开半夏又过半阅读 367评论 0 0
  • 总是冒出很多想法,昨天晚上翻看微博,现在觉得有些心疼你。因为我们经历很像,或许我也很心疼我自己吧,只是自己没有察觉...
    西西_随笔阅读 255评论 0 0
  • 不知道从什么时候养成的午休习惯,所以每天吃过午饭就会美美的睡上一觉,哪怕是小眯一会,也是一种享受。 因为昨晚从梦中...
    凤221阅读 113评论 0 0