• 热门专题

ButterKnife Android程序员的一大利器

作者:  发布日期:2014-04-18 18:13:40
Tag标签:利器  程序员  
  • 注:最近才看到的这个类库,来自于jakewharton大神的力作,安卓里面的视图注入库

    另小弟水平有限,翻译的不好,还请多多指正

    首先是地址(托管在github上):http://jakewharton.github.io/butterknife/

    进去后首先看到的是关于用法的讲解,翻译部分正式开始(通俗且精简化,建议对照着看)!

    简介:

    程序员都是懒惰的,不想写一大堆像下面这样的代码

    class ExampleActivity extends Activity {
      TextView title;
      TextView subtitle;
      TextView footer;
    
      @Override public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.simple_activity);
        title = (TextView) findViewById(R.id.title);
        subtitle = (TextView) findViewById(R.id.subtitle);
        footer = (TextView) findViewById(R.id.footer);
    
        // TODO Use views...
      }
    }

    这样很不好,因此我们就找到了一个方法,使用魔法一般的注解,来浓缩代码,就像下面这样

    class ExampleActivity extends Activity {
      @Magic(R.id.title) TextView title;
      @Magic(R.id.subtitle) TextView subtitle;
      @Magic(R.id.footer) TextView footer;
    
      @Override public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.simple_activity);
        // TODO Use "injected" views...
      }
    }

    然而,这样虽然看起来很酷,很Magic,不过还是会带来严重的运行时的问题

    于是,我们就利用javac 编译器中一大利器来生成前面例子中的findViewById的引用,并且继续保持代码的精简 ,继续看下面的代码

    class ExampleActivity extends Activity {
      @InjectView(R.id.title) TextView title;
      @InjectView(R.id.subtitle) TextView subtitle;
      @InjectView(R.id.footer) TextView footer;
    
      @Override public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.simple_activity);
        ButterKnife.inject(this);
        // TODO Use "injected" views...
      }
    }

    在原本Magic的地方使用inject 方法来替代,下面是该方法的一段代表(This method delegates to generated code 不明),可以看并debug

    public void inject(ExampleActivity activity) {
      activity.subtitle = (android.widget.TextView) activity.findViewById(2130968578);
      activity.footer = (android.widget.TextView) activity.findViewById(2130968579);
      activity.title = (android.widget.TextView) activity.findViewById(2130968577);
    }

    (这段可以忽略吗?貌似翻译不对,看不太懂)有些人称这个为视图注入,并加到了传统的依赖注入框架中,也许在术语上有错误,不过或许有一点作用.......



    NON-ACTIVITY INJECTION

    我们可以对任意的View对象使用注入,当然了,需要提供view root的对象

    public class FancyFragment extends Fragment {
      @InjectView(R.id.button1) Button button1;
      @InjectView(R.id.button2) Button button2;
    
      @Override View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
        View view = inflater.inflate(R.layout.fancy_fragment, container, false);
        ButterKnife.inject(this, view);
        // TODO Use "injected" views...
        return view;
      }
    }

    另外一个用处是简化list adapter中的View Holder模式,这个例子可以在提供的sample中看到

    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.whatever, parent, false);
          holder = new ViewHolder(view);
          view.setTag(holder);
        }
    
        holder.name.setText("John Doe");
        // etc...
    
        return convertView;
      }
    
      static class ViewHolder {
        @InjectView(R.id.title) TextView name;
        @InjectView(R.id.job_title) TextView jobTitle;
    
        public ViewHolder(View view) {
          ButterKnife.inject(this, view);
        }
      }
    }

    其他的API(这段真心建议看一下原版)

    -当使用activity作为view root节点时,你如果使用的是像MVC设计模式,你可以将控制器注入,使用它的acitvity并通过ButterKnife.inject(this, activity)方法 -将一个子View对象字段注入,使用ButterKnife.inject(this)(在前面例子的onCreate方法中就是,不懂的可以参考这个),如果你在一个layout 的构造方法中使用<merge>标签并且,inflate了一个自定义View,立即调用这个方法。或者,如果是从xml中inflate自定义view, 可以使用这个方法---onLayoutInflated()

    CLICK LISTENER INJECTION


    Click listener 也可以被注入

    @OnClick(R.id.submit)
    public void submit() {
      // TODO submit data to server...
    }

    也可以加一个view对象,特定的类型会被自动转换

    @OnClick(R.id.submit)
    public void sayHi(Button button) {
      button.setText("Hello!");
    }

    一次指定多个id,同时加事件

    @OnClick({ R.id.door1, R.id.door2, R.id.door3 })
    public void pickDoor(DoorView door) {
      if (door.hasPrizeBehind()) {
        Toast.makeText(this, "You win!", LENGTH_SHORT).show();
      } else {
        Toast.makeText(this, "Try again", LENGTH_SHORT).show();
      }
    }

    INJECTION RESET

    Fragments 有比Avtivity更多的生命周期 ,如果需要在onCreateView中注入一个fragment,在onDestroyView中销毁它

    Butter Knife 有一个reset 方法自动实现它

    public class FancyFragment extends Fragment {
      @InjectView(R.id.button1) Button button1;
      @InjectView(R.id.button2) Button button2;
    
      @Override View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
        View view = inflater.inflate(R.layout.fancy_fragment, container, false);
        ButterKnife.inject(this, view);
        // TODO Use "injected" views...
        return view;
      }
    
      @Override void onDestroyView() {
        super.onDestroyView();
        ButterKnife.reset(this);
      }
    }


    OPTIONAL INJECTIONS

    默认情况下 @InjectView和@OnClick都是必须加上的,如果当前对象不存在,就会抛出一个异常

    为了压制这个异常,可以在变量或者方法上加入一下注解

    @Optional @InjectView(R.id.might_not_be_there) TextView mightNotBeThere;
    
    @Optional @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() {
      // TODO ...
    }

    BONUS


    这段看不太懂,大意估计是除了以上注入方法之外还有一种,类型会自动转换,需要静态导入ButterKnife.findById

    View view = LayoutInflater.from(context).inflate(R.layout.thing, null);
    TextView firstName = ButterKnife.findById(view, R.id.first_name);
    TextView lastName = ButterKnife.findById(view, R.id.last_name);
    ImageView photo = ButterKnife.findById(view, R.id.photo);


    Download:当前版本 4.0.1


    具体:http://github.com/JakeWharton/butterknife

    jar包:http://repo1.maven.org/maven2/com/jakewharton/butterknife/4.0.1/butterknife-4.0.1.jar



    Maven配置:如果你是用maven开发的童鞋,请自觉加上如下依赖

    <dependency>
      <groupId>com.jakewharton</groupId>
      <artifactId>butterknife</artifactId>
      <version>4.0.1</version>
    </dependency>



    IDE的配置


    • IntelliJ IDEA — 如果你是用外部工具管理工程 (如 Maven pom.xml) 应该能正常工作, 不然就看看这个 http://jakewharton.github.io/butterknife/ide-idea.html
      • Eclipse — http://jakewharton.github.io/butterknife/ide-eclipse.html

        PROGUARD

        使用注入会导致ProGuard 认为变量未被使用,因此,需要在ProGuard 中加入如下字段

        -dontwarn butterknife.internal.**
        -keep class **$$ViewInjector { *; }
        -keepnames class * { @butterknife.InjectView *;}


        Having Happy Coding!




About IT165 - 广告服务 - 隐私声明 - 版权申明 - 免责条款 - 网站地图 - 网友投稿 - 联系方式
本站内容来自于互联网,仅供用于网络技术学习,学习中请遵循相关法律法规