1. 程式人生 > >Android依賴注入框架Dagger2學習筆記

Android依賴注入框架Dagger2學習筆記

依賴注入

面向物件程式設計的一種設計模式,目的是為了降低程式中類與類之間的依賴引起的耦合。

在Java中,依賴注入有
  • 通過介面注入
  • 通過set方法注入
  • 通過構造方法注入
  • 通過註解注入

Dagger2

官網

為什麼要用Dagger

  • 讓你不需要初始化物件。也就是說任何物件宣告完了就能直接用。另外一種說法:使用類和被依賴的物件構造分開,這樣如果我們需要改變被依賴類的構造方法,不必改動每一個使用類。

簡單的示例

比如現在我們要在RecycleView中顯示一系列資料,那麼我們需要在Activity中引用RecyclerViewAdapter。

最原始的構造方法注入的寫法

MainActivity

public class MainActivity extends AppCompatActivity {
    List<String> list = new ArrayList<>();
    RecyclerView recyclerView;
    ARecyclerViewAdapter aRecyclerViewAdapter;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super
.onCreate(savedInstanceState); setContentView(R.layout.activity_main); recyclerView = (RecyclerView) findViewById(R.id.rv); for (int i = 0; i < 30; i++) { list.add("item" + i); } recyclerView.setLayoutManager(new LinearLayoutManager(this)); //例項化並傳入list資料
aRecyclerViewAdapter = new ARecyclerViewAdapter(list); recyclerView.setAdapter(aRecyclerViewAdapter); } }

adapter


public class ARecyclerViewAdapter extends RecyclerView.Adapter<ARecyclerViewAdapter.AViewHolder>{

    private List<String> list ;

    public ARecyclerViewAdapter(List<String> list) {
        this.list = list;
    }

    @Override
    public AViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        View view = LayoutInflater.from(parent.getContext()).inflate(R.layout.layout_item, parent, false);
        return new AViewHolder(view);
    }

    @Override
    public void onBindViewHolder(AViewHolder holder, int position) {
        holder.textView.setText(list.get(position));
    }

    @Override
    public int getItemCount() {
        return list.size();
    }

    public class AViewHolder extends RecyclerView.ViewHolder{
        TextView textView;
        public AViewHolder(View itemView) {
            super(itemView);
            textView = itemView.findViewById(R.id.tv);
        }
    }
}

現在用Dagger2來改造,總體來說就是4步:
- 1 在Adapter構造器中加入@Inject註解
- 2 構建 Module
- 3 構建 Component
- 4 完成依賴注入

1 MainActivity中

public class MainActivity extends AppCompatActivity {
    List<String> list = new ArrayList<>();


    RecyclerView recyclerView;
    //1 這裡對注入類宣告並用註解@Inject標記
    @Inject
    ARecyclerViewAdapter aRecyclerViewAdapter;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        recyclerView = (RecyclerView) findViewById(R.id.rv);
        for (int i = 0; i < 30; i++) {
            list.add("item" + i);
        }
//        aRecyclerViewAdapter = new ARecyclerViewAdapter(list);


        ....
        ....
        recyclerView.setLayoutManager(new LinearLayoutManager(this));
        recyclerView.setAdapter(aRecyclerViewAdapter);
    }


}

在ARecyclerViewAdapter中

@Inject
public ARecyclerViewAdapter(List<String> list) {
        this.list = list;
    }

其實就是在倆個地方加了Inject註解

2 寫Module

@Module
public class ListModule {
    List<String> list;
    //引入資料
    public ListModule(List<String> list) {
        this.list = list;
    }

     //提供資料
    @Provides
    @ActivityScope
    List<String> provideList(){
        return list;
    }
}

原來的adapter的構造方法是

 public ARecyclerViewAdapter(List<String> list) {
        this.list = list;
    }

這裡這個list要從MainActivity中注入到adapter的,用module來提供資料,上面的provideList()方法就是提供資料的,用了Provides註解。這裡adapter只有一個引數,如果有多個引數,同理都在Module中用provide開頭方法提供。

@ActivityScope 是一個自定義的範圍註解,作用是允許物件被記錄在正確的元件中,當然這些物件的生命週期應該遵循 Activity 的生命週期

import java.lang.annotation.Retention;
 import static java.lang.annotation.RetentionPolicy.RUNTIME;

 import javax.inject.Scope;

 @Scope
 @Retention(RUNTIME)
 public @interface ActivityScope {
}

3 Component

負責注入依賴

@ActivityScope
@Component(modules = {ListModule.class})
public interface ListComponent {
    void inject(MainActivity mainActivity);
}

這裡void inject(MainActivity mainActivity)要注意這裡必須是真正消耗依賴的型別 MainActivity

4 在MainActivity中

onCreate方法中

DaggerListComponent.builder().listModule(new ListModule(list)).build().inject(this);

這樣就完了

為什麼用Dagger

參考資料

end