[오픈 소스 라이브러리 01] Butter Knife (버터나이프)

여러 View 들을 inject할때 도움을 주는 Butter knife 라이브러리

 안드로이드를 공부 할 수록 존경하게 되는 와튼 형님이 만든 라이브러리지만 사실 Butter knife를 사용해야 하는 필요성을 못 느끼고 있었다. 무조건 오픈소스 이용해서 쉽게, 쉽게 코딩하지말고 원리는 알고 이용하라는 선배들의 글을 본 후 더욱 이런 라이브러리는 게으른 사람들만 이용한다고 생각했다. 하지만 어느 순간 내가 Activity 에서 View를 적용할때 마다 불필요한 '노가다 코딩'을 반복한다는 느낌이 들었다. 예를 들어,

 
private void setUI() {
    mButtonBack = (Button) findViewById(R.id.btn_back);
    mButtonHome = (Button) findViewById(R.id.btn_home);
    mButtonEnter = (Button) findViewById(R.id.btn_enter);
    mButtonRightArrow = (Button) findViewById(R.id.btn_right_arrow);
    mButtonLeftArrow = (Button) findViewById(R.id.btn_left_arrow);
    mButtonUpArrow = (Button) findViewById(R.id.btn_up_arrow);
    mButtonDownArrow = (Button) findViewById(R.id.btn_down_arrow);
}
 
private void setEventListener() {
    mButtonBack.setOnClickListener(clickListener);
    mButtonHome.setOnClickListener(clickListener);
    mButtonEnter.setOnClickListener(clickListener);
    mButtonRightArrow.setOnClickListener(clickListener);
    mButtonLeftArrow.setOnClickListener(clickListener);
    mButtonUpArrow.setOnClickListener(clickListener);
    mButtonDownArrow.setOnClickListener(clickListener);
}
 

위의 코드와 같이 View(특히 Button)를 사용하려면 멤버변수로 선언하고 setUI()메소드를 통해 Id에 맞는 View들을 연결해주고 다시 setEventListerner()라는 메소드를 이용해서 리스너들과 연결해서 사용해왔다. 멤버변수 선언을 포함하면 내가 하나의 뷰를 사용하기 위해서는 세줄의 코드를 사용하고 있었다. 코드 줄 수가 많아서 무조건 적으로 싫다기 보다는 단순한 코드의 긴 반복이 점점 거슬리기 시작했다. 사족은 이쯤에서 줄이고, 위와 같은 코드를 Butter knife를 사용하면

 
@InjectView(R.id.btn_back) Button mButtonBack; 
@InjectView(R.id.btn_home) Button mButtonHome; 
@InjectView(R.id.btn_enter) Button mButtonEnter; 
@InjectView(R.id.btn_right_arrow) Button mButtonRightArrow; 
@InjectView(R.id.btn_left_arrow) Button mButtonLeftArrow; 
@InjectView(R.id.btn_up_arrow) Button mButtonUpArrow; 
@InjectView(R.id.btn_down_arrow) Button mButtonDownArrow 
 
 
private void setEventListener() {
    mButtonBack.setOnClickListener(clickListener);
    mButtonHome.setOnClickListener(clickListener);
    mButtonEnter.setOnClickListener(clickListener);
    mButtonRightArrow.setOnClickListener(clickListener);
    mButtonLeftArrow.setOnClickListener(clickListener);
    mButtonUpArrow.setOnClickListener(clickListener);
    mButtonDownArrow.setOnClickListener(clickListener);
}
 

위의 코드와 같이 멤버변수를 선언과 동시에 해당 View를 연결할 수 있다. 나아가서 만약 Butter knife에서 제공하는 @OnClick 어노테이션을 사용하면 리스너 injection도 가능한데 이를 이용하면 멤버변수 선언을 포함한 위의 모든 코드 자체를 사용할 필요가 없고

 
@OnClick({R.id.btn_back,R.id.btn_home,R.id.btn_enter,
        R.id.btn_right_arrow,R.id.btn_left_arrow,
        R.id.btn_up_arrow, R.id.btn_down_arrow})
public void onButtonClick(View view) {
    switch (view.getId()) {            
            case R.id.btn_back:
            ...
    }
}
 

 

위의 코드와 같이 바로 해당 클릭 리스너에 대한 구현만 해주면 된다.이런 방법은 코딩작업의 편의성도 좋지만 가독성 면에서도 나은 방법이라고 생각한다.

그럼 Butter Knife 라이브러리에 대한 사용 방법에 대해서 알아보자. 우선 설치법은, 이클립스 사용자일 경우

 

http://jakewharton.github.io/butterknife/ 

위의 사이트에서 JAR 파일을 다운받은후 적용을 하고 안드로이드 스튜디오 사용자들은 app내에 build.gradle의 dependencies 에

compile 'com.jakewharton:butterknife:6.0.0'

위의 컴파일 주소만 추가해 주면 된다. 라이브러리 설치가 끝났으면 사용법에 대해서 알아보자. 우선 Activity를 상속 받았을 경우 

@Override 
public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.simple_activity);
    ButterKnife.inject(this);
    // TODO Use "injected" views...
}

위와 같이 onCreate()에서 ButterKnife.inject(this)라는 명령을 통해 inject할 수 있다. 만약 activity가 아닌 fragment 라면

 
@Override 
public 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;
}
 

위와 같이 onCreateView()에서 ButterKnife.inject(this, view)라는 명령어를 통해 inject한다. 또한 adapter에서 ViewHolder pattern 을 사용할때에도

static class ViewHolder {
    @InjectView(R.id.title) TextView name;
    @InjectView(R.id.job_title) TextView jobTitle;
 
    public ViewHolder(View view) {
      ButterKnife.inject(this, view);
    }
}

처럼 사용할 수 있다.apply()메소드에 대해서는 다음에 기회가 되면 추가적으로 살펴보기로 하고 리스너 injection을 살펴보면 아까 위에서 예제에서 보여준것 처럼 @OnClick()어노테이션으로 injection을 할 때 {}안에 여러개의 id를 동시에 작용하게 할 수도 있지만

@OnClick(R.id.enter)
public void onButtonClick() {
  // TODO 
}
 

처럼 하나의 id에서만 적용할 수 있다. 여기서 참고할 사항은 메소드의 이름은 내가 정해 줄 수 있지만 만약 메소드에 Parameter값을 넣을 경우 반드시 해당 id가 속한 view 의 parameter가 필요하다. 예를 들어 위의 코드에서 R.id.enter는 버튼의 id인데 메소드 onButtonClick(ImageView img)와 같이 정의하면 런타임시 에러가 발생한다.