Android Annotation(注解),简化View控件的初始化操作。

转载请注明出处:http://blog.csdn.net/bbld_/article/details/38585385


概述:

在有Activity、Fragment的地方基本上我们少不了对一堆View控件的初始化操作,像findViewById、setOnXXXListener等等。这篇文章就是利用Java的Annotation注解、反射来解决这个问题,使对View控件的初始化操作变得简单明了一些。所以读这篇文章应对Java的Annotation(注解)和反射有所了解。当然解决这类问题大多的框架一般都是必不可少的,这里只不过是我用自己的方式去实现它。


思路:

我们知道一般对View控件的初始化时要:找到id即findViewById、然后可以是对其做监听setOnXXXListener。所以我们可以利用注解可以在View定义时给它注入id值和监听的类(Class),然后通过反射来获得View的注解再从注解里获得里面的id和监听的类(Class),因而就可以再通过反射把注解里的值处理一下后对View进行初始化了。


实现过程:

首先定义一个含有不同View控件的布局:

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:gravity="center|top"
    android:layoutAnimation="@anim/layout_random_fade"
    android:orientation="vertical" >

    <LinearLayout
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:orientation="horizontal" >

        <Button
            android:id="@+id/button1"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="btn1" />

        <Button
            android:id="@+id/button2"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="btn2" />

        <CheckBox
            android:id="@+id/checkBox1"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="ckBox" />

        <ToggleButton
            android:id="@+id/toggleButton1"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="ToggleButton" />

        <ToggleButton
            android:id="@+id/toggleButton2"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="ToggleButton" />
    </LinearLayout>

    <Spinner
        android:id="@+id/spinner1"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginTop="21dp"
        android:entries="@array/arrart_test" />

    <ListView
        android:id="@+id/listview"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content" >
    </ListView>

</LinearLayout>


然后就是Activity里的操作了:

package com.roc.annotation;

import android.app.Activity;
import android.os.Bundle;
import android.view.LayoutInflater;
import android.view.View;
import android.view.View.OnClickListener;
import android.view.View.OnLongClickListener;
import android.view.ViewGroup;
import android.widget.AdapterView;
import android.widget.AdapterView.OnItemClickListener;
import android.widget.AdapterView.OnItemLongClickListener;
import android.widget.AdapterView.OnItemSelectedListener;
import android.widget.BaseAdapter;
import android.widget.Button;
import android.widget.CheckBox;
import android.widget.CompoundButton;
import android.widget.ListView;
import android.widget.Spinner;
import android.widget.Toast;
import android.widget.ToggleButton;

import com.example.androidutils.R;

public class AnnotationTestActivity extends Activity implements OnClickListener, OnLongClickListener, OnItemClickListener,
		OnItemSelectedListener, android.widget.CompoundButton.OnCheckedChangeListener, OnItemLongClickListener
{
	// 注入需要初始化的内容:id为必填,监听和监听类根据需要填,都有默认值
	@InitView(id = { R.id.button1 }, onClickListener = true)
	private Button btn1, btn2;
	//ItitView注解的id设置为了数组,这样可以同时给定义在一起的控件一起初始化,避免一个个定义的麻烦
	@InitView(id = { R.id.toggleButton1, R.id.toggleButton2 }, onCompoundButtonCheckedChangeListener = true)
	private ToggleButton toggleButton1, toggleButton2;
	@InitView(id = R.id.listview, onItemClickListener = true, onItemLongClickListener = true)
	private ListView listView;
	@InitView(id = R.id.spinner1, onItemSelectedListener = true)
	private Spinner spinner;
	@InitView(id = R.id.checkBox1, onCompoundButtonCheckedChangeListener = true)
	private CheckBox checkBox;

	@Override
	protected void onCreate(Bundle savedInstanceState)
	{
		super.onCreate(savedInstanceState);
		setContentView(R.layout.activity_annotation);
		init();
	}

	private void init()
	{
		ViewInstaller.processAnnotation(this);
		listView.setAdapter(new MyAdapter());
	}

	@Override
	public void onClick(View v)
	{
		Toast.makeText(this, "onClick", 0).show();
		if (v.getId() == R.id.button2)
			Toast.makeText(this, "button2", 0).show();
	}

	@Override
	public boolean onLongClick(View v)
	{
		Toast.makeText(this, "onLongClick", 0).show();
		return false;
	}

	@Override
	public void onCheckedChanged(CompoundButton buttonView, boolean isChecked)
	{
		Toast.makeText(this, "CheckedChanged", 0).show();
		if (buttonView.getId() == R.id.toggleButton2)
			Toast.makeText(this, "toggleButton2", 0).show();

	}

	@Override
	public void onItemClick(AdapterView<?> parent, View view, int position, long id)
	{
		Toast.makeText(this, "item click", 0).show();
	}

	@Override
	public void onItemSelected(AdapterView<?> parent, View view, int position, long id)
	{
		Toast.makeText(this, "item select", 0).show();
	}

	@Override
	public void onNothingSelected(AdapterView<?> parent)
	{

	}

	@Override
	public boolean onItemLongClick(AdapterView<?> parent, View view, int position, long id)
	{
		Toast.makeText(this, "onItemLongClick", 0).show();
		return true;
	}

	private class MyAdapter extends BaseAdapter
	{

		@Override
		public int getCount()
		{
			return 2;
		}

		@Override
		public Object getItem(int position)
		{
			return null;
		}

		@Override
		public long getItemId(int position)
		{
			return 0;
		}

		@Override
		public View getView(int position, View convertView, ViewGroup parent)
		{
			convertView = LayoutInflater.from(AnnotationTestActivity.this).inflate(R.layout.notification_update, null);
			return convertView;
		}

	}

	private class MyOnItemSelectedListener implements OnItemSelectedListener
	{
		public MyOnItemSelectedListener()
		{

		}

		@Override
		public void onItemSelected(AdapterView<?> parent, View view, int position, long id)
		{
			Toast.makeText(AnnotationTestActivity.this, "MyOnItemSelectedListener onItemSelected", 0).show();
			System.out.println("MyOnItemSelectedListener onItemSelected");
		}

		@Override
		public void onNothingSelected(AdapterView<?> parent)
		{

		}

	}

}


