سلام دوستان عزیز، متاسفانه کمی طول کشید تا مطلب آموزشی بگذارم، کامنت ها و استقبال شما انرژی خاصی به من داد تا هرچه زود تر نسبت به کامل کردن این بحث اقدام کنم. خیلی خوب، در مقاله قبلی با نحوه استفاده از Dagger2 آشنا شدیم. در این بخش می خواهیم چند روش دیگر استفاده را به همراه امکانات بیشتر این کتابخانه مورد برسی قرار دهیم. همانطور که در آموزش قبلی به روز کردم به علت استفاده زیاد از این کتابخانه، گوگل امکان اضافه کردن آن را به صورت مستقیم داده و شما می توانید ازین پس بصورت زیر در gradle در سطح خود برنامه از آن استفاده کنید:

compile 'com.google.dagger:dagger:2.7'
annotationProcessor 'com.google.dagger:dagger-compiler:2.7'

می خواهیم کمی بیشتر با DI آشنا شویم و ابزار های آن را در Dagger2 ببینیم. ما چند نوع تزریق داریم.

Constructor injection

برروی کانستراکتور Inject@ گذاشته و در این صورت دیگر نیازی به نوشتن Module نداریم.

Fields injection

همینطور که در آموزش قبل ملاحظه کردید تزریق یک فیلد را گویند. ( در تمامی آموزش قبل از fields injection استفاده کردیم)

Methods injection

بروری یک متدی از یک کلاس Inject@ بگذاریم.

چند انوتیشن که باید در این جلسه با آنها آشنا شویم:

@Scope annotation

اصولا هدف استفاده از این انوتیشن معرفی Scope آبجک تولید شده است. یعنی Dagger2 به شما این امکان را می دهد تا Object های شما چرخه عمر متفاوت داشته باشند و شما فقط تعریف می کنید، مدیریتش با خود Dagger است. پیشنهاد من این است که برای این مقاله تا همین حد کافی است و بعد از اتمام این اموزش به مقاله کامل مراجعه کنید.

@Qualifier

وقتی از این انوتیشن استفاده می کنیم که متد ها همنام و و ورودی خروجی یکسان داشته باشند و به Dagger می فهمانیم کِی، چی را تزریق کند.

بسیار عالی. در آموزش قبل دیدیم که هرجا بخواهیم از DI توسط Dagger2 استفاده کنیم باید سه مرحله زیر را انجام دهیم:

۱- ساخت Provider ها در کلاس Module که مشخص می کنیم کلاس ها چگونه تولید شوند.

۲- ساخت اینترفیسی به نام Component که می گویم از کدام Module ها استفاده کند و متدی در آن قرار می دادیم که کلاسی که در آن Inject انجام شده بود وجود داشته باشد تا Dagger2 بفهمد کدام کلاس ها را جهت فیلد انجکشن اسکن و وایراپ کند و متوجه شدیم که Dagger متدها رو بصورت خودکار تولید می کند.

۳- در کلاس استفاده کننده ( قرار است Inject اتفاق بیافتد) متد تعریف شده در Component را از کلاس AutoGenerated توسط Dagger صدا بزنیم و  تمام!

اگر هنوز بخش مبهمی مانده با در نظر گرفتن سه مرحله بالا آموزش قبل را دوباره مطالعه کنید.

حال یک سوال:

با توجه به مطالب یاد شده می توانیم هر بخش از برنامه را بصورت DI توسط Dagger2 بنویسیم. مثلا یکسری کلاس هایی را بصورت Inject در کلاس های دیگر استفاده کنید. اما سوال من این است که اگر بخواهیم در کل پروژه از DI استفاده کنیم چه باید کرد؟ یعنی کلاس هایی که به همدیگر ربط پیدا می کنند. (مثلا Context که در خیلی جاها لازم داریم و یا SharedPrefrence و یا خیلی کلاس های دیگر) این سوالی بود که برای خودم هم پیش آمد و بهترین جواب برای آن طراحی از بالا به پایین کل پروژه است! یعنی به جای اینکه بیاییم  از پایین به بالا برای تک تک کلاس های استفاده شده Module بنویسیم و سپس برسیم به سطح کامپوننت های اندروید مثل fragment و Activity که واقعاً نشدنی است و ارتباطات خیلی پیچیده می شود و از طرفی Inject های تکراری ایجاد می شد که Dagger2 آن را قبول نمی کند، بهتر است از سطح Application به پایین طراحی کنیم. این نکته را هم در نظر داشته باشید که Dagger2 در یک DI مجزا، امکان ساخت یک کامپوننت اصلی را می دهد ( به شکل بالا توجه کنید) و اگر کامپوننت های دیگری داشتیم باید در ارتباط با کامپوننت اصلی باشند.  ( این ارتباط یا از نوع Dependency است یا SubComponent که در انتهای این بحث به تفاوت آنها اشاره خواهم کرد.) البته این مساله در صورتی است که Dependency Injection های مرتبط به هم داشته باشید. اما اگر فقط می خواهید در بخش های خاصی از برنامه از DI استفاده کنید که به هم مرتبط نیستند هر کدام Component و Module مستقل از هم را خواهند داشت که مشکلی هم پیش نمیاید. مثلا در مساله آموزش قبل که DI را برای تولید خودرو استفاده کردیم، فرض کنید یک DI هم برای قایق یا کشتی بنویسیم که بخواهیم تولید قایق را برایمان مدیریت کند. برای این کار دقیقاً مانند DI خودرو Module و Component مربوطه آن را تشکیل می دهیم و ربطی هم به DI خودرو ندارد و از هم مستقل اند. تنها نقطه مشترک کلاسی هست که استفاده کننده است. ( مانند Activity)

