关于Apt注解实践与总结【包含20篇博客】

时间 2019-11-07

标签关于 apt 注解实践总结包含20篇博客繁體版

原文原文链接

YCApt关于apt方案实践与总结

目录介绍

00.注解系列博客汇总
01.什么是apt
02.annotationProcessor和apt区别
03.项目目录结构
04.该案例做用
05.使用说明
06.编译期注解生成代码[点击事件案例]
07.运行期注解案例[setContentView案例]
08.使用注解替代枚举
09.使用注解搭建路由[综合案例]
- 9.1 搭建路由条件
- 9.2 经过注解去实现路由跳转
- 9.3 自定义路由Processor编译器
- 9.4 利用apt生成路由映射文件
- 9.5 路由框架的设计
- 9.6 路由参数的传递和接收
- 9.7 为什么须要依赖注入
- 9.8 Activity属性注入
- 9.9 路由开源库的使用

关于apt实践与总结开源库地址

github.com/yangchong21…

00.注解系列博客汇总

0.1 注解基础系列博客

01.Annotation注解详细介绍

1.Annotation库的简单介绍
2.@Nullable和@NonNull
3.资源类型注释
4.类型定义注释
5.线程注释
6.RGB颜色纸注释
7.值范围注释
8.权限注释
9.重写函数注释
10.返回值注释
11.@Keep注释
12.@SuppressWarnings注解
13.其余
复制代码

02.Dagger2深刻分析，待更新
03.注解详细介绍
- 什么是注解，注解分类有哪些？自定义注解分类？运行注解案例展现分析，以一个最简单的案例理解注解……使用注解替代枚举，使用注解限定类型
04.APT技术详解
- 什么是apt？理解注解处理器的做用和用途……android-apt被替代？annotationProcessor和apt区别？什么是jack编译方式？
06.自定义annotation注解
- @Retention的做用？@Target(ElementType.TYPE)的解释，@Inherited注解能够被继承吗？Annotation里面的方法为什么不能是private？
07.注解之兼容kotlin
- 后期更新
08.注解之处理器类Processor
- 处理器类Processor介绍，重要方法，Element的做用，修饰方法的注解和ExecutableElement，了解修饰属性、类成员的注解和VariableElement……
10.注解遇到问题和解决方案
- 没法引入javax包下的类库，成功运行一次，修改代码后再运行就报错
11.注解代替枚举
- 在作内存优化时，推荐使用注解代替枚举，由于枚举占用的内存更高，如何说明枚举占用内存高呢？这是为何呢？
12.注解练习案例开源代码
- 注解学习小案例，比较系统性学习注解而且应用实践。简单应用了运行期注解，经过注解实现了setContentView功能；简单应用了编译器注解，经过注解实现了防暴力点击的功能，同时支持设置时间间隔；使用注解替代枚举；使用注解一步步搭建简单路由案例。结合相应的博客，在来一些小案例，今后应该对注解有更加深刻的理解……

0.2 注解系列博客问题答疑

13.0.0.1 什么是注解？系统内置的标准注解有哪些？SuppressWarnings用过没？Android中提供了哪些与线程相关的注解？
13.0.0.2 什么是apt？apt的难点和优点？什么是注解处理器？抽象处理器中四个方法有何做用？annotationProcessor和apt区别？
13.0.0.3 注解是怎么分类的？自定义注解又是怎么分类的？运行期注解原理是什么？实际注解案例有哪些？
13.0.0.4 在自定义注解中，Annotation里面的方法为什么不能是private？Annotation里面的方法参数有哪些？
13.0.0.5 @Inherited是什么意思？注解是不能够继承的，这是为何？注解的继承这个概念该如何理解？
13.0.0.6 什么是依赖注入？依赖注入案例举例说明，有哪些方式，具有什么优点？依赖查找和依赖注入有什么区别？
13.0.0.7 路由框架为什么须要依赖注入，不用的话行不行？路由用什么方式注入，这些注入方式各具何特色，为什么选择注解注入？
13.0.0.8 实际开发中使用到注解有哪些，使用注解替代枚举？如何经过注解限定传入的类型？为什么说枚举损耗性能？

01.什么是apt

什么是apt
- APT，就是Annotation Processing Tool的简称，就是能够在代码编译期间对注解进行处理，而且生成Java文件，减小手动的代码输入。注解咱们平时用到的比较多的可能会是运行时注解，好比大名鼎鼎的retrofit就是用运行时注解，经过动态代理来生成网络请求。编译时注解平时开发中可能会涉及的比较少，但并非说不经常使用，好比咱们常常用的轮子Dagger2, ButterKnife, EventBus3 都在用，因此要紧跟潮流来看看APT技术的前因后果。
编译时注解。
- 也有人叫它代码生成，其实他们仍是有些区别的，在编译时对注解作处理，经过注解，获取必要信息，在项目中生成代码，运行时调用，和直接运行手写代码没有任何区别。而更准确的叫法：APT - Annotation Processing Tool
大概原理
- Java API 已经提供了扫描源码并解析注解的框架，开发者能够经过继承 AbstractProcessor 类来实现本身的注解解析逻辑。APT 的原理就是在注解了某些代码元素（如字段、函数、类等）后，在编译时编译器会检查 AbstractProcessor 的子类，而且自动调用其 process() 方法，而后将添加了指定注解的全部代码元素做为参数传递给该方法，开发者再根据注解元素在编译期输出对应的 Java 代码

