Mybatis -Custom Query

Mybatis, veri tabanı sorgulama işlemini java class'ları yardımı ile çok kolay kılsa da bütün sorgulama işlemlerini bu şekilde yapamayacağımızı bilmemiz gerekir. Örneğin iki farklı tablo arasında join sorgu yapmak istediğinizde ya da en basit bir işlemi yapmak istediğinizde bunu java kodu ile yapmak mümkün olmayacaktır. Bu durumlarda custom query olarak adlandırılan sorgu yönteminden faydalanacağız. Şöyle ki sorgularımız <name>sqlmap.xml  olan xml dosyaları içerisine yazılacak. Sorgu sonucu dönecek verinin modelini ya da sorguya gidecek parametreleri yine uygun syntax kuralları ile sqlmap dosyasına eklemeliyiz. Örnek ile anlatırsam daha iyi anlaşılacaktır. Örnekte CUSTOMER isimli müşteri bilgilerini içeren bir tablomuz olsun ve yine bu müşterilerin adres bilgisi için ADDRESS isimli adres verileri içeren bir tablomuz olsun.

CUSTOMER

ADDRESS

Bir müşterinin adres bilgisi yukarıdan da anlaşılacağı gibi ADDRESS_OID verisi ile ADDRESS tablosu ile ilişkili bir şekilde tutuluyor. Yazacağımız sorgu da hem müşterinin isim, soyisim verisini hem de adresinin il, ilçe bilgisini dönmesini amaçlayalım. Bu durumda bizim ihtiyacımız olan sorgu join şeklinde olmalı. Sorguyu aşağıdaki şekilde yazabiliriz.

Yukarıdaki sorgu bizim işimizi görecektir ve tek sorunumuz bunu mybatis'te nasıl gerçekleştireceğimizdir. Öncelikle ben CUSTOMER tablosu önceki yazılarımda anlattığım tablo ve bu tablo üzerinde ufak değişiklikler yaptığım için tekrar generate ettim. Yeni oluşturduğum ADDRESS tablosu için generate işlemini gerçekleştirdim. Önceki yazılarımda nasıl generate yapılacağından bahsetmiştim. Yine de örnek görüntüyü paylaşıyorum.

Yukarıdaki gibi generatorConfig.xml dosyasına ADDRESS tablosunu ekledim(sondan bir önceki satır). CUSTOMER tablosunu önceden generate ettiğim için comment içine alarak tekrar generate edilmesini engelledim. Tekrar generate edilse de bir sorun teşkil etmeyecekti fakat tekrar generate'e gerek yok. Generate işlemini runGenerator.xml dosyasını Build > Ant Build yaparak generate ediyoruz. Şimdi sorguya odaklanarak sorgu sonucunda hangi kolonlar dönecek ve bu kolonları nasıl karşılayacağımızı belirleyelim. Dönen verileri karşılayacak yeni bir model class'ı oluşturmak işimizi görecektir.

Kolonları karşılayacak propertyleri ve bunların Setter ve Getter'larını tanımlıyoruz.

Yukarıda gördüğümüz class bizim sorgu sonucu dönen verilerin objesi olacaktır. Bu şekilde veritabanı verilerini rahatlıkla yönetebileceğiz. İşin detay ve önemli noktası olan yer sorguyu ekleme adımına geldik. Dilersek bu sorgu Customer_sqlMap.xml ya da Address_sqlMap.xml içine konulabilir. Hangisi mantıklı geliyorsa o sqlMap seçilir. Ben Customer_sqlMap.xml dosyası içine sorgumu yerleştireceğim.

