SpringBoot 整合 WebService

程序员小杰
5562

这是我参与更文挑战的第 3 天，活动详情查看： 更文挑战

日积月累，水滴石穿 😄

在工作当中经常需要与第三方对接，某些第三方提供的接口是 WebService 类型的，所以需要集成 WebService 由于 SpringBoot提供了 WebService的 starter 组件，所以集成 WebService相当的简单

加入依赖

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web-services</artifactId>
</dependency>
<dependency>
        <groupId>org.apache.cxf</groupId>
        <artifactId>cxf-spring-boot-starter-jaxws</artifactId>
        <version>3.3.4</version>
</dependency>
<dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
</dependency>

服务端

创建WebService接口

package com.gongj.webservice_server.service;

import com.gongj.webservice_server.DTO.UserDTO;
import javax.jws.WebService;

public interface IUserServer {

    UserDTO getUser(Long str);
}

创建实体类

@Data
public class UserDTO {

    private Long id;
    private String name;
    private Integer age;
    private String address;
}

创建WebService接口的实现类

package com.gongj.webservice_server.service.impl;

import com.gongj.webservice_server.DTO.UserDTO;
import com.gongj.webservice_server.service.IUserServer;
import org.springframework.stereotype.Service;

import javax.jws.WebService;

@Service
@WebService
public class UserServerImpl implements IUserServer {
    @Override
    public UserDTO getUser(Long id) {
        UserDTO user = new UserDTO();
        user.setId(id);
        user.setAddress("上海市浦东新区");
        user.setAge(25);
        user.setName("gongj");
        return user;
    }
}

这里用到了一个注解@WebService，我这就只在实现类上使用了。这里介绍一下，先来看下它的定义：

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface WebService {
    String name() default "";

    String targetNamespace() default "";

    String serviceName() default "";

    String portName() default "";

    String wsdlLocation() default "";

    String endpointInterface() default "";
}
  • name：对应 wsdl:portType 标签，默认值为 Java 类或接口的名称
  • targetNamespace：命名空间，一般写为接口的包名倒序，默认值也是接口的包名倒序。对应 wsdl:definitions:targetNamespace 标签，
  • serviceName：WebService的服务名称，对应wsdl:service，默认值为WebService接口实现类的名称+ “Service”,示例：UserServerImplService
  • portName：对应 wsdl:port标签，默认值为：WebService接口实现类的名称 + "Port"，示例：UserServerImplPort
  • wsdlLocation：指定用于定义 WebService 的 WSDL 文档的地址
  • endpointInterface：WebService 接口全路径

创建 WebService 配置类

package com.gongj.webservice_server.config;

