Java开发必知:WebService客户端调用的5种常见方式-程序员宅基地

技术标签: cxf  java  webservice  后端  

之前系统中使用到了webservice进行第三方通信,这里总结一下常见的5种客户端调用方式。

在此之前我们先简单搭建一个webservice服务端项目,发布一个webservice服务。我这里使用springboot快速搭建一个,项目结构如下:
在这里插入图片描述
创建一个springboot项目,导入maven依赖:

<dependency>
     <groupId>org.projectlombok</groupId>
     <artifactId>lombok</artifactId>
     <optional>true</optional>
</dependency>
<dependency>
     <groupId>org.apache.cxf</groupId>
     <artifactId>cxf-spring-boot-starter-jaxws</artifactId>
     <version>3.3.5</version>
</dependency>

创建一个数据传输对象:

@Data
@NoArgsConstructor
@AllArgsConstructor
public class UserDto {
    
    private String name;
    private int age;
    private Sex sex;
}

这里声明一个性别的枚举类型:

public enum Sex {
    
    MALE("male"), FEMALE("female");
    String value;
    private Sex(String value) {
    
        this.value = value;
    }
    public String value() {
    
        return value;
    }
}

创建一个接口,作为服务发布的接口类,为了简单只声明一个方法:

/**
 * 创建webservice服务接口
 */
@WebService(targetNamespace = "http://webservice.simplewebserviceserver.learn.com"/*一般把包名倒着写*/,
        name = "userService")
public interface UserService {
    

    /**
     * 通过用户名获取用户
     *
     * @param userName
     * @return
     */
    @WebMethod(operationName = "getUserByName")
    UserDto getUserByName(@WebParam(name = "userName") String userName);

}

创建接口的实现类:

@WebService(targetNamespace = "http://webservice.simplewebserviceserver.learn.com"/*wsdl命名空间*/,
        name = "UserService"/*portType名称 客户端生成代码时 为接口名称*/,
        serviceName = "userService"/*服务name名称*/,
        portName = "userPortName"/*port名称*/,
        endpointInterface = "com.learn.simplewebserviceserver.webservice.UserService"/*指定发布webservcie的接口类,此类也需要接入@WebService注解*/)
public class UserServiceImpl implements UserService {
    

    @Override
    public UserDto getUserByName(String userName) {
    
        return new UserDto(userName, 23, Sex.MALE);
    }
}

增加一个webservice的配置类:

@Configuration
public class CxfWebServiceConfig {
    

    // 这里需要注意 若beanName命名不是 cxfServletRegistration 时,会创建两个CXFServlet的。
    // 具体可查看下自动配置类:Declaration
    // org.apache.cxf.spring.boot.autoconfigure.CxfAutoConfiguration
    // 也可以不设置此bean 直接通过配置项 cxf.path 来修改访问路径的
    @Bean("cxfServletRegistration")
    public ServletRegistrationBean<CXFServlet> cxfServletRegistration() {
    
        // 注册servlet 拦截/ws 开头的请求 不设置 默认为:/services/*
        return new ServletRegistrationBean<CXFServlet>(new CXFServlet(), "/ws/*");
    }

    /**
     * 申明业务处理类 当然也可以直接 在实现类上标注 @Service
     *
     */
    @Bean
    public UserService userService() {
    
        return new UserServiceImpl();
    }

    /*
     * 非必要项
     */
    @Bean(name = Bus.DEFAULT_BUS_ID)
    public SpringBus springBus() {
    
        SpringBus springBus = new SpringBus();
        return springBus;
    }

    /*
     * 发布endpoint
     */
    @Bean
    public Endpoint endpoint(UserService userService) {
    
        EndpointImpl endpoint = new EndpointImpl(springBus(), userService);
        endpoint.publish("/user");// 发布地址
        return endpoint;
    }
}

到此一个简单的webservice服务端项目就搭建完成了,这里我在application.properties文件中把端口改成8081:

server.port=8081

启动项目,访问http://127.0.0.1:8081/ws/user?wsdl,如果出现以下内容则表示启动成功了:
在这里插入图片描述
下面介绍一下webservice客户端如何调用服务端发布的服务:

