Effective Java Madde 31: API Esnekliğini Artırmak İçin Sınırlandırılmış Joker (bounded wildcard) Kullanın

Madde 28’de anlatıldığı üzere parametreli türler arasında hiçbir koşulda alt tür/üst tür ilişkisi bulunmaz. Örneğin String türü Object‘in bir alt türü olmasına rağmen, List<String> ile List<Object> arasında böyle bir ilişki bulunmaz. List<Object> içerisine istediğiniz türden nesneleri koyabilirsiniz ama List<String> sadece String türünden nesneler içerebilir. Bu durumda List<String> türü, List<Object> türünün yaptığı her işi yapamadığına göre, alt türü de değildir.

Bu her ne kadar mantıklı olsa da bazı durumlarda bizi kısıtlayabilir. Madde 29’daki üreysel yığıt olarak tasarladığımız Stack sınıfını düşünelim. Hafızanızı tazelemek için API hatırlatması yapalım:

public class Stack<E> {
    public Stack();
    public void push(E e);
    public E pop();
    public boolean isEmpty();
}

Farzedelim ki bu sınıfa bir dizi nesne alıp hepsini yığıta ekleyen yeni bir metot yazmak istiyoruz. İlk denememiz aşağıdaki gibi olsun:

// joker tür kullanmayan pushAll metodu - kusurlu!
public void pushAll(Iterable<E> src) {
    for (E e : src) {
        push(e);
    }
}

Bu metot tertemiz derlenir ama tam tatmin edici değildir. src içerisindeki elemanların türü ile yığıtın eleman türü tıpatıp aynı ise sorunsuz çalışır. Elinizde bir Stack<Number> varsa ve siz yığıta tek bir eleman eklemek için push metodunu bir Integer nesnesi ile çağırırsanız sorunsuz çalışacaktır çünkü Integer sınıfı Number‘ın bir alt türüdür. Mantık olarak aşağıdakinin de çalışmasını beklersiniz:

Stack<Number> numberStack = new Stack<>();
Iterable<Integer> integers = ... ;
numberStack.pushAll(integers);

Ancak denediğinizde aşağıdaki gibi bir hata alırsınız:

StackTest.java:7: error: incompatible types: Iterable<Integer>
   cannot be converted to Iterable<Number>
           numberStack.pushAll(integers);
                               ^

Burada hata almamızın sebebi, yazının başında belirtildiği gibi Integer ile Number arasında bulunan alt/üst tür ilişkisinin Iterable<Integer> ile Iterable<Number> arasında bulunmamasıdır.

Şanslıyız ki bunun bir çözümü var. Java bizlere sınırlandırılmış joker tür (bounded wildcard type) adında özel bir tür parametresi belirleme imkanı sunmaktadır. Bizim pushAll metodundan istediğimiz aslında sadece E türünden değil, E‘nin alt türlerinden nesneler içeren bir Iterator geçtiğimizde de doğru çalışarak bunları yığıta eklemesi. İşte joker tür tam burada devreye giriyor. pushAll metodunun parametresini Iterable<? extends E> olarak değiştirdiğimizde amacımıza ulaşmış oluyoruz. <? extends E> ifadesi E‘nin kendisi ve onu kalıtan türler anlamına gelmektedir. (Burada extends ifadesi hafif bir kafa karışıklığına sebep olabilir. Madde 29’dan hatırlayın, Java’da her tür kendisinin alt türü sayıldığı için bu ifade E türünü de kapsamaktadır.) Şimdi pushAll metodunu buna göre güncelleyelim:

// sınırlandırılmış joker tür ile esnekleştirilmiş pushAll metodu
public void pushAll(Iterable<? extends E> src) {
    for (E e : src) {
        push(e);
    }
}

Metodu yukarıdaki gibi yazdığımızda hem Stack sınıfı hem de daha önce hata veren istemci sınıfı sorunsuz derlenecek ve çalışacaktır. Derleyiciden uyarı almadığımız için tür güvenliğini de sağladığımızdan emin olabiliriz.

