Spring Remoting: Burlap--转

原文地址：http://www.studytrails.com/frameworks/spring/spring-remoting-burlap.jsp

Concept Overview

In the earlier tutorials we saw an introduction to Spring remoting and its support for RMI and Hessian. In this tutorial we look at another remoting protocol supported by Spring - Burlap. Burlap is an XML based protocol for web services. It has been developed by Caucho. It is similar to Hessian, the only difference being Hessian is binary and Burlap is XML. Like Hessian, Burlap needs to be hosted over HTTP. Similar to Hessian, it has a BurlapServiceExporter and a BurlapProxyFactoryBean class. Note that since Burlap is not being actively developed, its support has been deprecated since Spring 4.0.

Sample Program Overview

The sample program below is a Greeting Service and demonstrates Spring support for Burlap. 

Required Libraries

• aopalliance.jar
• commons-logging.jar
• log4j.jar
• org.springframework.aop.jar
• org.springframework.asm.jar
• org.springframework.beans.jar
• org.springframework.context.jar
• org.springframework.context.support.jar
• org.springframework.core.jar
• org.springframework.expression.jar
• org.springframework.web.jar
• org.springframework.web.servlet.jar
• hessian-3.1.5.jar

Interaction Flow

 

• Client sends a message call
• This message call is handled by a Burlap Proxy created by BurlapProxyFactoryBean
• The Burlap Proxy converts the call into a remote call over HTTP
• The Burlap Service Adapter created by BurlapServiceExporter intercepts the remote call over HTTP
• It forwards the method call to Service

Burlap Server Code Package Structure

Burlap Server Source Code

Create the GreetingService interface as shown below. 
Create a method named getGreeting() that takes a name as a parameter and returns the greeting message (see line 5 below).

package com.studytrails.tutorials.springremotingburlapserver;

public interface GreetingService {

String getGreeting(String name);
}

Create a class GreetingServiceImpl as shown below. 
It implements the GreetingService interface (described earlier) 
Implement the getGreeting() method by sending a greeting message (see lines 6-8 below).

package com.studytrails.tutorials.springremotingburlapserver;

public class GreetingServiceImpl  implements GreetingService{

@Override
public String getGreeting(String name) {
return "Hello " + name +  "!" ;
}

}

Create the burlap-servlet.xml file (see below). 

Declare the 'greetingService' (see lines 14-15 below). 

Export the 'greetingService' using Spring's BurlapServiceExporter class (see lines 17-21 below). 
Note the following properties of BurlapServiceExporter class:

• service: the service class bean which shall handle the Burlap call (see line 18 below)
• serviceInterface: The interface to be used by Spring to create proxies for Burlap (see line 19 below)

<? 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:mvc = "http://www.springframework.org/schema/mvc"
xmlns:context = "http://www.springframework.org/schema/context"

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

< bean id = "greetingService"
class = "com.studytrails.tutorials.springremotingburlapserver.GreetingServiceImpl" />

< bean name = "/greetingService.http"
class = "org.springframework.remoting.caucho.BurlapServiceExporter" >
< property name = "service" ref = "greetingService" />
< property name = "serviceInterface" value = "com.studytrails.tutorials.springremotingburlapserver.GreetingService" />
</ bean >
</ beans >

Create the web.xml file (see below). 

Create the servlet mapping for the url pattern '*.http' (see line 16 below) for Spring's DispatcherServlet (see line 10 below) 

<!DOCTYPE web-app PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd" >

< web-app >
< display-name >Spring Remoting: Burlap Server</ display-name >

< servlet >
< servlet-name >burlap</ servlet-name >
< servlet-class >org.springframework.web.servlet.DispatcherServlet</ servlet-class >
< load-on-startup >1</ load-on-startup >
</ servlet >

< servlet-mapping >
< servlet-name >burlap</ servlet-name >
< url-pattern >*.http</ url-pattern >
</ servlet-mapping >

</ web-app >

Burlap Client Code Package Structure

Burlap Client Source Code

Create the GreetingService interface as shown below. 
Copy the GreetingService interface created for Burlap Server (described above) and paste it in Burlap Client source code while retaining the java package structure. 

Note: For reference, the source code is shown below. 

package com.studytrails.tutorials.springremotingburlapserver;

public interface GreetingService {

String getGreeting(String name);
}

Create a class TestSpringRemotingBurlap shown below to test Spring Burlap Remoting. 
Load spring configuration file (see line 11 below) 
Get a reference to GreetingService using the bean name 'greetingService' (see line 12 below) 
Call the GreetingService.getGreting() method by passing the name 'Alpha' (see line 13 below) 
Print the greeting message (see line 14 below).

