سلام دوستان عزیز، متاسفانه کمی طول کشید تا مطلب آموزشی بگذارم، کامنت ها و استقبال شما انرژی خاصی به من داد تا هرچه زود تر نسبت به کامل کردن این بحث اقدام کنم. خیلی خوب، در مقاله قبلی با نحوه استفاده از 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 پدیدار شد.

, جاوا انوتیشن اطلاعات اضافی به کد ما اضافه می کند که بخشی از برنامه نیست ولی تاثیر در اجرای برنامه می گذارد.

Annotations, a form of metadata, provide data about a program that is not part of the program itself. Annotations have no direct effect on the operation of the code they annotate.

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

انوتیشن های زیادی توسط خود زبان جاوا استفاده می شوند که شاید با خیلی از آنها همچون @Override آشنا باشید. علاوه بر انواع موجود می توان انوتیشن اختصاصی داشته باشیم که در مثال های بعدی با آنها مواجه خواهیم شد. توجه داشته باشید که انوتیشن می تواند ورودی داشته باشد یا اینکه نداشته باشد.

چند نمونه:

@Override  به کامپایلر می گوید که متد اظهار شده در کلاس اصلی را با دستوراتی ما بازنویسی کند.

@SuppressWarnings می گوید که اخطارها را سرکوب کن. گرچه نمایش اخطار مفید است ممکن است در مواردی بخواهیم تا کامپایلر اخطاری را نمایش ندهد.

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

@SuppressWarnings("unused")
public void unusedmethod(){

    //some methods
}

@SuppressWarnings("deprecation")
public void oldmethdthatDepricated(){

    //some methods
}

بعضی انوتیشن ها هم برای توصیف انوتیشن های دیگر بکار می رود. یعنی انوتیشن برای انوتیشن:

@Retention می گوید که انوتیشن موردنظر چگونه ذخیره شود. استفاده است مثلا RetentionPolicy.SOURCE  انوتیشن اشاره شده در سطح سورس کدمی ماند و توسط کامپایلر قابل دسترسی نباشد. اگر مقدار را  RetentionPolicy.CLASS  بگذاریم باعث می شود که انوتیشن مان در زمان کامپایل در نظر گرفته شود و توسط JVM ایگنور شود و یا توسط RetentionPolicy.RUNTIME انوتیشنمان توسط JVM نگهداری شود و در زمان اجرا قابل استفاده است.

@Documented می گوید که انوتیشن بکار رفته باید توسط ابزار سندسازی جاوا به سند تبدیل شوند.

@Target  توسط این انوتیشن، دسترسی المنت های جاوا به انوتیشن ما را محدود می کند و انواع انتخاب شده می توانند به انوتیشن ما دسترسی داشته باشند.

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

@Repeatable  این امکان در جاوای ۸ اضافه شده که می توانیم چند انوتیشن یکسان ولی با مقادیر مختلف را به یک متد اضافه کنیم. مثلاً در مثال زیر دوبار انوتیشن آلارم را با دو role متفاوت اعمال کردیم.

@Alert(role="Manager")
@Alert(role="Administrator")
public class UnauthorizedAccessException extends SecurityException { ... }

حال که با برخی انوتیشن های پیش فرض آشنا شدیم می خواهیم نحوه ساخت انوتیشن را باهم برسی کنیم. انوتیشن بسیار شبیه به اینترفیس ساخته می شود با این تفاوت که از کاراکتر @ استفاده می کنیم.

package com.example.mtajik.annotationtest;


import java.lang.annotation.*;

@Inherited
@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)

@interface BasicInformation {
    String corpId() default "mobiro";
    String corpAddress() default "kordestan .st";
}

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

package com.example.mtajik.annotationtest;

@BasicInformation(corpId="Irancell", corpAddress="Vanak .ave")
public class Employee {
    String eId;
    String eName;
    public Employee(String eId, String eName){
        this.eId = eId;
        this.eName = eName;
    }

    public void getEmployeeDetails(){
        System.out.println("Employee ID: "+eId);
        System.out.println("Employee Name: "+eName);
    }
}

سپس کلاس زیر را بسازید و برنامه را اجرا کرده و نتیجه را در کنسول ببینید. همانطور که در اول اشاره کردم این کلاس همان ابزار تجزیه انوتیشن است که توسط reflection در هنگام Runtime انوتیشن های موجود در کلاس را گرفته و نتیجه را نمایش می دهد.

package com.example.mtajik.annotationtest;