方式一:使用jdk原生代码实现调用
必要条件:
1.webservice服务端发布地址
2.webservice服务发布的接口类
3.参数和返回值实体类
创建一个maven项目,结构如下:
在这里插入图片描述
其中Sex,UserDto,UserService同服务端的代码,导入maven依赖:

		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<version>1.18.12</version>
			<scope>provided</scope>
		</dependency>
		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-core</artifactId>
			<version>3.3.5</version>
		</dependency>

核心调用代码:

public class UserClient {
    

	public static void main(String[] args) throws MalformedURLException {
    
		URL url = new URL("http://127.0.0.1:8081/ws/user?wsdl");
		// 指定命名空间和服务名称
		QName qName = new QName("http://webservice.simplewebserviceserver.learn.com", "userService");
		Service service = Service.create(url, qName);
		// 通过getPort方法返回指定接口
		UserService myServer = service.getPort(
				new QName("http://webservice.simplewebserviceserver.learn.com", "userPortName"), // 绑定端口名称
				UserService.class);
		// 调用方法 获取返回值
		UserDto userDto = myServer.getUserByName("张三");
		System.out.println(userDto);
	}
}

方式二:使用wsimport 命令,生成客户端代码然后再调用
wsimport -keep -d D:\temp\d -s D:\temp\s -p com.map -verbose http://127.0.0.1:8081/ws/user?wsdl
将生成的代码导入项目中正常使用即可,网上资料很多,这里不做赘述。

方法三:动态调用,根据发布地址动态生成客户端然后调用方法
必要条件:
1.webservice服务端发布地址
2.调用方法使用的参数和返回值
3.如果参数或返回值是实体类,需要根据指定的namespace创建实体类
创建一个maven项目,结构如下:
在这里插入图片描述
其中Sex,UserDto,UserService同服务端的代码,注意这里的实体类的包名是有限制的必须和服务端中的targetNamespace属性值一样,否则会报错,导入maven依赖:

		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<version>1.18.12</version>
			<scope>provided</scope>
		</dependency>
		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-core</artifactId>
			<version>3.3.5</version>
		</dependency>
		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-rt-transports-http</artifactId>
			<version>3.3.5</version>
		</dependency>
		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-rt-frontend-jaxws</artifactId>
			<version>3.3.5</version>
		</dependency>

核心调用代码:

public class UserClient {
    
	// 创建动态客户端
	private static Client client = null;
	static {
    
		JaxWsDynamicClientFactory factory = JaxWsDynamicClientFactory.newInstance();
		client = factory.createClient("http://127.0.0.1:8081/ws/user?wsdl");
		// 需要密码的情况需要加上用户名和密码
		// client.getOutInterceptors().add(new
		// ClientLoginInterceptor(USER_NAME,PASS_WORD));
		HTTPConduit conduit = (HTTPConduit) client.getConduit();
		HTTPClientPolicy httpClientPolicy = new HTTPClientPolicy();
		httpClientPolicy.setConnectionTimeout(2000); // 连接超时
		httpClientPolicy.setAllowChunking(false); // 取消块编码
		httpClientPolicy.setReceiveTimeout(120000); // 响应超时
		conduit.setClient(httpClientPolicy);
	}

	public static void main(String[] args) {
    
		// client.getOutInterceptors().addAll(interceptors);//设置拦截器
		try {
    
			Object[] objects = null;
			// invoke("方法名",参数1,参数2,参数3....);
			objects = client.invoke("getUserByName", "李四");
			System.out.println((UserDto) objects[0]);
		} catch (Exception e) {
    
			e.printStackTrace();
		}
		System.out.println(client);
	}
}

方式四:代理工厂的方式
必要条件:
1.webservice服务端发布地址
2.webservice服务发布的接口类
3.参数和返回值实体类
创建一个maven项目,结构如下:
在这里插入图片描述
其中Sex,UserDto,UserService同服务端的代码,导入maven依赖:

		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<version>1.18.12</version>
			<scope>provided</scope>
		</dependency>

		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-core</artifactId>
			<version>3.3.5</version>
		</dependency>
		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-rt-transports-http</artifactId>
			<version>3.3.5</version>
		</dependency>
		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-rt-frontend-jaxws</artifactId>
			<version>3.3.5</version>
		</dependency>

核心调用代码:

public class UserClient {
    

