android注解入门并来自己写一个框架
介绍
这里我带大家来学习一下注解并且用来写下一个模仿xUtils3中View框架
此框架可以省略activity或者fragment的findViewById或者设置点击事件的烦恼
如下代码:
fragment
packagea.fmy.com.myapplication;
importandroid.os.Bundle;
importandroid.support.v4.app.Fragment;
importandroid.view.LayoutInflater;
importandroid.view.View;
importandroid.view.ViewGroup;
importandroid.widget.TextView;
importa.fmy.com.mylibrary.FmyClickView;
importa.fmy.com.mylibrary.FmyContentView;
importa.fmy.com.mylibrary.FmyViewInject;
importa.fmy.com.mylibrary.FmyViewView;
//你的fragment的布局idYourfragment''sLayoutId
@FmyContentView(R.layout.fragment_blank)
publicclassBlankFragmentextendsFragment{
//你想实例化控件的id
//Doyouwanttocontrolinstanceid
//等价于findViewByid
//EquivalenttothefindViewByid
@FmyViewView(R.id.tv1)
TextViewtv1;
@FmyViewView(R.id.tv2)
TextViewtv2;
@Override
publicViewonCreateView(LayoutInflaterinflater,ViewGroupcontainer,
BundlesavedInstanceState){
//初始化fragmentInitializeFragement
returnFmyViewInject.injectfragment(this,inflater,container);
}
//你想给哪个控件添加添加事件的id
//Doyouwanttoaddaddeventidtowhichcontrols
@FmyClickView({R.id.tv1,R.id.tv2})
publicvoidmyOnclick(Viewview){
switch(view.getId()){
caseR.id.tv1:
tv1.setText("TV1"+Math.random()100);
break;
caseR.id.tv2:
tv2.setText("TV2"+Math.random()100);
break;
default:
}
}
}
Activity
packagea.fmy.com.myapplication;
importandroid.os.Bundle;
importandroid.support.v4.app.FragmentTransaction;
importandroid.support.v7.app.AppCompatActivity;
importandroid.widget.FrameLayout;
importa.fmy.com.mylibrary.FmyContentView;
importa.fmy.com.mylibrary.FmyViewInject;
importa.fmy.com.mylibrary.FmyViewView;
@FmyContentView(R.layout.activity_main)
publicclassMainActivityextendsAppCompatActivity{
@FmyViewView(R.id.fl)
FrameLayoutfl;
@Override
protectedvoidonCreate(BundlesavedInstanceState){
super.onCreate(savedInstanceState);
//initActivity
//初始化activity
FmyViewInject.inject(this);
}
@Override
protectedvoidonResume(){
super.onResume();
FragmentTransactionfragmentTransaction=getSupportFragmentManager().beginTransaction();
fragmentTransaction.add(R.id.fl,newBlankFragment());
fragmentTransaction.commit();
}
}
java注解学习
要深入学习注解，我们就必须能定义自己的注解，并使用注解，在定义自己的注解之前，我们就必须要了解Java为我们提供的元注解和相关定义注解的语法。
元注解：
元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它annotation类型作说明。Java5.0定义的元注解：
1.@Target,
2.@Retention,
3.@Documented,
4.@Inherited
这些类型和它们所支持的类在java.lang.annotation包中可以找到。下面我们看一下每个元注解的作用和相应分参数的使用说明。
@Target：
@Target说明了Annotation所修饰的对象范围：Annotation可被用于packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。
作用：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）
取值(ElementType)有：
1.CONSTRUCTOR:用于描述构造器
2.FIELD:用于描述域
3.LOCAL_VARIABLE:用于描述局部变量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述参数
7.TYPE:用于描述类、接口(包括注解类型)或enum声明
使用实例：
复制代码
@Target(ElementType.TYPE)
public@interfaceTable{
/
数据表名称注解，默认值为类名称
@return
/
publicStringtableName()default"className";
}
@Target(ElementType.FIELD)
public@interfaceNoDBColumn{
}
复制代码
注解Table可以用于注解类、接口(包括注解类型)或enum声明,而注解NoDBColumn仅可用于注解类的成员变量。
@Retention：
@Retention定义了该Annotation被保留的时间长短：某些Annotation仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。使用这个meta-Annotation可以对Annotation的“生命周期”限制。
作用：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效）
取值（RetentionPoicy）有：
1.SOURCE:在源文件中有效（即源文件保留）
2.CLASS:在class文件中有效（即class保留）
3.RUNTIME:在运行时有效（即运行时保留）
Retentionmeta-annotation类型有唯一的value作为成员，它的取值来自java.lang.annotation.RetentionPolicy的枚举类型值。具体实例如下：
复制代码
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public@interfaceColumn{
publicStringname()default"fieldName";
publicStringsetFuncName()default"setField";
publicStringgetFuncName()default"getField";
publicbooleandefaultDBValue()defaultfalse;
}
复制代码
Column注解的的RetentionPolicy的属性值是RUTIME,这样注解处理器可以通过反射，获取到该注解的属性值，从而去做一些运行时的逻辑处理
@Documented:
@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。
复制代码
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public@interfaceColumn{
publicStringname()default"fieldName";
publicStringsetFuncName()default"setField";
publicStringgetFuncName()default"getField";
publicbooleandefaultDBValue()defaultfalse;
}
复制代码
@Inherited：
@Inherited元注解是一个标记注解，@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类。
注意：@Inheritedannotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation，方法并不从它所重载的方法继承annotation。
当@Inheritedannotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME，则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inheritedannotation类型的annotation时，反射代码检查将展开工作：检查class和其父类，直到发现指定的annotation类型被发现，或者到达类继承结构的顶层。
实例代码：
复制代码
/
@authorpeida
/
@Inherited
public@interfaceGreeting{
publicenumFontColor{BULE,RED,GREEN};
Stringname();
FontColorfontColor()defaultFontColor.GREEN;
}
复制代码
自定义注解：
使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。
定义注解格式：
public@interface注解名{定义体}
注解参数的可支持数据类型：
1.所有基本数据类型（int,float,boolean,byte,double,char,long,short)
2.String类型
3.Class类型
4.enum类型
5.Annotation类型
6.以上所有类型的数组
Annotation类型里面的参数该怎么设定:
第一,只能用public或默认(default)这两个访问权修饰.例如,Stringvalue();这里把方法设为defaul默认类型；
第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,Stringvalue();这里的参数成员就为String;
第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号.例:下面的例子FruitName注解就只有一个参数成员。
简单的自定义注解和使用注解实例：
复制代码
packageannotation;
importjava.lang.annotation.Documented;
importjava.lang.annotation.ElementType;
importjava.lang.annotation.Retention;
importjava.lang.annotation.RetentionPolicy;
importjava.lang.annotation.Target;
/
水果名称注解
@authorpeida
/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public@interfaceFruitName{
Stringvalue()default"";
}
复制代码
复制代码
packageannotation;
importjava.lang.annotation.Documented;
importjava.lang.annotation.ElementType;
importjava.lang.annotation.Retention;
importjava.lang.annotation.RetentionPolicy;
importjava.lang.annotation.Target;
/
水果颜色注解
@authorpeida
/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public@interfaceFruitColor{
/
颜色枚举
@authorpeida
/
publicenumColor{BULE,RED,GREEN};
/
颜色属性
@return
/
ColorfruitColor()defaultColor.GREEN;
}
复制代码
复制代码
packageannotation;
importannotation.FruitColor.Color;
publicclassApple{
@FruitName("Apple")
privateStringappleName;
@FruitColor(fruitColor=Color.RED)
privateStringappleColor;
publicvoidsetAppleColor(StringappleColor){
this.appleColor=appleColor;
}
publicStringgetAppleColor(){
returnappleColor;
}
publicvoidsetAppleName(StringappleName){
this.appleName=appleName;
}
publicStringgetAppleName(){
returnappleName;
}
publicvoiddisplayName(){
System.out.println("水果的名字是：苹果");
}
}
复制代码
注解元素的默认值：
注解元素必须有确定的值，要么在定义注解的默认值中指定，要么在使用注解时指定，非基本类型的注解元素的值不可为null。因此,使用空字符串或0作为默认值是一种常用的做法。这个约束使得处理器很难表现一个元素的存在或缺失的状态，因为每个注解的声明中，所有元素都存在，并且都具有相应的值，为了绕开这个约束，我们只能定义一些特殊的值，例如空字符串或者负数，一次表示某个元素不存在，在定义注解时，这已经成为一个习惯用法。例如：
复制代码
1packageannotation;
2
3importjava.lang.annotation.Documented;
4importjava.lang.annotation.ElementType;
5importjava.lang.annotation.Retention;
6importjava.lang.annotation.RetentionPolicy;
7importjava.lang.annotation.Target;
8
9/
10水果供应者注解
11@authorpeida
12
13/
14@Target(ElementType.FIELD)
15@Retention(RetentionPolicy.RUNTIME)
16@Documented
17public@interfaceFruitProvider{
18/
19供应商编号
20@return
21/
22publicintid()default-1;
23
24/
25供应商名称
26@return
27/
28publicStringname()default"";
29
30/
31供应商地址
32@return
33/
34publicStringaddress()default"";
35}
复制代码
activity设置填充布局框架
这里我们先写一个用于activity框架你学习完了之后其实你也会fragment了.
1.实现activity不需要调用setContentView(R.layout.activity_main);此方法完成布局填充我们看下效果
不使用框架:
packagea.fmy.com.mylibrary;
importandroid.support.v7.app.AppCompatActivity;
importandroid.os.Bundle;
publicclassMainActivityextendsAppCompatActivity{
@Override
protectedvoidonCreate(BundlesavedInstanceState){
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
}
}
使用框架:
packagea.fmy.com.mylibrary;
importandroid.support.v7.app.AppCompatActivity;
importandroid.os.Bundle;
@FmyContentView(R.layout.activity_main)
publicclassMainActivityextendsAppCompatActivity{
@Override
protectedvoidonCreate(BundlesavedInstanceState){
super.onCreate(savedInstanceState);
FmyViewInject.inject(this);
}
}
第一步:
创建一个注解类如下
@Target—>>此注解在什么地方可以使用如类还是变量
ElementType.TYPE只能在类中使用此注解
@Retention(RetentionPolicy.RUNTIME)注解可以在运行时通过反射获取一些信息(这里如果你疑惑那么请六个悬念继续向下看)
/
此方注解写于activity类上可以免去setContentView()步骤
@author范明毅
@version1.0
/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public@interfaceFmyContentView{
/
保存布局文件的ideg:R.layout.main
@return返回布局id
/
intvalue();
}
第二步:
写一个工具类配合注解使用当开发者使用此类时激活注解的作用
publicclassFmyViewInject{
/
保存传入的activity
/
privatestaticClassactivityClass;
/
初始化activity和所有注解
@paramobj
你需要初始化的activity
/
publicstaticvoidinject(Objectobj){
}
/
初始化activity布局文件让其不用调用setContentView
@paramactivity
/
privatestaticvoidinjectContent(Objectobj){
}
}
大家先不用着急看不懂为什么这样写原因
核心源码位于injectContent我们来实现此方法
/
初始化activity布局文件让其不用调用setContentView
@paramactivity
/
privatestaticvoidinjectContent(Objectobj){
//获取注解
FmyContentViewannotation=activityClass
.getAnnotation(FmyContentView.class);
if(annotation!=null){
//获取注解中的对应的布局id因为注解只有个方法所以@XXX(YYY)时会自动赋值给注解类唯一的方法
intid=annotation.value();
try{
//得到activity中的方法第一个参数为方法名第二个为可变参数类型为参数类型的字节码
Methodmethod=activityClass.getMethod("setContentView",
int.class);
//调用方法第一个参数为哪个实例去掉用第二个参数为参数
method.www.shanxiwang.netinvoke(obj,id);
}catch(Exceptione){
e.printStackTrace();
}
}
此方法写完后工具类的inject()方法调用即可
/
初始化activity和所有注解
@paramobj
你需要初始化的activity
/
publicstaticvoidinject(Objectobj){
activityClass=obj.getClass();
//初始化activity布局文件
injectContent(obj);
}
完整代码:
publicclassFmyViewInject{
/
保存传入的activity
/
privatestaticClassactivityClass;
/
初始化activity和所有注解
@paramobj
你需要初始化的activity
/
publicstaticvoidinject(Objectobj){
activityClass=obj.getClass();
//初始化activity布局文件
injectContent(obj);
}
/
初始化activity布局文件让其不用调用setContentView
@paramactivity
/
privatestaticvoidinjectContent(Objectobj){
//获取注解
FmyContentViewannotation=activityClass
.getAnnotation(FmyContentView.class);
if(annotation!=null){
//获取注解中的对应的布局id因为注解只有个方法所以@XXX(YYY)时会自动赋值给注解类唯一的方法
intid=annotation.value();
try{
//得到activity中的方法第一个参数为方法名第二个为可变参数类型为参数类型的字节码
Methodmethod=activityClass.getMethod("setContentView",
int.class);
//调用方法第一个参数为哪个实例去掉用第二个参数为参数
method.invoke(obj,id);
}catch(Exceptione){
e.printStackTrace();
}
}
}
赶快去试试我们继续写下一步用法在开始的示例有
activity查找控件
效果如下
@FmyContentView(R.layout.activity_main)
publicclassMainActivityextendsFragmentActivity{
//直接实例化
@FmyViewView(R.id.fl)
privateFrameLayoutfl;
@Override
protectedvoidonCreate(BundlesavedInstanceState){
super.onCreate(savedInstanceState);
FmyViewInject.inject(this);
}
}
第一步:
继续写一个注解
/
此方注解写于activity类中控件变量上可以省去findViewId的烦恼
@author范明毅
@version1.0
/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public@interfaceFmyViewView{
/
保存view控件的id
@returnview控件id
/
intvalue();
}
第二步继续第一节的”activity设置填充布局框架”中的工具类添加新的方法
/
初始化activity中的所有view控件让其不用一个findViewid实例化
@paramactivity
/
privatestaticvoidinjectView(ObjectactivityOrFragment){
//对象所有的属性
Field[]declaredFields=null;
//健壮性
if(activityClass!=null){
//获取du所有的属性包含私有保护默认共开但不包含继承等
//getFields可以获取到所有公开的包括继承的但无法获取到私有的属性
declaredFields=activityClass.getDeclaredFields();
}
//健壮性
if(declaredFields!=null){
//遍历所有的属性变量
for(Fieldfield:declaredFields){
//获取属性变量上的注解
FmyViewViewannotation=field.getAnnotation(FmyViewView.class);
//如果此属性变量包含FMYViewView
if(annotation!=null){
//获取属性id值
intid=annotation.value();
Objectobj=null;
try{
//获取activity中方法
obj=activityClass.getMethod("findViewById",
int.class).invoke(activityOrFragment,id);
Log.e("FMY",""+field.getClass());
//设置属性变量指向实例
//如果修饰符不为公共类这里注意了当activity
//控件变量为private的时候我们去访问会失败的要么打破封装系要么变量改为public
//如privateTextViewtv这种情况如果不打破封装会直接异常
if(Modifier.PUBLIC!=field.getModifiers()){
//打破封装性
field.setAccessible(true);
}
//这里相当于field=acitivity.obj
field.set(activityOrFragment,obj);
}catch(Exceptione){
//TODOAuto-generatedcatchblock
e.printStackTrace();
}
}
}
}
}
第三步
在工具类中的inject()方法调用
/
初始化activity和所有注解
@paramobj你需要初始化的activity
/
publicstaticvoidinject(Objectobj){
activityClass=obj.getClass();
//初始化activity布局文件
injectContent(obj);
//初始化所有控件实例省去findViewId的痛苦
injectView(obj);
}
activity设置控件的点击事件
这里需要的知识点如动态代理等这里大家可以自己百度看下
效果如下
@FmyContentView(R.layout.activity_main)
publicclassMainActivityextendsFragmentActivity{
@FmyViewView(R.id.fl)
privateFrameLayoutfl;
@Override
protectedvoidonCreate(BundlesavedInstanceState){
super.onCreate(savedInstanceState);
FmyViewInject.inject(this);
}
//当填充的布局中id为R.id.fl被点击将调用如下方法
@FmyClickView({R.id.fl})
publicvoidonClick(Viewv){
Log.e("fmy","===>>");
}
}
第一步:
同样写下一个注解
/
设置点击事件的注解只需要在某方法上写上此注解即可如@FmyClickView({R.id.bt1,R.id.bt2})
@version1.0
@author范明毅
/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public@interfaceFmyClickView{
/
保存所有需要设置点击事件控件的id
@return
/
int[]value();
}
第二步:
写下一个代理处理类(我写在工具类中)
/
代理处理点击逻辑代码
@author范明毅
/
staticclassMInvocationHandlerimplementsInvocationHandler{
//这里我们到时候回传入activity
privateObjecttarget;
//用户自定义view的点击事件方法
privateMethodmethod;
publicMInvocationHandler(Objecttarget,java.lang.reflect.Methodmethod){
super();
this.target=target;
this.method=method;
}
@Override
publicObjectinvoke(Objectproxy,Methodmethod,Object[]args)
throwsThrowable{
//调用用户自定义方法的点击事件让activity调用中开发者设定的方法
returnthis.method.invoke(target,args);
}
}
第三步:
在工具类中写下一个方法用于初始化点击事件
/
初始化所有控件的点击事件只需要某方法上写上对应注解和id即可
@paramactivity
/
privatestaticvoidinijectOnClick(ObjectactivityOrFragment){
//获得所有方法
Method[]methods=null;
methods=activityClass.getMethods();
//遍历所有的activity下的方法
for(Methodmethod:methods){
//获取方法的注解
FmyClickViewfmyClickView=method
.getAnnotation(FmyClickView.class);
//如果存在此注解
if(fmyClickView!=null){
//所有注解的控件的id
int[]ids=fmyClickView.value();
//代理处理类
MInvocationHandlerhandler=newMInvocationHandler(activityOrFragment,
method);
//代理实例这里也可以返回newClass[]{View.OnClickListener.class}中的接口类
//第一个参数用于加载其他类不一定要使用View.OnClickListener.class.getClassLoader()你可以使用其他的
//第二个参数你所实现的接口
ObjectnewProxyInstance=Proxy.newProxyInstance(
View.OnClickListener.class.getClassLoader(),
newClass[]{View.OnClickListener.class},handler);
//遍历所有的控件id然后设置代理
for(inti:ids){
try{
Objectview=null;
//如果对象是activity
view=activityClass.getMethod("findViewById",
int.class).invoke(activityOrFragment,i);
if(view!=null){
Methodmethod2=view.getClass().getMethod(
"setOnClickListener",
View.OnClickListener.class);
method2.invoke(view,newProxyInstance);
}
}catch(Exceptione){
e.printStackTrace();
}
}
}
}
}
第四部:
在工具类的inject()调用即可
/
初始化activity和所有注解
@paramobj
你需要初始化的activity
/
publicstaticvoidinject(Objectobj){
activityClass=obj.getClass();
//初始化activity布局文件
injectContent(obj);
//初始化所有控件实例省去findViewId的痛苦
injectView(obj);
//初始化所有控件的点击事件
inijectOnClick(obj);
}
|
|
