android 简单自定义注解

时间:2021-11-11 15:57:21

参考自:
http://www.cnblogs.com/peida/archive/2013/04/26/3038503.html
http://www.cnblogs.com/whoislcj/p/5671622.html
http://blog.csdn.net/lylwo317/article/details/52163304(强烈推荐)
项目中之前的代码有自定义注解,就简单的学习了一下,有很多我也不会,先记录一下,以后再慢慢学习吧
元注解:
java.lang.annotation提供了四种元注解,专门注解其他的注解(在自定义注解的时候,需要使用到元注解)

  • @Documented –注解是否将包含在JavaDoc中
  • @Retention –什么时候使用该注解
  • @Target –注解用于什么地方
  • @Inherited – 是否允许子类继承该注解

主要来认识下@Retention ,其它的我也没太了解,本例也没有用到,详见参考链接

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

自定义注解类编写的一些规则:
1. Annotation型定义为@interface, 所有的Annotation会自动继承java.lang.Annotation这一接口,并且不能再去继承别的类或是接口.
2. 参数成员只能用public或默认(default)这两个访问权修饰
3. 参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和String、Enum、Class、annotations等数据类型,以及这一些类型的数组.
4. 要获取类方法和字段的注解信息,必须通过Java的反射技术来获取 Annotation对象,因为你除此之外没有别的获取注解对象的方法
5. 自定义注解需要使用到元注解

eg:

@Retention(RetentionPolicy.RUNTIME)
public @interface ViewInject {
    int value();

    //false为默认值
    boolean click() default false;
}

Activity代码:只有竖直方向的两个TextView

public class InjectActivity extends AppCompatActivity implements View.OnClickListener {
    @ViewInject(value = R.id.tv_can_click, click = true)
    TextView tvCanClick;
    @ViewInject(value = R.id.tv_can_not_click)
    TextView tvCanNotClick;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_inject);
        ViewInjectUtil.inject(this, null);
        tvCanClick.setText("我是可点击的 已被find");
        tvCanNotClick.setText("我是不可点击的 已被find");
    }

    @Override
    public void onClick(View v) {
        Toast.makeText(this, "我被点击了", Toast.LENGTH_LONG).show();
    }
}

ViewInjectUtil


public class ViewInjectUtil {
    public static void inject(Object obj, View view) {
        //获得某个类的所有的公共(public)的字段,包括父类中的字段
        Field[] fields = obj.getClass().getFields();
        //遍历类中公共字段
        for (Field field : fields) {
            field.setAccessible(true);
            //如果指定类型的注解存在于此元素上,则返回 true,否则返回 false。
            if (field.isAnnotationPresent(ViewInject.class)) {
                //该元素如果存在指定类型的注解,则返回这些注解,否则返回 null。
                ViewInject annotation = field.getAnnotation(ViewInject.class);
                //获得此元素的值
                int viewId = annotation.value();
                boolean canClick = annotation.click();
                try {
                    field.set(obj, view == null ? ((Activity) obj).findViewById(viewId) : view.findViewById(viewId));
                    //设置点击监听时需要注意,需让Activity/Fragment/ViewHolder实现OnClickListener接口
                    if (canClick) {
                        //view为null,指在Activity中,若在ViewHolder、fragment中可用ViewInjectUtil.inject(this, view);
                        if (view == null) {
                            ((Activity)obj).findViewById(viewId).setOnClickListener((View.OnClickListener) obj);
                        }else{
                            view.findViewById(viewId).setOnClickListener((View.OnClickListener) obj);
                        }
                    }
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
            }
        }
    }
}

运行后:tvCanClick、tvCanNotClick上文字均改变,且由于tvCanClick上注解click 的 值为true为可点击的

代码地址