Spring Boot Devtools ile Docker Üzerindeki Kodu Debug Etme ve Değiştirme

Şu cümleyi mutlaka duymuşuzdur ya da bizzat söylemişizdir; “Ama benim makinemde çalışıyordu!”. Kodumuz kendi makinemizde çalışırken test ortamına gittiğinde çalışmamasının sebebi acaba neydi? Cevap: Kod aynıydı, ama ya gerisi?

Kodun aynı çalışabilmesi için aynı işletim sistemine, bunun doğru yapılandırılmasına(dil ve tarih ayarları, …), üzerinde gerekli kurulumların doğru versiyonlarla kurulmasına(JRE, DB, Queue, vb), bunların aynı patch’lerle upgrade edilmesine, uygulamasal parametrelerin aynı olmasına… Farkındaysanız listemiz uzayıp gidiyor. Ee peki bunca şeyi hem kendi makinemizde hem de test ortamlarında nasıl aynı yapabiliriz ki?

Cevap mikroservis mimarinin olmazsa olmazları olarak tanımlanan 12 Factor başlıklarında yer alıyor. Backing Services ve Dev/Prod Parity başlıkları ortamların tekilleştirilmesi için nelere dikkat edilmesi gerektiğini anlatıyor, dileyenler için Türkçe örneklerle anlattığım yazıya buradan ulaşabilirsiniz.

“Konfigürasyonun kodlanabilir olması ortamsal farklılıkları ortadan kaldırır. Komplikasyon riskini minimize eder ve kompleksiteyi düşürür.“

Sanallaştırma ve container teknolojileri bu noktada imdadımıza yetişiyor. Container teknolojisi olarak Docker kullandığımız için yazının bu noktasından sonra için keyword tercihlerimi bu yönde kullanarak devam edeceğim.

Kodun container’larda geliştirilmesi ya da geliştirme tamamlandıktan sonra Dockerize edilmesi ve tüm ortamlarda bu koda ait imajın dağıtılması mikroservis bakış açısının temelini oluşturuyor. Ancak bir sıkıntı var, kodun geliştirimini nasıl container’da yapacağız? Birinci çözüm, IDE’miz de başka bir containerın içerisinde olacak. Eclipse CHE gibi çözümlerle bu yaklaşım mümkün. Ya da bir diğer alternatif, kendi makinemizden containerda çalışan kodu geliştirip düzenlememiz gerekli. Hata ayıklama, debugging işlemlerini de keza aynı yöntemlerle yapabilmeliyiz.

İşte bu yazımızda Spring Boot Devtools ile Docker container’ı içerisinde embedded Tomcat üzerinde çalışan uygulamamızda runtimeda kod değişikliği yapıp Live Reload işlemini gözlemleyecek ve Remote Debugging yapacağız.


Teknik kısma geldik. İlk önce Spring Boot Devtools’dan bahsetmemiz lazım. Developer tools, projemize ait disk üzerindeki spesifik dizinleri dinleyerek bu dizinlerde meydana gelen değişiklikleri runtime’a yansıtma görevini üstlenen bir modül. Yani projenizi restart etmek yerine sadece değişen ya da etkilenen source’lar için binary’leri belleğe çekme işlemi yapılıyor. Burada bir sayfa açarak JRebel gibi hot code replacement toolları ile aynı işi yapmadığına değinmekte fayda var. Eğer projeniz Jrebel enabled bir proje ise devtools’un kısıtlı çalıştığına şahit olacaksınız. Farkları ise en güzel replacement ve reload kelimeleri ile anlatılabilir.

Jrebel => replacement, 
devtools => reload & automatic restart

Spring Boot Devtools’un yaptıkları sadece bunlar değil. Live Reload özelliği ile önyüz geliştirimi yapanlar için source’daki değişiklik durumunda sayfayı reload ederek güncel durumu alabilmek için bizim refreshment yapmamızı zorunluluk olmaktan çıkarıyor. Bunu React’taki Hot Reload’dan ayırmamız lazım, Live Reload statelerdeki değişimleri takip edip sayfanın belirli parçalarını yenilemek yerine sayfayı reload etmeyi tercih eder. Bu özelliği kullanabilmek için Chrome’da RemoteLiveReload extensionını edinmeniz gerekli.

Artık kod örneğimize geçebiliriz. Devtools’u etkinleştirmek için projemizin pom.xml dosyasına devtools dependency’sini eklemeliyiz. Kodumuzu test amacıyla bir rest uç açacağımızdan web-mvc dependency’sini de ekliyoruz. Son olarak plugin konfigürasyonuna projeden jar export alınırken Devtools’a ait bileşenlerin exclude edilmemesi için konfigürasyon ekliyoruz.

Projemize bir rest uç açıyoruz. Bu uçtan sorgulamalar yaparak kodumuzun son durumunu takip edeceğiz.

Uygulamamızı başlattıktan sonra çalışır durumda iken 11. satırdaki mesajımıza bir ekleme yapacağız. Kaydettiğimiz anda devtools bizim için projeyi otomatik olarak yeniden başlatacak.

STS içerisinde otomatik reload