می خواهیم مثالی ساده نوشته و  آن را باهم برسی کنیم. لطفاً به این بخش خیلی توجه کنید. به علت ارتباط بخش های مختلف ممکن است پیچیدگی ظاهری داشته باشد، اما واقعاً پیچیده نیست و تمامی قوانینی که در جلسه قبل گفتیم صادق است. تلاش من این است که تمامی حالت های ممکن برای ساخت DI را برسی کنیم تا تمامی سوالات برطرف شود.

شرح برنامه:

برنامه ای داریم که با استفاده از اطلاعات کاربری، درخواستی به وب زده و نتیجه را در پایگاه داده ذخیره می کند. توجه کنید که اتفاقات بصورت شماتیک است و هدف برسی روابط آنها در Dagger2 می باشد و صرفاً به ازای اکثر عملیات ها در کد، فقط لاگ کرده ایم. به شکل زیر دقت کنید: کلاس اپلیکیشن دارای کلاس های Context و User و Database (که وابسته به Context  و User است) و Activity است و خود کلاس Activity هم شامل NetworkCalss است که  وابسته به User است.

نکات برنامه:

کلاس Application به Database نیاز دارد تا آن را در اول برنامه Initilize کند از طرفی Database به User و Context نیاز دارد. سپس Activity یک Network Request می زند و نتیجه را در Database ذخیره می کند.اول از همه Module های مربوط به User و Database را ایجاد می کنیم تا Dagger بفهمد آنها را چگونه تولید کند.

@Module
public class UserModule {

    @Provides
    @Singleton
    User providesUser() {
        return new User("Farhad", "Majidi");
    }
}

@Module
public class DatabaseModule {

    @Singleton
    @Provides
    Database providesDatabase(Context context,User user){
        return new Database(context,user);
    }
}

@Singleton
@Component(modules = {ApplicationModule.class, DatabaseModule.class,UserModule.class})
public interface ApplicationComponent {

    void inject(DaggerTestApplication application);


    // Exported for child-components. (subcomponent need this to use Context or User or Database)

    Context getContext();

    User provideUser();

    Database provideDatabase();

}

سوال: چه چیزی را می خواهیم تزریق کنیم؟ جواب: DataBase و User

سوال: چطور ساخته می شود؟ جواب: در UserModule  و DatabaseModule مشخص شده است و آنها را به عنوان Module به Component داده ایم!

سوال: استفاده کننده نهایی کیست؟ جواب: DaggerTestApplication  است بنابر این یک متد با ورودی خودش نوشتیم تا Inject@ های روی فیلدهایش اسکن شود.

سوال: دوسه تا متد بعدی چیه؟ جواب: باید برای هر کلاسی که child ها به آن نیاز دارند یک متد Exporter  بنویسیم.

از آنجایی که می خواهم کلاس NetworkClass را فقط در Activity استفاده کنم و از طرفی NetworkClass به User نیاز دارد بنابراین یک کامپوننت جدا با Scope جدید می نویسیم. چون می خواهم مادامی که Activity وجود دارد NetworkClass نیز وجود داشته باشد. اما لازم است تا Component اصلی متدهایی داشته باشند تا کلاس User را برایم Export کنند. بنابر این من متدی اضافه کردم به نام provideUser که خروجی آن User است. خود Dagger پیداده سازی آن را مدیریت می کند. همچنین چون ممکن است Context برنامه را کلاس های دیگر بخواهند یک متد نیز برای آن نوشتیم و همچنین برای Database هم یک متد Export کننده نوشتم.( خواهید دید که DataBase در Activity جهت ذخیره مورد نیاز قرار خواهد گرفت. پس یک متد Export کننده لازم داشت.) این طراحی بالا به پایینی بود که اول مقاله گفتم. یعنی در Component اصلی که نحوه ارتباط ها را مشخص می کنیم برای فرزند ها نیز وابستگی های مشترک را در نظر بگیریم.

