Effective Java Madde 30: Üreysel Metotları Tercih Edin

Tıpkı sınıflar gibi metotlar da üreysel (generic) olarak yazılabilir. Parametreli türlerle çalışan statik yardımcı metotlar (utility method) genellikle üreyseldir. Örneğin, Collections içerisindeki binarySearch ve sort gibi algoritma metotlarının hepsi üreyseldir.

Üreysel metot yazmak üreysel tür yazmakla çok benzerdir. (Madde 29) İki kümenin birleşimini döndüren aşağıdaki kusurlu metoda bakalım:

// Ham tür kullanmaktadır - kabul edilemez! (Madde 26)
public static Set union(Set s1, Set s2) {
    Set result = new HashSet(s1);
    result.addAll(s2);
    return result;
}

Bu metot derlenir ama derleyici iki tane uyarı verir (Madde 27):

Union.java:5: warning: [unchecked] unchecked call to HashSet(Collection<? extends E>) as a member of raw type HashSet
           Set result = new HashSet(s1);
                        ^
   Union.java:6: warning: [unchecked] unchecked call to
   addAll(Collection<? extends E>) as a member of raw type Set
           result.addAll(s2);
                        ^

Bu hataları giderip tür güvenliğini sağlamak için, metodun imzasını değiştirerek bir tür parametresi tanımlayabiliriz. Bu tür parametresi hem parametre olan Set nesneleri hem de geri döndürdüğümüz Set için eleman türünü belirleyecektir. Böyle metotlarda tür parametreleri metodun dönüş türünün önünde tanımlanır:

// Üreysel metot
public static <E> Set<E> union(Set<E> s1, Set<E> s2) {
    Set<E> result = new HashSet<>(s1); 
    result.addAll(s2);
    return result;
}

Basit üreysel metotlar söz konusu olduğunda aslında anlatılabilecekler bundan ibaret. Yukarıdaki metot hatasız ve uyarısız derlenir, tür güvenliği sağlar ve kullanımı kolaydır. Aşağıda bu metodu kullanan bir istemci görüyoruz:

// Üreysel metodu kullanan istemci
public static void main(String[] args) {
    Set<String> guys = Set.of("Tom", "Dick", "Harry");
    Set<String> stooges = Set.of("Larry", "Moe", "Curly");
    Set<String> aflCio = union(guys, stooges);
    System.out.println(aflCio);
}

Bu programı çalıştırdığınızda şöyle bir çıktı alırsınız:

[Moe, Tom, Harry, Larry, Curly, Dick]

Üreysel union metodunda hem metot parametreleri hem de dönüş türü aynı türden olmak zorundadır. Bunu biraz esnekleştirmek için sınırlandırılmış joker tür (bounded wildcard type – Madde 31) kullanabilirsiniz.

Bazı durumlarda, değiştirilemeyen (immutable) ama birçok türle birlikte kullanılabilen nesneler yaratmak isteyebilirsiniz. Java’da üreysellik mekanizması çalışma zamanında tür bilgisini silecek şekilde tasarlandığı için (type erasure), birçok parametreli tür için tek bir nesneyi kullanabilirsiniz. Ancak bunun için bir de kullanacağınız parametreli türleri yaratacak static fabrika metodu (static factory method) yazmanız gerekir. Bu tasarım üreysel singleton fabrikası (generic singleton factory) olarak bilinir ve Collections.reverseOrder gibi Madde 42’de anlatılan fonksiyon nesneleri, bazen de Collections.emtpySet gibi koleksiyonlar için kullanılır.

Şimdi farzedelim ki birim fonksiyonu üreten bir kod yazmak istiyoruz. Java kütüphaneleri bunu zaten sağlamaktadır (Function.identity) o yüzden yazmanıza gerek yok ama öğretici olduğu için biz burda yazacağız. Birim fonksiyonların tek yaptığı iş verilen parametreyi geri döndürmektir. Herhangi bir durum (state) tutmadığı için her ihtiyaç olduğunda yenisini üretmek israf olacaktır. Eğer Java’da üreysel türlerin ve metotların tür parametreleri çalışma zamanında kaybolmasaydı, her bir tür için farklı fonksiyonlar gerekirdi. Ancak tür bilgisi kaybolduğu için aşağıdaki kod yeterli olacaktır:

