Java @ Održana bilješka

1. Pregled

U ovom ćemo brzom vodiču pogledati zastarjele API-je u Javi i kako koristiti @Deprecated bilješka.

2. The @Deprecated Bilješka

Kako se projekt razvija, njegov se API mijenja. Vremenom postoje određeni konstruktori, polja, vrste ili metode koje ne želimo da ljudi više koriste.

Umjesto da prekinemo povratnu kompatibilnost API-ja projekta, ove elemente možemo označiti znakom @Deprecated bilješka.

@Deprecated govori ostalim programerima dathe označeni element više ne bi smio biti korišten. Uobičajeno je dodati i Javadoc pored @Deprecated napomena koja objašnjava koja bi bila bolja alternativa koja služi ispravnom ponašanju:

public class Worker {/ ** * Izračunajte razdoblje između verzija * @deprecated * Ova metoda više nije prihvatljiva za izračunavanje vremena između verzija. * 

Umjesto toga upotrijebite {@link Utils # CalcuPeriod (Machine)}. * * @param instanca stroja * @return izračunato vrijeme * / @Osviješteno javno int izračunavanje (Strojni stroj) {return machine.exportVersions (). size () * 10; }}

Imajte na umu da kompajler prikazuje zastarjelo API upozorenje samo ako se označeni Java element koristi negdje u kodu. Dakle, u ovom bi se slučaju pokazalo samo da postoji kod koji se zove izračunati metoda.

Također, zastarjeli status možemo priopćiti i u dokumentaciji pomoću Javadoca @odgovoreno označiti.

3. Izborni atributi dodani u Javi 9

Java 9 dodaje neke neobavezne atribute @Deprecated napomena: od i zaUklanjanje.

The od atribut zahtijeva niz koji nam omogućuje definiranje u kojoj je verziji element zastario. Zadana vrijednost je prazan niz.

I zaUklanjanje je boolean koji nam omogućuje da odredimo hoće li element biti uklonjen u sljedećem izdanju. Njegova je zadana vrijednost lažno:

public class Worker {/ ** * Izračunajte razdoblje između verzija * @deprecated * Ova metoda više nije prihvatljiva za izračunavanje vremena između verzija. * 

Umjesto toga upotrijebite {@link Utils # CalcuPeriod (Machine)}. * * @param instanca stroja * @return izračunato vrijeme * / @ Odgojeno (jer = "4.5", forRemoval = true) public int izračun (Strojni stroj) {return machine.exportVersions (). size () * 10; }}

Jednostavno rečeno, gornja upotreba to znači izračunati zastario je od 4,5 naše biblioteke i njegovo je uklanjanje zakazano za sljedeće veliko izdanje.

Korisno nam je dodati ovo od sastavljač će nas upozoriti snažnije ako utvrdi da koristimo metodu s tom vrijednošću.

A već postoji podrška iz IDE-aza otkrivanje korištenja metode označene s forRemoval = true. IntelliJ, na primjer, probija kôd crvenom linijom umjesto crnom.

4. Zaključak

U ovom kratkom članku vidjeli smo kako se koristi @Deprecated napomena i njezini neobavezni atributi za označavanje koda koji se više ne bi trebali koristiti.

Cjeloviti izvorni kod za primjere možete pronaći na GitHubu.