	public static void main(String[] args) throws MalformedURLException {
    
		JaxWsProxyFactoryBean factory = new JaxWsProxyFactoryBean();
		factory.setServiceClass(UserService.class);
		factory.setAddress("http://127.0.0.1:8081/ws/user?wsdl");
		UserService service = (UserService) factory.create();
		// 通过代理对象获取本地客户端
		Client client = ClientProxy.getClient(service);
		// 需要密码的情况需要加上用户名和密码
		// client.getOutInterceptors().add(new
		// ClientLoginInterceptor(USER_NAME,PASS_WORD));
		HTTPConduit conduit = (HTTPConduit) client.getConduit();
		HTTPClientPolicy httpClientPolicy = new HTTPClientPolicy();
		httpClientPolicy.setConnectionTimeout(2000); // 连接超时
		httpClientPolicy.setAllowChunking(false); // 取消块编码
		httpClientPolicy.setReceiveTimeout(120000); // 响应超时
		conduit.setClient(httpClientPolicy);
		// client.getOutInterceptors().addAll(interceptors);//设置拦截器
		try {
    
			UserDto user = service.getUserByName("王五");
			System.out.println("返回数据:" + user);
		} catch (Exception e) {
    
			e.printStackTrace();
		}
	}
}

方法五:使用httpClient的方式调用,需要借助第三方工具SoapUI获取请求xml数据格式的内容,同时请求响应内容是xml格式内容,需要自己解析。
创建一个maven项目,导入maven依赖:

		<dependency>
			<groupId>org.apache.httpcomponents</groupId>
			<artifactId>httpclient</artifactId>
			<version>4.5.11</version>
		</dependency>

这里主要的是需要借助SoapUi工具,SoapUi的安装和使用网上教程有很多,这里不再赘述,总之我们借助SoapUi是为了得到请求的xml格式数据,核心调用代码:

public class UserClient {
    
	public static void main(String[] args) {
    
		// soap服务地址
		String url = "http://127.0.0.1:8081/ws/user?wsdl";

		StringBuilder soapBuilder = new StringBuilder(64);
		soapBuilder.append("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
		soapBuilder.append(
				"<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:web=\"http://webservice.simplewebserviceserver.learn.com\">");
		soapBuilder.append("   <soapenv:Header/>");
		soapBuilder.append("   <soapenv:Body>");
		soapBuilder.append("      <web:getUserByName>");
		soapBuilder.append("        <!--Optional:-->");
		soapBuilder.append("         <userName>").append("王大力").append("</userName>");
		soapBuilder.append("      </web:getUserByName>");
		soapBuilder.append("   </soapenv:Body>");
		soapBuilder.append("</soapenv:Envelope>");
		// 创建httpcleint对象
		CloseableHttpClient httpClient = HttpClients.createDefault();
		// 创建http Post请求
		HttpPost httpPost = new HttpPost(url);
		// 构建请求配置信息
		RequestConfig config = RequestConfig.custom().setConnectTimeout(1000) // 创建连接的最长时间
				.setConnectionRequestTimeout(500) // 从连接池中获取到连接的最长时间
				.setSocketTimeout(3 * 1000) // 数据传输的最长时间10s
				.build();
		httpPost.setConfig(config);
		CloseableHttpResponse response = null;
		try {
    
			// 采用SOAP1.1调用服务端,这种方式能调用服务端为soap1.1和soap1.2的服务
			httpPost.setHeader("Content-Type", "text/xml;charset=UTF-8");

			// 采用SOAP1.2调用服务端,这种方式只能调用服务端为soap1.2的服务
			// httpPost.setHeader("Content-Type", "application/soap+xml;charset=UTF-8");
			StringEntity stringEntity = new StringEntity(soapBuilder.toString(), Charset.forName("UTF-8"));
			httpPost.setEntity(stringEntity);
			response = httpClient.execute(httpPost);
			// 判断返回状态是否为200
			if (response.getStatusLine().getStatusCode() == 200) {
    
				String content = EntityUtils.toString(response.getEntity(), "UTF-8");
				System.out.println(content);
			} else {
    
				System.out.println("调用失败!");
			}
		} catch (Exception e) {
    
			e.printStackTrace();
		} finally {
    
			if (null != response) {
    
				try {
    
					response.close();
				} catch (IOException e) {
    
					e.printStackTrace();
				}
			}
			if (null != httpClient) {
    
				try {
    
					httpClient.close();
				} catch (IOException e) {
    
					e.printStackTrace();
				}
			}
		}
	}
}

返回内容:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ns2:getUserByNameResponse xmlns:ns2="http://webservice.simplewebserviceserver.learn.com">
      <return>
        <age>23</age>
        <name>王大力</name>
        <sex>MALE</sex>
      </return>
    </ns2:getUserByNameResponse>
  </soap:Body>
</soap:Envelope>

到此,常用的webservice客户端调用方式就介绍完了,我自己还是比较建议使用代理工厂的方式方式进行webservice方法调用,这种方式简单快捷,也方便跟springboot项目整合,当然具体使用哪种方法应该根据实际工作出发。

经过测试发现,服务端和客户端的参数实体类中字段不必完全一样,只要保证任一接收端的参数实体中字段可以完全覆盖发送端的参数实体类中的有效字段即可。

例如,发送端实体类:

@Data
@AllArgsConstructor
@NoArgsConstructor
public class UserDto {
    

