这两天要在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提供了各种方便的方式:我们一般根据服务地址和窄接口类创建客户调用程序。
在不能获得服务窄接
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)根据服务地址创建客户端调用程序
此种调用没有做测试