Java-Spring-WebService最基礎的配置示例

  很早很早之前，就初步學習了WebService，感覺還是比較“好”的。
  使用Web服務，感覺就像普通API一樣，和HTTP介面比較起來。
  WebService有個很大的侷限，就是事務，分散式事務麻煩程度就上升了不少，暫時沒有搞過。
  
  最近1年做的2個比較完整的專案，都有WebService的配置，只不過，都是別人配置好的。
  
  別人的，終究是別人的。
  
  作為一名熱愛學習並學以致用的程式設計師，我也來親自搞個配置~
  
  下面的例子，是我今天親自一步步配的，而且執行成功了。
  
  CSDN下載地址：http://download.csdn.net/detail/fansunion/9218657
  (我打算今後在這個基礎上，進一步完善示例）
  
 一、WebServiceClient介面專案
    其它專案如果想使用Web服務，直接呼叫介面就行了，根本不需要關注服務的實現。

	@WebService
public interface UserFacade {
	String query();
}

   介面，已經做到最簡了。查詢一個字串，就表明Web服務呼叫成功了。
   
 

 package cn.fansunion.webservice.test;


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


import cn.fansunion.webservice.UserFacade;


public class WebServiceTest {


	public static void main(String[] args) {
		//初始化Spring上下文，webservice檔案位於src目錄下（也可以說是Classpath下）
		ApplicationContext ac = new ClassPathXmlApplicationContext(
				"classpath:/spring-webservice.xml");
		//根據id獲得bean，我感覺是這個“jaxws:client id="remoteUserFacade"”WebService語法和Spring語法的結合
		UserFacade userFacade=(UserFacade) ac.getBean("remoteUserFacade");
		//查詢，返回並列印字串“WebService”
		System.out.println(userFacade.query());
	}


}

spring-webservice.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:context="http://www.springframework.org/schema/context"
	xmlns:aop="http://www.springframework.org/schema/aop" xmlns:jaxws="http://cxf.apache.org/jaxws"
	xmlns:soap="http://cxf.apache.org/bindings/soap" xmlns:util="http://www.springframework.org/schema/util"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd 
		http://www.springframework.org/schema/context 
    	http://www.springframework.org/schema/context/spring-context.xsd 
    	http://cxf.apache.org/bindings/soap http://cxf.apache.org/schemas/configuration/soap.xsd  
		http://cxf.apache.org/jaxws 
		http://cxf.apache.org/schemas/jaxws.xsd 
    	http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd
    	http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-3.0.xsd">


	<!-- 啟用autowire -->
	<context:annotation-config />
	<context:component-scan base-package="com.fansunion.webservice" />
	<jaxws:client id="remoteUserFacade"
		address="http://localhost:8080/webService/UserFacade" serviceClass="cn.fansunion.webservice.UserFacade" />


</beans>

  比較關鍵的是jaxws:client id="remoteUserFacade"，這個是WebService的核心配置。
  另外，需要注意http://cxf.apache.org/jaxws的xsi和xmlns的配置，如果沒有，應該會報錯的。
  
  pom.xml配置
 

<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-webmvc</artifactId>
			<version>${spring.version}</version>
		</dependency>
		<dependency>
			<groupId>org.aspectj</groupId>
			<artifactId>aspectjweaver</artifactId>
			<version>${aspectj.version}</version>
		</dependency>
		<dependency>
			<groupId>org.aspectj</groupId>
			<artifactId>aspectjrt</artifactId>
			<version>${aspectj.version}</version>
		</dependency>
		
		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-rt-frontend-jaxws</artifactId>
			<version>${cxf.version}</version>
		</dependency>
		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-rt-transports-http</artifactId>
			<version>${cxf.version}</version>
		</dependency>
	</dependencies>

二、WebServiceImpl介面的實現專案

package cn.fansunion.webservice.impl;


import javax.jws.WebService;


import org.springframework.stereotype.Service;


import cn.fansunion.webservice.UserFacade;


@WebService(endpointInterface = "cn.fansunion.webservice.UserFacade", serviceName = "UserFacade")
@Service("userFacadeImpl")
public class UserFacdeImpl implements UserFacade {


	@Override
	public String query() {
		return "WebService";
	}


}

和普通的Java介面實現類相比，就多了WebService註解。
看樣子，endpointInterface和serviceName很關鍵。
目前還不太清楚這2個屬性是否是必須的，根據我已有的經驗猜測，都是可選的，如果不寫，會按照一定的規則用預設的名字和類。
剛剛寫完，我就覺得不對了。
endpointInterface按說是必選的，當然如果不寫，程式是完全可以分析得出來的，因為有“implements”。
有興趣的，自己百度。




UserFacdeImpl需要作為Web的方式釋出，接下來配置web.xml檔案。
Spring配置檔案，基本都懂，主要就是配置了WebService的CXFServlet。

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" version="2.5">
  <context-param>
    <param-name>contextConfigLocation</param-name>
    	<param-value>      	
    		classpath:spring-webservice.xml
        </param-value>
  </context-param>
   <listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
  </listener>
  <servlet>
    <servlet-name>cxf</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</servlet-name>
    <url-pattern>/webService/*</url-pattern>
  </servlet-mapping>
 
</web-app>

spring-webservice.xml

<!-- Import CXF -->
	<import resource="classpath:META-INF/cxf/cxf.xml" />
	<import resource="classpath:META-INF/cxf/cxf-extension-soap.xml" />
	<import resource="classpath:META-INF/cxf/cxf-servlet.xml" />


	<bean id="userFacade"
		class="cn.fansunion.webservice.impl.UserFacdeImpl">
	</bean>
	<jaxws:server id="webserviceUserFacade" serviceBean="#userFacade" address="/UserFacade">
	</jaxws:server>
	<!-- 啟用autowire -->
	<context:annotation-config />
	<context:component-scan base-package="com.fansunion.webservice" />

引入CXF的xml配置，配置bean，最重要的還是“jaxws:server”，和Client專案的“jaxws:client”相對應吧~




pom.xml
和之前的完全一致~




三、簡要回顧下
UserFacadeClient專案：就一個介面UserFacade
UserFacadeImpl專案：介面實現UserFacadeImpl、spring-webservice.xml、pom.xml、web.xml
測試專案：WebServiceTest、pom.xml、spring-webservice.xml
為了方便，我們把測試專案，直接和Client介面專案放在了一起~


四、測試和執行流程
1.啟動UserFacadeImpl這個Web專案
  2015-10-27 22:39:02.195:INFO:oejs.Server:jetty-8.1.14.v20131031
2015-10-27 22:39:02.562:INFO:/:No Spring WebApplicationInitializer types detected on classpath
2015-10-27 22:39:03.087:INFO:/:Initializing Spring root WebApplicationContext
十月 27, 2015 10:39:03 下午 org.springframework.web.context.ContextLoader initWebApplicationContext
INFO: Root WebApplicationContext: initialization started
十月 27, 2015 10:39:03 下午 org.springframework.web.context.support.XmlWebApplicationContext prepareRefresh
INFO: Refreshing Root WebApplicationContext: startup date [Tue Oct 27 22:39:03 CST 2015]; root of context hierarchy
十月 27, 2015 10:39:03 下午 org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions
INFO: Loading XML bean definitions from class path resource [spring-webservice.xml]
十月 27, 2015 10:39:03 下午 org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions
INFO: Loading XML bean definitions from class path resource [META-INF/cxf/cxf.xml]
十月 27, 2015 10:39:03 下午 org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions
INFO: Loading XML bean definitions from class path resource [META-INF/cxf/cxf-extension-soap.xml]
十月 27, 2015 10:39:03 下午 org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions
INFO: Loading XML bean definitions from class path resource [META-INF/cxf/cxf-servlet.xml]
十月 27, 2015 10:39:04 下午 org.apache.cxf.service.factory.ReflectionServiceFactoryBean buildServiceFromClass
INFO: Creating Service {http://impl.webservice.fansunion.cn/}UserFacade from class cn.fansunion.webservice.UserFacade
十月 27, 2015 10:39:04 下午 org.apache.cxf.bus.spring.OldSpringSupport logWarning
WARNING: Import of META-INF/cxf/cxf-extension-soap.xml has been deprecated and is unnecessary.
十月 27, 2015 10:39:04 下午 org.apache.cxf.endpoint.ServerImpl initDestination
INFO: Setting the server's publish address to be /UserFacade
十月 27, 2015 10:39:04 下午 org.springframework.web.context.ContextLoader initWebApplicationContext
INFO: Root WebApplicationContext: initialization completed in 1644 ms
2015-10-27 22:39:04.839:INFO:oejs.AbstractConnector:Started SelectChannelConnector@0.0.0.0:8080
------------------------------------------------
Jetty startup finished in 3.1 s.
Used memory: 5.5 MB of 121.8 MB (1.8 GB maximum)
Console available: type "help".
------------------------------------------------


2.執行WebServiceTest這個Java應用程式
十月 27, 2015 10:39:08 下午 org.springframework.context.support.ClassPathXmlApplicationContext prepareRefresh
INFO: Refreshing org.springframework.context.support.ClassPathXmlApplicationContext@2484e723: startup date [Tue Oct 27 22:39:08 CST 2015]; root of context hierarchy
十月 27, 2015 10:39:08 下午 org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions
INFO: Loading XML bean definitions from class path resource [spring-webservice.xml]
十月 27, 2015 10:39:09 下午 org.apache.cxf.service.factory.ReflectionServiceFactoryBean buildServiceFromClass
INFO: Creating Service {http://webservice.fansunion.cn/}UserFacadeService from class cn.fansunion.webservice.UserFacade
WebService


3.也可以訪問http://localhost:8080/webService/UserFacade/query?wsdl
檢視這個WebService的定義


我想通過瀏覽器訪問http://localhost:8080/webService/UserFacade/query?wsdl類似的URL，直接顯示返回結果。
好像不太行哦，後面再研究吧~


五、最後說明
1.為了簡單起見，這2個專案都非常地簡單，完全沒有與WebService無關緊要的程式碼和配置。
麻雀雖小，五臟俱全哦
2.為了簡單起見，伺服器用的是localhost，而且是寫死的，你懂的~
3.看服務和應用程式的啟動日誌，是非常有價值的~


這次就先總結到這吧~


六、原始碼下載地址
http://download.csdn.net/detail/fansunion/9218657


小雷FansUnion-程式設計師一枚
2015年10月27日
湖北-武漢-循禮門
QQ:240370818
微信：FansUnion