CXF ile Rest Client

Daha önce bir çok kez farklı kütüphanelerle nasıl Rest servisler için client yazılacağına değinmiştim. Şimdi ise benzer şekilde CXF kullanarak nasıl yapılacağına bakalım. Bu server ki Client ile diğerlerinin en büyük farklı, API’nizi önceden tanımlamamız. Bunu yaparkende sanki Jax-RS servisi yazarmış gibi birebir aynı annotasyonları kullanmamız.

Projenin Yaratılması

Projemizi Spring-Boot kullanarak basit bir web projesi gibi oluşturacağız. Ama sadece CXF ile client tanımlamalarını yapıp, Junit ile test metodu yazacağız. CXF bildiğiniz üzere hem JAX-WS hem JAX-RS implementasyonu içeriyor. Biz JAX-RS implementasyonu tarafından rest client’ı oluşturup, testlerde bu rest client’ını kullnacağız. Test’te ana uygulama da aynı context’i kullandığından projenizde istediğiniz katmanda testteki gibi kullanabilirsiniz.

Intellij üzerinden yeni bir proje yaratıyoruz fakat proje türü olarak Spring Initializr seçiyoruz. Bu bizi bir takım adımlardan götürecek ve uygulamamızı tamamlamış olacağız. Eğer intellij kullanmıyorsanız aynı adımları https://start.spring.io/ adresinden de yapabilirsiniz. Intellij’de bu adımları https://start.spring.io/ adresinden temin ediyor.

SpringInitializr’ı seçtikten sonra next dediğimizde, gelen safyadan sadece web kımısnı seçiyoruz. Bundan başka CXF bağımlılığımız var ama onu sonradan kendimiz ekleyeceğiz. Sonraki ekranlardaki bilgileri ise aşağıdaki gibi dolduruyorum.

Name: cxf-rest-client
Group: com.bahadirakin
Artifact: cxf-rest-client
Package: com.bahadirakin.rest

Projemiz oluştuğuna göre şimdi CXF için gerekli bağımlılıkları ekleyebiliriz. Tüketeceğimiz servis JSON konuştuğundan aynı zamanda Jackson bağımlılıklarını da ekliyoruz. Jackson nesneden json’a ve json’dan nesneye çevirim yapabilen bir kütüphane. Benim en sevdiğim özelliklerinden biri doğrudan Jaxb annotasyonlarını kullanarak çevirim yapabilmesi.

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
...

	<properties>
		...
		<cxf.version>3.0.4</cxf.version>
		<jackson.version>1.9.13</jackson.version>
		...
	</properties>

	<dependencies>
		...
		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-rt-rs-client</artifactId>
			<version>{cxf.version}</version>
		</dependency>

		<!-- Json Serialization Dependencies -->
		<dependency>
			<groupId>org.codehaus.jackson</groupId>
			<artifactId>jackson-jaxrs</artifactId>
			<version>${jackson.version}</version>
		</dependency>
		<dependency>
			<groupId>org.codehaus.jackson</groupId>
			<artifactId>jackson-xc</artifactId>
			<version>${jackson.version}</version>
		</dependency>
		...
	</dependencies>
...
</project>

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

...

...

<cxf.version>3.0.4</cxf.version>

<jackson.version>1.9.13</jackson.version>

...

</properties>

...

<groupId>org.apache.cxf</groupId>

<artifactId>cxf-rt-rs-client</artifactId>

<version>{cxf.version}</version>

</dependency>

<groupId>org.codehaus.jackson</groupId>

<artifactId>jackson-jaxrs</artifactId>

<version>${jackson.version}</version>

</dependency>

<groupId>org.codehaus.jackson</groupId>

<artifactId>jackson-xc</artifactId>

<version>${jackson.version}</version>

</dependency>

...

</dependencies>

...

</project>

Rest API

Ben servis olarak daha önceki yazı dizisinde oluşturduğum kullanıcı servisini kullanacağımz. Basit bir arayüz içerisinden CRUD işlemlerini yapmamızı sağlayan bir servis bu. Ama siz isterseniz başka bir public api’da (GitHub ya da Facebook gibi) kullanabilirsiniz. Tüketeceğim servisten kısaca bahsedecek olursam

