注解的运用

举一个例子，日常开发中常有这样的需求：
后台接口自定义返回码，通常有code=200,201,202等等..
一般情况有这么几种做法：
1.定义常量
public static final int SUCCESS = 200;
public static final int FAIL = 201;
根据不用的情形，指定错误类型，比如200代表成功，201代表失败等..
是最常见方法

    private int test1() {
        switch ("value") {
            case "成功":
                return SUCCESS;
            case "失败":
                return FAIL;
        }
    }

但是int型的常量也是int，假如这样写：

    private int test1() {
        switch ("value") {
            case "成功":
                return SUCCESS;
            case "失败":
                return FAIL;
            case "空指针":
                return 500;
        }
    }

直接写500，依然可以正常编译运行。但是在某些具体的情形，这样的代码并不好维护，容易出现类型安全的问题。
2.使用枚举

    private State test2() {
        switch ("value") {
            case "成功":
                return State.SUCCESS;
            case "失败":
                return State.FAIL;
            default:
                return State.FAIL;
        }
    }

看是很完美，但是枚举类型是很占用内存的，每个枚举类型相当于一个单例对象
3.使用注解
Android源码中带有很多常见的注解的使用，support-annotations 是通过静态编译检测来提高代码质量的
一个注解工具
eg：@LayoutRes资源注解

@Documented
@Retention(CLASS)
@Target({METHOD, PARAMETER, FIELD, LOCAL_VARIABLE})
public @interface LayoutRes {
}

限定被注解的属性必须是layout布局资源，可以作用于方法、变量等，该资源以int的形式存储在Android系统之中，
使用方法如下：

    public BottomDialog setLayoutRes(@LayoutRes int layoutRes) {
       mLayoutRes = layoutRes;
       return this;
    }

setLayoutRes方法必须使用int类型的资源文件，如果传“1”，“2”，“23224234”或者任何一个int类型的参数，则会提出异常警告。

了解一下注解
注解(也称元数据)，为我们在代码中添加信息提供一种形式化的方法，使我们可以在稍后的某个时刻
非常方便的使用这些数据。就像注释是给人看的，注解是给机器“看的”。
1.注解的作用
注解可以作用于类、方法、变量、等
a,更加干净易读的代码
b.编译期类型检查
2.基本语法

@Target
@Retention
public @interface 注解名称{
    属性列表;
}

3.用法
定义-使用-执行
eg：

public class Demo1 {

    @Test1(getName = "cat")
    private void get1() {
    }
    
    @Target(ElementType.METHOD)
    @Retention(RetentionPolicy.CLASS)
    @interface Test1 {
        String getName();
    }
}

Target限定所能作用的位置，可以作用于类、方法、成员变量等等..
Retention：
SOURCE：源码注解，编译成.class文件后注解就不存在，用来提示开发者
CLASS： CLASS汇编注解，编译成.class文件后注解也还存在，但是JVM在加载类的时候不需要将其加载为
运行时可见的（反射可见）的注解，用于自动生成代码
RUNTIME：运行时动态注解，在编译过程中保留，会写入Class文件，并且JVM加载类的时候也会将其加载为
反射可见的注解,生命周期一直程序运行时都存在，常用于自动注入

回到上面的例子
根据注解的机制和上面的例子，可以使用support-annotations包编写自己的注解：

    @IntDef({ReturnCode.SUCCESS, ReturnCode.FAIL})
    @Target({ElementType.METHOD, ElementType.PARAMETER})
    @Retention(RetentionPolicy.SOURCE)
    @interface ReturnCode {
        int SUCCESS = 200;
        int FAIL = 201;
    }

    private void test() {
        InnerDemo innerDemo = new InnerDemo();
        innerDemo.t(200);//lint异常提醒
        innerDemo.t(ReturnCode.SUCCESS);
    }

    class InnerDemo {
        private void t(@ReturnCode int da) {

        }
    }

最后编辑于：2019.12.04 09:36:07