Şimdi de pushAll metoduna eşlik etmek üzere bir de popAll metodu yazmaya çalışalım. Bu metot yine bir koleksiyon parametresi alacak ama bu sefer yığıttaki elemanları çıkartıp bu koleksiyona ekleyecektir. Bu şekildeki bir popAll metodunu ilk denemede şöyle yazabiliriz:

// joker tür kullanılmayan popAll metodu, kusurlu!
public void popAll(Collection<E> dst) {
    while (!isEmpty()) {
        dst.add(pop());
    }
}

Önceki durumda olduğu gibi, eğer istemcinin geçtiği dst koleksiyonunun tür parametresi E ile yığıttaki elemanların türü tıpatıp aynı ise kod sorunsuz çalışacaktır. Ancak bu yine tatmin edici olmaz. Elimizde Stack<Number> türünde bir Stack varsa ve biz pop metodunu çağırıp sonucu bir Object içinde saklamak istesek hiçbir sorunla karşılaşmayız. O zaman aşağıdakini de yapabilmemiz gerekmez mi?

Stack<Number> numberStack = new Stack<Number>();
Collection<Object> objects = ... ;
numberStack.popAll(objects);

Bu istemci kodunu popAll metodunu da içeren Stack ile beraber derlersek, pushAll yazmaya çalışırken ilk başta aldığımıza çok benzer bir hatayla karşılaşırız. Bunun sebebi yine Collection<Object> ile Collection<Number> arasında bir alt/üst tür ilişkisi olmamasıdır. Bu sorunu da yine sınırlandırılmış joker tür ile çözebiliriz ama arada ufak bir fark var. Bu sefer yığıta yazma degil de okuma yaptığımız için, geçtiğimiz koleksiyon türünün E‘nin alt türlerini değil üst türlerini ifade etmesi gerekir. Bunu ifade etmenin yolu da tür parametresini Collection<? super E> olarak değiştirmektir. Dikkat ederseniz burada extends ifadesi üst türleri ifade edebilmek için super olarak değişti. Java’da her tür kendisinin üst türü olarak kabul edildiği için bu ifade hem E türünün kendisini de kapsamaktadır. Şimdi popAll metodunu yeniden yazalım:

// joker türünün üst türler için kullanımı  
public void popAll(Collection<? super E> dst) {
    while (!isEmpty()) {
        dst.add(pop());
    }
}

Bu kod kullanıldığı zaman hem Stack sınıfı hem de istemci uyarısız ve hatasız derlenip çalışacaktır.

Buradaki ders bellidir. Esnekliği artırmak için üretici (producer) ve tüketicileri (consumer) temsil eden girdi parametrelerini (input parameter) joker tür kullanarak tanımlayın. Farklı bir biçimde ifade edecek olursak, metoda geçilen parametreli tür T nesneleri üretmek için kullanılıyorsa <? extends T>, T nesnelerini tüketmek için kullanılıyorsa <? super T> kullanın.

Bizim pushAll örneğinde parametreli koleksiyon türü yığıt için yeni eleman üretmek için kullanıldığı için (üretici) extends, popAll metodunda ise benzer parametre yığıttan eleman çıkarmak için kullanıldığı için (tüketici) super kullanılmıştır. Şunu da belirmek gerekir ki, bir parametre hem üretici hem de tüketici görevi görüyorsa o zaman joker türü kullanmanın bir anlamı yoktur. Joker tür kullanmadan normal tür parametresi geçmek daha doğru olacaktır.

Bu kuralı unutmamak için PECS olarak aklımızda tutabiliriz. Bunun açılımı yukarıdaki anlatıma uygun olarak producer-extends, consumer-super olarak düşünülebilir. (producer=üretici, consumer=tüketici)

Bu ipucunu aklımızda tutarak, kitabın Üreyseller bölümünün daha önceki maddelerinde gördüğümüz örneklere tekrar bakalım. Madde 28‘deki Chooser sınıfının yapıcı metodundan başlayalım:

public Chooser(Collection<T> choices)

Bu yapıcı metot choices koleksiyonunu kullanarak T türünde nesneler üretmekte ve bunları sonradan kullanmak için saklamaktadır. Bu durumda üretici olduğundan dolayı joker türü extends ile kullanılmalıdır. Şimdi bu şekilde tekrar yazalım:

// T üreticisi görevi gören parametre için joker tür kullanımı
public Chooser(Collection<? extends T> choices)

Peki bu yeni tanım pratikte ne işimize yarayacak? Diyelim ki elimizde Chooser<Number> var ve biz yapıcı metoda List<Integer> geçmek istiyoruz. Orijinal tanımda bu mümkün olmazdı ama yukarıdaki gibi joker tür kullandığımızda sorunsuz çalışacaktır.

Şimdi de Madde 30’daki union metoduna bakalım. Bu metot parametre aldığı iki kümeyi birleştirip tek bir küme olarak döndürüyor:

public static <E> Set<E> union(Set<E> s1, Set<E> s2)

Hem s1 hem de s2 parametreleri üreticidir. PECS kuralına göre ikisini de extends ifadesi ile joker türe dönüştürebiliriz:

public static <E> Set<E> union(Set<? extends E> s1, 
                               Set<? extends E> s2)

Dikkat ederseniz, parametre olan Set türlerini joker türe çevirdik ama dönüş türünü (return type) ellemedik. Bu esneklik sağlamanın tersine, istemcileri joker türü kullanmaya zorlardı, bu istenen bir durum değildir. Yukarıdaki gibi güncellenen bir union metodunu kullanan aşağıdaki gibi bir istemci yazabiliriz (Java 8 ve sonrası):

Set<Integer> integers = Set.of(1, 3, 5);
Set<Double>  doubles  = Set.of(2.0, 4.0, 6.0);
Set<Number>  numbers  = union(integers, doubles);

Doğru kullanıldıklarında joker türler istemciler için görünmez olurlar, yani istemciler bunları fark etmeden dahi kodlarını yazabilirler. Kabul edilmesi gereken metot parametrelerini kabul eder, reddedilmesi gerekenleri reddelerler. Eğer bir sınıfın kullanıcısı kod yazarken sınıfta kullanılan joker türleri düşünüyorsa o sınıfın API’ında bir sorun var demektir.

Yine Madde 30’daki max metoduna bakalım. Tanımı şu şekildeydi:

public static <T extends Comparable<T>> T max(List<T> list)

Bunu PECS kuralına göre yeniden düzenlersek aşağıdaki gibi bir sonuç çıkar:

public static <T extends Comparable<? super T>> T max( 
                                List<? extends T> list)

Bu sonuca ulaşmak için iki kere PECS kuralını uyguladık. İlk olarak list parametresini T nesneleri ürettiği için List<T> iken List<? extends T> olarak değiştirdik. Kafa karıştırıcı kısım ise T extends Comparable<T> ifadesinin T extends Comparable<? super T> olarak değiştirilmiş olması. Bunun sebebi de Comparable<T> arayüzünün karşılaştırma yaparken T türündeki nesneleri tüketmesidir, bu sebeple de extends yerine super kullanılmıştır. (Burada tüketmek derken illa ki bir koleksiyondan çıkartılması, yok edilmesi manası çıkartılmamalıdır. Bir nesnenin parametre alınıp okunarak bir iş için kullanılması ”tüketilmesi” demektir)

Comparable ve Comparator her zaman tüketicidir. Bu sebeple Comparable<T> yerine Comparable<? super T>, Comparator<T> yerine de Comparator<? super T> kullanmanız önerilir.

Yukarıda yeniden yazdığımız max metodu bu kitapta göreceğiniz en karmaşık metot tanımıdır diyebiliriz. Peki bu karmaşıklık bize ne kazandırıyor? Örneğin aşağıdaki liste orijinal max metoduna parametre geçilemez, ama joker türlerle geliştirdiğimiz max metoduna bu listeyi geçebiliriz:

List<ScheduledFuture<?>> scheduledFutures = ... ;