یک نکته دیگر در مورد context است. از آنجایی که کلاس های دیگری ممکن است به آن وابسته شوند یک متد برای آن نوشتیم، اما چون Context را ما نمی سازیم و خود سیستم تولید می کند لازم نیست برایش Module بنویسیم و ساخت و Handle آن توسط خود Dagger با Android system انجام می شود. البته در این پروژه استفاده ای از آن نکردیم، اما مطمئناً به آن نیاز پیدا خواهید کرد.

حال می رویم سراغ وابستگی های Activity و این بخش است که کمی برایمان تازگی دارد.

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


@Module
public class ServiceModule {

    @ActivityScope
    @Provides
    NetworkClass providesNetworkClass(User user) {
        return new NetworkClass(user);
    }
}

@ActivityScope
@Component(dependencies = ApplicationComponent.class, modules = ServiceModule.class)
public interface ActivityComponent {

    void inject(MainActivity activity);

}

سوال: چه چیزی را می خواهیم تزریق کنیم؟ جواب: NetworkClass

سوال: چطور ساخته می شود؟ جواب: در ServiceModule مشخص شده است و آن را به عنوان Module به Component داده ایم!

سوال: اما نحوه ساخت یوزر را در ServiceModule  نداریم؟! جواب: در ActivityComponent  مشخص کردیم که

dependencies = ApplicationComponent.class ( یعنی وابستگی به ApplicationComponent داریم و هر کلاسی که در آن Export شده است را می توانیم استفاده کنیم. پس ServiceModule در ساخت NetworkClass یک User به عنوان ورودی می گیرد، و نحوه ساخت آن یوزر را ApplicationComponent  می داند.

سوال: چرا Scope جدید دادیم؟ جواب: برای اینکه می خواهیم مادامی که استفاده کننده آن (Activity ) وجود دارد، NetworkClass ما وجود داشته باشد. نحوه دقیق کار Scope در این آموزش موجود است.

سوال: این NetworkClass کجا استفاده می شود و Dagger از کجا می فهمد؟ جواب: این جواب رو دیگه شما هم می دانید و همانطور که در کلاس Activity ملاحظه می کنید چون درون دوتا فیلد اینجکشن داریم ( یکی NetworkClass و دیگری DataBase)  بنابر این یک متدی در Component قرار دادم تا ورودی آن از جنس MainActivity باشد تا تمامی Field injection های آن اسکن شود و ارتباط ها برقرار شود.

public class MainActivity extends AppCompatActivity {

 
    @Inject
    NetworkClass networkClass;

    @Inject
    Database database;

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

        initialize();
        webRequest();

    }

    private void webRequest() {

        networkClass.request("https://google.com");
        database.saveToDB();
    }

    private void initialize() {

        ((DaggerTestApplication)getApplicationContext()).getActivityComponent().inject(this);
    }


}

ملاحظه خواهید کرد که هم NetworkClass و هم DataBase به درستی در Activity تزریق شده اند و قابل استفاده هستند. حالا که نحوه کار با Dagger2 را متوجه شدیم می توانیم برای متوجه شدن بیشتر این کد را به چند صورت متفاوت نوشت و تغییر داد. که همه اینها در Github در شاخه های با نام های:lesson2, lesson2-type2, lesson2-type3, lesson2-subcomponent قرار گرفته اند.

روش های دیگر برای درک کامل

برای اینکه دقیقاً بفهمید Dagger2 چطور کار می کند حتماً این مثال ها را ببینید و درک کنید. در این چند مثال انواع روش های پیاده سازی را انجام داده ام و فهمیدن انها باعث از بین رفتن گنگی نسبی قضیه و تسلط کامل خواهد شد و جواب بسیاری از سوال هایی که در ذهن دارید را خواهید یافت. تلاشم تغییر روی یک کلاس واحد Database بود تا با ثابت بودن آن تغییر روش ها را ملاحظه نمایید.

شاخه lesson2 : همین کدی است که در این آموزش داشتیم.

شاخه lesson2-type2 :در کلاس Database خود User تزریق شده است. بنابراین ناچاریم تا متدی بنویسیم که ورودی آن Database باشد تا فیلد های تزریق شده اسکن شود.