// Üreysel singleton fabrika tasarım kalıbı
private static UnaryOperator<Object> IDENTITY_FN = (t) -> t;

@SuppressWarnings("unchecked")
public static <T> UnaryOperator<T> identityFunction() { 
    return (UnaryOperator<T>) IDENTITY_FN;
}

IDENTITY_FN fonksiyonu UnaryFunction<T> ‘ye dönüştürülürken derleyici kontrolsüz tür dönüşümü (unchecked cast) uyarısı verecektir. Ancak burada IDENTITY_FN fonksiyonu kendisine verilen değişkeni aynen geri döndürdüğü için tür güvenliğini tehlikeye sokmaz. Bu sebeple de @SuppressWarnings("unchecked") notasyonu ile bu derleyici uyarısı gizlenmiştir.

Bu fabrika metodunu kullanarak UnaryOperator<String> ve UnaryOperator<Number> üretip kullanan kod aşağıdaki gibi olacaktır:

// Üreysel singleton fabrikasının kullanımı
public static void main(String[] args) {
    String[] strings = { "jute", "hemp", "nylon" };
    UnaryOperator<String> sameString = identityFunction();
    for (String s : strings) {
        System.out.println(sameString.apply(s));
    }

    Number[] numbers = { 1, 2.0, 3L };
    UnaryOperator<Number> sameNumber = identityFunction();
    for (Number n : numbers) {
        System.out.println(sameNumber.apply(n));
    }
}

Çok yaygın olmasa da bazen tür parametresinin, kendisini de içeren bir tür sınırlama ifadesiyle sınırlandırıldığını görebilirsiniz. Buna özyineli tür sınırlaması (recursive type bound) denir. Bunun çok bilinen bir örneği Comparable arayüzü ile beraber kullanılır (Madde 14):

public interface Comparable<T> {
    int compareTo(T o);
}

Burada T tür parametresi, arayüzü uygulayan sınıfın kendi nesnelerini hangi tür nesnelerle karşılaştırmak istediğini belirler. Çoğu durumda her sınıf kendi türünden nesnelerle karşılaştırılır. Bu sebeple de örneğin String sınıfı Comparable<String>, Integer ise Comparable<Integer> olarak bu arayüzü uygular.

Birçok statik yardımcı metot Comparable arayüzünü uygulayan bir Collection parametresi alarak sıralama, arama, en küçük ve en büyük değerleri hesaplama gibi işlemler yapar. Bunu yapabilmek için, Collection içinde yer alan elemanların birbirleriyle karşılaştırılabilir olması gerekir. Bu koşulu aşağıdaki gibi ifade edebiliriz:

// özyineli tür sınırlaması örnek kullanımı
public static <E extends Comparable<E>> E max(Collection<E> c);

Burada sınırlandırılmış olan tür parametresi <E extends Comparable<E>>, metoda geçilebilecek E türünün kendi türünden nesnelerle karşılaştırılabilmesi gerektiğini ifade etmektedir.

Şimdi yukarıdaki metot imzasını kullanarak bir metot gövdesi yazalım. Bu metot Collection<E> içindeki en büyük değeri bularak döndürmektedir:

// Özyineli tür sınırlaması kullanarak 
// koleksiyondaki en büyük değeri bulur
public static <E extends Comparable<E>> E max(Collection<E> c) { 
    if (c.isEmpty()) {
        throw new IllegalArgumentException("Empty collection");
    }

    E result = null;
    for (E e : c) {
        if (result == null || e.compareTo(result) > 0) {
            result = Objects.requireNonNull(e);
        }
    }
    return result;
}

Bu metot boş listeler için IllegalArgumentException fırlatmaktadır. Daha iyi bir çözüm olarak Optional<E> döndürülebilir. (Madde 55)

Özyineli tür sınırlamaları bundan çok daha karmaşık olabilmektedir ancak böyle kullanımlar çok azdır. Bu kitapta gösterilen kullanımları anladığınız taktirde pratikte karşılaşabileceğiniz çoğu durumla baş edebilirsiniz.

