這兩天要在SSH項目內加入WebService 於是海選了一下,找到如下經典之貼,於是把它轉到自己這邊來,留作記錄。
以我在自己項目爲例,我們有兩個不同的項目A和B,它們在不同的服務器上,而A發佈的新聞要在B項目中使用,且A項目發佈的新聞是在當前項目中生成的靜態頁面,因此使用WebServic。
首先在自己的項目中加入如下JAR包(WEB-INF/lib):
activation- 1.1.jar、
commons -beanutils-1.7.0.jar、
commons-codec-1.3.jar、
commons-httpclient.jar、
commons-logging-1.0.4.jar、
jaxen-1.1-beta-9.jar、
jaxws-api-2.0.jar、
jdom- 1.0.jar、
jsr173_api-1.0.jar、
mail-1.4.jar、
saaj-api-1.3.jar、
saaj-impl- 1.3.jar、
spring-1.2.6.jar、
stax-api-1.0.1.jar、
wsdl4j-1.5.2.jar、
wstx-asl- 3.0.1.jar、
xbean-2.1.0.jar、
xbean-spring-2.5.jar、
xfire-aegis-1.2.2.jar、
xfire-annotations-1.2.2.jar、
xfire-core-1.2.2.jar、
xfire-java5-1.2.2.jar、
xfire-jaxws-1.2.2.jar、
xfire-jsr181-api-1.0-M1.jar、
xfire-spring- 1.2.2.jar、
XmlSchema-1.1.jar
然後做如下配置:
1)web.xml的配置
一般情況下,我們通過HTTP作爲Web Service的傳輸協議,這樣我們只需啓動一個Web服務器(如Tomcat,在本例中使用的是Tomcat5.5.20),這樣客戶端就可以通過 HTTP訪問到Web Service服務。爲了集成Spring容器,XFire專門提供一個XFireSpringServlet,我們可以在web.xml中配置該 Servlet,將Spring容器中定義的Web Service在某個URI下發布。
爲了能正確使用XFire,需在 web.xml中進行相應配置,在該文件中配置XFire的servlet和servlet-mapping。同時因爲本實例需要將XFire集成到 Spring中,因而需要在web.xml文件中加載Spring的相應配置文件。在本實例中,我們首先在WEB-INF下建立兩個配置Spring配置文件,一個爲applicationContext.xml,該文件用來定義本工程的bean,一個爲xfire-servlet.xml,用來配置 XFire的相關bean。修改後的web.xml的內容如下所示:
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>
/WEB-INF/classes/applicationContext.xml,
/WEB-INF/spring/application*.xml,
/WEB-INF/xfire-servlet.xml
</param-value>
</context-param>
<listener>
<listener-class>
org.springframework.web.util.IntrospectorCleanupListener
</listener-class>
</listener>
<!-- begin XFire 配置 -->
<servlet>
<servlet-name>xfire</servlet-name>
<servlet-class>
org.springframework.web.servlet.DispatcherServlet
</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>xfire</servlet-name>
<url-pattern>*.ws</url-pattern>
</servlet-mapping>
<servlet>
<!-- 配合Spring容器中XFire一起工作的Servlet-->
<servlet-name>xfireServlet</servlet-name>
<servlet-class>
org.codehaus.xfire.spring.XFireSpringServlet
</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>xfireServlet</servlet-name>
<!-- 在這個URI下開放Web Service服務 -->
<url-pattern>/service/*</url-pattern>
</servlet-mapping>
<!-- end XFire 配置 -->
2)Web Service的接口類ReadNewsService.java和對應實現類ReadNewsServiceImpl.java
爲了用Web Service完成HelloWorld功能,我們首先在src/webservice目錄下建立接口類ReadNewsService.java。它僅包含一個articleShow(long name)的方法,其詳細內容如下:
public interface ReadNewsService {
public String articleShow(long artId) ;
}
我們還需要建立一個對應的實現類,來實現articleShow的功能,該實現類即爲ReadNewsServiceImpl.java。該類的詳細內容如下:
public class ReadNewsServiceImpl extends HibernateDaoSupport implements ReadNewsService {
private String tableName = null;
private GetLoadSql loadSql = null;
FileOperator fileOperator ;
public ReadNewsServiceImpl() {
fileOperator = new FileOperator();
loadSql = new GetLoadSql(WebConfig.SERVICE_PATH);
}
public String articleShow(long artId) {
tableName = "News";
String sql = "" ;
String content = "" ;
try{
sql = loadSql.getSqlLoad(WebConfig.PERSONAL_ARTICLESHOWINFOR);
Query q = this.getSession().createQuery(sql) ;
// SQL 條件設定
q.setLong(0, artId);
// SQL 執行
Iterator it = q.list().iterator() ;
while(it.hasNext()) {
News news = (News)it.next() ;
// 路徑取得
String articleAddr = news.getPageAddr() ;
if (articleAddr != null && !"".equals(articleAddr)) {
// 根目錄取得
// String basePath = request.getScheme() + "://"
// + request.getServerName() + ":"
// + request.getServerPort()
// + request.getContextPath();
//獲取WebService接口的URL地址
String basePath = WebConfig.SERVICE_HUJIAO_PATH ; //"http://192.168.0.119:8088/rck" ;
// 絕對路徑absolutePath
String absolutePath = basePath + articleAddr ;
URI uri = new URI(absolutePath);
if (uri.isAbsolute()) {
// if (uri.getPath().toString().startsWith(
// request.getContextPath().toString())) {
// absolutePath = request.getSession()
// .getServletContext().getRealPath(
// uri.getPath().toString().replace(
// request.getContextPath(), ""));
// }
//取得新聞靜態文件存放的目錄
absolutePath = ClassLoaderUtil.getExtendResource(".." + articleAddr).getFile() ;
//此處纔是真正取得靜態頁面的絕對路徑
absolutePath = absolutePath.replaceAll("/WEB-INF", "") ;
} else {
absolutePath = String.valueOf(uri);
}
if (fileOperator.fileIsExist(absolutePath)) {
// workArticle.setArticleLoad(articleAddr);
//content = articleAddr ;
//構造URL地址
content = basePath + articleAddr ;
} else {
content = "對不起,您訪問的頁面不存在或已被刪除!" ;
}
}
}
} catch (Exception e) {
ZPLogger.error(this, "articleShow()", "API DB出現異常。"
+ tableName + " SQL(STATEMENT) " + sql);
content = "程序出現錯誤,請稍候重試!" ;
}
return content ;
}
}
3)Spring配置文件applicationContext.xml和xfire-servlet.xml的配置
首先我們在applicationContext.xml文件中配置對應的bean——readNewsService,該xml文件的內容如下:
<bean id="readNewsService" class="com.chinarck.service.impl.news.ReadNewsServiceImpl">
<property name="hibernateTemplate">
<ref bean="hibernateTemplate"/>
</property>
</bean>
這個配置文件很簡單,在此不詳述。
XFire 爲Spring 提供了方便易用的導出器XFireExporter,藉助該導出器的支持,我們可以在Spring容器中將一個POJO導出爲Web Service。HelloWorld是業務服務類,在此擁有一個sayHelloWorld的方法,我們希望將此方法開放爲Web Service。在實際應用中,如果某個類具有衆多的方法,而其中的某些方法不需要開放爲Web Service的情況下,我們可以定義一個窄接口,該接口中只需定義那些開放爲Web Service的業務方法。
將一個業務類所有需要開放爲Web Service的方法通過一個窄接口來描述是值得推薦的作法,這讓Web Service的接口顯得很“乾淨”。其次,XFire的導出器也需要服務接口的支持,因爲它採用基於接口的動態代理技術。
窄接口中的方法在真實的系統中可能需要引用其它的業務類或DAO獲取數據庫中的真實數據,爲了簡化實例,我們在此簡化了實例。
下面讓我們看看在xfire-servlet.xml文件中導出器的設置,該文件內容如下:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN"
"http://www.springframework.org/dtd/spring-beans.dtd">
<beans>
<!-- 引入XFire預配置信息 -->
<import resource="classpath:org/codehaus/xfire/spring/xfire.xml" />
<!-- 定義訪問的url -->
<bean
class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping">
<property name="urlMap">
<map>
<entry key="/ReadNewsService.ws">
<ref bean="ReadNewsService" />
</entry>
</map>
</property>
</bean>
<!-- 使用XFire導出器 -->
<bean id="baseWebService"
class="org.codehaus.xfire.spring.remoting.XFireExporter"
lazy-init="false" abstract="true">
<!-- 引用xfire.xml中定義的工廠 -->
<property name="serviceFactory" ref="xfire.serviceFactory" />
<!-- 引用xfire.xml中的xfire實例 -->
<property name="xfire" ref="xfire" />
</bean>
<bean id="ReadNewsService" parent="baseWebService">
<!-- 業務服務bean -->
<property name="serviceBean" ref="readNewsService" />
<!-- 業務服務bean的窄接口類 -->
<property name="serviceClass" value="com.chinarck.service.news.ReadNewsService" />
</bean>
</beans>
上面的配置中,我們可以看到,在該配置文件中引入了xfire.xml這個Spring配置文件。它是在XFire核心JAR包中擁有一個預定義的 Spring配置文件,它定義了XFire在Spring中必須用到的一些Bean和資源,需要引入這個預定義的配置文件。從該配置文件中可以看出,我們通過XFireExporter將業務類導出爲Web Service,對於任何導出器,我們都需要引入XFire環境,即serviceFactory和xfire,這是標準的配置。 ServiceFactory是XFire的核心類,它可以將一個POJO生成爲一個Web Service。
在本實例中,我們通過定義一個baseWebService,其餘的webService配置都將該bean作爲父bean,這樣可以簡化Spring的配置,不需要多次引入serviceFactory和xfire。
3. Web Service的測試
在上一步操作完成之後,我們的這個簡單的Web Service已經編寫完畢,下面讓我們來看看自己的勞動成果吧。
在瀏覽器中輸入地址:http://localhost:8080/rck/ReadNewsService.ws?wsdl,我們可以看到ReadNewsService對應的WSDL信息,閱讀這個WSDL文檔,我們可以知道readNewsService的articleShow方法已經被成功地發佈爲Web Service了。只要拿到這個WSDL就可以開發相應的客戶端調用程序了。
XFire爲訪問服務端Web Service提供了各種方便的方式:我們一般根據服務地址和窄接口類創建客戶調用程序。
在不能獲得服務窄接
口類的情況下,XFire允許我們通過WSDL文件生成客戶端調用程序,通過指定服務接口的方式調用服務。
1)通過WSDL文件生成客戶端調用程序
首先我們通過http://localhost:8080/rck/ReadNewsService.ws?wsdl我們可以獲得WSDL文件ReadNewsService.wsdl,並將其放在src目錄下面,接着我們通過程序訪問該WSDL文件,並調用需測試的方法。此時測試類WebServiceClientTest .java的內容如下所示:
import java.net.URI;
import java.net.URL;
import java.net.URLConnection;
import org.codehaus.xfire.client.Client;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import com.bean.UserWebServiceTest;
public class WebServiceClientTest {
//HelloWorld helloWorld = null ;
/**
* HelloWorld的webservice的測試類
* @param args
*/
public static void main(String[] args) {
//WebServiceClientTest test = new WebServiceClientTest() ;
UserWebServiceTest useService = new UserWebServiceTest() ;
useService.setArtId("9") ;
try {
//test.testClient() ;
String to_url = useService.getNewsContent() ;
StringBuffer document = new StringBuffer();
try {
URI uri = new URI(to_url);
if (uri.isAbsolute()) {
URL url = new URL(to_url);
URLConnection conn = url.openConnection();
BufferedReader reader = new BufferedReader(new InputStreamReader(conn.getInputStream()));
String line = null;
while ((line = reader.readLine()) != null)
document.append(line + " ");
reader.close();
} else {
document.append("很抱歉,讀取新聞出現異常!請稍候重試!") ;
}
} catch (MalformedURLException e) {
e.printStackTrace();
document.append("很抱歉,讀取新聞出現異常!請稍候重試!") ;
} catch (IOException e) {
e.printStackTrace();
document.append("很抱歉,讀取新聞出現異常!請稍候重試!") ;
}
System.out.println(document.toString());
//useService.testClient() ;
} catch (Exception e) {
e.printStackTrace();
}
}
public void testClient() throws Exception {
String wsdl = "ReadNewsService.wsdl" ; //對應的WSDL文件
Resource resource = new ClassPathResource(wsdl) ;
Client client = new Client(resource.getInputStream() ,null) ; //根據WSDL創建客戶實例
Object[] objArray = new Object[1] ;
objArray[0] = "1" ;
//調用特定的WebService方法
Object[] result = client.invoke("articleShow", objArray) ;
System.out.println("result:" + result[0]) ;
}
}
2)根據服務地址創建客戶端調用程序
此種調用沒有做測試