Spring Boot+CXF搭建WebService(轉）

概述

　　最近項目用到在Spring boot下搭建WebService服務，對Java語言下的WebService瞭解甚少，而今抽個時間查閱資料整理下Spring Boot結合CXF打架WebService通常步驟與方法；本文章結合各個博客資料整理而成，若有雷同，謹記轉載；

Spring Boot WebService開發

須要依賴Maven的Pom清單

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.dbgo</groupId>
    <artifactId>webservicedemo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
    <name>webservicedemo</name>
    <description>Demo project for Spring Boot</description>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.8.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--WerbService CXF依賴-->
        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-frontend-jaxws</artifactId>
            <version>3.1.12</version>
        </dependency>
        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-transports-http</artifactId>
            <version>3.1.12</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>
        <dependency>
            <groupId>commons-io</groupId>
            <artifactId>commons-io</artifactId>
            <version>2.5</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

構建併發布服務

構建Model對象

package com.dbgo.webservicedemo.Model; import java.io.Serializable; import java.util.Date; public class User implements Serializable { private static final long serialVersionUID = -5939599230753662529L; private String userId; private String username; private String age; private Date updateTime; public String getUserId() { return userId; } public void setUserId(String userId) { this.userId = userId; } public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public String getAge() { return age; } public void setAge(String age) { this.age = age; } public Date getUpdateTime() { return updateTime; } public void setUpdateTime(Date updateTime) { this.updateTime = updateTime; } }

構建服務接口

package com.dbgo.webservicedemo.service; import com.dbgo.webservicedemo.Model.User; import javax.jws.WebMethod; import javax.jws.WebParam; import javax.jws.WebService; import java.util.ArrayList; @WebService public interface UserService { @WebMethod String getName(@WebParam(name = "userId") String userId); @WebMethod User getUser(String userI); @WebMethod ArrayList<User> getAlLUser(); }

構建接口實現類

package com.dbgo.webservicedemo.service; import com.dbgo.webservicedemo.Model.User; import javax.jws.WebService; import java.util.ArrayList; import java.util.Date; import java.util.HashMap; import java.util.Map; @WebService(targetNamespace="http://service.webservicedemo.dbgo.com/",endpointInterface = "com.dbgo.webservicedemo.service.UserService") public class UserServiceImpl implements UserService { private Map<String, User> userMap = new HashMap<String, User>(); public UserServiceImpl() { System.out.println("向實體類插入數據"); User user = new User(); user.setUserId("411001"); user.setUsername("zhansan"); user.setAge("20"); user.setUpdateTime(new Date()); userMap.put(user.getUserId(), user); user = new User(); user.setUserId("411002"); user.setUsername("lisi"); user.setAge("30"); user.setUpdateTime(new Date()); userMap.put(user.getUserId(), user); user = new User(); user.setUserId("411003"); user.setUsername("wangwu"); user.setAge("40"); user.setUpdateTime(new Date()); userMap.put(user.getUserId(), user); } @Override public String getName(String userId) { return "liyd-" + userId; } @Override public User getUser(String userId) { User user= userMap.get(userId); return user; } @Override public ArrayList<User> getAlLUser() { ArrayList<User> users=new ArrayList<>(); userMap.forEach((key,value)->{users.add(value);}); return users; } }

備註說明：接口實現類名稱前的註解targetNamespace是當前類實現接口所在包名稱的反序（PS：加上反斜線），endpointInterface是當前須要實現接口的全稱；@WebService(targetNamespace="http://service.webservicedemo.dbgo.com/",endpointInterface = "com.dbgo.webservicedemo.service.UserService")

服務發佈類編寫

package com.dbgo.webservicedemo; import com.dbgo.webservicedemo.service.UserService; import com.dbgo.webservicedemo.service.UserServiceImpl; import org.apache.cxf.Bus; import org.apache.cxf.bus.spring.SpringBus; import org.apache.cxf.jaxws.EndpointImpl; import org.apache.cxf.transport.servlet.CXFServlet; import org.springframework.boot.web.servlet.ServletRegistrationBean; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import javax.xml.ws.Endpoint; @Configuration public class WebServiceConfig { @Bean public ServletRegistrationBean dispatcherServlet(){ return new ServletRegistrationBean(new CXFServlet(),"/service/*");//發佈服務名稱 } @Bean(name = Bus.DEFAULT_BUS_ID) public SpringBus springBus() { return  new SpringBus(); } @Bean public UserService userService() { return  new UserServiceImpl(); } @Bean public Endpoint endpoint() { EndpointImpl endpoint=new EndpointImpl(springBus(), userService());//綁定要發佈的服務 endpoint.publish("/user"); //顯示要發佈的名稱 return endpoint; } }

運行程序，輸入 http://localhost:8080/service/user?wsdl 便可查詢發佈出去的接口文件；

若是須要發佈多個webservice，須要配置多個Config實現類文件；

客戶端調用服務

基於cxf客戶端調用WebService能夠簡單概述2中模式：動態調用和協議調用；

package com.dbgo.webservicedemo; import com.dbgo.webservicedemo.Model.User; import com.dbgo.webservicedemo.service.UserService; import org.apache.cxf.endpoint.Client; import org.apache.cxf.frontend.ClientProxy; import org.apache.cxf.jaxws.JaxWsProxyFactoryBean; import org.apache.cxf.jaxws.endpoint.dynamic.JaxWsDynamicClientFactory; import org.apache.cxf.transport.http.HTTPConduit; import org.apache.cxf.transports.http.configuration.HTTPClientPolicy; import java.util.ArrayList; public class webserviceclient { //動態調用
    public static void main(String[] args) throws Exception { JaxWsDynamicClientFactory dcflient=JaxWsDynamicClientFactory.newInstance(); Client client=dcflient.createClient("http://localhost:8080/service/user?wsdl"); Object[] objects=client.invoke("getUser","411001"); System.out.println("*******"+objects[0].toString()); Object[] objectall=client.invoke("getAlLUser"); System.out.println("*******"+objectall[0].toString()); main3(args); } //調用方式二，經過接口協議獲取數據類型
    public static void main2(String[] args) throws Exception { JaxWsProxyFactoryBean jaxWsProxyFactoryBean=new JaxWsProxyFactoryBean(); jaxWsProxyFactoryBean.setAddress("http://localhost:8080/service/user?wsdl"); jaxWsProxyFactoryBean.setServiceClass(UserService.class); UserService userService=(UserService)jaxWsProxyFactoryBean.create(); User userResult= userService.getUser("411001"); System.out.println("UserName:"+userResult.getUsername()); ArrayList<User> users=userService.getAlLUser(); } //調用方式三，經過接口協議獲取數據類型,設置連接超時和響應時間
    public static void main3(String[] args) throws Exception { JaxWsProxyFactoryBean jaxWsProxyFactoryBean=new JaxWsProxyFactoryBean(); jaxWsProxyFactoryBean.setAddress("http://localhost:8080/service/user?wsdl"); jaxWsProxyFactoryBean.setServiceClass(UserService.class); UserService userService = (UserService) jaxWsProxyFactoryBean.create(); // 建立客戶端對象
        Client proxy= ClientProxy.getClient(userService); HTTPConduit conduit=(HTTPConduit)proxy.getConduit(); HTTPClientPolicy policy=new HTTPClientPolicy(); policy.setConnectionTimeout(1000); policy.setReceiveTimeout(1000); conduit.setClient(policy); User userResult= userService.getUser("411001"); System.out.println("UserName:"+userResult.getUsername()); ArrayList<User> users=userService.getAlLUser(); } }

 基於wsimport和JAX-WS調用Web Service接口

       使用Jdk原生態wsimport指令生成相應的接口文件，來調取webservice接口。操做以下：

一、生成接口文件：cmd->wsimport -d . -s . -p acme.client http://127.0.0.1/Services/InvoiceService.asmx?WSDL  

便可經過cmd命令生成相應的接口文件；

參數說明：
-d 指定生成輸出文件的保存路徑（.class文件，根據須要決定是否生成class文件）
-s 指定生成的java源文件的保存路徑（.java文件，根據須要決定是否生成java源文件）
-p 指定生成的java類的包（package）名稱
http://127.0.0.1/Services/InvoiceService.asmx?WSDL URL地址，URL地址後面必須添加「?WSDL」參數。WSDL參數也能夠是小寫（wsdl）。

二、配置調用相應的文件

import java.net.MalformedURLException; import java.net.URL; import javax.xml.namespace.QName; import com.opertion.wsimport.HiService; /** * 使用Service類進行調用 * @author Administrator */  
public class Service { public static void main(String[] args) throws MalformedURLException { //wsdl網絡路徑 
        URL url = new URL("http://127.0.0.1/Services/InvoiceService.asmx?WSDL"); //服務描述中服務端點的限定名稱 兩個參數分別爲 命名空間 服務名 
        QName qName = new QName("http://tempuri.org/", "InvoiceService"); //建立服務對象 
        javax.xml.ws.Service service = javax.xml.ws.Service.create(url, qName); //得到Hiservice的實現類對象 
        InvoiceService hiService = service.getPort(new QName("http://tempuri.org/","InvoiceServiceSoap"),InvoiceService.class); //調用WebService方法 
        System.out.println(hiService.sayHi("xiaoming")); } } 

注意事項:

命名空間 (http://tempuri.org/)的取值，是以下內容:

服務名稱InvoiceService和InvoiceServiceSoap的取值：

 

參考博客

Spring boot+CXF開發WebService Demo https://www.cnblogs.com/fuxin41/p/6289162.html

springboot1.5.4 集成cxf完整實例   https://www.cnblogs.com/xiaojf/p/7231529.html

JAX-WS調用Web Service參考地址

經過javax.xml.ws.Service的方式調用WebService  https://blog.csdn.net/syy19930112/article/details/17427165

使用wsimport和JAX-WS調用Web Service接口 https://www.cnblogs.com/yitouniu/p/7640079.html#commentform

完整Demo下載