Özetle, üreysel metotlar da üreysel türler gibi hem daha güvenli hem de istemcilerin tür dönüşümü yapmalarına gerek kalmadığı için kullanımları daha kolaydır. Yazdığınız metotları kullanırken istemciler tür dönüşümü yapmak zorunda kalıyorsa, üreysele çevirerek bunu düzeltin. Yine türlerde olduğu gibi, kullanımları tür dönüşümü gerektiren metotları da güvenli bir biçimde üreysele çevirebilirsiniz çünkü mevcut istemciler etkilenmeyecektir. (Madde 26)

Share

Effective Java Madde 29: Üreysel Türleri Tercih Edin

JDK tarafından sağlanan üreysel türleri (generic types) ve metotları kullanmak çok zor olmasa da, kendiniz üreysel türler yazmak istediğinizde biraz zorlanabilirsiniz ama bunu öğrenmeniz çok faydalı olacaktır.

Şimdi Madde 7’deki basitleştirilmiş yığıt (stack) gerçekleştirimine bakalım:

// Object tabanlı yığıt - üreysel tür olmak için müsait!
public class Stack {
    private Object[] elements;
    private int size = 0;
    private static final int DEFAULT_INITIAL_CAPACITY = 16;

    public Stack() {
        elements = new Object[DEFAULT_INITIAL_CAPACITY];
    }
    
    public void push(Object e) { 
        ensureCapacity(); 
        elements[size++] = e;
    }

    public Object pop() { 
        if (size == 0) {
            throw new EmptyStackException();
        }
        Object result = elements[--size];
        elements[size] = null; // kullanılmayan referansı kaldır 
        return result;
    }

    public boolean isEmpty() {
        return size == 0;
    }
    
    private void ensureCapacity() {
        if (elements.length == size) {
            elements = Arrays.copyOf(elements, 2 * size + 1);
        }
    } 
}

Bu sınıf en başından beri üreysel olmalıydı ama sonradan mevcut istemcilere zarar vermeden üreysele dönüştürmek de mümkündür. Bu haliyle, istemciler yığıttan okudukları değerleri kullandıkları türe kendileri dönüştürmek zorundadır. Bu tür dönüşümleri çalışma zamanında başarısız olup aykırı durum (exception) fırlatabilir.

Bir sınıfı üreysele çevirmek için ilk adım, sınıf tanımına bir veya daha çok tür parametresi eklemektir. Bizim örneğimizde eleman türünü temsil edecek şekilde tek bir tür parametresi yeterlidir. Eleman türünü temsil eden tür parametreleri genellikle E olarak isimlendirilir. (Madde 68)

Sonraki adım ise Object türü kullanılan yerlere yeni tanımladığımız tür parametresini yazıp programı derlemek olacaktır:

// Yığıtı üreysel türe çevirmek için ilk deneme. Derlenmez!
public class Stack<E> {
    private E[] elements;
    private int size = 0;
    private static final int DEFAULT_INITIAL_CAPACITY = 16;

    public Stack() {
        elements = new E[DEFAULT_INITIAL_CAPACITY];
    }

    public void push(E e) { 
        ensureCapacity(); 
        elements[size++] = e;
    }

    public E pop() { 
        if (size == 0) {
            throw new EmptyStackException();
        }
        E result = elements[--size];
        elements[size] = null; // kullanılmayan referansı kaldırın 
        return result;
    }
       ... // isEmpty ve ensureCapacity değişmiyor
}

Stack sınıfını yukarıdaki gibi üreysel türe dönüştürmeye çalışırsak aşağıdaki üreysel dizi yaratma (generic array creation) hatasını alırız:

Stack.java:8: generic array creation
        elements = new E[DEFAULT_INITIAL_CAPACITY];
                   ^

Madde 28’de anlatıldığı gibi E gibi tür parametrelerinden dizi yaratamayız. Bu problem, arka planda dizi kullanan üreysel türler yazmaya çalıştığınızda her zaman karşınıza çıkacaktır. Mantıklı bir şekilde çözmek için iki yol bulunur. Birincisi, diziyi E türünde yaratmak yerine Object türünde yaratıp sonradan E türüne dönüştürmektir. Yani yukarıdaki örnekte 8. satırı aşağıdaki gibi değiştirebiliriz:

elements = (E[]) new Object[DEFAULT_INITIAL_CAPACITY];

Bu kullanım geçerlidir ancak derleyici bu sefer hata yerine tür güvenliğini sağlayamadığı için uyarı verecektir.

