【Android】Android自定义注解——利用Java的Annotation

Github地址:Github

其实Android开发的时候,每次都要写什么findViewById之类的挺烦的,所以如果可以直接用注解的方式最好。
先直接上效果:

@ContentView(value = R.layout.activity_main)
public class MainActivity extends BaseActivity {
    super.onCreate(savedInstanceState);
    Injection.inject(this);

    @BindView(value = R.id.button1)
    Button button1;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
    }

    @OnClick(value = R.id.button1)
    public void button1Click(View view) {
        Toast.makeText(MainActivity.this, "button1 clicked", Toast.LENGTH_LONG).show();
    }
}

可以看见非常的简洁,本文用Java的Annontation会用到反射,影响效率,显然不是最好的解决方法,只是起到一个学习的作用而已。

Annontation是Java5引入的,即注解。
用处主要在于:
1、生成文档,比如@param @return
2、起到检查的作用,比如@Override
3、依赖配置。

定义注解的时候使用关键字@interface,这个不是interface,而是定义注解类的关键字。注解本质是一个继承了Annotation的特殊接口,其具体实现类是Java运行时生成的动态代理类。

一、元注解

java.lang.annotation提供了四种元注解,专门注解其他的注解(在自定义注解的时候,需要使用到元注解):
1、@Documented –注解是否将包含在JavaDoc中。
2、@Retention –什么时候使用该注解。
值以及含义如下:

含义
RetentionPolicy.SOURCE 在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义,所以它们不会写入字节码。
RetentionPolicy.CLASS 在类加载的时候丢弃。在字节码文件的处理中有用。
RetentionPolicy.RUNTIME 始终不会丢弃,运行期也保留该注解,因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。

3、@Target – 表示该注解用于什么地方。默认值为任何元素。
值以及含义如下:

含义
ElementType.CONSTRUCTOR 用于描述构造器。
ElementType.FIELD 成员变量、对象、属性(包括enum实例)。
ElementType.LOCAL_VARIABLE 用于描述局部变量。
ElementType.METHOD 用于描述方法。
ElementType.PACKAGE 用于描述包。
ElementType.PARAMETER 用于描述参数。
ElementType.TYPE 用于描述类、接口(包括注解类型) 或enum声明。

4、@Inherited - 定义该注释和子类的关系
@Inherited 元注解是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。

二、常见的注解

1、Override
java.lang.Override是一个标记类型注解,它被用作标注方法。能起到检查的作用,编译器会检查是否覆盖了父类的方法,如果没有覆盖的话会报错。
2、Deprecated
过时的方法或者成员。
3、SuppressWarnings
抑制警告。它有一个类型为String[]的成员,这个成员的值为被禁止的警告名。

三、自定义注解

介绍了Java的Annontation的一些知识之后,开始自定义我们的注解。首先先说下总体思路:
自定义注解类, 具体的注解解析类里面实现注解解释,通过反射拿到对应的类,然后通过getFields和getMethods遍历方法进行动态注入。

有个比较重要的方法getAnnotation,这个是尝试获得对应的注释。

1、findViewById 注解BindView实现

使用如下,需要能解析成 Button button1 = (Button)findViewById(R.id.button1);

@BindView(value = R.id.button1)
Button button1;

首先,定义注解。新建BindView类,实现如下:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface BindView {
    int value () default 0;
}

解释一下含义:
(1)Retention指定运行时使用注解。
(2)Target指定注解对象是成员。
(3)value指定注解参数,默认值为0。

注解的具体实现。新建一个Injection类,然后添加一个inject方法用以解析注解。

public class Injection {
    public static void inject(Object object) {
        bindView(object);
    }
}

bindView方法即用来解释BindView,实现思路为先通过object.getClass()拿到类,然后getFields()拿到类的所有成员,进行遍历,getAnnotation可以拿到注解,如果有BindView注解,则将value值拿出来并将((Activity)object).findViewById(id))赋值给现在的成员。具体代码如下:

private static void bindView(Object object) {
    Class cls = object.getClass();
    Field[] fields = cls.getFields(); //得到所有成员
    for(Field field : fields) {
        BindView bindView = field.getAnnotation(BindView.class);
        if(bindView != null && bindView.value() != 0) {
            int id = bindView.value();
            try {
                field.setAccessible(true);
                if(object instanceof Activity) {
                    field.set(object, ((Activity)object).findViewById(id));
                }
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }
        }
    }
}

同时需要在MainActivity加载的时候调用inject函数并将this传入。

Injection.inject(this);

2、setOnClickListener注解OnClick实现。

效果如下:

@OnClick(value = R.id.button1)
public void button1Click(View view) {
    Toast.makeText(MainActivity.this, "button1 clicked", Toast.LENGTH_LONG).show();
}

首先,还是自定义注解类。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface OnClick {
    int value() default 0;
}

和上面不同的是这个注解是作用在方法上的,所以Target的值是ElementType.METHOD。

同时,在方法inject中加入。

public class Injection {
    public static void inject(Object object) {
        bindView(object);
        onClick(object);
    }
}

onClick方法的实现即要将注解的方法添加到对应的控件上,因此思路上首先需要先找到所有有这个注解的方法。通过object.getClass().getMethods()获得所有方法,然后进行遍历如果发现有OnClick注解的,将注解的value拿出来,然后通过findViewById(id)拿到View,然后调用view.setOnClickListener,在重写onClick由于需要运行现在的方法,因此用调用method.invoke(object, view),第一个是类,第二个是参数。

具体代码如下:

private static void onClick(final Object object) {
    Class cls = object.getClass();

    Method[] methods = cls.getMethods();
    for(final Method method : methods) {
        OnClick onClick = method.getAnnotation(OnClick.class);
        if (onClick != null && onClick.value() != 0) {
            int id = onClick.value();
            View view = null;
            if (object instanceof Activity) {
                view = ((Activity)object).findViewById(id);
                if (view != null) {
                    view.setOnClickListener(new View.OnClickListener() {
                        @Override
                        public void onClick(View view) {
                            try {
                                method.invoke(object, view);
                            } catch (IllegalAccessException e) {
                                e.printStackTrace();
                            } catch (InvocationTargetException e) {
                                e.printStackTrace();
                            }

                        }
                    });
                }
            }
        }
    }
}

3、setContentView的注解ContentView的实现。

效果如下:

@ContentView(value = R.layout.activity_main)
public class MainActivity extends BaseActivity {
    super.onCreate(savedInstanceState);
    Injection.inject(this);
}

首先,还是定义一个注解类。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface ContentView {
    int value() default 0;
}

作用在类上,因此Target值为ElementType.TYPE。
同样的,加入inject中,注意,这个需要是最先被执行的,因为后面有findViewById,所以页面必选先加载,所以最先执行解释处理。

public class Injection {
    public static void inject(Object object) {
        contentView(object);
        bindView(object);
        onClick(object);
    }
}

contentView实现其实就是执行了一下setContentView。实现如下:

private static void contentView(Object object) {
    Class cls = object.getClass();
    ContentView contentView = (ContentView)cls.getAnnotation(ContentView.class);
    if (object instanceof Activity) {
        int id = contentView.value();
        if (id != 0) {
            ((Activity)object).setContentView(id);
        }
    }
}

4、再稍微进一步

每次新建个Activity都要写一句Injection.inject(this)其实挺麻烦的,所以,我们自己新建一个BaseActivity,在里面执行这个,然后以后的Activity都继承自这个,也便于管理。

public class BaseActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        Injection.inject(this);
    }
}

总的来说,这种通过Java反射机制的方法自定义注解虽然实现起来简单,但是在Android中反射效率低,对性能影响比较大,所以只是适合学习一种思路,不适合在Android中用来自定义注解。

你可能感兴趣的:(【Android】Android自定义注解——利用Java的Annotation)