使用 SpringBoot 发布一个 WebService 很简单,主要分为三步:

1、添加依赖

<!-- WebService -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web-services</artifactId>
</dependency>

<!-- CXF webservice -->
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-spring-boot-starter-jaxws</artifactId>
</dependency>
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-transports-http</artifactId>
</dependency>
<!-- CXF webservice -->

2、编写主配置类

import com.shanhy.muses.example.wsservice.DemoWebService;
import org.apache.cxf.Bus;
import org.apache.cxf.bus.spring.SpringBus;
import org.apache.cxf.jaxws.EndpointImpl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.xml.ws.Endpoint;

/**
* 注意:
* org.apache.cxf.Bus
* org.apache.cxf.bus.spring.SpringBus
* org.apache.cxf.jaxws.EndpointImpl
* javax.xml.ws.Endpoint
*
* @author shanhy
* @date 2020/11/19 20:38
*/
@Configuration
public class WebServiceConfiguration {


@Autowired
private DemoWebService demoWebService;

/**
* Apache CXF 核心架构是以BUS为核心,整合其他组件。
* Bus是CXF的主干, 为共享资源提供一个可配置的场所,作用类似于Spring的ApplicationContext,这些共享资源包括
* WSDl管理器、绑定工厂等。通过对BUS进行扩展,可以方便地容纳自己的资源,或者替换现有的资源。默认Bus实现基于Spring架构,
* 通过依赖注入,在运行时将组件串联起来。BusFactory负责Bus的创建。默认的BusFactory是SpringBusFactory,对应于默认
* 的Bus实现。在构造过程中,SpringBusFactory会搜索META-INF/cxf(包含在 CXF 的jar中)下的所有bean配置文件。
* 根据这些配置文件构建一个ApplicationContext。开发者也可以提供自己的配置文件来定制Bus。
*/
@Bean(name = Bus.DEFAULT_BUS_ID)
public SpringBus springBus() {
return new SpringBus();
}

/**
* 此方法作用是改变项目中服务名的前缀名,此处127.0.0.1或者localhost不能访问时,请使用ipconfig查看本机ip来访问
* 此方法被注释后, 即不改变前缀名(默认是services), wsdl访问地址为 http://127.0.0.1:8080/services/ws/api?wsdl
* 去掉注释后wsdl访问地址为:http://127.0.0.1:8080/soap/ws/api?wsdl
* http://127.0.0.1:8080/soap/列出服务列表 或 http://127.0.0.1:8080/soap/ws/api?wsdl 查看实际的服务
* 新建Servlet记得需要在启动类添加注解:@ServletComponentScan
* <p>
* 如果启动时出现错误:not loaded because DispatcherServlet Registration found non dispatcher servlet dispatcherServlet
* 可能是springboot与cfx版本不兼容。
* 同时在spring boot2.0.6之后的版本与xcf集成,不需要在定义以下方法,直接在application.properties配置文件中添加:
* cxf.path=/service(默认是services)
*/
//@Bean
//public ServletRegistrationBean dispatcherServlet() {
// return new ServletRegistrationBean(new CXFServlet(), "/soap/*");
//}

@Bean
public Endpoint endpoint() {
Endpoint endpoint = new EndpointImpl(springBus(), demoWebService);
endpoint.publish("/ws/demoWsApi");
return endpoint;
}
}

3、编写WebService具体实现

接口定义:

import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebService;
import java.util.HashMap;
import java.util.Map;

/**
* @author shanhy
* @date 2020/11/19 20:27
*/
@WebService(name = DemoWebService.WEBSERVICE_NAME, targetNamespace = DemoWebService.TARGET_NAMESPACE)
public interface DemoWebService {

String WEBSERVICE_NAME = "DemoWebService";
String TARGET_NAMESPACE = "http://demo.webservice.shanhy.com";
String WEBSERVICE_INTERFACE_NAME = "com.shanhy.muses.example.wsservice.DemoWebService";

@WebMethod
String hello(@WebParam(name = "userName3") String name);

@WebMethod
String test(@WebParam(name="headerMap") HashMap<String, String> headerMap, @WebParam HashMap<String, String> parameterMap, @WebParam String bodyJson);

}

接口实现类:

import com.shanhy.muses.example.wsservice.DemoWebService;
import org.apache.commons.lang3.StringUtils;
import org.springframework.stereotype.Component;

import javax.jws.WebService;
import java.util.HashMap;

/**
* WebService涉及到的有这些 "四解三类 ", 即四个注解,三个类
*
* @author shanhy
* @WebMethod
* @WebService
* @WebResult
* @WebParam SpringBus
* Endpoint
* EndpointImpl
* <p>
* 一般我们都会写一个接口,然后再写一个实现接口的实现类,但是这不是强制性的
* @WebService 注解表明是一个webservice服务。
* name:对外发布的服务名, 对应于<wsdl:portType name="ServerServiceDemo"></wsdl:portType>
* targetNamespace:命名空间,一般是接口的包名倒序, 实现类与接口类的这个配置一定要一致这种错误
* Exception in thread "main" org.apache.cxf.common.i18n.UncheckedException: No operation was found with the name xxxx
* 对应于targetNamespace="http://server.webservice.example.com"
* endpointInterface:服务接口全路径(如果是没有接口,直接写实现类的,该属性不用配置), 指定做SEI(Service EndPoint Interface)服务端点接口
* serviceName:对应于<wsdl:service name="ServerServiceDemoImplService"></wsdl:service>
* portName:对应于<wsdl:port binding="tns:ServerServiceDemoImplServiceSoapBinding" name="ServerServiceDemoPort"></wsdl:port>
* @WebMethod 表示暴露的服务方法, 这里有接口ServerServiceDemo存在,在接口方法已加上@WebMethod, 所以在实现类中不用再加上,否则就要加上
* operationName: 接口的方法名
* action: 没发现又什么用处
* exclude: 默认是false, 用于阻止将某一继承方法公开为web服务
* @WebResult 表示方法的返回值
* name:返回值的名称
* partName:
* targetNamespace:
* header: 默认是false, 是否将参数放到头信息中,用于保护参数,默认在body中
* @WebParam name:接口的参数
* partName:
* targetNamespace:
* header: 默认是false, 是否将参数放到头信息中,用于保护参数,默认在body中
* model:WebParam.Mode.IN/OUT/INOUT
* @date 2020/11/19 20:29
*/
@Component
@WebService(name = DemoWebService.WEBSERVICE_NAME, targetNamespace = DemoWebService.TARGET_NAMESPACE,
endpointInterface = DemoWebService.WEBSERVICE_INTERFACE_NAME)
public class DemoWebServiceImpl implements DemoWebService {

@Override
public String hello(String userName) {
if (StringUtils.isBlank(userName)) {
return "传入的name为空";
}
return "Hello: ".concat(userName);
}

@Override
public String test(HashMap<String, String> headerMap, HashMap<String, String> parameterMap, String bodyJson) {
return "mapParameters";
}
}

(END)