Stack.java:8: warning: [unchecked] unchecked cast
   found: Object[], required: E[]
         elements = (E[]) new Object[DEFAULT_INITIAL_CAPACITY]; 
                        ^

Derleyici burada tür güvenliği olup olmadığından emin olamasa da, siz bunu kanıtlayabilirsiniz. Tabi öncelikle buradaki kontrolsüz tür dönüşümünün programdaki tür güvenliğini tehlikeye düşürmediğinden emin olmalısınız. Burada söz konusu olan elements dizisi private bir alanda saklanıyor ve istemciye asla döndürülmüyor. Diziye eleman eklenen tek yer push metodu. Burada da E türünde geçilen parametreler diziye eklendiği için tür güvenliğini sıkıntıya sokacak bir durum yoktur, dolayısıyla yapılan tür dönüşümü güvenlidir.

Tür dönüşümünün güvenli olduğunu kanıtladığımıza göre, derleyici uyarısını @SuppressWarnings("unchecked") notasyonu ile gizlemeyi deneyebiliriz. (Madde 27) Burada uyarıya sebep olan yapıcı metodun (constructor) tek yaptığı iş dizi yaratmak olduğu için, notasyonu yapıcı metoda uygulamakta bir sakınca yoktur. Yapıcı metot aşağıdaki şekilde güncellendiğinde sınıf hata ve uyarı vermeden derlenir:

// elements dizisi sadece push(E) tarafından eklenen E nesneleri
// içermektedir. Bu, tür güvenliğinin sağlanması için yeterlidir.
// Çalışma zamanında dizinin türü Object[] olacaktır, E[] değil.
@SuppressWarnings("unchecked")
public Stack() {
    elements = (E[]) new Object[DEFAULT_INITIAL_CAPACITY];
}

Stack sınıfı içerisinde üreysel dizi yaratma hatasını ortadan kaldırmanın ikinci yolu ise elements dizisinin türünü E[] yerine Object[] yapmaktır. Ancak bunu deneyince aşağıdaki gibi başka bir hata alırsınız:

 Stack.java:19: incompatible types
   found: Object, required: E
           E result = elements[--size];
                              ^

Burada artık elements bir Object dizisi olduğu için, diziden okunan değeri E türündeki referansta saklamamız tür uyumsuzluğundan dolayı mümkün olmuyor. Tabi biz okunan değeri E türüne dönüştürerek hatadan kurtulabiliriz. Stack sınıfında 20. satırı aşağıdaki gibi değiştirirsek:

E result = (E) elements[--size];

Sınıfı tekrar derleyince hata kaybolacaktır ama yine bir uyarı alırsınız:

Stack.java:19: warning: [unchecked] unchecked cast
   found: Object, required: E
        E result = (E) elements[--size]; 
                               ^

Bu ilk çözümde rastladığımıza çok benzer bir uyarı. Derleyici tür güvenliğini garanti edemediği için bizi uyarıyor. Ancak burada da biz tür güvenliği olduğundan eminiz, çünkü diziye eleman eklenen tek yer push metodu ve burada sadece E türünden elemanlar ekleniyor. Dolayısıyla okunan değer de E türünde olmak zorundadır. Madde 27’de anlatılan önerileri göz önünde bulundurarak, uyarıyı sadece buna sebep olan satır için gizliyoruz, pop metodu için değil:

// tür dönüşüm uyarısının doğru biçimde gizlenmesi
public E pop() {
    if (size == 0) {
        throw new EmptyStackException();
    }

    // push metodu sadece E türünden elemanlar eklediğinden 
    // tür dönüşümü güvenlidir
    @SuppressWarnings("unchecked") 
    E result = (E) elements[--size];
    elements[size] = null; // kullanılmayan referansı kaldırın
    return result;
}

