Butter Knife 8.8.1的安装和使用(一)

简介: Butter Knife 8.8.1的安装和使用(一)

注解插件Butterknife 8.8.1


(注:本文部分内容来源自网络,经学习总结后成文。仅用于学习交流。)


温馨提示:本文ButterKnife 8.8.1插件的使用是基于AndroidStudio3.0以前的版本有效。

这几天有很多同学更新AS3.0以后,使用ButterKnife8.8.1遇到了很多问题。我想说,不遇到问题才怪。AS3.0与ButterKnife8.8.1不兼容啊!目前此插件的原作者还没有更新可以兼容的版本。

如果你一定要在AS3.0上用ButterKnife,那么建议使用低版本ButterKnife8.4.0,具体配置自行学习,本文不提供。

如果你坚持要在AS3.0上用ButterKnife8.8.1版本,那么我可以帮你配制通过运行,但是R2的功能肯定无法使用了,其他的功能本人还未尝试哪些不能正常使用,先给出我的方案吧:

首先,在你已经配置好ButterKnife8.8.1版本,刚升级AS3.0的同学,需要删除两行配置代码:

classpath 'com.jakewharton:butterknife-gradle-plugin:8.8.1'
apply plugin: 'com.jakewharton.butterknife'

然后将原有的配置更改如下:

api 'com.jakewharton:butterknife:8.8.1'
annotationProcessor 'com.jakewharton:butterknife-compiler:8.8.1'

同学们,AS3.0正式版刚更新完不久,而且是一次变化比较大的更新,所有很多插件都与其不兼容,别人的插件兼容也需要给开发者一个时间,所以大家不要急着在你工作项目中更新使用,因为要修改和完善的东西真的太多了,当然你可以自己更新了解玩玩。我上周刚更新完项目也是各种bug啊!没办法。建议大家暂时只以学习AS3.0为主,不要过早用于工作中,会带来很多麻烦的。我是不是太啰嗦了?实在是很多同学都问我啊……

如果你使用的是AS3.0以前的版本,那么请继续往下学习吧。后期如果有变化我会更新的。


一.Butter Knife简介


ButterKnife是目前常用的一种依托Java注解机制实现辅助代码生成的框架;用到了注解处理器。

它是一个专注于Android系统的View注入框架,将Android视图和回调方法绑定到成员变量和方法上;可视化一键生成; 可以减少大量的findViewById以及setOnClickListener代码,是 注解 中相对简单易懂的开源框架 。


原理:利用了IOC的(Inverse of Controll)控制反转结构,2004年后改名为DI(dependency injection)依赖注入。目的是为了使类与类之间解耦合,提高系统的可扩展性和可维护性。


英文使用说明地址:http://jakewharton.github.io/butterknife/

API文档地址:http://jakewharton.github.io/butterknife/javadoc/


GitHub源码地址:

https://github.com/JakeWharton/butterknife/blob/master/CHANGELOG.md#version-800-2016-04-25


二.Butter Knife的优点


1) 强大的View绑定和Click事件处理功能,简化代码,提升开发效率


2)方便的处理Adaper里的ViewHolder绑定问题


3) 运行时不会影响app效率,使用配置方便


4)代码清晰,可读性强


三.Butterknife 的安装


1.在线安装Butterknife


在AndroidStudio中在线安装注解插件Butterknife,过程如图:

image.png

分解如下:

image.png

image.png

搜索“zelezny”,找到Butterknife插件下载、安装即可。

image.png

2.激活Butterknife


在安装完成后,会出现一个有下面内容的弹框:


Restart android Studio to activate changes in plugins?


(译:重新启动 Android Studio 激活插件的变化?)


点击Restart激活已安装的插件。

四.Butter Knife的项目配置


1.在项目的project 的build.gradle 文件中的dependencies标签下添加如下代码:

classpath 'com.jakewharton:butterknife-gradle-plugin:8.8.1'

具体位置如下:(添加插件)

buildscript {
  repositories {
    ...
   }
  dependencies {
  classpath 'com.android.tools.build:gradle:2.3.3'
  //butterknife的新版插件必须在此处作配置
    classpath 'com.jakewharton:butterknife-gradle-plugin:8.8.1'
  }
}

2.在module的build.gradle 文件中的dependencies标签中添加代码如下(导入库的依赖)

dependencies {
  compile 'com.jakewharton:butterknife:8.8.1'
  annotationProcessor 'com.jakewharton:butterknife-compiler:8.8.1'
}

3.在module的build.gradle 文件中设置支持插件 ,添加如下代码

apply plugin: 'com.android.library'
apply plugin: 'com.jakewharton.butterknife'

(注:这条是开发者给出的配置,目前不加此配置也是不影响正常使用的,但小区别还是有的(eg:R2.id.XXX能否正常使用),是否作此配置看使用者自己吧,本人建议加此配置。)


五.Butter Knife的注册绑定


1.使用注意事项


(注:不理解可以继续往下看,都有详细说明,或者自己动手写写就明白了。)


1)在Activity 类中绑定 :ButterKnife.bind(this);


必须在setContentView();之后绑定;且父类bind绑定后,子类不需要再bind。


2)在非Activity 类(eg:Fragment、ViewHold)中绑定: ButterKnife.bind(this,view);