شاخه lesson2-type3: در کلاس Database از Constructor Injection استفاده کردم. همانطور که در تعریف اول بحث مطرح کردم در این روش Inject@ در روی Constructor  کلاس می گذاریم و دیگر نیازی به نوشتن Module برای نحوه پیاده سازی آن نداریم و کلا DatabaseModule حذف می شود. البته ActivityComponent تغییری نمی کند.

public class Database {

    private static final String TAG = "mahditajik.ir";

    @Inject
    User user;
    private Context context;

    @Inject
    public Database(Context context) {
        this.context = context;

    }

    public void initialize() {
        Log.i(TAG, "initialize with context: " + context.toString());

    }

    public void saveToDB() {
        Log.i(TAG, "saveToDB: " + user.toString());
    }
}

@Singleton
@Component(modules = {ApplicationModule.class,UserModule.class})
public interface ApplicationComponent {

    void inject(DaggerTestApplication application);

    // Exported for child-components.

    Context getContext();

    User provideUser();

    //because it had Constructor injected and do not need for Module or exporter
//    Database provideDatabase();

}

Subcomponent vs Dependency

همانطور که در مثال ملاحظه کردید برای ارتباط ActivityComponent با ApplicationComponent از Dependencies استفاده کردیم

@Component(dependencies = ApplicationComponent.class, modules = ServiceModule.class)

و سپس هر Object که لازم بود را در ApplicationComponent برایش یک متد exporter نوشتیم. اما راه دیگر استفاده به عنوان Subcomponent است. در این روش انترفیس subcomponent به همه Object های Component دسترسی دارد و نیازی به نوشتن متد های exporter ندارد و کارایی آن هنگامی است که واقعاً به تمامی object ها نیاز داریم. برای شناساندن Subcomponent به Component اصلی فقط کافیست که یک متد Factory برایش در Component بنویسیم.

@MahdiScope
@Subcomponent(modules = ServiceModule.class)
public interface ActivityComponent {

    void inject(MainActivity activity);

}

@Singleton
@Component(modules = {ApplicationModule.class, DatabaseModule.class, UserModule.class})
public interface ApplicationComponent {

    void inject(DaggerTestApplication application);


    // Exported for child-components.

//    Context getContext();
//
//    User provideUser();
//
//    Database proDatabase();


    //sub component

    ActivityComponent providesActivityComponent(ServiceModule service);

}

و برای استفاده wire-up کردن هم متد ماژول ان را از کامپوننت اصلی بگیریم. ( خط ۲۷)

public class MainActivity extends AppCompatActivity {

    @Inject
    NetworkClass networkClass;

    @Inject
    Database database;

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

        initialize();
        webRequest();

    }

    private void webRequest() {

        networkClass.request("https://google.com");
        database.saveToDB();
    }

    private void initialize() {

        ((DaggerTestApplication) getApplicationContext()).getAppComponent()
                .providesActivityComponent(new ServiceModule()).inject(this);

    }
}

امیدوارم تونسته باشم مطلب رو خوب بیان کنم. در صورت وجود هر گونه مشکل یا سوال یا بحث، که واقعاً این مبحث نیاز به بحث داره، راحت باشید و کامنت بگذارید.

بعد از گرفتن پروژه یکبار اون رو import کنید تا قابل اجرا بشه.

منبع: بایت کد

نوشته کار با Dagger2 به زبان ساده بخش دوم (پیشرفته) اولین بار در Mahdi Tajik پدیدار شد.

@Scope annotation

اصولا هدف استفاده از این انوتیشن معرفی Scope آبجک تولید شده توسط Dagger2 است. یعنی Dagger2 به شما این امکان را می دهد تا Object های شما چرخه عمر متفاوت داشته باشند و شما فقط تعریف می کنید، پیاده سازی اش با خود Dagger است. فرض کنید که سه component به شرح زیر داریم و سلسله مراتب ارتباط و وابستگی Component ها هم مشخص است.

و ما برای آنها سه اسکوپ تعریف می کنیم. ActivityScope, UserScope, Applicationscope(singletone).

Dagger2 به طور پیش فرض singletone یا همان applicationScope را دارد و چرخه عمرآن با چرخه عمر Application یکی است. احتمالاً در کد autogenerated خودش بصورت static نگهداری می کند. استفاده از این اسکوپ ها مانند این است که tag تعریف کنیم و اسمشان اهمیتی ندارد. فقط Object ای که با اسکوپ خاصی تولید می شود، طول عمر و LifeCycle اش با صدا زننده آن یکی خواهد شد. مثلا اگر یک Object با ActivityScope@ داریم که در درون activity تزریق می شود، Lifecycle  آن با Lifecycle مربوط به activity یکی می شود و تا زمانی وجود دارد که Activty تزریق کننده آن وجود داشته باشد و کنترل کردن آن اتوماتیک توسط Dagger2 انجام می شود.