	private String name;

	private Integer age;

	private Integer id;

	private String message;

}

接收端实体类:

@Data
@AllArgsConstructor
@NoArgsConstructor
public class UserDto {
    

	private String name;

	// private Integer age;

	// private Integer id;

	// private String message;

}

调用:

		UserDto userDto = new UserDto();
		userDto.setName("张三");
		userDto.setAge(null);
		userDto.setId(null);
		objects = client.invoke("getUser", userDto);

由于此时有效字段只有name,所以这样调用,系统也可以正常运行。

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/C_AJing/article/details/104246720

智能推荐

从零开始搭建Hadoop_创建一个hadoop项目-程序员宅基地

文章浏览阅读331次。第一部分:准备工作1 安装虚拟机2 安装centos73 安装JDK以上三步是准备工作,至此已经完成一台已安装JDK的主机第二部分:准备3台虚拟机以下所有工作最好都在root权限下操作1 克隆上面已经有一台虚拟机了,现在对master进行克隆,克隆出另外2台子机;1.1 进行克隆21.2 下一步1.3 下一步1.4 下一步1.5 根据子机需要,命名和安装路径1.6 ..._创建一个hadoop项目

心脏滴血漏洞HeartBleed CVE-2014-0160深入代码层面的分析_heartbleed代码分析-程序员宅基地

文章浏览阅读1.7k次。心脏滴血漏洞HeartBleed CVE-2014-0160 是由heartbeat功能引入的,本文从深入码层面的分析该漏洞产生的原因_heartbleed代码分析

java读取ofd文档内容_ofd电子文档内容分析工具(分析文档、签章和证书)-程序员宅基地

文章浏览阅读1.4k次。前言ofd是国家文档标准,其对标的文档格式是pdf。ofd文档是容器格式文件,ofd其实就是压缩包。将ofd文件后缀改为.zip,解压后可看到文件包含的内容。ofd文件分析工具下载:点我下载。ofd文件解压后,可以看到如下内容: 对于xml文件,可以用文本工具查看。但是对于印章文件(Seal.esl)、签名文件(SignedValue.dat)就无法查看其内容了。本人开发一款ofd内容查看器,..._signedvalue.dat

基于FPGA的数据采集系统(一)_基于fpga的信息采集-程序员宅基地

文章浏览阅读1.8w次,点赞29次,收藏313次。整体系统设计本设计主要是对ADC和DAC的使用,主要实现功能流程为:首先通过串口向FPGA发送控制信号,控制DAC芯片tlv5618进行DA装换,转换的数据存在ROM中,转换开始时读取ROM中数据进行读取转换。其次用按键控制adc128s052进行模数转换100次,模数转换数据存储到FIFO中,再从FIFO中读取数据通过串口输出显示在pc上。其整体系统框图如下:图1:FPGA数据采集系统框图从图中可以看出,该系统主要包括9个模块:串口接收模块、按键消抖模块、按键控制模块、ROM模块、D.._基于fpga的信息采集

微服务 spring cloud zuul com.netflix.zuul.exception.ZuulException GENERAL-程序员宅基地

文章浏览阅读2.5w次。1.背景错误信息:-- [http-nio-9904-exec-5] o.s.c.n.z.filters.post.SendErrorFilter : Error during filteringcom.netflix.zuul.exception.ZuulException: Forwarding error at org.springframework.cloud..._com.netflix.zuul.exception.zuulexception

邻接矩阵-建立图-程序员宅基地

文章浏览阅读358次。1.介绍图的相关概念  图是由顶点的有穷非空集和一个描述顶点之间关系-边(或者弧)的集合组成。通常,图中的数据元素被称为顶点,顶点间的关系用边表示,图通常用字母G表示,图的顶点通常用字母V表示,所以图可以定义为:  G=(V,E)其中,V(G)是图中顶点的有穷非空集合,E(G)是V(G)中顶点的边的有穷集合1.1 无向图:图中任意两个顶点构成的边是没有方向的1.2 有向图:图中..._给定一个邻接矩阵未必能够造出一个图

随便推点

MDT2012部署系列之11 WDS安装与配置-程序员宅基地

文章浏览阅读321次。(十二)、WDS服务器安装通过前面的测试我们会发现,每次安装的时候需要加域光盘映像,这是一个比较麻烦的事情,试想一个上万个的公司,你天天带着一个光盘与光驱去给别人装系统,这将是一个多么痛苦的事情啊,有什么方法可以解决这个问题了?答案是肯定的,下面我们就来简单说一下。WDS服务器,它是Windows自带的一个免费的基于系统本身角色的一个功能,它主要提供一种简单、安全的通过网络快速、远程将Window..._doc server2012上通过wds+mdt无人值守部署win11系统.doc

python--xlrd/xlwt/xlutils_xlutils模块可以读xlsx吗-程序员宅基地

文章浏览阅读219次。python–xlrd/xlwt/xlutilsxlrd只能读取,不能改,支持 xlsx和xls 格式xlwt只能改,不能读xlwt只能保存为.xls格式xlutils能将xlrd.Book转为xlwt.Workbook,从而得以在现有xls的基础上修改数据,并创建一个新的xls,实现修改xlrd打开文件import xlrdexcel=xlrd.open_workbook('E:/test.xlsx') 返回值为xlrd.book.Book对象,不能修改获取sheett_xlutils模块可以读xlsx吗

关于新版本selenium定位元素报错:‘WebDriver‘ object has no attribute ‘find_element_by_id‘等问题_unresolved attribute reference 'find_element_by_id-程序员宅基地

文章浏览阅读8.2w次,点赞267次,收藏656次。运行Selenium出现'WebDriver' object has no attribute 'find_element_by_id'或AttributeError: 'WebDriver' object has no attribute 'find_element_by_xpath'等定位元素代码错误,是因为selenium更新到了新的版本,以前的一些语法经过改动。..............._unresolved attribute reference 'find_element_by_id' for class 'webdriver

DOM对象转换成jQuery对象转换与子页面获取父页面DOM对象-程序员宅基地

文章浏览阅读198次。一:模态窗口//父页面JSwindow.showModalDialog(ifrmehref, window, 'dialogWidth:550px;dialogHeight:150px;help:no;resizable:no;status:no');//子页面获取父页面DOM对象//window.showModalDialog的DOM对象var v=parentWin..._jquery获取父window下的dom对象

什么是算法?-程序员宅基地

文章浏览阅读1.7w次,点赞15次,收藏129次。算法(algorithm)是解决一系列问题的清晰指令,也就是,能对一定规范的输入,在有限的时间内获得所要求的输出。 简单来说,算法就是解决一个问题的具体方法和步骤。算法是程序的灵 魂。二、算法的特征1.可行性 算法中执行的任何计算步骤都可以分解为基本可执行的操作步,即每个计算步都可以在有限时间里完成(也称之为有效性) 算法的每一步都要有确切的意义,不能有二义性。例如“增加x的值”,并没有说增加多少,计算机就无法执行明确的运算。 _算法

【网络安全】网络安全的标准和规范_网络安全标准规范-程序员宅基地

文章浏览阅读1.5k次,点赞18次,收藏26次。网络安全的标准和规范是网络安全领域的重要组成部分。它们为网络安全提供了技术依据,规定了网络安全的技术要求和操作方式,帮助我们构建安全的网络环境。下面,我们将详细介绍一些主要的网络安全标准和规范,以及它们在实际操作中的应用。_网络安全标准规范