这里的this不能替换成getActivity()。


3)在Activity中不需要做解绑操作,在Fragment 中必须在onDestroyView()中做解绑操作。


4)使用ButterKnife修饰的方法和控件,不能用private or static 修饰,否则会报错。


5)setContentView()不能通过注解实现。(其他的有些注解框架可以)


6)使用Activity为根视图绑定任意对象时,如果你使用类似MVC的设计模式你可以在Activity 调用ButterKnife.bind(this, activity),来绑定Controller。


7)使用ButterKnife.bind(this,view)绑定一个view的子节点字段。如果你在子View的布局里或者自定义view的构造方法里 使用了inflate,你可以立刻调用此方法。或者,从XML inflate来的自定义view类型可以在onFinishInflate回调方法中使用它。


2.在Activity中绑定ButterKnife


使用:ButterKnife.bind(this);


示例代码:

public class MainActivity extends Activity{
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        //绑定初始化ButterKnife
        ButterKnife.bind(this);
    }
}

Note:


1)由于每次使用都要在Activity中的onCreate绑定Activity,因此个人建议在项目的BaseActivity中完成绑定,子类继承即可。


2)必须在setContentView();之后绑定。


3.在Fragment中绑定ButterKnife


使用:ButterKnife.bind(this, view);


Fragment的生命周期不同于activity。在onCreateView中绑定一个Fragment时,在onDestroyView中将视图设置为null。


当你调用bind来为你绑定一个Fragment时,Butter Knife会返回一个Unbinder的实例。


在适当的生命周期(onDestroyView)回调中调用它的unbind方法进行Fragment解绑。


代码示例:

public class ButterknifeFragment extends Fragment{
    private Unbinder unbinder;
    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {
        View view = inflater.inflate(R.layout.fragment, container, false);
        //返回一个Unbinder值(进行解绑),注意这里的this不能使用getActivity()
        unbinder = ButterKnife.bind(this, view);
        return view;
    }
    /**
     * onDestroyView中进行解绑操作
     */
    @Override
    public void onDestroyView() {
        super.onDestroyView();
        unbinder.unbind();
    }
}

4.在Adapter中绑定ButterKnife


使用:ButterKnife.bind(this, view);


在Adapter的ViewHolder中使用,将ViewHolder加一个构造方法,在new ViewHolder的时候把view传递进去。


示例代码:

public class MyAdapter extends BaseAdapter {
  // 部分代码省略...
  @Override 
  public View getView(int position, View view, ViewGroup parent) {
    ViewHolder holder;
    if (view != null) {
      holder = (ViewHolder) view.getTag();
    } else {
      view = inflater.inflate(R.layout.testlayout, parent, false);
      holder = new ViewHolder(view);
      view.setTag(holder);
    }
    holder.name.setText("诺诺");
    // etc...
    return view;
  }
  static class ViewHolder {
    @BindView(R.id.title) TextView name;
    @BindView(R.id.job_title) TextView jobTitle;
    public ViewHolder(View view) {
      ButterKnife.bind(this, view);
    }
  }
}


目录
相关文章
|
7月前
|
Java Spring
Spring Boot3整合knife4j(swagger3)
Spring Boot3整合knife4j(swagger3)
1363 1
|
JSON 前端开发 Java
Springboot中整合knife4j接口文档
Springboot中整合knife4j接口文档
485 0
|
13天前
|
JSON JavaScript 前端开发
springboot中使用knife4j访问接口文档的一系列问题
本文作者是一位自学前端两年半的大一学生,分享了在Spring Boot项目中使用Knife4j遇到的问题及解决方案,包括解决Swagger请求404错误、JS错误等,详细介绍了依赖升级、注解替换及配置修改的方法。
22 1
|
2月前
|
前端开发 Java 程序员
springboot 学习十五:Spring Boot 优雅的集成Swagger2、Knife4j
这篇文章是关于如何在Spring Boot项目中集成Swagger2和Knife4j来生成和美化API接口文档的详细教程。
120 1
|
2月前
|
安全 Java API
SpringSecurity结合knife4j实现swagger文档
通过将Spring Security与Knife4j相结合,我们不仅能够为RESTful API提供强大的安全防护,还能保证API文档的易用性和可访问性,这对于API的设计、开发和维护来说至关重要。这种集成方式不仅提升了开发效率,也优化了API使用者的体验,是现代API驱动开发中不可或缺的一环。
84 0
|
7月前
|
前端开发 Java
springboot集成knife4j接口文档
springboot集成knife4j接口文档
springboot集成knife4j接口文档
|
7月前
|
Java Maven
【SpringBoot专题_01】springboot集成Knife4J
【SpringBoot专题_01】springboot集成Knife4J
150 0
|
7月前
|
前端开发 Java API
Knife4j使用教程
Knife4j使用教程
674 0
|
7月前
|
安全 Java Spring
如何在调试开发阶段,在已经配置了springsecurity的情况下还能使用swagger或者knife4j
如何在调试开发阶段,在已经配置了springsecurity的情况下还能使用swagger或者knife4j
152 0
|
Java Maven 开发者
Springboot 整合 knife4j | Swagger文档最简单配置
Springboot 整合 knife4j | Swagger文档最简单配置
1440 0
Springboot 整合 knife4j | Swagger文档最简单配置