به تصویر زیر توجه کنید:

ApplicationScope در طول کل برنامه وجود دارد. پس ما برای هر آیتمی این اسکوپ را بگذاریم تا پایان برنامه وجود خواهد داشت. با شروع هر اکتیویتی، ActivityScope شروع و با بسته شدن آن اسکوپ هم تمام می شود. همچنین برای UserScope. با انتخاب یا ساخت هر یوزری شروع و  در نهایت با رهاکردن آن، تمام می شود.

پس یادمان باشد که نام Scope ها مهم نیست. بلکه این مهم است که برای چه Provider ای تعریف شده و آن Object در چه کلاسی Inject می شود. برای ساخت آن بدین صورت عمل می کنیم:

@Scope
@Retention(RetentionPolicy.RUNTIME)
public @interface ScopeName{
}

نوشته برسی Scope@ ها در Dagger2 اولین بار در Mahdi Tajik پدیدار شد.

چقدر خوب می شد اگر هر وقت نیازمندی داشتیم فقط آن را مطرح می کردیم و به سادگی برایمان فراهم می شد؟ مفهوم Dependency Injection یا به اختصار DI همین است، شما فقط می گویید من آن object را می خواهم و شخص دیگری آن را با تمام پیچیدگی هایش برایتان فراهم می کند! در ضمن تمام امور مربوط به تولید، نگهداری، چرخه حیات و مسائل مربوط آن شئی را برایمان کنترل می کند و باعث می شود ارتباطات بین کلاس ها ساده تر شود و در نتیجه نگهداری و توسعه ساده تر گردد. قرار است این کار را توسط Dagger2 در اندروید پیاده سازی نماییم.

مقدمه:

Dependency Injection is a set of software design principles and patterns that enable us to develop loosely coupled code.

Loose coupling makes code extensible, and extensibility makes it maintainable

Mark Seemann

یکی از اصول SOLID اصل Dependency Inversion Principle است که یکی از دیزاین پترن هایی که آن را پیاده سازی می کند Dependency Injection است که هدف اصلی آن کم کردن وابستگی ها برای نگهداری و توسعه راحت تر می باشد. در صورتی که علاقه مند به آشنایی بیشتر با این دیزان پترن هستید  می توانید کتاب Mark seemann را از اینجا دانلود کنید. در ضمن دوست و همکار عزیزم مثالی خوب و  ملموسی با نام “Dependency Injection in the Coffeeshop” دارد که دیدن آن خالی از لطف نیست. Dagger

  Dagger2 یک Dependency Injection FrameWork است که Dependency Injection را با استفاده از تولید خودکار کد بر پایه annotations بهره می گیرد (در مورد انوتیشن می توانید به این آموزش مراجعه کنید) یعنی برای استفاده از امکانات آن باید از annotation های خاصی استفاده کنیم که به توضیح آنها خواهم پرداخت. بخاطر اینکه  کار با Dagger2 کمی ابهام دارد و فهم آن برای خودم هم کمی طول کشید، مثال ساده ای آماده کردم که نحوه کار با Dagger2 را خیلی واضح و راحت باهم برسی کنیم. فقط توجه داشته باشید که هدف اصلی این مقاله نحوه کارکرد با Dagger2 است و نه پیاده سازی صددرصد صحیح Dependency Injection و تلاش می کنیم در مقاله دوم به این امر نیز پرداخته و پروژه را از هر نظر باهم تکمیل کنیم.

به نظرم یک از دلایل پیچیدگی های کار با Dagger2 ، روش های گوناگون پیاده سازی آن است که شاید بعضاً کار کند ولی از نظر DI درست نباشد و می توان با اطلاع  از این روش ها تسلط خوبی برآن پیدا کرد. بنابر این سعی می کنم به مرور کد را تمیز تر و به DI اصولی نزدیک تر کنم. پس تا آخر این مقاله با من باشید و درصورت وجود هرگونه ابهام یا ایراد یا سوال آن را با من در میان بگذارید تا در اسرع وقت پاسخ دهم.

قدم اول: اضافه کردن Dagger2 به پروژه

اول از همه اطلاعات زیر را به Gradle سطح پروژه اضافه کنید:

dependencies {
    
    classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
}

سپس خط زیر را در آخر Gradle سطح برنامه اضافه کنید.

apply plugin: 'com.neenbedankt.android-apt'