Burada anlattığımız iki yöntem de kullanılabilir. Birinci yöntemde okunabilirlik daha yüksektir çünkü dizi sadece E türünden elemanları tuttuğunu açıkça göstermek için E[] türünde tanımlanmıştır. Ayrıca sadece bir yerde, dizi yaratılırken tür dönüşümü yapılmaktadır. Bu şekilde üreysel türler yazılırken çoğunlukla birden fazla yerde diziden okuma yapılır. İkinci yöntem bu sebeple dezavantajlıdır çünkü her okuma yapılan yerde tür dönüşümü de yapılması gerekir. Bu yüzden de pratikte genelde birinci yöntem tercih edilir. Ancak birinci yöntemin dezavantajı da dizinin çalışma zamanındaki türü ile derleme zamanındaki türü uyuşmadığı için yığın kirliliğine (heap pollution – Madde 32) sebep olmasıdır. (E türünün Object‘i temsil ettiği durumda bu problem yaşanmaz ) Bazı programcılar bu konuda çok hassas davranıp ikinci yöntemi tercih etmektedirler, ancak bizim örneğimizde yığın kirliliği zararsızdır.

Aşağıdaki program üreysel Stack sınıfının kullanımını örneklemektedir. Komut satırından geçilen argümanları ters sırada ve büyük harflere çevirerek yazdırmaktadır. String‘in toUpperCase metodunu çağırırken tür dönüşümü yapmaya gerek kalmamıştır:

// Üreysel Stack kullanımı
public static void main(String[] args) {
    Stack<String> stack = new Stack<>();
    for (String arg : args)
        stack.push(arg);
    while (!stack.isEmpty())
        System.out.println(stack.pop().toUpperCase());
}

Bu maddede verdiğimiz Stack örneği, diziler yerine listeler kullanmayı önerdiğimiz Madde 28 ile çelişebilir. Üreysel türler içerisinde dizi yerine liste kullanmak her zaman mümkün olmayabilir veya istenmeyebilir. ArrayList gibi bazı üreysel türler mecburen dizileri kullanacak şekilde yazılmıştır. HashMap gibi örnekler de performans kazanımı için dizilerden faydalanmaktadır.

Bizim Stack örneğinde olduğu gibi, üreysel türlerin büyük çoğunluğu herhangi bir kısıtlamaya gitmeden istediğiniz tür parametrelerini kullanmanıza izin verirler. Örneğin Stack<Object>, Stack<int[]>, Stack<List<String>> gibi kullanımların hepsi geçerlidir, istediğiniz herhangi bir referans türünden elemanlar tutan bir Stack yaratabilirsiniz. Ancak int, double gibi temel türleri tutan bir Stack yaratmaya çalışırsanız derleme hatası alırsınız. Bu, Java’da üreysel tür sisteminin kısıtlarından birisidir. Ancak bunların yerine Integer, Double gibi kutulanmış temel türleri (boxed primitive type) kullanarak bu sorunu aşabilirsiniz. (Madde 61)

Kullanılabilecek tür parametrelerinde kısıtlama yapan üreysel türler de mevcuttur. Örneğin java.util.concurrent.DelayQueue sınıfının tanımı aşağıdaki gibidir:

class DelayQueue<E extends Delayed> implements BlockingQueue<E>

Burada parametre olarak tanımlanan <E extends Delayed>, ifadesinin anlamı şudur: istemci tür parametresi olan E yerine sadece Delayed türünün bir alt türünü geçebilir. Bu şekilde DelayQueue sınıfı ve bu sınıfın istemcileri, DelayQueue‘nun elemanları için Delayed türünden gelen metotları da tür dönüşümüne gerek kalmadan ve ClassCastException riski olmadan kullanabilirler. Buradaki tür parametresi E aynı zamanda sınırlandırılmış tür parametresi (bounded type parameter) olarak da anılır. Java’da her tür kendisinin alt türü kabul edildiği için (JLS 4.10), DelayQueue<Delayed> geçerli bir ifadedir.

Özetle, istemcilerin kullanırken tür dönüşümü yapmak zorunda kaldığı türlere kıyasla üreysel türleri kullanmak hem daha güvenlidir hem de istemcilere kullanım kolaylığı sağlar. Yeni türler tanımlarken, istemcilerin tür dönüşümü yapmadan bunları kullanabileceğinden emin olun. Bu çoğu zaman bu türlerin üreysel olarak tasarlanması anlamına gelmektedir. Eğer üreysel olması gerektiği halde olmayan türleriniz varsa bunları güvenle üreysele dönüştürebilirsiniz çünkü mevcut istemciler etkilenmeyecek ve yeni istemciler için kolaylık sağlayacaktır. (Madde 26)

Share