Yukarıda gördüğüz gibi iki yapı bulunmakta. Biri sorgumuzu içeren <select/> kısmı diğeri sorgu sonucu verileri class'ımıza (objeye dolduracak) aktaracak <resultMap/> kısmı. İkisinin de id bilgisini unique(tekil) olacak şekilde istediğimiz gibi verebiliriz. Mantıklı bir şeyler yazmakta fayda var. Daha sonra resultMap için hangi class'ımıza (hangi objeye) veriler aktırılacak bunu type property'si ile belirliyoruz. Burada class'ımızın yolunu veriyoruz. Daha sonra içerisinde hangi kolon hangi property'e map edecek(eşleşecek) bunun bilgilerini ve veri tiplerini uygun olacak şekilde belirliyoruz.
<select> için resultMap kısmına eşleşeceği resultMap'in id bilgisini veriyoruz. Biz üstteki resultMap ile eşleşmesini istediğimiz için onun id bilgisini verdik. Sorguya bir parametre bilgisi geleceği durumda bu alan parameterClass propertysi ekleyerek gelecek parametrenin tipini de vermemiz gerekirdi. Ben daha basit olması açısından bir parametre falan göndererek bir sorgu oluşturmak istemedim. İlerleyen zamanda bir örneğini gösteririm. Yukarıdaki gibi sqlMap'teki olacak işlemlerimizi tamamlıyoruz. Şimdi bu sorguyu çağıracak olan metodumuzu oluşturmalıyız. Bunun için ilgili sqlMap'in ilişkili olduğu Mapper.java class'ına metod tanımını yapıyoruz.

Şimdi istediğimiz şekilde bu metodu kullanarak veritabanından verileri alabiliriz. Ben önceden oluşturmuş olduğum manager içerisinde bir metot içerisinde bu metotu çağırdım.

Şimdi çalıştığını görelim.

Gördüüğünüz üzere veritabanı içerisindeki verilere bu şekilde erişerek bilgileri console'a döktüm. Bundan sonra bu verileri istediğim gibi işleyebilirim, benzer sorgular oluşturarak ekleyebilir, güncelleyebilir ya da silebilirim. Mybatis'te custom query kullanımı bu kadar, umarım faydalı olur.

Mybatis sorgu teknikleri (Mybatis Quering)

Mybatis ile ilgili genel ayarlarımızı yaptıysak veritabanına bir sorgu nasıl gönderilir ona bakalım. Bu paylaşımım bir önceki paylaşımımın devamı niteliğindedir. Öncelikle bir yazılımcı olarak tüm kodlamalarımız iyi bir düzene sahip olmalıdır. Yani bean classlarınız varsa hepsi farklı bir package altında, manager classlarınız varsa onlar ayrı bir package altında, ya da txt, png vb. uzantılı diğer dış kaynak dosylarınız farklı bir package ya da folder'ın altında tutulması hem hoş bir görüntü hem de yazılımcıya büyük kolaylık sağlar. Bu durumda konumuz içerisinde veritabanına yapacağımız sorguların her bir tablo için farklı bir class içinde olması güzel olacaktır. Öyle ki benim Customer tabloma ait sorgu class'ımın ismi CustomerManager.java olsun ve bu tarz class'lar manager isimli bir package'ın altında yer alsın istiyorum. Öncelikle gördüğünüz üzere manager isimli bir package oluşturdum.

Bu package'ın altına manager class'ımızı oluşturdum.

Şimdi biraz yapıdan bahsedersek bu class içerisinde sorgu (insert-updete-delete-select) metotlarımızı yazacağız. Hangi tablodan sorgu yapacak isek öncelikle o tabloya ait olan Mapper nesnesine erişmemiz lazım. Bu nesne yardımı ile sorgularımızı gönderebileceğiz.

Gördüğünüz üzere CustomerMapper tipinden değer döndüren private static bir getMapper isimli metod oluşturmuşum. Bu metot içerisinde yapılandırma ayarlarında oluşturmuş olduğumuz SessionFactory class'ının getSession metodu ile ilgili class'ımızın Mapper'ı dönderilecektir. Böylelikle sorgularımız bu nesne ile gerçekleştireceğiz. Hemen alttaki metotta CustomerExample ve buna bağlı Criteria nesnesi gözünüze çarpmış olacak. Şöyle ki CustomerExample nesnesi bu şekilde gerçekleştirilen her sorguda oluşturulmalıdır. Çünkü bu example nesnesi üzerinden sorgulamalar gerçekleştirilir. Criteria nesnesi ise görüldüğü üzere ilgili example'a ait kriterleri içerecektir. Resimde de gördüğünüz üzere hangi example'a ait ise o example'ın createCriteria metodu ile nesne oluşturulur. Bu Criteria nesnesi içerisine yine ekranda bir kısmını gördüğünüz kriterleri set edebiliriz. Örnekler ile gösterir isem;