https://mysterious-woodland-4843.herokuapp.com/rest/users adresinden çalışıyor.
Doğruca bu adrese “GET” isteğinde bulunursanız tüm kullanıcıların listesi geliyor.
Doğruca bu adrese “POST” isteğinde bulunursanız ve post gövdesinde Json formatında User nesnesi gönderirseniz yeni kullanıcı oluşturuyor. Aynı zamanda oluşturduğu kullanacıyı size cevapta dönüyor.
Bu adresin devamına id ekleyip “GET” isteğinde bulunursanız id ile ilişkili kullanıcı bilgisini dönüyor. Örneğin https://mysterious-woodland-4843.herokuapp.com/rest/users/54fc333ce4b065c0c473d2e1 gibi…

API’ın kullanıcı güncelleme ve silme ile iligli metodları da mevcut. İsterseniz client’ınıza bunlarıda ekleyebilirsiniz. Fakat ben basitlik sağlaması açısından bu kadarla bırakacağım. Anlayacağınız üzere client tarafında tüm API’ı kapsamak zorunda değilsiniz.

Şimdi bu metodları bir interface üzerinde JAX-RS annotasyonları ile gerçekleyelim. CXF üzerinden client taratırken bu interface’i kullanacağız. Öncelikle src/main/java altına com.bahadirakin.rest.api isminde bir paket yaratıyoruz. Daha sonra bu paketin altına UserService isminde bir interface yaratıyoruz.

UserInterface.java

package com.bahadirakin.rest.api;

import javax.ws.rs.*;
import java.util.List;

@Path("/users")
public interface UserService {

    @GET
    List<User> findAllUsers();

    @GET
    @Path("/{id}")
    User findUser(@PathParam("id") String userId);

    @POST
    User createUser(User user);
}

package com.bahadirakin.rest.api;

import javax.ws.rs.*;

import java.util.List;

@Path("/users")

public interface UserService {

@GET

List<User> findAllUsers();

@GET

@Path("/{id}")

User findUser(@PathParam("id") String userId);

@POST

User createUser(User user);

}

CXF ve Spring Ayarları

Kullanacağımız arayüzü yarattığımıza göre şimdi cxf ve spring üzerinden hangi adresten hangi servisi kullanacağımızı belirtelim. Bunun için src/main/resources altına cxf-client-context.xml isminde bir dosya yaratıyoruz ve içeriğini aşağıdaki gibi yapıyoruz.

cxf-client-context.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:jaxrs-client="http://cxf.apache.org/jaxrs-client"
       xsi:schemaLocation="http://www.springframework.org/schema/beans  http://www.springframework.org/schema/beans/spring-beans.xsd
       http://cxf.apache.org/jaxrs-client http://cxf.apache.org/schemas/jaxrs-client.xsd">

    <import resource="classpath:META-INF/cxf/cxf.xml"/>
    <import resource="classpath:META-INF/cxf/cxf-servlet.xml"/>

    <jaxrs-client:client id="userService" serviceName="userService" name="userService"
                         address="https://mysterious-woodland-4843.herokuapp.com/rest"
                         serviceClass="com.bahadirakin.rest.api.UserService" inheritHeaders="true">
        <jaxrs-client:headers>
            <entry key="Accept" value="application/json"/>
            <entry key="Content-Type" value="application/json" />
        </jaxrs-client:headers>
        <jaxrs-client:providers>
            <bean class="org.codehaus.jackson.jaxrs.JacksonJaxbJsonProvider"/>
        </jaxrs-client:providers>
    </jaxrs-client:client>

</beans>

<?xml version="1.0" encoding="UTF-8"?>

<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:jaxrs-client="http://cxf.apache.org/jaxrs-client"

xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd

http://cxf.apache.org/jaxrs-client http://cxf.apache.org/schemas/jaxrs-client.xsd">

<jaxrs-client:client id="userService" serviceName="userService" name="userService"

address="https://mysterious-woodland-4843.herokuapp.com/rest"

serviceClass="com.bahadirakin.rest.api.UserService" inheritHeaders="true">

<jaxrs-client:headers>

