Interface Class

다음은 Movie Service의 인터페이스 클래스를 작성한 MovieService.java 의 일부이다. Annotation 설정에 유의하도록 한다.

import javax.ws.rs.Path;
import javax.ws.rs.Produces;

@Path("/movies/")
@Produces("application/xml")
public interface MovieService {

    @POST
    Response create(Movie movie) throws Exception;

    @GET
    @Path("/{movieId}/")
    Response get(@PathParam("movieId") String movieId)
           throws Exception;

    @PUT
    Response update(Movie movie) throws Exception;

    @DELETE
    @Path("/{movieId}/")
    Response remove(@PathParam("movieId") String movieId)
           throws Exception;

    @GET
	Response getPagingList(@QueryParam("") Movie movie,
			@QueryParam("pageIndex") @DefaultValue("1") int pageIndex)
			throws Exception;
중략...

Implementation Class

Interface Class를 구현한 클래스로 JAX-RS 관련 Annotation 설정 부분 없이 작성될 수 있다. 이때 서비스 메소드 별로 Response 객체를 리턴할 수도 있고 리턴하지 않을 수도 있다. cxf-jaxrs plugin 샘플 코드로 제공되는 예제에서는 Response 객체를 리턴하는 것으로 구현되어 있는데 이는 Response 객체에 Status Code 값을 설정하여 보내줄 수 있기 때문이다.

다음은 Movie Service의 인터페이스 클래스를 구현한 MovieServiceImpl.java 의 일부이다.

@Service("cxfJaxRsMovieService")
@Transactional(rollbackFor = { Exception.class }, propagation = Propagation.REQUIRED)
public class MovieServiceImpl implements MovieService {

	@Inject
	@Named("cxfJaxRsMovieDao")
	private MovieDao movieDao;

	public Response create(Movie movie) throws Exception {
		movieDao.create(movie);
		return  Response.status(Status.CREATED).build();
	}

	public Response get(String movieId) throws Exception {
		Movie movie = movieDao.get(movieId);
		if (movie == null)
		    return Response.status(Status.NOT_FOUND).build();
		return Response.ok(movie).build();
	}

	public Response update(Movie movie) throws Exception {
		this.movieDao.update(movie);
		return Response.status(Status.NO_CONTENT).build();
	}

	public Response remove(String movieId) throws Exception {
		this.movieDao.remove(movieId);
		return Response.status(Status.NO_CONTENT).build();
	}

	public Response getPagingList(Movie movie, int pageIndex) throws Exception {
		ResultPage resultPage = new ResultPage();
		resultPage.setPage(this.movieDao.getPagingList(movie, pageIndex));
		return Response.ok(resultPage).build();
	}
중략...

Java Beans Class

다음은 Movie Service의 인터페이스 클래스에서 상세 조회 시 리턴 값으로 사용하는 Movie.java 의 일부이다. Movie 클래스 정의 시 작성한 @XmlRootElement Annotation 설정에 유의하도록 한다. JAXB를 이용하여 XML을 JavaBeans 객체로 변환 시 이 Annotation 정보를 이용한다.

import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement
public class Movie implements Serializable {
	private String movieId;

	@NotNull
	@Size(min = 1, max = 50)
	private String title = "";
	
	@NotNull
	@Size(min = 1, max = 50)
	private String director;
	
중략...

다음은 Movie Service의 인터페이스 클래스에서 목록 조회 시 리턴 값으로 사용하는 ResultPage.java 의 일부이다. ResultPage 클래스 정의 시 작성한 @XmlRootElement와 @XmlSeeAlso(Movie.class) Annotation 설정에 유의하도록 한다. JAXB를 이용하여 XML을 JavaBeans 객체로 변환 시 이 Annotation 정보를 이용한다. 특히 목록 조회 결과 시 사용되는 리턴 값은 내부 멤버 변수로 Page 객체를 사용하는데 이때 이 Page 클래스는 org.anyframe.pagination.Page 클래스로 내부에 Collection 객체를 가지고 있다. 이 Collection 객체내에 저장된 JavaBeans 객체를 JAXB Databinding 시키기 위해 @XmlSeeAlso(Movie.class) Annotation을 설정하고 있다.

import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlSeeAlso;
import org.anyframe.pagination.Page;

@XmlRootElement
@XmlSeeAlso(Movie.class)
public class ResultPage implements Serializable {
	private Page page;