getCustomerListByFirstName metodu'nun içerisinde parametre olarak verilecek firstName'e ait kayıtların filtrelenmesini istiyorum. Yukarıda görüldüğü şekilde andCustomerFirstNameEqualTo metodu içerisine bu parametre veriliyor. Bununla birlikte extra olarak aynı şekilde surName ile kriter ekleyebilirdik. Bunun için hemen bir alt satıra "criteria.andCustomerSurNameEqualTo(surName);" şeklinde bir kriter belirlemeliydik.
getCustomerCount metodu içerisinde de yine example nesnesi kullanılarak database'de bulunan kayıtların sayısını countByExample metotu ile ulaşabiliriz.
getCustomerByAge metodu biraz daha kompleks yapıda olup doğum yılı verilen iki tarih arasında olan ve bu kayıtlar arasında doğum yılı büyükten küçüğe olacak şekilde olan Customer kayıt listesini elde eder.
insert metodu ile oluşturulan bir Customer nesnesi üzerinden database'e kayıt atılabilir.

Bu kısa açıklamaların ardından öncelikle database'in durumunu gösterelim.

Şimdi bu metotları nasıl kullanabileceğimizi örnekleyeyim.

Görüldüğü üzere CustomerManager sınıf ismi ile yazdığımız metotların public ve static olması nedeniyle erişebildik ve kod okunaklığı açısından güzel oldu. Bununla birlikte ilgili tabloya ait metotlar bu şekilde o tabloya ait manager class'ı oluşturup içine yazılırsa hoş bir düzen sağlayacaktır. Resimdeki class'ı run ettiğimde Console ekranına düşen sonuçların istediğim şeyler olduğunu görüyorum.

Mybatis yapılandırma ayarları (Mybatis Configuration Settings)

Mybatis, bir ORM(Object Relational Mapping) aracıdır. Database'deki verilerimizi class yapıları ile modeller ve developer'ı büyük bir yükten kurtarır.Yani database'deki bir kaydı nesneleştirerek kullanmamızı sağlar. Select, insert, update, delete gibi işlemleri esnek bir şekilde yapmamızı sağlar. Hibernate (farklı bir ORM aracı) ile kıyaslandığında bir takım artıları ve eksikleri vardır. Fakat konumuz bu olmadığı için bu konuyu sizin araştırmanıza bırakıyorum. Fakat emin olabilirsiniz ki Mybatis bir çok kurumsal firmada yoğun bir şekilde kullanılmaktadır. Bu konudaki Türkçe dökümanın azlığı benim ilgimi çekti ve böyle bir döküman oluşturmaya karar verdim. Eclipse üzerinde Mybatis yapılandırması için öncelikle sqljdbc4.jar'ına veya bunun farklı sürümlerine ihtiyacınız vardır. Ben resimde görüldüğü üzre bunu indirerek masa üstüme kaydettim.



Daha sonra Eclipse üzerinde MybatisTest isimli bir java projesi oluşturdum ve bir mybatis folder'ı ekledim.

 

Daha sonra ihtiyacımız olan mybatis jar dosyasını indirdim.



Proje hiyerarşisini aşağıda olduğu gibi düzenleyin. Config folder'ı içerisinde configuration ayar dosyalarımızı barındıracağız. Ben önce generatorConfig.xml dosyasını oluşturmuşum. Kısaca bu xml dosyası bize database'i kullanarak model oluşturmada yardımcı olacak dosyadır.
sqljdbc4.jar dosyasını ve mybatis-3.3.0.jar dosyalarını proje üzerine sağ tıklayarak Build Path > Configure Build Path > Libraries tab ve Add External Jars seçeneği ile projeye dahil ettim. Aşağıdaki gib Referenced Library bölümünde jar'ları göreceksiniz. Tıpkı bu yaptığımız işlem gibi indirmiş olduğunuz mybatis zip dosyası içinde bulunan log jarlarını da eklemeniz de fayda var. Hata esnasında hatayı neden kaynaklı ve nasıl çözebileceğiniz hakkında yardımcı olurlar.