02.annotationProcessor和apt区别

annotationProcessor和apt区别
- Android 官方的 annotationProcessor 同时支持 javac 和 jack 编译方式，而 android-apt 只支持 javac 方式。固然，目前 android-apt 在 Android Gradle 插件 2.2 版本上面仍然能够正常运行，若是你没有想支持 jack 编译方式的话，能够继续使用 android-apt。
- 目前好比一些经常使用框架dagger2，butterKnife，ARouter等，都支持annotationProcessor
什么是jack编译方式？
- Jack (Java Android Compiler Kit)是新的Android 编译工具，从Android 6.0 开始加入,替换原有的编译工具，例如javac, ProGuard, jarjar和 dx。它主要负责将java代码编译成dex包，并支持代码压缩，混淆等。
Jack工具的主要优点
- 彻底开放源码，源码均在AOSP中，合做伙伴可贡献源码
- 加快编译源码，Jack 提供特殊的配置，减小编译时间：pre-dexing, 增量编译和Jack编译服务器.
- 支持代码压缩，混淆，重打包和multidex，不在使用额外单独的包，例如ProGuard。

03.项目目录结构

项目目录结构如图：
- app：Demo
- AptAnnotation：java Library主要放一些项目中须要用到的自定义注解及相关代码
- AptApi：Android Library. 是咱们真正对外发布并交由第三方使用的库，它引用了apt-jar包
- AptCompiler：java Library主要是应用apt技术处理注解，生成相关代码或者相关源文件，是核心所在。

04.该案例做用

前期仅仅是为了学习，同时先让demo运行起来，虽然网上不少讲解apt的博客写的很详细，可是仍是有必要结合实际案例练习一下。
使用apt实现点击事件【编译期注解生成代码】
- 在必定时间内，按钮点击事件只能执行一次。未到指定时间，不执行点击事件。
使用apt实现setContentView功能【运行期注解案例】
- 使用简单的注解，即可以设置布局，等效于setContentView(R.layout.activity_main)
使用apt实现路由【综合型案例】
- 比较全面的介绍从零起步，一步一步封装简易的路由开源库。一共用10篇博客记录了大部分的过程，想要更加深刻了解，欢迎clone该项目。

05.使用说明

以下所示

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    //初始化OnceClick,并设置点击事件间隔是2秒
    OnceInit.once(this,2000);
}

@OnceClick(R.id.tv_1)
public void Click1(){
    Log.d("tag--------------------","tv_1");
}
复制代码

06.编译期注解生成代码

以下所示，在app/build/generated/source/apt/debug/MainActivity$$_Once_Proxy目录下

// 编译生成的代码，不要修改
// 更多内容：https://github.com/yangchong211
package com.ycbjie.ycapt;

import android.view.View;
import com.ycbjie.api.Finder;
import com.ycbjie.api.AbstractInjector;

public class MainActivity$$_Once_Proxy<T extends MainActivity> implements AbstractInjector<T> {

    public long intervalTime;

    @Override
    public void setIntervalTime(long time) {
        intervalTime = time;
    }

    @Override
    public void inject(final Finder finder, final T target, Object source) {
        View view;
        view = finder.findViewById(source, 2131165325);
        if(view != null){
            view.setOnClickListener(new View.OnClickListener() {
            long time = 0L;
            @Override
            public void onClick(View v) {
                long temp = System.currentTimeMillis();
                if (temp - time >= intervalTime) {
                    time = temp;
                    target.Click1();
                }
            }});
        }
        view = finder.findViewById(source, 2131165326);
        if(view != null){
            view.setOnClickListener(new View.OnClickListener() {
            long time = 0L;
            @Override
            public void onClick(View v) {
                long temp = System.currentTimeMillis();
                if (temp - time >= intervalTime) {
                    time = temp;
                    target.Click2(v);
                }
            }});
        }
  }

}
复制代码

07.运行期注解案例

首先先定义自定义注解

//@Retention用来修饰这是一个什么类型的注解。这里表示该注解是一个运行时注解。
@Retention(RetentionPolicy.RUNTIME)
//@Target用来表示这个注解可使用在哪些地方。好比：类、方法、属性、接口等等。
//这里ElementType.TYPE 表示这个注解能够用来修饰：Class, interface or enum declaration。
//当你用ContentView修饰一个方法时，编译器会提示错误。
@Target({ElementType.TYPE})
//这里的interface并非说ContentView是一个接口。
//就像申明类用关键字class。申明枚举用enum。申明注解用的就是@interface。
public @interface ContentView {
    //返回值表示这个注解里能够存放什么类型值。
    int value();
}
复制代码

而后须要在activity中作注解解析