و وابستگی های زیر را نیز به همان فایل اضافه نمایید

dependencies {
    compile 'com.google.dagger:dagger:2.7'
    apt 'com.google.dagger:dagger-compiler:2.7'
    provided 'javax.annotation:jsr250-api:1.0'
}

سپس Gradle خود را sync کنید.

به روز رسانی: اخیراً به علت کاربرد زیاد Dagger گوگل امکان اضافه کردن این کتابخانه را بصورت مستقیم فراهم کرده و می توان بدین صورت نیز عمل کرد:

compile 'com.google.dagger:dagger:2.7'
annotationProcessor 'com.google.dagger:dagger-compiler:2.7'

قدم دوم: آماده سازی کلاس هایی که می خواهیم برایمان تزریق شوند و ارتباط بین آنها (Wiring up)

مفاهیم اصلی مطرح در Dagger2 به شرح زیر می باشند که همانطور که اشاره کردم برای استفاده از این مفاهیم باید از انوتیشن های هم نام آنها استفاده کرد.

Provides@

نحوه تولید وابستگی ها را مشخص می کند. هر جا که این انوتیشن بروی متدی بود یعنی خروجی این متد قرار است در جایی از برنامه تزریق شده و مورد استفاده قرار گیرد.

Module@

کلاسی هست که Provider ها در آن قرار می گیرند.

Component@

اینترفیسی که ارتباط وابستگی ها و استفاده کننده آن را مطرح می کند. ما فقط اینترفیس را می نویسیم و پیاده سازی آن با خود Dagger است.

Inject@

هرکجا که نیاز به تزریق وابستگی داشتیم از این انوتیشن استفاده می کنیم.

قصد ندارم که مانند خیلی از مقاله ها سرتان رو با تعاریف اولیه درد بیارم، پس صاف می رویم سر مثال که کاربرد این انوتیشن ها را ببینیم.

برنامه ای داریم که قرار است موتور خودرو تولید کند و جهت تست، آن را روشن کرده و استارت بزند.  موتور ماشین وابسته به کامپیوتر داخلی و رادیاتور می باشد. ( این بخش ها را می توان بیشتر کرد ولی جهت سادگی فرض کنید موتور فقط نیازمند این دوبخش است.) و می خواهیم به کمک Dagger2 هرجا نیازی به کلاس خودرو شد بدون اینکه درگیر وابستگی های آن یعنی  کامپوتر و رادیاتور شویم، فقط بگوییم یک موتور آماده تحویل ما بده. کلاس ها رو بصورت زیر تعریف می کنیم:

public class Computer {

    private int voltage;
    private String model;

    public Computer(String model ,int voltage){

        this.model=model;
        this.voltage = voltage;
    }
}

public class Radiator {
    private String name;

    public Radiator(String name){
        this.name = name;
    }
}

همانطور که دیدیم دو کلاس رادیاتور و کامپیوتر را داریم که وابستگی خاصی ندارند. حال نوبت به تعریف کلاس موتور می رسد. برای ایجاد و بیان وابستگی از انوتیشن Inject@ استفاده می کنیم و Dagger می فهمد که باید یک وابستگی را تزریق کند.

public class Motor {

    @Inject
    public Computer computer;

    @Inject
    Radiator radiator;

    String name;

    public Motor(String name) {
        this.name = name;
    }

    public boolean startEngin() {
        if (computer != null && radiator != null) {
            return true;
        } else {
            return false;
        }
    }

    public Computer getComputer() {
        return computer;
    }


    public String getName() {
        return name;
    }

    public Radiator getRadiator(){
        return radiator;
    }
}

پس ما تا اینجا نحوه وابستگی کلاس ها را با انوتیشن Inject@ مشخص کردیم. یعنی به Dagger گفتیم که هنگام ساخت موتور رادیاتور و کامپیوتر را در اختیارم قرار بده! ( حالا نمی دانم چطوری، هرطور خودت صلاح می دونی!) ولی قبل آن لازم است تا یکبار نحوه ساخته شدن وابستگی ها را به Dagger را معرفی کنیم. برای اینکار کلاسی با نام ماژول می سازیم که از انوتیشن Module@ استفاده می کند و بخش های آن که نحوه ساختن وابستگی را شرح می دهند با انوتیشن Provides@ مشخص می کنیم.

@Module
public class MotorModule {

    String motoName;
    String computerName;
    String radiatorName;
    int voltage;

    public MotorModule(String computerName, int voltage , String radiatorName) {
        this.radiatorName = radiatorName;
        this.computerName = computerName;
        this.voltage = voltage;
    }