package com.studytrails.tutorials.springremotingburlapclient;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

import com.studytrails.tutorials.springremotingburlapserver.GreetingService;

public class TestSpringRemotingBurlap {

public static void main(String[] args) {
ApplicationContext context =  new ClassPathXmlApplicationContext( "spring-config-client.xml" );
GreetingService greetingService = (GreetingService)context.getBean( "greetingService" );
String greetingMessage = greetingService.getGreeting( "Alpha" );
System.out.println( "The greeting message is : " + greetingMessage);
}
}

Create the spring-config-client.xml file (see below). 
Declare the 'greetingService' using Spring's BurlapProxyFactoryBean class (see lines 13-16 below). 
Note the following properties of BurlapProxyFactoryBean class:

• serviceUrl : refers the URL of the remote service (see line 14 below). 
  Note URL part 'greetingService' corresponds to bean name property of BurlapServiceExporter bean defined in burlap-servlet.xml (defined earlier)
• serviceInterface: The interface to be used by Spring to create proxies for Burlap (see line 15 below)

 

<? 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:aop = "http://www.springframework.org/schema/aop"
xmlns:context = "http://www.springframework.org/schema/context"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop-3.0.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-3.0.xsd">

< bean id = "greetingService" class = "org.springframework.remoting.caucho.BurlapProxyFactoryBean" >
< property name = "serviceUrl" value = "http://localhost:8080/springremotingburlapserver/greetingService.http" />
< property name = "serviceInterface" value = "com.studytrails.tutorials.springremotingburlapserver.GreetingService" />
</ bean >

</ beans >

Running Sample Program

Burlap Server Sample Program

This sample program has been packaged as a jar installer which will copy the source code (along with all necessary dependencies)on your machine and automatically run the program for you as shown in the steps below. To run the sampleprogram, you only need Java Runtime Environment (JRE) on your machine and nothing else. 

Download And Automatically Run Burlap Server Sample Program

• Save the springremotingburlapserver-installer.jar on your machine
• Execute/Run the jar using Java Runtime Environment

(Alternatively you can go the folder containing the springremotingburlapserver-installer.jar and execute the jar using java -jar springremotingburlapserver-installer.jar command) 

• You will see a wizard page as shown below

• Enter the location of the directory where you want the program to install and run (say, C:\Temp)

• The installer will copy the program on your machine and automatically execute it. The expected output indicating that the program has run successfully on your machine is shown in the image below. 
  This shows that the Burlap Server program has run successfully on your machine

Burlap Client Sample Program

This sample program has been packaged as a jar installer which will copy the source code (along with all necessary dependencies)on your machine and automatically run the program for you as shown in the steps below. To run the sampleprogram, you only need Java Runtime Environment (JRE) on your machine and nothing else. 

Download And Automatically Run Burlap Client Sample Program

• Save the springremotingburlapclient-installer.jar on your machine
• Execute/Run the jar using Java Runtime Environment

(Alternatively you can go the folder containing the springremotingburlapclient-installer.jar and execute the jar using java -jar springremotingburlapclient-installer.jar command) 

• You will see a wizard page as shown below

 

• Enter the location of the directory where you want the program to install and run (say, C:\Temp)

• The installer will copy the program on your machine and automatically execute it. The expected output indicating that the program has run successfully on your machine is shown in the image below. 
  This shows that the Burlap Client program has run successfully on your machine

Browsing the Program

Burlap Server Sample Code

This source code for this program is downloaded in the folder specified by you (say, C:\Temp) as an eclipse project called springremotingburlapserver . All the required libraries have also been downloaded and placed in the same location. You can open this project from Eclipe IDE and directly browse the source code. See below for details of the project structure.

Redeploying this sample program in a different web server

The WAR file for this example is available as springremotingburlapserver.war in the download folder specified by you earlier (e.g. C:\Temp). The path for the WAR file is <DOWNLOAD_FOLDER_PATH>/springremotingburlapserver/dist/springremotingburlapserver.war. 
This WAR file can be deployed in any webserver of your choice and example can be executed. 

Burlap Client Sample Code

This source code for this program is downloaded in the folder specified by you (say, C:\Temp) as an eclipse project called springremotingburlapclient . All the required libraries have also been downloaded and placed in the same location. You can open this project from Eclipe IDE and directly browse the source code. See below for details of the project structure.