1、概述
记得很久以前,写过几篇博客,容我列举一下:
Android 进阶 教你打造 Android 中的 IOC 框架 【ViewInject】 (上)
Android 进阶 教你打造 Android 中的 IOC 框架 【ViewInject】 (下)
Android 框架炼成 教你如何写组件间通信框架EventBus
大家可以关注下这些博客的评论,不管咋样,大家对于性能的考虑还是很多呢,一看到这类的框架,不解析还好,只要解析出来是注解和反射,必然的一个问题就是:这样会不会影响性能呀?嗯,肯定会有性能的损耗,那么我就再考虑有没有更好的实现方式呢?既可以实现注入,还能保证性能无损耗呢?好消息来说,是有哒,对没错,上述博客实现方式,包括xutils , afinal 目前的注入使用的都是运行时注解,当然了还有一类注解叫做编译时注解。
2、注解
说道注解,竟然还有各种分类,得,这记不住,我们从注解的作用来反推其分类,帮助大家记忆,然后举例强化大家的记忆,话说注解的作用:
1、标记一些信息,这么说可能太抽象,那么我说,你见过@Override、@SuppressWarnings等,这类注解就是用于标识,可以用作一些检验
2、运行时动态处理,这个大家见得应该最多,在运行时拿到类的Class对象,然后遍历其方法、变量,判断有无注解声明,然后做一些事情。类似上述三篇博文中的做法。
3、编译时动态处理,这个呢?就是我们今天的主角了,一般这类注解会在编译的时候,根据注解标识,动态生成一些类或者生成一些xml都可以,在运行时期,这类注解是没有的~~会依靠动态生成的类做一些操作,因为没有反射,效率和直接调用方法没什么区别~~~
关于3,大家不明白,没事,下文会详谈,使用这类注解的项目有:ParcelableGenerator、butterknife 、androidannotaion等。
作用谈完了,那么如果你看到一个注解的声明你如何去判断他的作用呢?例如:
1 2 3 4 5 6 |
@Retention(RetentionPolicy.CLASS) @Target({ ElementType.FIELD, ElementType.TYPE }) public @interface InjectView { int value(); } |
1秒钟告诉我,它的作用是什么?哈,大家可能会郁闷,擦,我咋知道。其实可以看这个注解上面的@Retention后面的值,设置的为CLASS,说明就是编译时动态处理的。
这个值是一个枚举:有三个:SOURCE、RUNTIME、CLASS , 到这里,是不是,搜噶,这三个11对应于上面三个作用。
好了,说完了注解的作用以及判断方式,那么大家可以看到除了@Retention还有个@Target,@Target的值呢是一个ElementType[]数组。什么意思呢?就是标明这个注解能标识哪些东西,比如类、变量、方法、甚至是注解本身(元注解)等。这个在:Android 进阶 教你打造 Android 中的 IOC 框架 【ViewInject】 (上)有详细说明。
好了,到此注解告一段落,大家只要记得注解的作用,以及如何去定义一个注解就好。
接下来进入我们的主题编译时注解。
对了,我创建了一个公众号,会推送一些开源项目、最新博客、视频等,关于博客涉及到的东西,也会提前给大家通知,可以关注一下,谢谢,左侧栏目,微信扫描即可。
3、编译时注解
那我们说一下编写过程。
1、创建一个类,继承AbstractProcessor
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
package com.zhy.util.ioc.processor; import java.util.Set; import javax.annotation.processing.AbstractProcessor; import javax.annotation.processing.RoundEnvironment; import javax.annotation.processing.SupportedAnnotationTypes; import javax.annotation.processing.SupportedSourceVersion; import javax.lang.model.SourceVersion; import javax.lang.model.element.TypeElement; @SupportedAnnotationTypes("com.zhy.util.ioc.annotation.InjectView") @SupportedSourceVersion(SourceVersion.RELEASE_6) public class ViewInjectProcessorBeta extends AbstractProcessor { @Override public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) { // TODO Auto-generated method stub return false; } } |
这个类上可以添加注解:
@SupportedAnnotationTypes的值为当前类支持的注解的完整类路径,支持通配符。
@SupportedSourceVersion 标识该处理器支持的源码版本
除此以外还有一个@SupportedOptions,这个一般是命令行时候用的,设置一些选项,but,命令行我不熟,因此:略。
注:如果大家找不到AbstractProcessor,记得右键build-path add library把jdk加进来。
2、创建resources等文件。
这个对项目的一个结构有着固定的要求,下面我通过一张图来说:
可以看到,在我们的项目中呢,还需要创建一个resources这样的source folder ,右键 new sources folder即可。
然后在里面创建META-INF/services/javax.annotation.processing.Processor文件,这个文件中去写我们处理器的类完整路径。
经过上述两部,我们的编写环境就OK了。
4、完整例子
下面我们通过一个例子来给大家演示编译时动态生成数据,我们的效果是这样的,用户编写一堆bean,例如User类,我们通过注解提取属性动态生成一个json文件,以及一个代理类,注意是编译时生成。
注:以下为一个教学示例,无任何使用价值。
那么我们依然分为步骤来做:
1、创建编写环境
javax.annotation.processing.Processor里面写的是:com.zhy.annotationprocess.processor.BeanProcessor
我们还创建了一个注解:
1 2 3 4 5 6 7 8 9 10 11 12 13 |
package com.zhy.annotationprocess.annotation; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Target({ ElementType.FIELD, ElementType.TYPE }) @Retention(RetentionPolicy.CLASS) public @interface Seriable { } |
哈,一秒钟告诉我,哪一类作用的注解。
2、动态生成数据
1、首先明确一下我们的目标:
我们有很多bean类,例如:
1 2 3 4 5 6 7 8 9 10 |
public class User { @Seriable private String username; @Seriable private String password; private String three; private String four; } |
Android 框架炼成 教你如何写组件间通信框架EventBus
大家可以关注下这些博客的评论,不管咋样,大家对于性能的考虑还是很多呢,一看到这类的框架,不解析还好,只要解析出来是注解和反射,必然的一个问题就是:这样会不会影响性能呀?嗯,肯定会有性能的损耗,那么我就再考虑有没有更好的实现方式呢?既可以实现注入,还能保证性能无损耗呢?好消息来说,是有哒,对没错,上述博客实现方式,包括xutils , afinal 目前的注入使用的都是运行时注解,当然了还有一类注解叫做编译时注解。
2、注解
说道注解,竟然还有各种分类,得,这记不住,我们从注解的作用来反推其分类,帮助大家记忆,然后举例强化大家的记忆,话说注解的作用:
1、标记一些信息,这么说可能太抽象,那么我说,你见过@Override、@SuppressWarnings等,这类注解就是用于标识,可以用作一些检验
2、运行时动态处理,这个大家见得应该最多,在运行时拿到类的Class对象,然后遍历其方法、变量,判断有无注解声明,然后做一些事情。类似上述三篇博文中的做法。
3、编译时动态处理,这个呢?就是我们今天的主角了,一般这类注解会在编译的时候,根据注解标识,动态生成一些类或者生成一些xml都可以,在运行时期,这类注解是没有的~~会依靠动态生成的类做一些操作,因为没有反射,效率和直接调用方法没什么区别~~~
关于3,大家不明白,没事,下文会详谈,使用这类注解的项目有:ParcelableGenerator、butterknife 、androidannotaion等。
作用谈完了,那么如果你看到一个注解的声明你如何去判断他的作用呢?例如:
1 2 3 4 5 6 |
@Retention(RetentionPolicy.CLASS) @Target({ ElementType.FIELD, ElementType.TYPE }) public @interface InjectView { int value(); } |
1秒钟告诉我,它的作用是什么?哈,大家可能会郁闷,擦,我咋知道。其实可以看这个注解上面的@Retention后面的值,设置的为CLASS,说明就是编译时动态处理的。
这个值是一个枚举:有三个:SOURCE、RUNTIME、CLASS , 到这里,是不是,搜噶,这三个11对应于上面三个作用。
好了,说完了注解的作用以及判断方式,那么大家可以看到除了@Retention还有个@Target,@Target的值呢是一个ElementType[]数组。什么意思呢?就是标明这个注解能标识哪些东西,比如类、变量、方法、甚至是注解本身(元注解)等。这个在:Android 进阶 教你打造 Android 中的 IOC 框架 【ViewInject】 (上)有详细说明。
好了,到此注解告一段落,大家只要记得注解的作用,以及如何去定义一个注解就好。
接下来进入我们的主题编译时注解。
对了,我创建了一个公众号,会推送一些开源项目、最新博客、视频等,关于博客涉及到的东西,也会提前给大家通知,可以关注一下,谢谢,左侧栏目,微信扫描即可。
3、编译时注解
那我们说一下编写过程。
1、创建一个类,继承AbstractProcessor
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
package com.zhy.util.ioc.processor; import java.util.Set; import javax.annotation.processing.AbstractProcessor; import javax.annotation.processing.RoundEnvironment; import javax.annotation.processing.SupportedAnnotationTypes; import javax.annotation.processing.SupportedSourceVersion; import javax.lang.model.SourceVersion; import javax.lang.model.element.TypeElement; @SupportedAnnotationTypes("com.zhy.util.ioc.annotation.InjectView") @SupportedSourceVersion(SourceVersion.RELEASE_6) public class ViewInjectProcessorBeta extends AbstractProcessor { @Override public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) { // TODO Auto-generated method stub return false; } } |
这个类上可以添加注解:
@SupportedAnnotationTypes的值为当前类支持的注解的完整类路径,支持通配符。
@SupportedSourceVersion 标识该处理器支持的源码版本
除此以外还有一个@SupportedOptions,这个一般是命令行时候用的,设置一些选项,but,命令行我不熟,因此:略。
注:如果大家找不到AbstractProcessor,记得右键build-path add library把jdk加进来。
2、创建resources等文件。
这个对项目的一个结构有着固定的要求,下面我通过一张图来说:
可以看到,在我们的项目中呢,还需要创建一个resources这样的source folder ,右键 new sources folder即可。
然后在里面创建META-INF/services/javax.annotation.processing.Processor文件,这个文件中去写我们处理器的类完整路径。
经过上述两部,我们的编写环境就OK了。
4、完整例子
下面我们通过一个例子来给大家演示编译时动态生成数据,我们的效果是这样的,用户编写一堆bean,例如User类,我们通过注解提取属性动态生成一个json文件,以及一个代理类,注意是编译时生成。
注:以下为一个教学示例,无任何使用价值。
那么我们依然分为步骤来做:
1、创建编写环境
javax.annotation.processing.Processor里面写的是:com.zhy.annotationprocess.processor.BeanProcessor
我们还创建了一个注解:
1 2 3 4 5 6 7 8 9 10 11 12 13 |
package com.zhy.annotationprocess.annotation; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Target({ ElementType.FIELD, ElementType.TYPE }) @Retention(RetentionPolicy.CLASS) public @interface Seriable { } |
哈,一秒钟告诉我,哪一类作用的注解。
2、动态生成数据
1、首先明确一下我们的目标:
我们有很多bean类,例如:
1 2 3 4 5 6 7 8 9 10 |
public class User { |