    @Provides
    @Singleton
    Motor provideMotor() {
        return new Motor(motoName);
    }

 

    @Provides
    @Singleton
    Computer provideComputer() {
        return new Computer(computerName, voltage);
    }


    @Provides
    @Singleton
    Radiator provideRadiator(){
        return new Radiator(radiatorName);
    }
}

اگر قرار است وابستگی های ما ورودی داشته باشند آن را در Constructor مربوط به Module پاس می دهیم. همانطور که می بینید اسم رادیاتور، اسم کامپیوتر و ولتاژ آن ( که جزو ورودی های ما بودند) به همراه Constructor پاس داده شد. ما در Module به Dagger می فهمانیم که وقتی آبجکتی خواستیم آن را چگونه تولید کند. در ضمن با استفاده  ازاسکوپ Singletone@ به Dagger می فهمانیم که همیشه یک نمونه از آن داشته باشد و هر دفعه یک نمونه جدید تولید نکند. برای مشاهده نحوه کار Scope به این مقاله مراجعه کنید.

کلاسی بعدی که به آن نیاز داریم interface ای هست که Dagger توسط آن می فهمد که کدام ماژول ها را در کجا باید تزریق کند و برای تولید کد خودکار Dagger مورد نیاز است، ولی اجازه بدهید تا این کلاس را بعد از نحوه استفاده از Dagger شرح دهم. فقط همین اندازه بدانیم که دو متد با نام دلخواه ( من نام هردو را void inject گذاشتم.) یکی با ورودی MainActivity و دیگری Motor ساختم.

@Singleton
@Component(modules = {MotorModule.class})
public interface MotorComponent {

    void inject(MainActivity activty);
    void inject(Motor moto);

}

خیلی خوب. حال همه چیز آماده است و نوبت به این می رسد که  object مورد نظرمان یعنی موتور را در کلاس تزریق و استفاده کنیم. فقط یک نکته باقی مانده است. لازم است تا Dagger کد خودکار را تولید کند و ورودی ماژول را به آن بدهیم تا کل ارتباطات کامل و تمامی آبجکت ها قابل تزریق باشد. اصطلاحاً سیم کشی یا Wiring up را تمام کنیم.  فقط توجه نمایید که برای اینکه dagger بتواند کدهای مربوطه خود را auto generate کند بعد از این بخش ( یعنی ساخت ماژول ها و کامپوننت) باید کل پروژه را Rebuild کنیم. به متد generateDaggerCode توجه نمایید:

public class MainActivity extends AppCompatActivity {

    @Inject
    public Motor motor;

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

        generateDaggerCode();

        createCar(motor);

    }

    private void createCar(Motor motor) {

        if (motor != null) {
            Toast.makeText(this, "car is created", Toast.LENGTH_SHORT).show();
        }

        startCar(motor);
    }

    private void startCar(Motor motor) {
        if (motor.startEngin()) {

            Toast.makeText(this, "it is started", Toast.LENGTH_SHORT).show();
            Toast.makeText(this, "motor name is:" + motor.getName(), Toast.LENGTH_SHORT).show();
        } else {
            Toast.makeText(this, "motor is not provided", Toast.LENGTH_SHORT).show();
        }
    }

    private void generateDaggerCode() {
        MotorComponent component = DaggerMotorComponent.builder().motorModule(new MotorModule
                (this, "Computer name",12, "radiator name")).build();

    component.inject(this);
    component.inject(motor);
      
    }
    
}

حال به تجزیه تحلیل کد دقت نمایید

اول از همه کد Dagger را تولید می کنیم که در ورودی آن ماژول را با ورودی آن پاس می دهیم. ( نام رادیاتور، نام کامپیوتر، ولتاژ) سپس دو متد موجود در Component را صدا می زنیم. حال ما هرجای این کد که یک موتور خواستیم کافی است آن را با Inject@ بیاوریم و خود Dagger آن را مدیریت می کند.

چند نکته و قانون وجود دارد که فهم آنها باعث می شود این پیچیدگی کم شود. اول اینکه اگر هرجایی Inject را در فیلد های یک کلاس انجام دادیم ( مثل همین جا که در MainActivity کلاس Motor را در اول کلاس تزریق کرده و سپس از آن استفاده کردیم) Dagger متوجه آن نمی شود مگر اینکه  یک متدی ( با نام دلخواه) در Component بنویسم که ورودی آن، همان کلاس استفاده کننده باشد تا Dagger بفهمد چه کلاسی در فیلد خود Inject انجام داده و بتواند کد خود را بصورت صحیح تولید کند. برای همین امر بود که در Component یک متد به نام inject ساختم که ورودی آن MainActivity بود. همانطور که ملاحظه می کنید چون خود Motor هم در داخل خودش field Injection داشت ( هم Computer و هم Radiator در خط ۴ و ۷ کلاس موتور) پس ناچاراً متدی هم برای آن در Component نوشتم تا ارتباط آنها را نیز متوجه بشود و به اصطلاح فیلداینجکشن ها را اسکن کند.