@SuppressLint("Registered")
public class ContentActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        //注解解析
        //遍历全部的子类
        for (Class c = this.getClass(); c != Context.class; c = c.getSuperclass()) {
            assert c != null;
            //找到修饰了注解ContentView的类
            ContentView annotation = (ContentView) c.getAnnotation(ContentView.class);
            if (annotation != null) {
                try {
                    //获取ContentView的属性值
                    int value = annotation.value();
                    //调用setContentView方法设置view
                    this.setContentView(value);
                } catch (RuntimeException e) {
                    e.printStackTrace();
                }
                return;
            }
        }
    }
}
复制代码

关于如何使用，注意你写的Activity须要实现ContentActivity，才能让注解生效

@ContentView(R.layout.activity_four)
public class FourActivity extends ContentActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        findViewById(R.id.tv_1).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Toast.makeText(FourActivity.this,"运行期注解",Toast.LENGTH_SHORT).show();
            }
        });
    }
}
复制代码

09.使用注解搭建路由[综合案例]

9.1 ARouter路由解析
- 比较详细地分析了阿里路由库
9.1 搭建路由条件
- 为什么须要路由？实现路由方式有哪些，这些方式各有何优缺点？使用注解实现路由须要具有的条件以及简单原理分析……
9.2 经过注解去实现路由跳转
- 自定义Router注解，Router注解里有path和group，这即是仿照ARouter对路由进行分组。而后看看注解生成的代码，手写路由跳转代码。
9.3 自定义路由Processor编译器
- Processor介绍，重要方法，Element的做用，修饰方法的注解和ExecutableElement
9.4 利用apt生成路由映射文件
- 在Activity类上加上@Router注解以后，即可经过apt来生成对应的路由表，那么到底是如何生成的代码呢？
- 在组件化开发中，有多个module，为什么要在build.gradle配置moduleName，又是如何经过代码拿到module名称？
- process处理方法如何生成代码的，又是如何写入具体的路径，写入文件的？
- 看完这篇文章，应该就可以理解上面这些问题呢！
9.5 路由框架的设计和初始化
- 编译期是在你的项目编译的时候，这个时候尚未开始打包，也就是你没有生成apk呢！路由框架在这个时期根据注解去扫描全部文件，而后生成路由映射文件。这些文件都会统一打包到apk里，app运行时期作的东西也很多，但总而言之都是对映射信息的处理，如执行执行路由跳转等。那么如何设计框架呢？
- 生成的注解代码，又是如何把这些路由映射关系拿到手，或者说在何时拿到手比较合适？为什么注解须要进行初始化操做？
- 如何获得获得路由表的类名，如何获得全部的routerAddress---activityClass映射关系？
9.6 路由框架设计注意要点
- 须要注意哪些要点？
9.7 为什么须要依赖注入
- 有哪些注入的方式能够解耦，你能想到多少？路由框架为什么须要依赖注入？路由为什么用注解进行依赖注入，而不是用反射方式注入，或者经过构造方法注入，或者经过接口方式注入？
9.8 Activity属性注入
- 在跳转页面时，如何传递intent参数，或者如何实现跳转回调处理逻辑？

9.9 路由开源库的使用

不带参数直接跳转

@Router(path = Path.six)
public class SixActivity extends AppCompatActivity {

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

}

ARouter.getsInstance().build(Path.six)
            .navigation(MainActivity.this, new NavigationCallback() {
        @Override
        public void onFound(Postcard postcard) {
            Log.e("NavigationCallback","找到跳转页面");
        }

        @Override
        public void onLost(Postcard postcard) {
            Log.e("NavigationCallback","未找到");
        }

        @Override
        public void onArrival(Postcard postcard) {
            Log.e("NavigationCallback","成功跳转");
        }
    });
复制代码

带参数跳转

@Router(path = Path.five)
public class FiveActivity extends AppCompatActivity {

    @Extra
    String title;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_five);
        //添加这行代码，实际上就是自动生成了下面获取参数值的代码
        ARouter.getsInstance().inject(this);
        //若是不添加插入注解，则能够直接用下面的代码。
        //Intent intent = getIntent();
        //String title = intent.getStringExtra("title");
        Toast.makeText(this, "title=" + title, Toast.LENGTH_SHORT).show();
    }

}

Bundle bundle = new Bundle();
bundle.putString("title","标题-------------");
ARouter.getsInstance()
        .build(Path.five)
        .withBundle(bundle)
        .navigation();
复制代码

路由注解生成的代码位置

10.其余说明

00.参考案例

01.关于博客汇总连接

02.关于个人博客

个人我的站点：www.yczbj.org，www.ycbjie.cn
github：github.com/yangchong21…
知乎：www.zhihu.com/people/yczb…
简书：www.jianshu.com/u/b7b2c6ed9…
csdn：my.csdn.net/m0_37700275
喜马拉雅听书：www.ximalaya.com/zhubo/71989…
开源中国：my.oschina.net/zbj1618/blo…
泡在网上的日子：www.jcodecraeer.com/member/cont…
邮箱：yangchong211@163.com
阿里云博客：yq.aliyun.com/users/artic… 239.headeruserinfo.3.dT4bcV
segmentfault头条：segmentfault.com/u/xiangjian…
掘金：juejin.im/user/593943…