Bir başka önemli nokta ise bağlanacağınız database Microsoft Sql Server ise sqljdbc_auth.dll dosyasına ihtiyacınızın olmasıdır. Database'e authentication(kimlik kanıtlama) esnasında bu dosyaya ihtiyaç vardır. Bu .dll dosyası indirmiş olduğum sqljdbc zip dosyasının içinde mevcut. sqljdbc_auth.dll dosyasını kopyalayıp C:\Windows\System32 klasörünün içine atmalısınız.
Ben database'e Windows Authentication modunda bağlanıyorum. Yani bana parola falan sormuyor. Bu durumda connection stringimiz biraz farklılık gösterir. Aşağıda <connctionUrl> tag'ı içerisinde görebilirsiniz.



generatorConfig.xml dosyamın içeriği yukarıda görülmektedir. Bu dosyada bazı yapılandırma ayarlarıyla beraber <table> tag'ı içerisinde database'de CUSTOMER isminde bir tablonun olduğu ve bu tabloyu Customer class ile modellemeyi istediğimi belirtmişim. İkinci yapılandırma dosyamız yine config içine oluşturulan MapperConfig.xml dosyasıdır. Aşağıda onun içeriğini görüntülemektesiniz.



mapper tag'ı şu an boş fakat generate etme işleminden sonra oluşacak mapper'ın path'i ile resource alanını doldurmalısınız. Bir diğer yapılandırma dosyası bir java classı olan SessionFactory.java'dır.



Bu class içerisinde ilgili mapperXML gibi yapılandırma ayarları yükleniyor. Eğer üstte bahsettğim gibi generate işleminden sonra MapperConfig.xml dosyasına mapper'ı vermezseniz mapper'ı bulamıyorum diye bir hata alırsınız. Bu kritik bir nokta.

Son yapılandırma ayarımız bir ant dosyası içinde olacaktır. Build etme işlemini ant file üzerinden yapacağız. Proje üzerine sağ tıklayın New>Other ve Ant Files seçneğini seçin.






Size .xml ve .properties uzantılı iki tane dosya oluşacak. İsimlerini benim yaptığım gibi güncelleyebilirsiniz.



Bütün configuration dosyalarımızı yukarıdaki hiyerarşide görüntülüyorsunuz.

Bu generate etme(model oluşturma, ya da bizim CUSTOMER tablosunu Customer sınıfı haline getirme diye basit bir şekilde açıklayayım) işlemini mybatis-generator jar'ı ile yapacağız. Onu şuradan indirin.



Şimdi runGenerator.xml dosyasını aşağıdaki şekilde kendinize uygun olarak güncelleyiniz.



Bütün yapılandırma ayarlarını halletmiş bulunuyoruz. Son olarak generate etme işlemini gerçekleştireceğiz. Son oluşturduğumuz runGenerator.xml dosyasına sağ tıklayın ve Run As> Ant Build seçenekleri ile build edin.



Aşağıda resimde görüldüğü üzere belirttiğimiz alanlarda istediğimiz class'lar, xml'ler oluştu. Oluşan CustomerMapper.xml dosyamızı MapperConfig.xml'e ekledik. Her şey tamam.



Şimdi bir test edelim ve çalıştığını görelim. Test isminde bir class oluşturup içini aşağıdaki şekilde düzenledim. Test.java sınıfına Run As > Java Application şeklinde çalıştırdım.




Customer tablosunda bulunan iki kayıda gördüğünüz üzre kolaylıkla eriştim. Yukarıda basitçe bir select sorgusu gördünüz. Bu query konusunu ilerleyen durumlarda daha açıklayıcı ve komplex örneklerle anlatmayı planlıyorum. Mybatis yapılandırması bu kadar. Kolay gelsin.

Uygulamanın kodlarını bu adreste bulabilirsiniz :
https://github.com/emresevinc/MyRepo-Mybatis