	public Page getPage() {
		return page;
	}

	public void setPage(Page page) {
		this.page = page;
	}
중략...

Exception Transfer Aspect for error handling

Movie Service의 비즈니스 메소드 수행 중 에러가 발생하는 경우, Response 객체에 Internal Server Error(500) Code 값을 전달해 주기 위해 ExceptionTransfer Aspect 클래스를 작성한다.

다음은 ExceptionTransfer.java 의 일부이다.

@Aspect
@Service("cxfJaxRsExceptionTransfer")
public class ExceptionTransfer {

	@Pointcut("execution(* myproject.cxf.jaxrs..*Impl.*(..))")
	public void serviceMethod() {
	}
	
    @Around("serviceMethod()")
	public Object aroundExecuteServiceMethod(ProceedingJoinPoint thisJoinPoint)
			throws Throwable {
		Object target = thisJoinPoint.getTarget();
		String className = target.getClass().getSimpleName().toLowerCase();
		String opName = (thisJoinPoint.getSignature().getName()).toLowerCase();

		Log logger = LogFactory.getLog(target.getClass());

		logger.debug("***** Around Advice of ExceptionTransfer [" + className + "."
				+ opName + "()]");

		// before logic
		Object retVal = null;
		try {
			retVal = thisJoinPoint.proceed();
		} catch (Exception e) {
			return Response.serverError().build();
		}
		// after logic
		return retVal;
	}	
중략...

다음은 비즈니스 레이어의 서비스를 Web Service로 노출시키는 <jaxrs:server/> tag 속성을 정의한 context-cxf-jaxrs.xml 의 일부이다.

Configuration

<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:cxf="http://cxf.apache.org/core"
  xmlns:jaxrs="http://cxf.apache.org/jaxrs"	
  xsi:schemaLocation="http://www.springframework.org/schema/beans
  http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
  http://cxf.apache.org/core http://cxf.apache.org/schemas/core.xsd
  http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd"> 
          			
    <!-- Load CXF modules from cxf.jar -->
    <import resource="classpath:META-INF/cxf/cxf.xml" />
    <import resource="classpath:META-INF/cxf/cxf-extension-jaxrs-binding.xml" />
    <import resource="classpath:META-INF/cxf/cxf-servlet.xml" /> 
	
	<jaxrs:server id="restCxfJaxRsMovieService" address="/movie">
		<jaxrs:serviceBeans>
			<ref bean="cxfJaxRsMovieService" />
		</jaxrs:serviceBeans>
		<!-- Enable message logging using the CXF logging feature -->
		<jaxrs:features>
			<cxf:logging />
		</jaxrs:features>
	</jaxrs:server>
중략...

Jetty 혹은 Tomcat 서버 등의 WAS를 이용하여 웹 어플리케이션을 구동하고 비즈니스 레이어의 서비스를 Web Service로 노출시키게 되는데, 이때 web.xml 파일에 Spring 속성 정의 XML 파일을 org.springframework.web.context.ContextLoaderListener를 이용하여 등록시켜 줘야 한다. 다음은 CXFServlet과 ContextLoaderListener를 정의한 web.xml의 일부이다.

<web-app 
    중략...
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>
            classpath:/spring/context-*.xml
        </param-value>
    </context-param>
	
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
	중략...
    <!-- cxf-configuration-START -->  
    <servlet>
        <servlet-name>CXF-JAXRS-Servlet</servlet-name>
           <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>	
	
