打造自己的注解框架

打造自己的注解框架


github上有很多注解框架，加个注解就会完成各种各样的任务，这样的方法
既减少了代码量，又方便项目的统一管理，清晰明了
今天，我就用java中的反射+自定义注解，为大家简单介绍下这种框架的设计思路，并和大家一起实现3个比较常用的功能


首先给大家简单说下反射，java是面向对象的语言，万物皆对象，所以每一个类，方法，属性都是是一个对象
分别属于class,method,field,可以在运行期获得类并剖析出它的方法和属性，并做相关操作


还有就是注解，java中其实定义了很多注解，而且我们也可以进行自定义注解

今天我们用到的java提供的注解有

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)

这两个注解运用为我们自定义注解添加注解
其中第一个注解表示我们的自定义注解的使用对象，可以是类（TYPE），方法（METHOD）,属性（Field）
然后第二个注解是表示这个注解是在哪个阶段作用，因为我们是运用反射机制，肯定是运行时
然后开始码代码

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

这个是一个BaseActivitity，如果要运用注解框架，让Activity调用这个类即可
这个基类为我们调用了InjectUtils.inject(this);
这个方法
首先我们先实现这样一个功能

@ContentView(R.layout.activity_main)
public class MainActivity extends Activity {
}

就是这个什么代码都没有，但是注解使相当于执行setContentView(R.layout.activity_main);
我们先来看下ContenView这个注解如何定义的

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

就是运用了上面说的那2个注解
然后里面就个方法获取到一个Int类型的值，为什么要一个这样的方法，因为我们要获取到一个布局
然后这个注解又是如何与我们Activity关联的呢？
之前说过我们的Activity继承了一个BaseActivity，这个BaseActivity的Oncreat()方法里面
调用了InjectUtils.inject(this);
那就一起看下这个InjectUtils类inject方法

public  static  void inject(Activity activity){
        injectContentView(activity);
    }

这个方法调用了injectContentView(activity);对了此处和大家说过简单的java多态的知识，当我们程序运行的时候这里面的
Activity传的是MainActivity还是BaseActivity呢？
当然是MainActivity，因为目前是子类对象在调用

	public static final String SET_CONTENT_VIEW="setContentView";
   private static  void  injectContentView(Activity activity){
            Class<? extends Activity> clazz=activity.getClass();       //通过反射拿到activity的类对象
            ContentView contentView=clazz.getAnnotation(ContentView.class);//获取到activity类的ContentView注释
            if(contentView!=null){										//如果有这个注释继续操作
                int layoutId=contentView.value();						//获得这个注释的值，即布局id
                try {
                    Method method=clazz.getMethod(SET_CONTENT_VIEW,int.class);//获取到这个类的"setContentView"方法，我这边提取了下
                    method.invoke(activity,layoutId);					//执行这个方法，将布局id传入
                } catch (NoSuchMethodException e) {
                    e.printStackTrace();
                } catch (InvocationTargetException e) {
                    e.printStackTrace();
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
            }
    }
}

ok,这样就写完了，不过瘾的话再写个，findViewByid是我们经常需要写的东东，今天我们也来思考下如何写
先思考需要什么
1.这个控件的声明比如：TextView Tv;
2.方法findViewByid
3.id:R.id.xx
ok,想好需要的就开始写
先写个注释，和刚刚一样只要获取id值就可以了

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

然后初始化控件也是在Oncreat里面的，所以可以和刚刚那个方法放到一起
给InjectUtils.inject里面加一句话injectViews(activity);
然后开始写这个方法

public static final String FIND_VIEW_BY_ID="findViewById";
private static void injectViews(Activity activity) {
            Class<? extends Activity> clazz=activity.getClass();//获得activity类
            Field fields[]=clazz.getDeclaredFields();			//获取到这个类里面的所有属性
            for(Field field:fields){							//遍历这个属性
                field.setAccessible(true);						//强制设定这个属性的为可见的
                ViewInject viewInject = field.getAnnotation(ViewInject.class);//得到这个属性的ViewInject注解
                if(viewInject!=null){							//如果这个属性有ViewInject注解继续
                    int idId=viewInject.value();				//拿到这个注解的值
                    try {
                        Method method=clazz.getMethod(FIND_VIEW_BY_ID,int.class);得到这个activity类的"findViewById"方法
                        field.set(activity,method.invoke(activity,idId));		给这个属性设置值，为findViewByID后的值
                    } catch (NoSuchMethodException e) {
                        e.printStackTrace();
                    } catch (InvocationTargetException e) {
                        e.printStackTrace();
                    } catch (IllegalAccessException e) {
                        e.printStackTrace();
                    }

                }
            }
    }

搞定，运用超级简单

@ContentView(R.layout.activity_main)
public class MainActivity extends Activity {
    @ViewInject(R.id.tv)
    TextView textView;
}

然后最后介绍一个资源的获取吧，比如要获取字符串
大家分析，获得字符串现在的方法是getString(id),所以注释应该这样定义

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

这里不做修改了，还是直接InjectUtils.inject方法添加 injectString(activity);调用
接下来实现这个方法

public static final String GET_STRING="getString";
private static void injectString(Activity activity) {
        Class<? extends Activity> clazz=activity.getClass(); //获得这个activity的类对象
        Field[] fileds=clazz.getDeclaredFields();			//获得这个类的所有属性
        for(Field field:fileds){							//遍历属性
            field.setAccessible(true);						//强制属性为可见
            StringRes stringRes=field.getAnnotation(StringRes.class);	获得属性的StringRes注解
            if(stringRes!=null){							//如果注解不为空
                try {
                    Method method=clazz.getMethod(GET_STRING,int.class);//获得activity的getString方法
                    int StringId=stringRes.value();						//获得注解的值，String的id
                    field.set(activity,method.invoke(activity,StringId));	//给属性设置值
                } catch (NoSuchMethodException e) {
                    e.printStackTrace();
                } catch (InvocationTargetException e) {
                    e.printStackTrace();
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
            }

        }
    }

ok,使用一样

@ContentView(R.layout.activity_main)
public class MainActivity extends Activity {
    @ViewInject(R.id.tv)
    TextView textView;
    @StringRes(R.string.Success)
    String s;
}

运用这种方法可以将大部分方法进行封装为注解，非常简单
这里留个问题给大家思考，如果是需要将一个监听事件进行封装呢？
给大家个思路方法拦截