Hatırlayacağınız üzere orijinal tanımda T extends Comparable<T> şunu söylemektedir: T türü sadece kendisiyle direk olarak karşılaştırılabilen türlerden seçilebilir. Bu listede kullanılan ScheduledFuture türü Comparable<ScheduledFuture> arayüzünü uygulamadığı için orijinal max metoduna geçilemez. Ancak ScheduledFuture arayüzü Delayed arayüzünü ve Delayed arayüzü de Comparable<Delayed> arayüzünü kalıtmaktadır. Bunun anlamı şudur: ScheduledFuture kendi türünden nesneler ile karşılaştırılamasa da, üst türü olan Delayed nesneleri ile karşılaştırılabilir. Bu durumda super kullanılarak eklenen joker tür parametresi problemi çözmektedir. Comparable (veya Comparator) arayüzünü direk uygulamayan ama uygulayan bir üst türü kalıtan türleri desteklemek istiyorsak yukarıdaki gibi bir joker tür parametresi kullanmamız gerekir

Joker türlerle alakalı tartışmaya değer bir konu daha var. Aşağıdaki gibi bir swap metodunu üreysel mekanizmalar kullanarak tanımlamanın iki yolu vardır. Birincisi sınırlandırılmamış tür parametresi (Madde 30) ikincisi ise sınırlandırılmamış joker türü kullanmaktadır:

// swap metodunun iki farklı tanımı
public static <E> void swap(List<E> list, int i, int j); 
public static void swap(List<?> list, int i, int j);

Bunlardan hangisini kullanmak daha mantıklıdır ve neden? Açık (public) bir API için ikinci kullanım daha mantıklıdır çünkü daha basittir. İstediğiniz bir listeyi geçebilirsiniz ve metot i ve j indislerindeki (index) elemanları yer değiştirecektir. Tür parametresi ile ilgilenmeye gerek yoktur. Bir kural olarak, eğer tür parametresi metot tanımında sadece bir kere görülüyorsa bunu joker türüne çevirebilirsiniz. Tür parametresi sınırlandırılmamış ise sınırlandırılmamış joker, sınırlandırılmış ise de sınırlandırılmış jokere çevirebilirsiniz.

Ancak ikinci swap tanımıyla ilgili bir problem vardır, aşağıdaki gibi yazıldığında derlenmeyecektir:

public static void swap(List<?> list, int i, int j) {
    list.set(i, list.set(j, list.get(i)));
}

Bu kod aşağıdaki gibi çok da anlaşılmayan bir hata vermektedir:

Swap.java:5: error: incompatible types: Object cannot be
   converted to CAP#1
           list.set(i, list.set(j, list.get(i)));
                                           ^
     where CAP#1 is a fresh type-variable:
       CAP#1 extends Object from capture of ?

Bir elemanı listeden okuyup sonra aynı listede başka bir indise yazarken hata almak pek de mantıklı değil. Buradaki problem şudur: List<?> türünden listelere null haricinde bir değer yazmak yasaktır. Ancak bunu tür güvenliğini tehlikeye atmadan çözmek mümkündür. Yardımcı bir private metot yazarak ? ile temsil edilen türü yakalayabilir, sonra da elemanları yer değiştirebiliriz:

public static void swap(List<?> list, int i, int j) {
    swapHelper(list, i, j);
}

// joker türünü yakalamak için yazılmış yardımcı metot
private static <E> void swapHelper(List<E> list, int i, int j) { 
    list.set(i, list.set(j, list.get(i)));
}

swap metodunda ? ile temsil edilen tür bilgisi swapHelper içerisinde artık E ile ifade edilmektedir. İçinde E türünden nesneler olan bir listenin elemanlarının yerlerini değiştirmek tür güvenliğini tehlikeye atmayacağı için bu kod tertemiz derlenecektir. Biraz dolambaçlı bir yöntem gibi görünse de, bu sayede istemciler daha karmaşık görünen swapHelper metodunun imzasını görmeyecek ama bundan faydalanabilecektir.

Özetle, API tasarlarken joker türler kullanmak biraz alengirli olsa da esnekliği çok artıracaktır. Eğer çok kullanılan bir kütüphane yazacak olursanız, joker tür kullanımı çok daha önemli hale gelmektedir. Temel PECS (producer-extends consumer-super) kuralımızı hatırlayın. Comparable ve Comparator her zaman tüketicidir, bunu da aklınızdan çıkarmayın.

Share

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