import java.lang.annotation.Annotation;
public class TestCustomAnnotationBasicBenefits {
    public static void main(String[] args) throws Exception{
        Employee emp = new Employee("E-100", "user3320018");
        emp.getEmployeeDetails();
        Class reflectedClass = emp.getClass();

        Annotation informationAnn = reflectedClass.getAnnotation(BasicInformation.class);
        BasicInformation bBenefits = (BasicInformation)informationAnn;
        System.out.println("corporation ID: "+bBenefits.corpId());
        System.out.println("corporation address: "+bBenefits.corpAddress());
    }
}

ملاحظه کردید که چگونه می توان با استفاده از Annotation از Meta-data در هنگام Runtime دسترسی پیدا کرد و استفاده کرد.

همچنین می توان با استفاده از انوتیشن نوع ورودی را برای یک تابع محدود کرد و با آن مانند enum برخورد کرد. هرچند به نظر شخصی بنده بسیار مفید تر از enum خواهد بود زیرا اطلاعاتی به همراه دارد که بسیار جای مانور دارد. به مثال زیر توجه کنید.

IntDef

انوتیشنی است که توسط آن یک عنصر  integer را ارائه می دهد که در هنگام استفاده فقط می توانیم از مقادیر داده شده استفاده کنیم. ما یک انوتیشن داریم به عنوان روزهای هفته که انواع آن را از مقادیر static انتخاب کردیم. ( انواع آن روزهای هفته است)

static public final int SHANBE_ = 0;
static public final int YEK_SHANBE_ = 1;
static public final int DO_SHANBE = 2;
static public final int SE_SHANBE_ = 3;
static public final int CHAHR_SHANBE_ = 4;
static public final int PANJ_SHANBE_ = 5;
static public final int JOMHE_ = 6;

@IntDef({SHANBE_, YEK_SHANBE_,DO_SHANBE,SE_SHANBE_,CHAHR_SHANBE_,PANJ_SHANBE_, JOMHE_})
@Retention(RetentionPolicy.SOURCE)
@Inherited
public @interface RozayeHafte {}

حال متدی برای محاسبه حقوق داریم که ورودی آن را از جنس این انوتیشن می گذاریم. حال هر جا که متد را صدا بزنید intellisense ide یعنی Android Studio به عوان ورودی پیش فرض همان روز ها را به ما پیشنهاد می دهد! جالب است نه؟ این همان کاری است که در هنگام انتخاب visibility در View خودش بطور پیش فرض GONE و Visible و Invisible را پیشنهاد می دهد و اگر سورس کد View را در SDK های زیر ۲۲ ببینید ملاحظه خواهید کرد که از همین روش برای مشخص کردن ورودی هایش استفاده کرده است.

استفاده از StringDef هم بهمین صورت است با این تفاوت که انواع آن string هستند.

سورس کامل

public class MainActivity extends AppCompatActivity {
    
    static public final int SHANBE_ = 0;
    static public final int YEK_SHANBE_ = 1;
    static public final int DO_SHANBE = 2;
    static public final int SE_SHANBE_ = 3;
    static public final int CHAHR_SHANBE_ = 4;
    static public final int PANJ_SHANBE_ = 5;
    static public final int JOMHE_ = 6;

    static public final String GHAWY = "ghavi";
    static public final String ZAEEF = "zaeef";
    static public final String PIZORI = "pizoori";


    public void mohasebeheHoggogh(@RozayeHafte int day, @GhodratBadani String body) {

        switch (day) {
            case SHANBE_:
                Toast.makeText(MainActivity.this, body + " SHANBE_", Toast.LENGTH_SHORT).show();
                break;
            case YEK_SHANBE_:
                Toast.makeText(MainActivity.this, body + " YEK_SHANBE_", Toast.LENGTH_SHORT).show();
                break;
            case JOMHE_:
                Toast.makeText(MainActivity.this, body + " JOMHE_", Toast.LENGTH_SHORT).show();
                break;
        }

    }


    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        
        mohasebeheHoggogh(JOMHE_, GHAWY);
    }

    private enum RozhayeHafteType2 {
        SHANBE_,
        YEK_SHANBE_,
        JOMHE_

    }

    @IntDef({SHANBE_, YEK_SHANBE_, DO_SHANBE, SE_SHANBE_, CHAHR_SHANBE_, PANJ_SHANBE_, JOMHE_})
    @Retention(RetentionPolicy.SOURCE)
    @Inherited
    public @interface RozayeHafte {
    }


    @StringDef({GHAWY, ZAEEF, PIZORI})
    @Inherited
    @Retention(RetentionPolicy.SOURCE)
    public @interface GhodratBadani {
    }
}

منبع: بایت کد

نوشته Java Annotation چیست؟ اولین بار در Mahdi Tajik پدیدار شد.