SpringBoot整合WebService

最新推荐文章于 2024-05-28 12:54:40 发布
最新推荐文章于 2024-05-28 12:54:40 发布
阅读量2.9k 收藏 11
点赞数
分类专栏： SpringBoot 文章标签： spring boot 后端 java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_41405524/article/details/131966824
版权

SpringBoot整合WebService

WebService是一个比较旧的远程调用通信框架，现在企业项目中用的比较少，因为它逐步被SpringCloud所取代，它的优势就是能够跨语言平台通信，所以还有点价值，下面来看看如何在SpringBoot项目中使用WebService

我们模拟从WebService客户端发送请求给WebService服务端暴露的下载文件服务，并获取服务端返回的文件保存到本地

环境

SpringBoot2.7.3

Jdk17

服务端

在SpringBoot中整合WebService的服务端，需要通过一个配置文件将服务接口暴露出去给客户端调用

项目结构

image-20230727183518916

配置

服务端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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.3</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>webservice</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>webservice</name>
    <description>webservice</description>
    <properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!--cxf-->
        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-transports-http</artifactId>
            <version>3.5.1</version>
        </dependency>

        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-frontend-jaxws</artifactId>
            <version>3.5.1</version>
        </dependency>

        <!--hutool-->
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.8.12</version>
        </dependency>

        <!--fastjson-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>2.0.16</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

服务端YML

server: # 必须配置端口，客户端需要
  port: 7001

FileCxfConfig

该文件为WebService服务暴露配置文件

package com.example.webservice.config;

import com.example.webservice.service.FileCxfService;
import com.example.webservice.service.impl.FileCxfServiceImpl;
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 FileCxfConfig {

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

    @Bean(name = "downloadFileBean")
    public ServletRegistrationBean dispatcherServlet() {
        ServletRegistrationBean wbsServlet = new ServletRegistrationBean(new CXFServlet(), "/file/*");
        return wbsServlet;
    }

    @Bean
    public FileCxfService fileCxfService() {
        return new FileCxfServiceImpl();
    }

    @Bean
    public Endpoint endpointPurchase(SpringBus springBus, FileCxfService fileCxfService) {
        EndpointImpl endpoint = new EndpointImpl(springBus(), fileCxfService());
        endpoint.publish("/download");
        System.err.println("服务发布成功！地址为：http://localhost:7001/file/download?wsdl");
        return endpoint;
    }
    
}

FileCxfService

该类指定了暴露的服务接口，注意类中的注解都很重要，不能丢，具体可以看说明

package com.example.webservice.service;


import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;
import javax.xml.ws.BindingType;

@BindingType(value = "http://www.w3.org/2003/05/soap/bindings/HTTP/")
@WebService(serviceName = "FileCxfService", // 与接口中指定的name一致
        targetNamespace = "http://webservice.example.com" // 与接口中的命名空间一致,一般是接口的包名倒
)
public interface FileCxfService {

    @WebMethod(operationName = "downloadFile")
    @WebResult(name = "String")
    String downloadFile(@WebParam(name = "params", targetNamespace = "http://webservice.example.com") String params,
                @WebParam(name = "token", targetNamespace = "http://webservice.example.com") String token);

}

FileCxfServiceImpl

该类指定了暴露的服务接口的具体实现，注意类中的注解都很重要，不能丢，具体可以看说明

package com.example.webservice.service.impl;

import cn.hutool.core.codec.Base64;
import com.alibaba.fastjson2.JSONObject;
import com.example.webservice.pojo.FileDto;
import com.example.webservice.service.FileCxfService;

import javax.jws.WebService;

@WebService(serviceName = "FileCxfService", // 与接口中指定的name一致
        targetNamespace = "http://webservice.example.com" // 与接口中的命名空间一致,一般是接口的包名倒
)
public class FileCxfServiceImpl implements FileCxfService {

    @Override
    public String downloadFile(String params, String token) {
        //下载文件
        System.err.println("params : " + params);
        FileDto fileDto = JSONObject.parseObject(params, FileDto.class);
        System.err.println("fileDto : " + fileDto);
        String data = null;
        try {
            data = Base64.encode("C:\\Users\\YIQI\\Desktop\\ebook\\Java70.pdf");
        } catch (Exception e) {
            e.printStackTrace();
        }
        System.err.println(data);
        return data;
    }

}

FileDto

该类为参数实体类，用于接受客户端传来的参数

package com.example.webservice.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.ToString;

@Data
@AllArgsConstructor
@ToString
public class FileDto {