这里的InitView是自定义的Annotation,他的源码说明在如下给出的代码。在Activity中的控件初始化操作就是:1、首先全局定义出控件; 2、其次给控件注入id值和是否监听和使用的监听类,后面的两个都有默认值,不设的话就会使用默认值去处理了;3、在OnCreate中调用51行处的处理方法。说到这里那么是否可以在局部变量里给控件注入呢,注入是可以的不过处理起来会比在全局变量里定义它麻烦很多,有这样处理的可以跟我说说。51行的ViewInstaller.processAnnotation(this);方法的说明在后面ViewInstaller类里的源码书名里。其它代码块都是一些listener的回调方法和ListView的适配器了,这里就不说明了。

自定义Annotation注解类(InitView):

package com.roc.annotation;

import java.lang.annotation.Annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * View控件的{@link Annotation}<br>
 * 使用范围为全局变量<br>
 * listenerClass一般使用默认值
 * 
 * @author Mr.Zheng
 * @date 2014年8月11日13:27:31
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.FIELD })//这里可以定义多个值
public @interface InitView
{
	/**
	 * View控件的id<br>
	 * 数量大于一个时如果有监听则全部使用同一个监听实例
	 */
	int[] id();

	/**
	 * 是否添加单击事件监听<br>
	 * {@link android.view.View.OnClickListener}
	 */
	boolean onClickListener() default false;

	/**
	 * 是否添加长按事件监听<br>
	 * {@link android.view.View.OnLongClickListener}
	 */
	boolean onLongClickListener() default false;

	/**
	 * 是否添加item点击事件监听<br>
	 * {@link android.widget.AdapterView.OnItemClickListener}
	 */
	boolean onItemClickListener() default false;

	/**
	 * 是否添加item长按事件监听<br>
	 * {@link android.widget.AdapterView.OnItemLongClickListener}
	 */
	boolean onItemLongClickListener() default false;

	/**
	 * 是否添加item选择事件监听<br>
	 * {@link android.widget.AdapterView.OnItemSelectedListener}
	 */
	boolean onItemSelectedListener() default false;

	/**
	 * 是否添加{@link android.widget.CompoundButton}的item选择改变时的事件监听<br>
	 * CompoundButton: CheckBox、RadioButton,、Switch、ToggleButton<br>
	 * 
	 * @see {@link android.widget.CheckBox}<br>
	 *      {@link android.widget.RadioButton}<br>
	 *      {@link android.widget.Switch}<br>
	 *      {@link android.widget.ToggleButton}<br>
	 * <br>
	 */
	boolean onCompoundButtonCheckedChangeListener() default false;

	/**
	 * 是否添加{@link android.widget.RadioGroup}的item选择改变时的事件监听<br>
	 * RadioGroup:RadioGroup
	 */
	boolean onRadioGroupCheckedChangeListener() default false;

	/**
	 * 监听器所在类,默认值为{@link #InitView}.class,即默认将 {@link
	 * ViewInstaller.processAnnotation(Object obj)} 中的obj对象作为listener监听器实例对象<br>
	 * 推荐使用默认值的方法<br>
	 * eg:<br>
	 * 1:使用默认值 <br>
	 * 2:使用内部类(可以是静态内部类)时要求监听类有构造方法且为public所修饰,否则会抛出异常<br>
	 * 3:使用一般类,无特殊要求
	 * 
	 * @bug 使用内部类做监听时,且做了多个动作监听,目前需要把监听回调方法都放在一个listenerClass里
	 * @see ViewInstaller
	 */
	Class listenerClass() default InitView.class;
}

自定义Annotation类里主要分3部分:1、id,设置为数组,当View控件定义声明在一起时可以一起处理;2、是否添加的一些监听类,默认值都为fasle,大家应该判别控件是否支持设置你设为true的监听listener),否则不支持哪个监听事件的话InstallView里会抛异常。3、View控件的监听类,即要new出来的设置给控件setxxxListener的类,默认值为InitView.class时即使用ViewInstaller.processAnnotation(this);传进的Object对象,在本例中this就是AnnotationTestActivity。

