自定义注解

最新推荐文章于 2025-03-18 20:43:35 发布

飞天德007

最新推荐文章于 2025-03-18 20:43:35 发布

阅读量276

点赞数 1

分类专栏：安卓基础

安卓基础专栏收录该内容

13 篇文章

订阅专栏

本文详细介绍了Java元注解的工作原理及其应用场景，重点解释了@Target、@Retention、@Documented和@Inherited四种元注解的作用，并通过一个自定义ViewUtils框架示例展示了如何利用元注解实现视图绑定和点击事件处理。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

原理

运行时通过元注解获取到传递的值，然后通过反射来实现对应的逻辑。

元注解相关语法

定义：Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。
注解不会也不能影响代码的实际逻辑，仅仅起到辅助性的作用。包含在 java.lang.annotation 包中。
元注解的作用就是负责注解其他注解。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声明
　@Retention：

　　@Retention定义了该Annotation被保留的时间长短：某些Annotation仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。

　　作用：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效）

　　取值（RetentionPoicy）有：

　　　　1.SOURCE:在源文件中有效（即源文件保留）
　　　　2.CLASS:在class文件中有效（即class保留）
　　　　3.RUNTIME:在运行时有效（即运行时保留）
　　　　
@Documented:

　　@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。

　@Inherited：

　　@Inherited 元注解是一个标记注解，@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类。

　　注意：@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation，方法并不从它所重载的方法继承annotation。

　　当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME，则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时，反射代码检查将展开工作：检查class和其父类，直到发现指定的annotation类型被发现，或者到达类继承结构的顶层。

代码示例
自定义ViewUtils框架，类似Butterknife。

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface OnClick {

    int value();

}

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

}

public class ViewUtils {

    public static void inject(Activity activity){

        /*
         * 获取字节码
         */
        Class<Activity> clazz = (Class<Activity>) activity.getClass();
        bindView(activity, clazz);
        bindMethod(activity, clazz);
    }
    //绑定点击事件
    private static void bindMethod(final Activity activity, Class<Activity> clazz) {
        /*
         * 获取所有方法
         */
        Method[] methods = clazz.getDeclaredMethods();
        for(final Method method : methods){
            /*
             * 获取方法上的自定义注解
             */
            OnClick onClick = method.getAnnotation(OnClick.class);
            if (onClick!=null) {
                /*
                 * 获取id
                 */
                int resId = onClick.value();
                /*
                 * 根据id找到指定的控件
                 */
                final View view = activity.findViewById(resId);//其实就是Button对象
                /*
                 * 给View绑定点击监听事件
                 */
                view.setOnClickListener(new OnClickListener() {

                    @Override
                    public void onClick(View v) {
//                      System.out.println("我被点击了："+v);
                        //通过反射调用用户想调用的方法
                        method.setAccessible(true);//暴力反射
                        try {
                            method.invoke(activity, view);
                        } catch (Exception e) {
                            e.printStackTrace();
                        }
                    }
                });
            }

        }

    }
    //绑定View
    private static void bindView(Activity activity, Class<Activity> clazz) {
        /*
         * 获取字节码中所有的字段
         */
        Field[] fields = clazz.getDeclaredFields();
        for(Field field : fields){
            /*
             * 获取field上的注解
             */
            ViewInject viewInject = field.getAnnotation(ViewInject.class);
            if (viewInject!=null) {
                /*
                 * 获取注解中的值（id 资源的id）
                 */
                int resId = viewInject.value();
                /*
                 * 通过Activity的findViewById查找控件
                 */
                View view = activity.findViewById(resId);
                /*
                 * 把这个控件设置（注入）给当前的字段
                 */
                field.setAccessible(true);

                try {
                    field.set(activity, view);
                } catch (Exception e) {
                    e.printStackTrace();
                }

            }
        }
    }

}

使用

public class MainActivity extends Activity {

    @ViewInject(R.id.tv_xxxx)
    private TextView tv;

    @ViewInject(R.id.tv_yyy)
    private TextView tvy;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        ViewUtils.inject(this);

        Log.d("tag", "tv="+tv);
        Log.d("tag", "tvy="+tvy);


        Toast.makeText(this, "tv="+tv, Toast.LENGTH_LONG).show();
    }
    @OnClick(R.id.btn)
    private void method1(View view){
        Toast.makeText(this, "我被点击了", Toast.LENGTH_SHORT).show();
    }

}

布局文件activity_main.xml

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
   android:orientation="vertical"
    android:layout_width="match_parent"
    android:layout_height="match_parent" >

    <TextView
        android:id="@+id/tv_xxxx"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="@string/hello_world" />
     <TextView
        android:id="@+id/tv_yyy"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="@string/hello_world" />

     <Button 
         android:id="@+id/btn"
         android:layout_width="match_parent"
         android:layout_height="wrap_content"
         android:text="点击我"
         />

</LinearLayout>