java實現REST方式的webService
阿新 • • 發佈：2018-12-31
此文章是基於
一. 簡介
WebService有兩種方式，一是SOAP方式，二是REST方式。SOAP是基於XML的互動，WSDL也是一個XML文件，
可以使用WSDL作為SOAP的描述檔案；REST是基於HTTP協議的互動，支援JSON、XML等互動，不需要WSDL。
二. 準備工作
1. 點選此下載相關檔案，並把檔案放到 ims 工程對應的資料夾下
三. jar包介紹
1. 點選此下載 apache-cxf-3.0.3，並在 lib 資料夾下得到：
commons-codec-1.9.jar cxf-core-3.0.3.jar cxf-rt-frontend-jaxrs-3.0.3.jar cxf-rt-transports-http-3.0.3.jar javax.ws.rs-api-2.0.1.jar
2. commons-httpclient-3.1.jar
四. 相關程式程式碼
1. applicationInterface.xml：spring配置檔案
<?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:tx="http://www.springframework.org/schema/tx" xmlns:aop="http://www.springframework.org/schema/aop" xmlns:context="http://www.springframework.org/schema/context" xmlns:jaxrs="http://cxf.apache.org/jaxrs" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.1.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.1.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.1.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.1.xsd http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd"> <!-- cxf釋出rest服務 --> <import resource="classpath:META-INF/cxf/cxf.xml"/> <!-- 這裡是cxf2.x版本的配置，3.0沒有了要去掉 --> <!-- <import resource="classpath:META-INF/cxf/cxf-extension-soap.xml" /> --> <import resource="classpath:META-INF/cxf/cxf-servlet.xml" /> <bean id="receiver" class="com.ims.test.webService.cxf.Receiver" /> <jaxrs:server id="serviceContainer" address="/"> <jaxrs:serviceBeans> <ref bean="receiver" /> </jaxrs:serviceBeans> </jaxrs:server> <!-- cxf釋出rest服務 --> </beans>
2. web.xml：web工程配置檔案
<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:web="http://xmlns.jcp.org/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_4.xsd http://xmlns.jcp.org/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" version="2.4"> <context-param> <param-name>contextConfigLocation</param-name> <param-value> classpath:applicationInterface.xml </param-value> </context-param> <servlet> <servlet-name>CXFServlet</servlet-name> <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class> </servlet> <servlet-mapping> <servlet-name>CXFServlet</servlet-name> <url-pattern>/service/*</url-pattern> </servlet-mapping> </web-app>
3. 基礎服務
a. BaseService.java：介面
package com.ims.interfaces.webService.cxf; import javax.ws.rs.Consumes; import javax.ws.rs.POST; import javax.ws.rs.Produces; import javax.ws.rs.QueryParam; import javax.ws.rs.core.MediaType; public interface BaseService { @POST @Consumes(MediaType.TEXT_HTML) @Produces(MediaType.TEXT_HTML) public void execute(@QueryParam("type") String type); }
b. BaseServiceImpl.java：實現
package com.ims.interfaces.webService.cxf; import java.io.BufferedInputStream; import java.io.BufferedReader; import java.io.IOException; import java.io.InputStreamReader; import java.io.OutputStream; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import javax.ws.rs.Consumes; import javax.ws.rs.POST; import javax.ws.rs.Produces; import javax.ws.rs.QueryParam; import javax.ws.rs.core.Context; import javax.ws.rs.core.MediaType; /** * 基礎服務介面 */ public abstract class BaseServiceImpl implements BaseService{ @Context protected HttpServletRequest request; @Context protected HttpServletResponse response; @Override @POST @Consumes(MediaType.TEXT_HTML) @Produces(MediaType.TEXT_HTML) public void execute(@QueryParam("type") String type) { try { // 獲取請求型別 RequestType reqType = RequestType.getTypeByCode(Integer.valueOf(type)); // 獲取HTTP請求體XML字元輸入流 BufferedReader reader = new BufferedReader( new InputStreamReader( new BufferedInputStream(request.getInputStream()), "gb2312")); // 業務處理 ResponseResult result = process(reqType, reader); // 設定響應編碼 response.setStatus(result.getStatus().getCode()); // 輸出響應體 response.setCharacterEncoding("gb2312"); OutputStream outputStream = response.getOutputStream(); outputStream.write(result.getResult().getBytes("gb2312")); } catch (IOException ioe) { response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR); } } public abstract ResponseResult process(RequestType reqType, BufferedReader reader); }
4. Receiver.java：接收端類
package com.ims.test.webService.cxf; import java.io.BufferedReader; import javax.ws.rs.Path; import com.ims.interfaces.webService.cxf.BaseServiceImpl; import com.ims.interfaces.webService.cxf.RequestType; import com.ims.interfaces.webService.cxf.ResponseResult; import com.ims.interfaces.webService.cxf.ResponseStatus; @Path(value = "/receive.do") public class Receiver extends BaseServiceImpl { @Override public ResponseResult process(RequestType reqType, BufferedReader reader) { ResponseResult result = null; switch(reqType){ case UNKNOWN: result = new ResponseResult(ResponseStatus.CODE400, ""); break; default: break; } return result; } }
5. Sender.java：傳送端類
package com.ims.test.webService.cxf; import org.apache.commons.httpclient.HttpClient; import org.apache.commons.httpclient.HttpStatus; import org.apache.commons.httpclient.methods.PostMethod; import org.apache.commons.httpclient.methods.StringRequestEntity; public class Sender { public static void main(String[] args) { String url = "http://localhost:8090/ims/service/receive.do?type=0"; String xmlString = "<?xml version=\"1.0\" encoding=\"gbk\"?>"; post(url, xmlString); } /** * 傳送xml資料請求到server端 * @param url xml請求資料地址 * @param xmlString 傳送的xml資料流 * @return null傳送失敗，否則返回響應內容 */ public static boolean post(String url,String xmlString){ boolean result = false; //建立httpclient工具物件 HttpClient client = new HttpClient(); //建立post請求方法 PostMethod myPost = new PostMethod(url); //設定請求超時時間 client.getHttpConnectionManager().getParams().setConnectionTimeout(300*1000); try{ //設定請求頭部型別 myPost.setRequestHeader("Content-Type","text/html"); myPost.setRequestEntity(new StringRequestEntity(xmlString,"text/html","gbk")); int statusCode = client.executeMethod(myPost); if(statusCode == HttpStatus.SC_OK){ result = true; } }catch (Exception e) { e.printStackTrace(); }finally{ myPost.releaseConnection(); } return result; } }
四. 測試
eclipse上啟動ims工程（webService接收端），以java執行Sender類，eclipse上除錯檢視Receive類是否收到xml檔案