注解处理:

这部分就是最关键的部分了,源码分析如下:

package com.roc.annotation;

import java.lang.reflect.Field;

import android.app.Activity;
import android.view.View;
import android.widget.AdapterView;
import android.widget.CompoundButton;
import android.widget.RadioGroup;

/**
 * 为带InitView注解的View控件初始化并设置监听器的加载器<br>
 * 主要方法: {@link #processAnnotation(Object obj)}
 * 
 * @author Mr.Zheng
 * @date 2014年8月11日21:59:01
 */
public class ViewInstaller
{
	/**
	 * 初始化控件,处理View控件的Annotation注解
	 * 
	 * @param obj
	 *            Object实例对象 其或父类应有findViewById方法
	 */
	public static void processAnnotation(Object obj)
	{
		int[] viewIds = null; // 当前Field注解的id值
		int fieldCur = 0; // 记录、判断有多个控件在一起声明时,field对应的控件id值,像 Button btn1, btn2。
		View view = null; // 控件
		InitView initView = null; // InitView注解
		try
		{
			// 获取obj对象的类
			Class cl = obj.getClass();
			// 获取指定obj对象的所有Field,并遍历每个Field
			for (Field f : cl.getDeclaredFields())
			{
				initView = f.getAnnotation(InitView.class);
				if (initView != null && initView instanceof InitView)
				{
					viewIds = initView.id();
					/* id值的处理 */
					if (viewIds.length == 1)
						view = ((Activity) obj).findViewById(viewIds[0]);
					else
					{
						// 当前Field的id数组大小>1
						view = ((Activity) obj).findViewById(viewIds[fieldCur++]);
						// fieldCur值等于当前声明在一起的View数量时应当置零。length是从1开始、fieldCur是0开始,因为fieldCur++
						if (viewIds.length == fieldCur)
							fieldCur = 0;
					}
					// 将Field设置成可以自由访问的,避免private的Field
					f.setAccessible(true);
					// 将obj中属性f的值设置为view,实现findViewById
					f.set(obj, view);
					// 监听添加处理
					if (initView.listenerClass().equals(InitView.class))
						addListener(obj, initView, view);
					else
					{
						Class listenCl = initView.listenerClass();
						Object listenetObj = null;
						try
						{
							// 非静态内部类时。要是很多控件使用这个listenerClass的话会new出很多,不太好。debuging
							listenetObj = listenCl.getConstructor(cl).newInstance(obj);
						} catch (Exception e)
						{
							// 一般类或静态内部类时
							listenetObj = listenCl.newInstance();
							e.printStackTrace();
						}
						addListener(listenetObj, initView, view);
					}
				}
			}
		} catch (Exception e)
		{
			e.printStackTrace();
			throw new RuntimeException("View控件初始化异常,请检查控件InitView注解配置。\n" + e);
		}
	}

	/**
	 * 添加监听
	 * 
	 * @param obj
	 *            监听类实例
	 * @param initView
	 *            View控件锁配置的InitView
	 * @param view
	 */
	private static void addListener(Object obj, InitView initView, View view)
	{
		// 单击
		if (initView.onClickListener())
		{
			view.setOnClickListener((android.view.View.OnClickListener) obj);
		}
		// 长按
		if (initView.onLongClickListener())
		{
			view.setOnLongClickListener((android.view.View.OnLongClickListener) obj);
		}
		// item单击
		if (initView.onItemClickListener())
		{
			((AdapterView) view).setOnItemClickListener((android.widget.AdapterView.OnItemClickListener) obj);
		}
		// item长按
		if (initView.onItemLongClickListener())
		{
			((AdapterView) view).setOnItemLongClickListener((android.widget.AdapterView.OnItemLongClickListener) obj);
		}
		// item选择
		if (initView.onItemSelectedListener())
		{
			((AdapterView) view).setOnItemSelectedListener((android.widget.AdapterView.OnItemSelectedListener) obj);
		}
		// CompoundButton的item选择更改
		if (initView.onCompoundButtonCheckedChangeListener())
		{
			((CompoundButton) view).setOnCheckedChangeListener((android.widget.CompoundButton.OnCheckedChangeListener) obj);
		}
		// RadioGroup的item选择更改
		else if (initView.onRadioGroupCheckedChangeListener())
		{
			((RadioGroup) view).setOnCheckedChangeListener((android.widget.RadioGroup.OnCheckedChangeListener) obj);
		}
	}
}


代码注释应该够详细了。其中processAnnotation方法的主要步骤:1、遍历obj所述的Class里的所有Field;2、找到带InitView注解的Field;3、处理当前Filed的注解。

在3中,首先或去id值并根据id的个数进行处理,分1个时和大于1个时,应为Filed是有顺序遍历的,所以可以根据当前Field的InitView的id值得个数进行处理。然后就是根据获取的listener的boolean去判断执行是否setXXXListener了。最后就是listenerClass的处理了。


最后看看根据自定义注解初始化控件的效果:




总结:效果基本实现了所期望的要求,代码还需要优化,不足之处大家多多指教指教。

源码下载:名字为AndroidAnnotation














  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值