spring Boot和CXF构建WebService

说明

说起web service最近几年restful大行其道，大有取代传统soap web service的趋势，但是一些特有或相对老旧的系统依然使用了传统的soap web service，例如银行、航空公司的机票查询接口等。

目前就遇到了这种情况，需要在系统中查询第三方提供的soap web service接口，也就是说要将它整合进现有的系统当中。

Spring整合CXF本来十分简单，但是因为使用了Spring Boot，不想用以前xml一堆配置的方式，那么能否按照Spring Boot的风格优雅的进行整合呢？

答案当然是肯定的，但是遍查网上几乎没有这方面的资料，折腾过后觉得还是有必要记录一下，虽然它显得非常的简单。

1. pom文件引用

这里主要添加的是cxf的包依赖

<!-- cxf支持 -->
<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-rt-frontend-jaxws</artifactId>
    <version>3.1.6</version>
</dependency>
<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-rt-transports-http</artifactId>
    <version>3.1.6</version>
</dependency>

2. 业务层的创建

这里我创建了一个hello word的测试方法

@WebService
public interface UserService {

    /**
     * 用户say:hello
     * @param userName
     * @return
     */
    @WebMethod
    public String sayHello(@WebParam(name = "userName") String userName);
}

在业务实现中我们需要如下配置:
参数说明：
targetNamespace 为这是我的接口类所在路径；
endpointInterface 这是我的业务类所在路径；

@WebService(name = "userService",targetNamespace = "http://www.hrabbit.xin/",endpointInterface = "com.hrabbit.xin.service.UserService")
public class UserServiceImpl implements UserService {
    /**
     * 用户say:hello word Webservice
     * @param userName
     * @return
     */
    @Override
    public String sayHello(String userName) {
        return userName+":say hello word WebService!";
    }
}

3. 添加配置类

业务层我们已经创建完成了，但是我们应该如何让webService运行起来呢？

@Configuration
public class WebServiceConfig {

    @Bean
    public ServletRegistrationBean servletRegistrationBean() {
        ServletRegistrationBean bean = new ServletRegistrationBean(new CXFServlet(), "/webService/*");
        bean.setLoadOnStartup(0);
        bean.setOrder(Ordered.HIGHEST_PRECEDENCE);
        return bean;
    }

    @Bean(name = Bus.DEFAULT_BUS_ID)
    public SpringBus springBus() {
        return new SpringBus();
    }

    @Bean
    public UserService layout() {
        return new UserServiceImpl();
    }

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

那么到这里呢，我们的所有的步骤基本完成了，启动spring boot 然后再浏览器中输入url：http://localhost:8080/webService/user?wsdl
可以看到有相关的wsdl描述信息输出了，说明服务已经发布了。
那么这里我又要增加注释了，请大家注意，我在最初查询资料，配置demo的时候，启动以后，发布时候总是报404，网上有很多关于什么端口冲突等说法，我试过后，根本不是那一回事，然后我无意中尝试了一下，在url地址处加入工程名，结果，问题解决了。
因此请大家注意：在测试发布服务的时候，你在浏览器中输入的url地址应该是：http://localhost:8080/你的工程名/user?wsdl

注：如果大家在搭建过程中遇到了注册CXFServlet的时候，一直报错，则可检查是否添加了autoconfigure的配置

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-autoconfigure</artifactId>
</dependency>

4.启动服务

启动服务之后，在浏览器上输入http://localhost:8080/webService/user?wsdl 如果出现如下界面，则代表发布成功了！

webService

5. 客户端

服务端我们已经写好了，那么客户端如何弄呢？其实我们可以借助Idea自己生成WebServiceClient，步骤如下:

5.1 新建项目

打开新建一个项目，选择WebServiceClient

image.png

5.2 输入url地址

输入webService服务端的地址

步骤二

点击Ok即可生成WebService的客户端

5.3 调用接口

通过如下方法即可调用方法，是不是很简单！