Kodumuz şu anda STS(eclipse) içerisinde. Şu anda sadece kodda yaptığımız her değişiklik için projemizi tekrar başlatmaktan kurtulduk. Peki kodumuz jar haline gelmiş olsaydı ve STS içerisinde çalışmıyor olsaydı da STS’de yaptığımız bir değişiklikle kodumuzu acaba reload edebilir miydik?

Kod değişikliklerini remote olarak yönetebilmek için yapmamız gereken birkaç adım var. İlk önce STS’den gelecek kod değişikliği bilgilerinin trusted bir kaynaktan geldiğinden emin olabilmek için bir secret paylaşımı yapılması lazım. Bu sebeple application.properties dosyamıza aşağıdaki şekilde secret’ımızı tanımlıyoruz.

spring.devtools.remote.secret=MCYMCYMCY

Sonrasında STS dışında kodumuzu çalıştırmak istediğimizden jar paketimizi oluşturuyoruz. Bunu maven ayarlarınız yapılmış ise mvn clean install -DskipTests diyerek terminalden de yapabilirsiniz. Biz STS üzerindeki embedded gelen maven ile bu işimizi yapacağız.

jar oluşturma

Oluşan jar dosyamızı bir docker containerı içerisinde çalıştıracağız. Bunun için Dockerfile’ımızı aşağıdaki şekilde yapılandırıyoruz.

Maven ile oluşturduğumuz jardan Dockerfile aracılığı ile kendi imajımızı yaratacağız. Dilerseniz bu yazıda değindiğim yöntemlerle maven pluginlerini kullanarak kısa yoldan da imajınızı yaratabilirsiniz. Burada dikkat çekmek istediğim nokta, oluşan jarımızı java -jar yordamına ek bazı parametreler ekleyerek çalıştırdığımız. bu parametrelerle Java Debug Wire Protocol (JDWP) kullanarak uygulamamızı remote debug’a açıyoruz. Ve bu işlem için uygulamamızın dinleyeceği port olarak 8001 portunu atıyoruz. Docker imajımızı oluşturmak için konsolda docker build -t mcy-sb-devtools-docker . komutunu çalıştırıyoruz. Sonrasında da docker images ile imajımızın oluşup oluşmadığını kontrol ediyoruz.

İmajımız hazır, şimdi container ayağa kaldırıp kodumuzu çalıştıralım ve browserdan rest ucumuza istek gönderelim. Port bindinglerimizi 8080 ve 8001 portlarına yapıyoruz. 8080 hem kod reload hem de rest uç için, 8080 ise remote debugging için kullanılacak.

Artık elimizde Docker’da çalışan, REST servis sunan bir Spring Boot uygulamamız var. O zaman STS ile bağımsız olarak çalışan bu uygulamamızı STS üzerinden nasıl runtime’da değiştirebileceğimizi gösterebiliriz. Bunun için STS’de Run menüsünün altında Run Configurations tabındaki Java Application başlığı altına geliyoruz. Sağ tıklayarak New Configuration yaratacağız. Yapmamız gereken Spring Boot uygulamamız için default olarak gösterilen Main Class tercihimizi remote uygulamamızı yönetmemizi sağlayacak başka bir startup classı ile değiştirmek. Main class kısmına org.springframework.boot.devtools.RemoteSpringApplication yazıyoruz. Sonrasında da Arguments tabında program argumanlarına standalone çalışan uygulamamızın Remote bağlantılar için dinlediği adresi yazıyoruz(default olarak 8080 remote reload için dinleme yapılan adrestir).

remote reloading ayarlama

Artık kodu değiştirme kısmını deneyebiliriz. RestController sınıfımızdaki return edilen response mesajının içeriğini değiştirdiğimizde kodumuz remote şekilde standalone çalışan jar’a push edilecek ve browser’dan ucumuzu tekrar çağırdığımızda artık yeni kodlar çalışarak yeni response dönecek.

Kodumuzun reload’ını başardık ancak remote debugging henüz ayarlanmadı. Bunun için hatırlarsanız yukarıda 8001 portunu remote debugging için yapılandırmıştık. Debugging’i açmak için ise aşağıdaki şekilde bir STS’de debug configurations altında Remote Java Application altına aşağıdaki şekilde bir yapılandırma yapmamız gerekiyor. Bu yaptığımız işlemi remote reload çalışmaktayken debugging stack’inin kodumuz ile bağlanması olarak özetleyebiliriz.

remote debugging yapılandırması

Artık yeni rest çağırımlarımızda 11. satıra koyduğumuz breakpoint yardımıyla remote olarak çalışan uygulamamızda remote debugging de yapabilmeye başladık.

remote debugging

Bu yazımız da burada sona erdi.

Projenin kodlarına buradan ulaşabilirsiniz.

Her pazar yeni bir yazı ile görüşmek üzere!

En yalın haliyle…

Mehmet Cem Yücel


Bu yazılar ilgilinizi çekebilir:
Spring Boot ile SLF4J ve Log4J Loglama Altyapısı
Twelve Factor Nedir Türkçe ve Java Örnekleri
Blockchain teknolojisi ile ilgileniyor iseniz bunlar da hoşunuza gidebilir:
BlockchainTurk.net yazıları