import com.gongj.webservice_server.service.IUserServer;
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.beans.factory.annotation.Autowired;
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 CxfConfig {

    @Autowired
    private IUserServer userServer;
    /**
     * 注入Servlet 注意beanName不能为dispatcherServlet
     * @return
     */
    @Bean
    public ServletRegistrationBean cxfServlet() {
        return new ServletRegistrationBean(new CXFServlet(),"/webservice/*");
    }

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


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

启动服务，进行访问：http://localhost:8080/webservice

image.png 点击链接跳转，我们会看到一个页面，这是 wsdl 服务描述文档。对于这个文档也需要简单的了解一下，也许某次对接第三方系统直接给你一个 wsdl 文档让你自己看去，注意：wsdl 文档是从下往上看的。

image.png

wsdl 文档

<?xml version='1.0' encoding='UTF-8'?>
<wsdl:definitions xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" 
xmlns:tns="http://impl.service.webservice_server.gongj.com/" 
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" 
xmlns:ns1="http://schemas.xmlsoap.org/soap/http" name="UserServerImplService" 
targetNamespace="http://impl.service.webservice_server.gongj.com/">


<!-- web service 使用的数据类型 -->
  <wsdl:types>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://impl.service.webservice_server.gongj.com/" elementFormDefault="unqualified" targetNamespace="http://impl.service.webservice_server.gongj.com/" version="1.0">

  <xs:element name="getUser" type="tns:getUser"/>

  <xs:element name="getUserResponse" type="tns:getUserResponse"/>

<!-- getUser 方法的请求参数类型 -->
  <xs:complexType name="getUser">
    <xs:sequence>
      <xs:element minOccurs="0" name="arg0" type="xs:long"/>
    </xs:sequence>
  </xs:complexType>

<!-- getUser 方法的响应参数类型 -->
  <xs:complexType name="getUserResponse">
    <xs:sequence>
      <xs:element minOccurs="0" name="return" type="tns:userDTO"/>
    </xs:sequence>
  </xs:complexType>

<!-- getUser 方法的响应参数的具体类型 -->
  <xs:complexType name="userDTO">
    <xs:sequence>
      <xs:element minOccurs="0" name="address" type="xs:string"/>
      <xs:element minOccurs="0" name="age" type="xs:int"/>
      <xs:element minOccurs="0" name="id" type="xs:long"/>
      <xs:element minOccurs="0" name="name" type="xs:string"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>
  </wsdl:types>
  
  <!-- 
        message:用来定义soap消息结构
        part：引用上面 types 中的约束格式
 -->
  <wsdl:message name="getUser">
    <wsdl:part element="tns:getUser" name="parameters">
    </wsdl:part>
  </wsdl:message>
  <wsdl:message name="getUserResponse">
    <wsdl:part element="tns:getUserResponse" name="parameters">
    </wsdl:part>
  </wsdl:message>
  
  <!-- 
    portType:用来指定服务器端的接口
    operation:接口中定义的方法
    input:方法getUser的输入
    output:方法getUser的输出
    输入输出引用的是上面message的定义
     -->
  <wsdl:portType name="UserServerImpl">
    <wsdl:operation name="getUser">
      <wsdl:input message="tns:getUser" name="getUser">
    </wsdl:input>
      <wsdl:output message="tns:getUserResponse" name="getUserResponse">
    </wsdl:output>
    </wsdl:operation>
  </wsdl:portType>
  
  <!-- 
    type属性:引用<portType>的定义
    <soap:binding style="document">:表示传输的一个document (xml)
    <input><output>方法的输入、输出
    <soap:body use="literal" />:表示body传输采用文本即xml格式的文本
-->
  <wsdl:binding name="UserServerImplServiceSoapBinding" type="tns:UserServerImpl">
    <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
    <wsdl:operation name="getUser">
      <soap:operation soapAction="" style="document"/>
      <wsdl:input name="getUser">
        <soap:body use="literal"/>
      </wsdl:input>
      <wsdl:output name="getUserResponse">
        <soap:body use="literal"/>
      </wsdl:output>
    </wsdl:operation>
  </wsdl:binding>
  
  <!-- 
    name:用于指定客户端的容器类/工厂类
     binding:引用上面的 binding 标签
     port name:容器通过这个方法获得实现类，自动生成会出现这个类，可以不用管
     address:客户端真正用于请求的地址
     -->
  <wsdl:service name="UserServerImplService">
    <wsdl:port binding="tns:UserServerImplServiceSoapBinding" name="UserServerImplPort">
      <soap:address location="http://localhost:8080/webservice/api"/>
    </wsdl:port>
  </wsdl:service>
  
</wsdl:definitions>

客户端

加入依赖

<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-spring-boot-starter-jaxws</artifactId>
    <version>3.3.4</version>
</dependency>

调用

public static void main(String[] args) {
        JaxWsDynamicClientFactory dcf = JaxWsDynamicClientFactory.newInstance();
        Client client = dcf.createClient("http://localhost:8080/webservice/api?wsdl");
        ObjectMapper mapper = new ObjectMapper();
        try {
            // invoke("方法名",参数1,参数2,参数3....);
            Object[] objects = client.invoke("getUser", 99L);
            System.out.println(mapper.writeValueAsString(objects[0]));
        } catch (java.lang.Exception e) {
            e.printStackTrace();
        }
    }

输出结果：
{"address":"上海市浦东新区","age":25,"id":99,"name":"gongj"}
  • 如你对本文有疑问或本文有错误之处，欢迎评论留言指出。如觉得本文对你有所帮助，欢迎点赞和关注。
相关推荐
  • 邀您参加｜掘力计划25期：性能专场！9月23日北京与您不见不散～
    掘力计划25期性能专场在9月23日与您相约北京海淀区大钟寺1号楼3层17报告厅，报名且线下签到前100的小伙伴有周边领取，分享干货满满，千万不要错过哦～
    前端 后端 性能优化
    邀您参加｜掘力计划25期：性能专场！9月23日北京与您不见不散～
  • 权限控制-RBAC模型
    权限控制一直是系统设计绕不开的话题，RBAC 是一种常用的权限控制模型，今天让我们一起来探究一下其中的奥秘。
    后端 面试 架构
    权限控制-RBAC模型
  • 「聊设计模式」之装饰器模式（Decorator）
    装饰器模式是指在不改变原有对象的基础上，通过对其进行包装拓展，使其具有更强的功能。它在不改变原有代码的基础上，通过添加一些新的功能来满足用户的需求。
    后端 Java 设计模式
    「聊设计模式」之装饰器模式（Decorator）
  • Windows下搭建Redis哨兵集群模式
    哨兵模式，是基于主从复制模式，主从复制的优点全都拥有，并且主从可以实现自动切换，故障转移等功能，系统的可用性更好，哨兵模式其实就是主从模式的升级版，手动到自动切换，更加健壮。
    后端 架构 Linux
  • 基于ReactPortals实现无限层级弹出层结构｜掘金一周 9.20
    本期看点：这么多人用codesandbox，他服务器扛得住么？基于ReactPortals实现无限层级弹出层结构，记一次线上间隙锁引发的死锁问
    前端 后端 人工智能
  • 一篇文章带你了解 NestJS 中的 AOP 架构(中间件,拦截器,守卫,异常过滤器,管道)
    在NestJS中,一个请求首先会先经过控制器,然后调用服务中的方法,在 Service 中可能还会进行数据库的访问,但是如果我们想在这个过程中加入一些通用逻辑,比如打印日志,权限控制等,该如何做呢?
    前端 后端 NestJS
    一篇文章带你了解 NestJS 中的 AOP 架构(中间件,拦截器,守卫,异常过滤器,管道)
  • Puppeteer无头浏览器：开启自动化之门，掌握浏览器世界的无限可能
    大概还是入门期，我曾用Puppeteer做爬虫工具以此来绕过某网站的防爬机制。近期有需求要做任意链接网页截图，像这种场景非常适合用Puppeteer完成。无头浏览器我已知的还有Selenium。
    前端 后端 Node.js
    Puppeteer无头浏览器：开启自动化之门，掌握浏览器世界的无限可能
  • JDK 21探秘：引领Java开发新潮流的强大功能
    JDK 21是Java开发工具包的最新版本，它引入了许多令人振奋的新特性，旨在提高开发人员的生产力和代码质量。在本文中，我们将介绍一些JDK 21的新特性，并提供使用示例，以帮助您更好地理解和应用这些
    Java 后端
  • 大规模异构数据迁移的探索与实践
    1.背景 近一年交易对系统的技术架构做了重大升级和改造，其中包括订单、运单、账单模型升级，升级过程中很重要的一部分是数据迁移。在数据迁移过程中面临如下挑战： 数据量大：账单和订单数据规模庞大(订单、账
    后端 Java 数据库
    大规模异构数据迁移的探索与实践
  • 深入理解 Java 动态代理
    在 Java 中，动态代理是一种代理模式的实现方式，它允许在运行时动态地创建代理类并动态地处理方法调用。 动态代理常用于解耦合、处理和其他对象交互相关的行为控制。
    后端 Java
  • 10分钟巩固多线程基础
    10分钟巩固多线程基础：进程与线程，线程模型，串行、并行与并发，线程状态，同步，通信，中断.....
    后端 面试 Java
  • uWSGI 日志切割
    在使用 `uwsgi` 时，日志管理是一个重要的方面，`uwsgi` 自带日志切割特性，也可以使用 Linux 的 `logrotate` 服务来管理 uwsg
    后端 Django uWSGI
  • 深入理解 pytest_collection_modifyitems 钩子函数：优化测试集收集与管理
    前言 在解锁 pytest_configure(config) 的神奇功能：个性化定制你的测试框架这篇文章中，我们在文章最后，抛出了pytest_collection_modifyitems()钩子函
    后端 Python 测试
    深入理解 pytest_collection_modifyitems 钩子函数：优化测试集收集与管理
  • 记一次线上HBase服务JVM metaspace内存泄漏问题
    公司的HBase集群偶尔有个很奇怪的现象：内存占用会逐渐升高，响应延迟越来越高，最终服务宕机也会造成集群抖动，影响SLA。
    后端 HBase JVM
  • 聊聊Go语言的异常处理机制
    背景 最近因为遇到了一个panic问题，加上之前零零散散看了些关于程序异常处理相关的东西，对这块有点兴趣，于是整理了一下golang对于异常处理的机制。 名词介绍 Painc golang的内置方法，
    后端
    聊聊Go语言的异常处理机制

    • 友情链接：

    avatar
    获得点赞
    文章被阅读