    <servlet-mapping>
        <servlet-name>CXF-JAXRS-Servlet</servlet-name>
        <url-pattern>/cxf-jaxrs/*</url-pattern>
    </servlet-mapping>	    
    중략...
</web-app>

Spring Configuration XML Client 설정

RESTful 서비스에 접근하기 위한 클라이언트를 구현할 때 Spring 설정 파일을 이용할 수 있다.

다음은 RESTful 서비스에 접근하기 위한 클라이언트를 구현하기 위해 <jaxrs:client/> tag 속성을 정의한 cxf-jaxrs-servlet.xml의 일부이다.

Configuration

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:jaxrs="http://cxf.apache.org/jaxrs"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
    http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd">
    
	<jaxrs:client id="cxfJaxRsClientMovieService"
		address="http://localhost:8080/myproject/cxf-jaxrs" serviceClass="myproject.cxf.jaxrs.moviefinder.service.MovieService">
	</jaxrs:client>
  중략...

Exception Handling

RESTful Web Services를 호출하여 사용 시, 에러가 발생하는 경우 WebClient에서 javax.ws.rs.WebApplicationException을 throw하고 있으므로 이 Exception을 처리하는 Exception Resolver를 Spring Configuration XML에 등록하여 사용하도록 한다.

다음은 SimpleMappingExceptionResolver 클래스를 정의한 cxf-jaxrs-servlet.xml의 일부이다. javax.ws.rs.WebApplicationException이 발생하는 경우 default error view가 아닌 cxfJaxRsError view로 이동하도록 설정한다.

<bean id="cxfJaxRsExceptionResolver"
	class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
	<property name="exceptionMappings">
		<props>
		    <prop key="javax.ws.rs.WebApplicationException">cxf-jaxrs/common/error</prop>
		</props>
	</property>
	<property name="defaultErrorView" value="forward:/sample/common/error.jsp" />
	<property name="order" value="1" />
</bean>
  중략...

Test Case

다음은 RESTful Web Services로 노출된 Movie Service에 접근하는 클라이언트 코드를 작성한 Controller 클래스의 일부이다.

@Controller("cxfJaxRsMovieController")
@DependsOn("cxfJaxRsClientMovieService")
@RequestMapping("/cxfJaxRsMovie.do")
public class MovieController {
	@Inject
	@Named("cxfJaxRsClientMovieService")
	private MovieService movieService;

	private WebClient client;	

	private WebClient getClient() {
		if (this.client == null)
			client = WebClient.fromClient(WebClient.client(movieService));
		return client.reset();
	}  
	
	@RequestMapping(params = "method=create")
	public String create(Movie movie, BindingResult results,
			SessionStatus status) throws Exception {
		if (results.hasErrors()) {
			return "cxf-jaxrs/moviefinder/movie/form";
		}
		Response response = getClient().path("/movies").post(movie);
		if (response.getStatus() == Status.INTERNAL_SERVER_ERROR
				.getStatusCode()) {
			throw new Exception("Fail to create : Movie Title="
					+ movie.getTitle());
		}

		status.setComplete();
		return "redirect:/cxfJaxRsMovie.do?method=list";
	}

	@RequestMapping(params = "method=get")
	public String get(@RequestParam("movieId") String movieId, Model model)
			throws Exception {
		Movie movie = getClient().path("/movies/" + movieId).get(Movie.class);
		model.addAttribute("movie", movie);

		return "cxf-jaxrs/moviefinder/movie/form";
	}

	@RequestMapping(params = "method=list")
	public String list(
			@RequestParam(value = "pageIndex", defaultValue = "1") int pageIndex,
			Movie movie, BindingResult result, Model model) throws Exception {
		ResultPage resultPage = getClient().path("/movies").query("title",
				movie.getTitle()).query("nowPlaying", movie.getNowPlaying())
				.query("pageIndex", pageIndex).get(ResultPage.class);
		Page page = resultPage.getPage();

		model.addAttribute("movie", movie);
		model.addAttribute("movies", page.getList());
		model.addAttribute("resultPage", page);

		return "cxf-jaxrs/moviefinder/movie/list";
	}          
중략...