Android 打造编译时注解解析框架
2019独角兽企业重金招聘Python工程师标准>>>
说道注解,竟然还有各种分类,得,这记不住,我们从注解的作用来反推其分类,帮助大家记忆,然后举例强化大家的记忆,话说注解的作用:
1、标记一些信息,这么说可能太抽象,那么我说,你见过@Override、@SuppressWarnings等,这类注解就是用于标识,可以用作一些检验
2、运行时动态处理,这个大家见得应该最多,在运行时拿到类的Class对象,然后遍历其方法、变量,判断有无注解声明,然后做一些事情。类似上述三篇博文中的做法。
3、编译时动态处理,这个呢?就是我们今天的主角了,一般这类注解会在编译的时候,根据注解标识,动态生成一些类或者生成一些xml都可以,在运行时期,这类注解是没有的~~会依靠动态生成的类做一些操作,因为没有反射,效率和直接调用方法没什么区别~~~
关于3,大家不明白,没事,下文会详谈,使用这类注解的项目有:ParcelableGenerator、butterknife 、androidannotaion等。
作用谈完了,那么如果你看到一个注解的声明你如何去判断他的作用呢?例如:
[java] view plaincopy
@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
[java] view plaincopy
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
我们还创建了一个注解:
[java] view plaincopy
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类,例如:
[java] view plaincopy
public class User
{
@Seriable
private String username;
@Seriable
private String password;
private String three;
private String four;
}
[java] view plaincopy
@Seriable
public class Article
{
private String title ;
private String content ;
}
看到有两个普通的bean,上面声明了我们的注解,如果类上声明注解我们就将其所有的变量都生成一个json描述文件;如果仅仅是成员变量呢?那我们只提取声明的成员变量来动态生成。
类似如下的描述文件:
[html] view plaincopy
{class:"com.zhy.Article",
fields:
{
content:"java.lang.String",
title:"java.lang.String"
}
}
是不是觉得没撒用处,其实用处大大滴,以后我们会验证。
2、编写BeanProcessor
[java] view plaincopy
package com.zhy.annotationprocess.processor;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.ProcessingEnvironment;
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.Element;
import javax.lang.model.element.ElementKind;
import javax.lang.model.element.TypeElement;
import javax.lang.model.element.VariableElement;
import javax.lang.model.util.ElementFilter;
import javax.lang.model.util.Elements;
import com.zhy.annotationprocess.annotation.Seriable;
@SupportedAnnotationTypes("com.zhy.annotationprocess.annotation.Seriable")
@SupportedSourceVersion(SourceVersion.RELEASE_6)
public class BeanProcessor extends AbstractProcessor
{ // 元素操作的辅助类
Elements elementUtils;
@Override
public synchronized void init(ProcessingEnvironment processingEnv)
{
super.init(processingEnv);
// 元素操作的辅助类
elementUtils = processingEnv.getElementUtils();
}
@Override
public boolean process(Set<? extends TypeElement> annotations,
RoundEnvironment roundEnv)
{
// 获得被该注解声明的元素
Set<? extends Element> elememts = roundEnv
.getElementsAnnotatedWith(Seriable.class);
TypeElement classElement = null;// 声明类元素
List<VariableElement> fields = null;// 声明一个存放成员变量的列表
// 存放二者
Map<String, List<VariableElement>> maps = new HashMap<String, List<VariableElement>>();
// 遍历
for (Element ele : elememts)
{
// 判断该元素是否为类
if (ele.getKind() == ElementKind.CLASS)
{
classElement = (TypeElement) ele;
maps.put(classElement.getQualifiedName().toString(),
fields = new ArrayList<VariableElement>());
} else if (ele.getKind() == ElementKind.FIELD) // 判断该元素是否为成员变量
{
VariableElement varELe = (VariableElement) ele;
// 获取该元素封装类型
TypeElement enclosingElement = (TypeElement) varELe
.getEnclosingElement();
// 拿到key
String key = enclosingElement.getQualifiedName().toString();
fields = maps.get(key);
if (fields == null)
{
maps.put(key, fields = new ArrayList<VariableElement>());
}
fields.add(varELe);
}
}
for (String key : maps.keySet())
{
if (maps.get(key).size() == 0)
{
TypeElement typeElement = elementUtils.getTypeElement(key);
List<? extends Element> allMembers = elementUtils
.getAllMembers(typeElement);
if (allMembers.size() > 0)
{
maps.get(key).addAll(ElementFilter.fieldsIn(allMembers));
}
}
}
generateCodes(maps);
return true;
}
private void generateCodes(Map<String, List<VariableElement>> maps)
{
File dir = new File("f://apt_test");
if (!dir.exists())
dir.mkdirs();
// 遍历map
for (String key : maps.keySet())
{
// 创建文件
File file = new File(dir, key.replaceAll("\\.", "_") + ".txt");
try
{
/**
* 编写json文件内容
*/
FileWriter fw = new FileWriter(file);
fw.append("{").append("class:").append("\"" + key + "\"")
.append(",\n ");
fw.append("fields:\n {\n");
List<VariableElement> fields = maps.get(key);
for (int i = 0; i < fields.size(); i++)
{
VariableElement field = fields.get(i);
fw.append(" ").append(field.getSimpleName()).append(":")
.append("\"" + field.asType().toString() + "\"");
if (i < fields.size() - 1)
{
fw.append(",");
fw.append("\n");
}
}
fw.append("\n }\n");
fw.append("}");
fw.flush();
fw.close();
} catch (IOException e)
{
e.printStackTrace();
}
}
}
}
代码略长,但是注释很清除,我来解释一下,基本分为两个过程:1、找出标识注解的类或成员变量,封装到maps中;2、遍历maps为每个类创建json文件。我们把文件输出到了f://apt_test文件夹中,如果你没有f盘神马的,自行修改目录。
3、使用
到此,我们写完了~~那么如何用呢?
1、导出jar
为了更好的演示,以及省篇幅,我录成gif
注意我选择的一些复选框,和一些默认复选框的选中状态,我将其放在桌面上~~
2、新建一个android或java项目
将jar拷贝到libs下,如果是java项目,需要自己创建lib文件夹,自己手动引用。
然后就开始编写bean吧:我这里就写了两个类,一个User,一个Article,上面贴过代码了。
3、启用annotation processor
这里我是eclipse,大家如果是maven项目或者是别的什么IDE,自行进行网络搜索,这里有个Android Studio下的使用,自己点击哈,其实命令行也可以。
下面我们eclipse依然是个gif,不然得截一堆图片:
假设我们的jar已经拷贝到项目中了,进行如下操作
操作完成以后,那么就可以去f://apt_test中
打开即可看到:
[java] view plaincopy
{class:"com.zhy.User",
fields:
{
username:"java.lang.String",
password:"java.lang.String"
}
}
[java] view plaincopy
{class:"com.zhy.Article",
fields:
{
content:"java.lang.String",
title:"java.lang.String"
}
}
ok,这样的话,我们一个简单的annotation processor的教程就搞定了~~如果想学,一定要去试,各种试,不要怕麻烦,要是简单谁都会,那还有什么意义~~
这是一个非常简单的例子,那么具体到我们的项目中如何使用呢?鉴于篇幅,可能只能在下一篇给大家继续了。不过库的雏形已经形成:
5、HyViewInject
ok,这就是基于上述的一个库,主要用于Android的控件的注入,类似butterknife,尚在完善中,欢迎大家使用,fork or star ,我们一起完善。
sample的效果图:
第一个Activity中一个TextView和ListView,第二个Activity一个TextView和Fragment,主要测试了Activity、Fragment、Adapter中注入控件。
转载于:https://my.oschina.net/u/731542/blog/401823
Android 打造编译时注解解析框架相关推荐
- android编译时注解,Android编译时注解框架系列2-Run Demo
概述 先讲一下编写<Android编译时注解框架>的初衷吧,APT其实并不难,可以说是简单且高效,但关于APT的资料却并不多,甚至很多人都不知道这么一个技术.国内关于APT的博客屈指可数, ...
- 【Android APT】编译时技术 ( 开发编译时注解 )
文章目录 一.编译时注解 二.编译时注解 使用 三.注解的保留时间 四.博客资源 一.编译时注解 上一篇博客 [Android APT]编译时技术 ( 编译时注解 和 注解处理器 依赖库 ) 中创建并 ...
- Android使用APT编译时注解生成代码
1.前言 最近在使用Butterknife的时候感觉它使用的注解挺有意思的,就了解一下,顺便自己花点时间实现一个类似的框架.加深对这块的理解,下面上干货. 2.注解 注解和class.interfac ...
- 【Android APT】编译时技术 ( 编译时注解 和 注解处理器 依赖库 )
文章目录 一.编译时注解和注解处理器 二.创建 编译时注解 和 注解处理器 三.添加 编译时注解 和 注解处理器 依赖库依赖 四.博客资源 一.编译时注解和注解处理器 上一篇博客 [Android A ...
- Android编译时注解处理器
Java注解处理器 Android 如何编写基于编译时注解的项目 Java编译时注解处理器(APT)详解 Android APT 系列 (一):APT 筑基之反射 Android APT 系列 (二) ...
- 万能的APT!编译时注解的妙用
转载自:http://zjutkz.net/2016/04/07/万能的APT!编译时注解的妙用/ 本篇文章会带你了解什么是注解,注解的用法和分类,并且从knight和butterKnife的使用方式 ...
- java编译时注解_简单介绍 Java 中的编译时注解
1. 前言 上一篇 主要介绍了什么是 注解 (Annotation) 以及如何读取 运行时注解 中的数据, 同时用注解实现了简单的 ORM 功能. 这次介绍另一部分: 如何读取 编译时注解 ( Ret ...
- java可以在类中直接定义语句_基于javac实现的编译时注解
很多同学都知道jdk中有一个很重要的jar : tools.jar,但是 很少有人知道这个包里面究竟有哪些好玩的东西. javac入口及编译过程 在使用javac命令去编译源文件时,实际上是去执行co ...
- 3. 自定义Java编译时注解处理器
1. 絮絮叨叨 要么是注解跟我有仇,要么是公司配发的笔记本跟我有仇,要么是因为心急吃不了热豆腐 痛定思痛:从头开始,新建一个Java项目,实现一个超级简单的注解@Hello 通过获取被标识类的类名(原 ...
最新文章
- php如何对 mysql 中text类型拆分存入一个数组_PHP、Mysql笔试题
- windows server 2008 - 创建域和本机用户
- 利用OpenCV的threshold函数实现双阈值法二值化操作的源码
- MTK 驱动(66)---Android recovery UI实现分析
- 生命周期 用户可以操作dom_当面试官问:能否介绍下Vue生命周期时,该如何回答...
- Gridview创建行列 合并列、行类
- 2021考研王道计算机408
- 互联网行业数据安全建设实践方案
- 【Dynamics365】创建报表
- 华为鸿蒙鲲鹏麒麟凌霄,华为麒麟、凌霄、鸿鹄三大芯片有什么区别?
- 从0开始学大数据(十四)
- 3.Regression(二)
- 锐捷交换机(S2924/2928G)光口改电口,或电口改光口的准确方法
- (转)图解如何制作网线
- 搞清楚 Python traceback
- [精]Oracle 内存结构详解
- 3c计算机通讯消费类电子产品,什么是3c产品?3c产品具体包括哪些
- 2022年中考英语热点话题作文预测(满分范文15篇)
- 鸟哥Linux私房菜:第六章笔记
- sdnu.1026 田忌赛马续
热门文章
- pytorch 三维点分类_基于深度学习的三维重建——MVSNet系列论文解读
- linux root所在目录,Linux下误删root目录
- 在线html编辑器 asp,(ewebeditor)比较简单好用的ASP网页在线编辑器
- React Router V6 新特性
- let声明变量时的特点
- php网站模板怎么修改,自己做网站如何用好并自主修改网上的免费模板
- java method 注解_JAVA 注解详解及简单实例
- mysql默认值是随机数_mysql生成指定位数的随机数及批量生成随机数的方法
- 小数变百分数_小数除法三要“点”
- 计算机二级c语言编程题型,全国计算机等级二级C语言上机编程题题型