</jaxrs-client:headers>

<jaxrs-client:providers>

</jaxrs-client:providers>

</jaxrs-client:client>

</beans>

Burada dikkat etmenizi istediğim kısımlar aşağıdaki gibidir:

Client yaratırken serviceClass kısmında UserService interface’ini kullandık.
Servisimizde kullanacağımız header tanımlamalarımızı burada yapabiliyoruz.
Eğer Http basic authentication kullanacaksak yine burada kullanıcı adı ve şifremizi belirtebiliriz.

Şimdi ise bu xml dosyamızı ana application context’imize ekleyelim. Spring-Boot tüm varsayılan ayarlarını annotasyon tabanlı yapıyor. Projenizi ilk oluşturduğunuzda da bu sınıfı bizim için oluşturuyor. Eğer benimle aynı ismi verdiyseniz bu sınıf CxfRestClientApplication isminde olmalı ve com.bahadirakin.rest paketi altında bulunmalı. Bunun bir eşleniğide test içerisinde olmalı. Bu sınıfın başına ImportResource annotasyonunu kullanarak yeni xml dosyamızı ekliyoruz. Son durumda CxfRestClientApplication sınıfı aşağıdaki gibi oluyor.

CxfRestClientApplication.java

package com.bahadirakin.rest;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Import;
import org.springframework.context.annotation.ImportResource;

@SpringBootApplication
@ImportResource(value = {"classpath*:cxf-client-context.xml"})
public class CxfRestClientApplication {

    public static void main(String[] args) {
        SpringApplication.run(CxfRestClientApplication.class, args);
    }

}

package com.bahadirakin.rest;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Import;

import org.springframework.context.annotation.ImportResource;

@SpringBootApplication

@ImportResource(value = {"classpath*:cxf-client-context.xml"})

public class CxfRestClientApplication {

public static void main(String[] args) {

SpringApplication.run(CxfRestClientApplication.class, args);

}

Client’ın Test Edilmesi

Tüm ayarları ve tanımlamaları yaptığımıza göre şimdi client’ımızı test edebiliriz. Bunun için hali hazırda bulunan CxfRestClientApplicationTests sınıfına UserService nesnemizi inject edip yeni bir test yazıyoruz. Son durumda CxfRestClientApplicationTests sınıfı aşağıdaki gibi oluyor. Bu sınıftaki testleri çalıştırdığınızda bir sorun olmadığını ve datanın düzgün gelip gittiğini göreceksiniz.

CxfRestClientApplicationTests.java

package com.bahadirakin.rest;

import com.bahadirakin.rest.api.User;
import com.bahadirakin.rest.api.UserService;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.SpringApplicationConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.web.WebAppConfiguration;

import java.util.List;

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = CxfRestClientApplication.class)
@WebAppConfiguration
public class CxfRestClientApplicationTests {

    @Autowired
    private UserService userService;

    @Test
    public void testGetUsers() {
        final List<User> users = userService.findAllUsers();
        Assert.assertNotNull(users);
    }

}

package com.bahadirakin.rest;

import com.bahadirakin.rest.api.User;

import com.bahadirakin.rest.api.UserService;

import org.junit.Assert;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.boot.test.SpringApplicationConfiguration;

import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

import org.springframework.test.context.web.WebAppConfiguration;

import java.util.List;

@RunWith(SpringJUnit4ClassRunner.class)

@SpringApplicationConfiguration(classes = CxfRestClientApplication.class)

@WebAppConfiguration

public class CxfRestClientApplicationTests {

@Autowired

private UserService userService;

@Test

public void testGetUsers() {

final List<User> users = userService.findAllUsers();

Assert.assertNotNull(users);

}

Son

Bana API olarak tanımlayıp sonrasında tüketmek çok daha mantıklı bir çözüm gibi geldi. Bunu tek yapan kütüphane CXF değil. Retrofit’te benzer işlevi yapıyor, üstelik Spring bağımlılığı olmadan. Daha hafif birşey arıyorsanız kesinlikle Retrofit’e de bir bakmanızı tavsiye ederim. Son olarak projenin son haline aşağıdaki adresten ulaşabilirsiniz.