    private String fileId;
    private String newFileId;
    private String bucketName;

}

客户端

在SpringBoot中整合WebService的客户端，需要指定服务端暴露的服务接口

项目结构

image-20230727184202714

配置

客户端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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.3</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>webclient</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>webclient</name>
    <description>webclient</description>
    <properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!--cxf-->
        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-transports-http</artifactId>
            <version>3.5.1</version>
        </dependency>

        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-frontend-jaxws</artifactId>
            <version>3.5.1</version>
        </dependency>

        <!--hutool-->
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.8.12</version>
        </dependency>

        <!--fastjson-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>2.0.16</version>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

客户端YML

server: # 可以不配置
  port: 1000

FileCxfService

这个文件和服务端的FileCxfService保持一致，用于指定客户端请求的方式

package com.example.webclient.service;


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

@WebService(name = "FileCxfService", // 暴露服务名称
        targetNamespace = "http://webservice.example.com"// 命名空间,一般是接口的包名倒序
)
public interface FileCxfService {

    String downloadFile(@WebParam(name = "data", targetNamespace = "http://webservice.example.com") String data,
                @WebParam(name = "token", targetNamespace = "http://webservice.example.com") String token);

}

FileCxfClient

这个类是客户端的主类，里面有发送WebService请求的方法

package com.example.webclient.client;

import cn.hutool.core.codec.Base64;
import com.alibaba.fastjson2.JSONObject;
import com.example.webclient.pojo.FileDto;
import com.example.webclient.service.FileCxfService;
import com.example.webclient.util.ConvertBASE64;

import javax.xml.bind.DatatypeConverter;
import javax.xml.namespace.QName;
import javax.xml.ws.Service;
import java.net.URL;


public class FileCxfClient {

    public static void main(String[] args) throws Exception {

        // 创建wsdl的url
        URL url = new URL("http://localhost:7001/file/download?wsdl");
        // 指定命名空间和服务名称
        QName qName = new QName("http://webservice.example.com", "FileCxfService");
        Service service = Service.create(url, qName);
        // 通过getPort方法返回指定接口
        FileCxfService myServer = service.getPort(FileCxfService.class);
        // 调用方法返回数据
        FileDto fileDto = new FileDto();
        fileDto.setFileId("1");
        fileDto.setNewFileId("1");
        fileDto.setBucketName("book");
        String params = JSONObject.toJSONString(fileDto);
        Long st = System.currentTimeMillis();
        String file = myServer.downloadFile(params, "TOKEN:ABC");
        // 解析文件到本地
        // 可以解析成字节数组，如果服务端返回的也是字节数组的话
        byte[] decode= Base64.decode(file);
        // 也可以将Base64写入到本地文件中
        ConvertBASE64.decoderBase64File(file, "C:\\Users\\YIQI\\Desktop\\ebook\\demo70.pdf");
        System.err.println("decode : " + decode.toString());
        System.err.println("result get file success!");
        System.err.println("cost time : " + (System.currentTimeMillis() - st) / 1000 + " s.");

    }

}

FileDto

这个类是封装请求参数的实体类，和服务端的FileDto保持一致

package com.example.webclient.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;

@Data
@AllArgsConstructor
@NoArgsConstructor
@ToString
public class FileDto {

    private String fileId;
    private String newFileId;
    private String bucketName;

}

ConvertBASE64

该类是Base64工具类，可以完成Base64字符串和文件的互换

package com.example.webclient.util;


import cn.hutool.core.codec.Base64Decoder;
import cn.hutool.core.codec.Base64Encoder;
import cn.hutool.core.io.FileUtil;
import com.alibaba.fastjson2.JSONObject;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;

public class ConvertBASE64 {

    /**
     * 将文件转成base64编码字符串
     *
     * @param path
     * @return
     * @throws Exception
     */
    public static String encodeBase64File(String path) throws Exception {
        File file = new File(path);
        FileInputStream inputFile = new FileInputStream(file);
        byte[] buffer = new byte[(int) file.length()];
        inputFile.read(buffer);
        inputFile.close();
        return new Base64Encoder().encode(buffer);
    }


    /**
     * 将base64编码字符串转成文件
     *
     * @param base64Code
     * @param targetPath
     * @throws Exception
     */
    public static void decoderBase64File(String base64Code, String targetPath)
            throws Exception {
        byte[] buffer = Base64Decoder.decode(base64Code);
        FileOutputStream out = new FileOutputStream(targetPath);
        out.write(buffer);
        out.close();
    }