اگر برنامه را اجرا کنید Motor به درستی Inject شده و پیغام مناسب دریافت خواهید کرد و ما توانسته ایم با استفاده از Dagger2 وابستگی را به کد تزریق کنیم.

حال توجه شما را به یک پیاده سازی دیگر جلب می نمایم. در این روش برای ساخت موتور، اجزای لازم را بدون استفاده از انوتیشن Inject@ و با Constructor پاس می دهم. همانطور که در بالا گفتیم چون تزریق در فیلد انجام ندادیم پس در کامپوننت هم متد آن ( void inject(Motor moto)) را حذف می کنیم. بدین صورت:

public class Motor {

    private Computer computer;
    private Radiator radiator;
    private String name;

    public Motor(String name, Computer computer ,Radiator radiator) {
        this.name = name;
        this.computer = computer;
        this.radiator = radiator;
    }

    public boolean startEngin() {
        if (computer != null && radiator != null) {
            return true;
        } else {
            return false;
        }
    }

    public Computer getComputer() {
        return computer;
    }


    public String getName() {
        return name;
    }

    public Radiator getRadiator() {
        return radiator;
    }
}

پس Dagger می فهمد که برای ساخت موتور باید دو ورودی رادیاتور و کامپیوتر به موتور پاس دهد، از طرفی نحوه ساخت کامپیوتر و رادیاتور را می داند. پس همین کافی است که بتواند موتور را برایمان تولید کند و Component هم بصورت زیر می شود:

@Singleton
@Component(modules = {MotorModule.class})
public interface MotorComponent {

    void inject(MainActivity activty);

}

حال اگر از شما بپرسند چرا متدی قرار دادیم با نام inject که ورودی آن از جنس MainActivity است جواب دهید: بخاطر اینکه در MainActivity در فیلد Motor را تزریق کرده ایم! بله درست گفتید!

public class MainActivity extends AppCompatActivity {

    @Inject
    public Motor motor;

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

        generateDaggerCode();

        createCar(motor);

    }

    private void createCar(Motor motor) {

        if (motor != null) {
            Toast.makeText(this, "car is created", Toast.LENGTH_SHORT).show();
        }

        startCar(motor);
    }

    private void startCar(Motor motor) {
        if (motor.startEngin()) {

            Toast.makeText(this, "it is started", Toast.LENGTH_SHORT).show();
            Toast.makeText(this, "motor name is:" + motor.getName(), Toast.LENGTH_SHORT).show();
        } else {
            Toast.makeText(this, "motor is not provided", Toast.LENGTH_SHORT).show();
        }
    }

    private void generateDaggerCode() {
        DaggerMotorComponent.builder().motorModule(new MotorModule
                (this, "Computer name",12, "radiator name")).build().inject(this);


    }

}

همانطور که ملاحظه کردید هرجایی که بخواهیم وابستگی را تزریق کنیم باید  از Inject@ استفاده کنیم و بنابراین باید کلاسی که در آن تزریق کرده ایم را توسط متدی در Component به Dagger معرفی کنیم. به نظر می رسد که بهتر است در هنگام ایجاد و تعریف وابستگی ها (Register) تا حد امکان از Inject@ استفاده نکنیم و در صورت امکان بصورت ورودی به Constructor بدهیم. دلیل من هم این است که هم خوانایی کد بالا می رود و هم تعداد متدهای Component کمتر می شود و در هنگام Resolve از Inject@ استفاده کنیم. ( Register, Resolve, Release پترنی است که در DI Container مورد استفاده قرار می گیرد که در مقاله بعد بیشتر راجع به آن صحبت خواهم کرد. )

بسیار عالی. تا اینجا با نحوه استفاده از Dagger2 آشنا شدید و دو نمونه از پیاده سازی های آن را دیدید. Dagger2 امکانات بسیار زیاد دیگری نیز دارد که انشاء الله در آموزش بعدی به همراه برسی چند مورد نکته دیگر، به آنها پرداخته و پرونده را به کل می بندیم. در ضمن می توانید پروژه تست را از گیت دانلود کنید:

منبع: بایت کد

نوشته کار با Dagger2 به زبان ساده بخش اول اولین بار در Mahdi Tajik پدیدار شد.