Spring boot 集成 WebService(简单使用、文件上传下载)
WebService是一个SOA(面向服务的编程)的架构,它是不依赖于语言,不依赖于平台,可以实现不同的语言间的相互调用,通过Internet进行基于Http协议的网络应用间的交互。 其实WebService并不是什么神秘的东西,它就是一个可以远程调用的类,或者说是组件,把你本地的功能开放出去共别人调用。具体的说,Web Service可以让你的网站使用其他网站的资源,比如在网页上显示天气、地图、twitter上的最新动态等等。
1. 原理
在Web Service的体系架构中有三个角色:服务提供者(Service Provider),也叫服务生产者;服务请求者(Service Requester),也叫服务消费者;服务注册中心(Service Register),也叫服务代理,服务提供者在这里发布服务,服务请求者在这里查找服务,获取服务的绑定信息。
角色间主要有三个操作:
- 发布(Publish),服务提供者把服务按照规范格式发布到服务注册中心;
- 查找(Find),服务请求者根据服务注册中心提供的规范接口发出查找请求,获取绑定服务所需的相关信息。
- 绑定(Bind),服务请求者根据服务绑定信息对自己的系统进行配置,从而可以调用服务提供者提供的服务。
Web Service的实现是通过SOAP在Web上提供的软件服务,使用WSDL文件进行说明,并通过UDDI进行注册。
相关概念:
- XML:(Extensible Markup Language)扩展型可标记语言。面向短期的临时数据处理、面向万维网络,是SOAP的基础。
- SOAP:(Simple Object Access Protocol)简单对象存取协议。是XML Web Service 的通信协议。当用户通过UDDI找到你的WSDL描述文档后,他通过可以SOAP调用你建立的Web服务中的一个或多个操作。SOAP是XML文档形式的调用方法的规范,它可以支持不同的底层接口,像HTTP(S)或者SMTP。
- WSDL:(Web Services Description Language) WSDL 文件是一个 XML 文档,用于说明一组 SOAP 消息以及如何交换这些消息。大多数情况下由软件自动生成和使用。
- UDDI (Universal Description, Discovery, and Integration) 是一个主要针对Web服务供应商和使用者的新项目。在用户能够调用Web服务之前,必须确定这个服务内包含哪些商务方法,找到被调用的接口定义,还要在服务端来编制软件,UDDI是一种根据描述文档来引导系统查找相应服务的机制。UDDI利用SOAP消息机制(标准的XML/HTTP)来发布,编辑,浏览以及查找注册信息。它采用XML格式来封装各种不同类型的数据,并且发送到注册中心或者由注册中心来返回需要的数据。
2. 集成
2.1 服务端
创建一个spring boot项目;
依赖
<dependencies><!-- 核心启动器 --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter</artifactId></dependency><!-- web启动器 --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><!-- 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><version>3.2.1</version></dependency><dependency><groupId>org.apache.cxf</groupId><artifactId>cxf-rt-transports-http</artifactId><version>3.2.1</version></dependency><!-- CXF webservice --><dependency><groupId>org.hibernate</groupId><artifactId>hibernate-validator</artifactId><version>6.0.18.Final</version></dependency> </dependencies>
接口
@WebService(name = "WebServices", targetNamespace = "http://service.webservicedemo.example.com")// 命名空间,一般是接口的包名倒序 public interface WebServices {@WebMethodString emrService(@WebParam String data); }
实现
/*** WebService涉及到的有这些 "四解三类 ", 即四个注解,三个类** @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*/ @WebService(serviceName = "WebServices"//服务名, targetNamespace = "http://service.webservicedemo.example.com"//报名倒叙,并且和接口定义保持一致, endpointInterface = "com.example.webservicedemo.service.WebServices")//包名 @Component public class WebServicesImpl implements WebServices {@Overridepublic String emrService(@WebParam String data) {if (null == data || "".equals(data.trim())) {return "传入的参数为空";}System.out.println("start======================");return "调用成功";} }
接口发布类
/*** 注意:* org.apache.cxf.Bus* org.apache.cxf.bus.spring.SpringBus* org.apache.cxf.jaxws.EndpointImpl* javax.xml.ws.Endpoint*/ @Configuration public class CxfConfig {@Autowiredprivate WebServices webServices;/*** 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/*");//}@Beanpublic Endpoint endpoint() {EndpointImpl endpoint = new EndpointImpl(springBus(), webServices);endpoint.publish("/ws/api");return endpoint;} }
启动项目
访问地址:http://localhost:8080/services/ 列出在services下的所有服务列表
http://localhost:8080/services/ws/api?wsdl 查看访问具体的服务信息。
标签的重要信息说明可以参考:https://blog.csdn.net/xxssyyyyssxx/article/details/50292787
2.2 客户端创建
创建一个新项目;
引入依赖
<dependencies><!-- 核心启动器 --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter</artifactId></dependency><!-- 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><version>3.2.1</version></dependency><dependency><groupId>org.apache.cxf</groupId><artifactId>cxf-rt-transports-http</artifactId><version>3.2.1</version></dependency><!-- CXF webservice --><!-- 如果使用代理类工厂的方式, 因需要知道服务端发布的接口名,所以这里是需要引入服务端的接口模块。服务端一般需要将所有对外接口抽取到单独的一个模块,再再pom.xml进行引入 --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency> </dependencies>
测试代码
public class Main {public static void main(String[] args) {invokeService_2();}/*** 1.代理类工厂的方式,需要拿到对方的接口地址, 同时需要引入接口*/ // public static void invokeService_1() {// // 接口地址 // String address = "http://localhost:8080/services/ws/api?wsdl"; // // 代理工厂 // JaxWsProxyFactoryBean jaxWsProxyFactoryBean = new JaxWsProxyFactoryBean(); // // 设置代理地址 // jaxWsProxyFactoryBean.setAddress(address); // // 设置接口类型 // jaxWsProxyFactoryBean.setServiceClass(ServerServiceDemo.class); // // 创建一个代理接口实现 // ServerServiceDemo us = (ServerServiceDemo) jaxWsProxyFactoryBean.create(); // // 数据准备 // String data = "hello world"; // // 调用代理接口的方法调用并返回结果 // String result = us.emrService(data); // System.out.println("返回结果:" + result); // }/*** 2. 动态调用*/public static void invokeService_2() {// 创建动态客户端JaxWsDynamicClientFactory dcf = JaxWsDynamicClientFactory.newInstance();Client client = dcf.createClient("http://localhost:8080/services/ws/api?wsdl");// 需要密码的情况需要加上用户名和密码// client.getOutInterceptors().add(new ClientLoginInterceptor(USER_NAME, PASS_WORD));Object[] objects = new Object[0];try {// invoke("方法名",参数1,参数2,参数3....);//这里注意如果是复杂参数的话,要保证复杂参数可以序列化objects = client.invoke("emrService", "hello world");System.out.println("返回数据:" + objects[0]);} catch (java.lang.Exception e) {e.printStackTrace();}} }
测试结果
3. 文件上传下载
该部分的代码参考github上一个老哥的代码;我采用了其中的文件上传,并将代码简洁了一下。如果需要文件下载的话可以去看这个老哥的。
https://github.com/TorresZheng/webservice-file-transport
4. 项目地址
https://gitee.com/cl1429745331/javaer
Spring boot 集成 WebService(简单使用、文件上传下载)相关推荐
- 树莓派3B+采用花生棒进行内网穿透,从拆箱到实现SSH远程控制与sftp简单远程文件上传下载
树莓派3B+采用花生棒进行内网穿透,使用sftp实现远程控制与简单远程文件上传下载) 准备步骤 物理环境搭建 关于基础配置的博文推荐 树莓派联网配置 基础联网 配置静态ip 花生壳内网穿透 常用远程端 ...
- 关于SpringMVC框架实现简单的文件上传下载(ssm)
关于ssm框架整合文件的上传和下载. 首先来看单个附件的上传和下载: 1.首先创建一个用来测试的jsp文件上传下载的页面 代码如下 <%@ page language="java&q ...
- spring boot 整合web开发之文件上传、静态资源访问、异常处理、返回JSON数据
目录 springboot 整合web开发 返回json数据 静态资源访问 文件上传 全局异常 1.返回json数据 springboot默认的是jackson-databind做为json处理器.也 ...
- Spring Boot配置MinIO(实现文件上传、下载、删除)
1 MinIO MinIO 是一个基于Apache License v2.0开源协议的对象存储服务.它兼容亚马逊S3云存储服务接口,非常适合于存储大容量非结构化的数据,例如图片.视频.日志文件.备份数 ...
- python scoket、SocketServer简单实现文件上传下载
2019独角兽企业重金招聘Python工程师标准>>> 1.描述 实现任何位置文件下载到客户端执行的当前目录下 实现任何位置文件上传到服务端执行的当前目录下服务端: #!/usr/b ...
- Spring Boot配置静态资源实现文件上传在线查看
spring.mvc.static-path-pattern 代表的含义是我们应该以什么样的路径来访问静态资源,换句话说,只有静态资源满足什么样的匹配条件,Spring Boot才会处理静态资源请求. ...
- java批量上传文件_Spring boot 实现单个或批量文件上传功能
一:添加依赖: org.springframework.boot spring-boot-starter-thymeleaf javax.servlet jstl org.apache.tomcat. ...
- salesforce 零基础学习(四十二)简单文件上传下载
项目中,常常需要用到文件的上传和下载,上传和下载功能实际上是对Document对象进行insert和查询操作.本篇演示简单的文件上传和下载,理论上文件上传后应该将ID作为操作表的字段存储,这里只演示文 ...
- spring boot基础教程之文件上传下载
一文件上传 文件上传主要分以下几个步骤: (1)新建maven java project: (2)在pom.xml加入相应依赖: (3)新建一个文件上传表单页面; (4)编写controller; ( ...
- 项目_功能模块_基于Spring Boot的文件上传下载功能的设计与实现
文章目录 基于Spring Boot的文件上传下载功能模块的设计与实现 1.前言 2.技术栈 3.关键源码 4.实现效果 4.1.登录 4.2.文件列表 4.3.上传文件测试 4.3.1.测试图片 4 ...
最新文章
- AngularJS 指令
- as工程放到源码编译_关于AS高版本SDK编译生成的apk放入低版本android源码中集成编译...
- RL之PG:基于TF利用策略梯度算法玩Cartpole游戏实现智能得高分
- Django的电子商务网站的调研
- Oracle发布Java 8
- Vue.js最佳实践
- C语言空指针NULL详解
- 不断的感悟、不断的学习、不断的成长
- 【Git】Git处理新Repository无法push的问题
- 有两个集合,两个集合都是10万个数据(已排序),判断B是不是A的子集,算法时间复杂度为Q(N)...
- 【AI视野·今日Robot 机器人论文速览 第十八期】Fri, 2 Jul 2021
- kafka java客户端消息的分区与缓存发送
- NB-IOT技术以及物联网安全问题简述
- Python2.5.4移植到arm-linux
- 基于Matlab使用雷达和摄像头对公路车辆跟踪仿真(附源码)
- 2021年1~11月语音合成和语音识别论文月报
- 关于GitHub Education(GitHub教育认证)认证
- 201819102036张祺
- 后来的我们都老了——看《后来的我们》
- SpringBoot电商项目前后端界面搭建
热门文章
- No such file or directory: ‘/tmp/tmpxxx/tmpxxx.py‘
- 超级万能计算机在线应用,超级万能计算器手机版
- extern 关键字详解
- Unity3D “xx AnimationEvent has no function name specified!”解决方案
- Linux操作系统笔记(基本命令+环境安装项目部署+Shell编程)
- 中国无损探伤检测行业发展前景与投资战略规划分析报告2021-2027年
- 初探Freebase和Wikidata的转换
- 一个外国程序员中的中国程序员
- mysql哨兵模式_redis 哨兵模式集群搭建
- URP——后期处理特效——通道混合器Channel Mixer