spring boot 集成webservice soap发短信【干货踩坑、亲测可用、干就完了】

说明：springboot版本 2.7.11

1.pom

 <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web-services</artifactId>
             <version>2.7.11</version>
        </dependency>
        <!-- apache-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>

        <!-- apache-cxf  此处与上处二选其一 -->
        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-spring-boot-starter-jaxws</artifactId>
            <version>3.5.2</version>
        </dependency>

2.config

package com.ruoyi.config;

import com.ruoyi.webservice.SmsService;
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.annotation.Resource;
import javax.xml.ws.Endpoint;

/**
 * @author: zjl
 * @datetime: 2024/3/29
 * @desc:
 */
@Configuration
public class WebServiceConfig {

    @Resource
    private SmsService smsService;

/*    @Resource
    private AgeInfoService ageInfoService;*/
/*    @Resource
    private WebServiceAuthInterceptor interceptor;*/

    /**
     * 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();
    }

    /**
     * 设置WebService访问父路径
     * <p>
     * 此方法作用是改变项目中服务名的前缀名，此处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/webServices/ws/api?wsdl
     * http://127.0.0.1:8080/soap/列出服务列表 或 http://127.0.0.1:8080/soap/ws/api?wsdl 查看实际的服务
     * 新建Servlet记得需要在启动类添加注解：@ServletComponentScan
     * 如果启动时出现错误：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 getRegistrationBean() {
        return new ServletRegistrationBean(new CXFServlet(), "/webServices/*");
    }

    @Bean
    public Endpoint messageEndPoint() {
        EndpointImpl endpoint = new EndpointImpl(springBus(), this.smsService);
        endpoint.publish("/smsService");
//        endpoint.getInInterceptors().add(this.interceptor);
        return endpoint;
    }

    /*用于发布多个WebService*/
//    @Bean
//    public Endpoint messageEndPoint2() {
//        EndpointImpl endpoint = new EndpointImpl(springBus(), this.ageInfoService);
//        endpoint.publish("/smsService");
//        endpoint.getInInterceptors().add(this.interceptor);
//        return endpoint;
//    }
}

3.service

package com.ruoyi.webservice;

import com.ruoyi.dto.SmsRequest;
import com.ruoyi.dto.SmsResponse;

import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebService;

@WebService(name = "smsService", targetNamespace = "http://tempuri.org")
public interface SmsService {
    @WebMethod(action = "http://tempuri.org/sendSms" ,operationName = "sendSms")
    SmsResponse sendSms(@WebParam(name = "sysname") String sysname,
                        @WebParam(name = "mobiles") String mobiles,
                        @WebParam(name = "content") String content);
}

4.serviceimpl

package com.ruoyi.webservice.impl;

import com.ruoyi.dto.SmsResponse;
import com.ruoyi.webservice.SmsService;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Service;

import javax.jws.WebParam;
import javax.jws.WebService;

@Service
@WebService(name = "smsService", targetNamespace = "http://tempuri.org")
public class SmsServiceImpl implements SmsService {
    @Override
    public SmsResponse sendSms(@WebParam(name = "sysname") String sysname,
                               @WebParam(name = "mobiles") String mobiles,
                               @WebParam(name = "content") String content) {
        // 实现发送短信的逻辑
        SmsResponse response = new SmsResponse();
        // 设置响应状态码和消息
        response.setCode(HttpStatus.OK.value());
        response.setMessage("短信发送成功");
        return response;
    }
}

5.测试类

package com.ruoyi.test;

import cn.hutool.http.HttpRequest;
import cn.hutool.http.HttpResponse;
import cn.hutool.json.JSONUtil;

public class SmsServiceTest {

    private static final String ADDRESS = "http://localhost:8080/webServices/smsService";
    private static final String SOAP_ACTION = "sendSms";
    private static final String NAMESPACE = "http://tempuri.org";

    public static void main(String[] args) {
        try {
            // 创建HttpRequest对象
            HttpRequest request = HttpRequest.post(ADDRESS);

            // 构造SOAP请求体
            String soapBody = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
                    "<soap:Envelope xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\" " +
                    "xmlns:sns=\"" + NAMESPACE + "\">" + // 使用服务的命名空间
                    "<soap:Body>" +
                    "<sns:" + SOAP_ACTION + ">" +
                    "<sysname>您的系统名称</sysname>" +
                    "<mobiles>13800000000</mobiles>" +
                    "<content>这是一条测试短信</content>" +
                    "</sns:" + SOAP_ACTION + ">" +
                    "</soap:Body>" +
                    "</soap:Envelope>";

            // 设置请求头信息
            request.header("Content-Type", "text/xml; charset=utf-8")
            .header("SOAPAction", NAMESPACE + "/" + SOAP_ACTION);


            // 设置请求体
            request.body(soapBody);

            // 发送请求并获取响应
            HttpResponse response = request.execute();

            // 打印响应内容
            String responseContent = response.body();
            System.out.println(responseContent);

            // 将响应内容转换为JSON（如果需要）
            String jsonResponse = JSONUtil.parse(responseContent).toString();
            System.out.println(jsonResponse);

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}