    /**
     * 将base64字节装成文件
     *
     * @param base64Code
     * @param targetPath
     * @throws Exception
     */
    public static void toFile(String base64Code, String targetPath)
            throws Exception {
        byte[] buffer = base64Code.getBytes();
        FileOutputStream out = new FileOutputStream(targetPath);
        out.write(buffer);
        out.close();
    }


    public static String toJson(Object obj) {
        return JSONObject.toJSONString(obj);
    }


    public static Object toObject(String JSONString, Class cls) {
        return JSONObject.parseObject(JSONString, cls);
    }


    public static void writeByteArrayToFile(File desFile, byte[] data)
            throws IOException {
        FileUtil.writeBytes(data, desFile);
    }


    public static byte[] readFileToByteArray(File srcFile)
            throws IOException {
        return FileUtil.readBytes(srcFile);
    }


    public static String encode(String string) {
        return new String(Base64Encoder.encode(string.getBytes()));

    }


    public static void main(String[] args) {
        try {
            String a = encodeBase64File("C:\\Users\\YIQI\\Desktop\\工作文件\\bg2.jpg");
            // String base64Code = encodeBase64File("D:/0101-2011-qqqq.tif");
            System.out.println(a);
            decoderBase64File(a, "C:\\Users\\YIQI\\Desktop\\工作文件\\bg3.jpg");
            // toFile(base64Code, "D:\\three.txt");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}

测试

先启动服务端，可以看到对外发布的服务

image-20230727190423700

在启动客户端给服务端发送请求的方法，可以看到服务端返回的数据

image-20230727190539581

因为我把从服务端获取的文件写入到了本地，所以可以在文件目录中看到该文件

image-20230727190638111

BirdMan98
关注
  • 0
    点赞
  • 踩
  • 11
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
专栏目录
【十二】springboot整合WebService
weixin_56995925的博客
09-22 1万+
springboot整合WebService
Springboot集成WebService
weixin_49390750的博客
07-21 1866
Springboot集成WebService
SpringBoot 创建 WebService
05-05 1942
SpringBoot WebService
Springboot注解开发WebService
最新发布
Braycep的博客
05-28 518
SpringBoot + Spring WebService 快速发布WebService接口
SpringBoot集成webservice
qq_42582773的博客
11-20 1万+
webservice
SpringBoot 整合WebService详解
Java的一只小实习生的博客
04-24 9340
WebService服务端是以远程接口为主的，在Java实现的WebService技术里主要依靠CXF开发框架，而这个CXF开发框架可以直接将接口发布成WebService。RS基于Restful风格，WS基于SOAP的XML协议RS比WS传输的数据更少，效率更高WS只能传输XML数据，RS可以传输XML，也可以传输JSON参考:此处讲解JAX-WS。
SpringBoot 整合WebService
q1372302825的博客
03-01 2175
SOAP Web服务：基于SOAP（Simple Object Access Protocol）协议的Web服务。SOAP是一种用于交换结构化信息的协议，它使用XML作为消息格式，并通常通过HTTP协议进行传输。RESTful Web服务：基于REST（Representational State Transfer）原则的Web服务。RESTful服务使用标准的HTTP方法（如GET、POST、PUT、DELETE）来执行操作，并通常返回JSON或XML格式的数据。
[亲测可用]springBoot调用对方webService接口的几种方法示例
热门推荐
小小鱼儿小小林的博客
06-28 4万+
平常我们开发调用接口一般会用到几种协议方式，有restful的，这个是最简单开发的，还有一种就是webservice协议 那什么是webservice呢，Web service是一个平台独立的，低耦合的，自包含的、基于可编程的web的应用程序，可使用开放的XML（标准通用标记语言下的一个子集）标准来描述、发布、发现、协调和配置这些应用程序，用于开发分布式的互操作的应用程序 在调用别人写好...
springboot整合webservice采用CXF技术
06-23
以上就是Spring Boot整合Apache CXF实现Web服务的基本步骤。在实际项目中，可能还需要考虑安全性、异常处理、日志记录等更多细节。通过这种方式，Spring Boot项目可以作为一个高效的Web服务提供者或消费者，与其他...
springboot整合CXF发布webservice和客户端调用
04-10
SpringBoot整合CXF是将流行的Java Web服务框架CXF与SpringBoot轻量级框架结合，以便更方便地创建和消费Web服务。这个项目提供了一个很好的示例，通过详细注释帮助开发者理解如何在SpringBoot应用中发布和调用Web服务...
SpringBoot开发WebService之Axis示例
07-15
通过整合SpringBoot与Axis，我们可以快速构建高效且易于维护的Web服务。 首先，让我们了解什么是SpringBoot。SpringBoot是Spring框架的扩展，旨在简化Spring应用的初始搭建以及开发过程。它提供了开箱即用的设置，...
springboot+webservice搭建webservice服务端及使用java客户端两种方式进行调用webservice接口
11-10
首先，我们需要理解Spring Boot与CXF的整合。Spring Boot通过其自动配置特性简化了CXF的设置。我们可以通过添加`cxf-spring-boot-starter-jaxws`依赖到项目中来启动这个过程。在`pom.xml`文件中添加如下依赖： ```...
WebService（springboot整合案例 wsdl）
01-20
首先，目前springboot的版本最高为2.2.6，在集成cxf的3.2.4或3.2.5 时候会出现启动报错，这个太折磨人。。。。必须把springboot版本换到2.1.2以下，否者不兼容。 这是模拟企业用户的开发，在远程调用的时候客户端...
SpringBoot整合WebService（wsdd）
z1696637434的博客
03-19 1622
在SpringBoot中整合WebService（wsdd），WebService需要依赖Servlet并且需要Tomcat才能运行。
springboot开发webservice服务端，发布多个webservice服务案例（带你玩转webservice）
Brave_heart4pzj的博客
09-05 5890
webservice
SpringBoot整合WebService 【客户端、服务端】
qq_46220373的博客
04-03 744
在线的wsdl：http://127.0.0.1:9090/xx/user?
在springboot中创建webservice服务
hjseo_seg的博客
07-31 1950
最近因为业务的需要，甲方让我在项目中提供webservice接口，然后他推送数据。我来这个新公司不长时间，因为业务的关系，以前没接触过sap的相关东西，sap是什么我也不知道，后来百度查了一下，我靠，好牛掰的样子，一套要十几万。我感觉webservice也是post方式接口，因为我用apipost工具进行测试，body里放左侧的请求的xml，得到完全相同的的结果，为了验证我的猜想，我用springboot自带的RestTemplate类发送了一次post请求，发现也是得到了右侧的返回内容，这是我的测试类。.
用Springboot搭建webService服务
weixin_43952429的博客
07-31 606
概述 WebService简单概述就是用http发送接收xml数据，但这个xml得遵守系统的规范。这个规范就是WSDL（Web服务描述语言，Web Services Description Language），在WebService中传输的xml有一个正式的名称叫Soap（简单对象访问协议 Simple Object Access Protocol）。 代码实现 首先，准备一个wsdl 文档 wsdl 文档包含五个标准元素：types, message, portType, binding and se
Springboot 项目 调用webservice接口
mmZXB97的博客
10-23 2417
近期接到个需求，项目中需要集成零几年建设的OA系统。OA系统使用的接口全部都是webservice接口，在此分享一下使用Hutool及Cxf依赖包调用webservice接口过程中遇到的问题及调用方式。
springboot整合webservice
03-23
可以使用 Spring Boot 的 WebServiceTemplate 类来实现与 WebService 的交互。首先需要在 pom.xml 文件中添加以下依赖： ``` <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web-services</artifactId> </dependency> ``` 然后在 Spring Boot 应用程序中创建一个 WebServiceTemplate 对象，使用该对象调用 WebService 的方法即可。 示例代码如下： ``` @Configuration public class WebServiceConfig { @Bean public WebServiceTemplate webServiceTemplate() { Jaxb2Marshaller marshaller = new Jaxb2Marshaller(); marshaller.setContextPath("com.example.webservice"); WebServiceTemplate webServiceTemplate = new WebServiceTemplate(); webServiceTemplate.setMarshaller(marshaller); webServiceTemplate.setUnmarshaller(marshaller); webServiceTemplate.setDefaultUri("http://localhost:8080/ws"); return webServiceTemplate; } } @Service public class WebServiceClient { @Autowired private WebServiceTemplate webServiceTemplate; public void callWebService() { GetCountryRequest request = new GetCountryRequest(); request.setName("Spain"); GetCountryResponse response = (GetCountryResponse) webServiceTemplate.marshalSendAndReceive(request); System.out.println(response.getCountry().getCapital()); } } ``` 以上代码演示了如何使用 Spring Boot 整合 WebService，其中 GetCountryRequest 和 GetCountryResponse 是根据 WebService 的 WSDL 自动生成的 Java 类。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

BirdMan98

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值