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

智能推荐

hive使用适用场景_大数据入门:Hive应用场景-程序员宅基地

文章浏览阅读5.8k次。在大数据的发展当中,大数据技术生态的组件,也在不断地拓展开来,而其中的Hive组件,作为Hadoop的数据仓库工具,可以实现对Hadoop集群当中的大规模数据进行相应的数据处理。今天我们的大数据入门分享,就主要来讲讲,Hive应用场景。关于Hive,首先需要明确的一点就是,Hive并非数据库,Hive所提供的数据存储、查询和分析功能,本质上来说,并非传统数据库所提供的存储、查询、分析功能。Hive..._hive应用场景

zblog采集-织梦全自动采集插件-织梦免费采集插件_zblog 网页采集插件-程序员宅基地

文章浏览阅读496次。Zblog是由Zblog开发团队开发的一款小巧而强大的基于Asp和PHP平台的开源程序,但是插件市场上的Zblog采集插件,没有一款能打的,要么就是没有SEO文章内容处理,要么就是功能单一。很少有适合SEO站长的Zblog采集。人们都知道Zblog采集接口都是对Zblog采集不熟悉的人做的,很多人采取模拟登陆的方法进行发布文章,也有很多人直接操作数据库发布文章,然而这些都或多或少的产生各种问题,发布速度慢、文章内容未经严格过滤,导致安全性问题、不能发Tag、不能自动创建分类等。但是使用Zblog采._zblog 网页采集插件

Flink学习四:提交Flink运行job_flink定时运行job-程序员宅基地

文章浏览阅读2.4k次,点赞2次,收藏2次。restUI页面提交1.1 添加上传jar包1.2 提交任务job1.3 查看提交的任务2. 命令行提交./flink-1.9.3/bin/flink run -c com.qu.wc.StreamWordCount -p 2 FlinkTutorial-1.0-SNAPSHOT.jar3. 命令行查看正在运行的job./flink-1.9.3/bin/flink list4. 命令行查看所有job./flink-1.9.3/bin/flink list --all._flink定时运行job

STM32-LED闪烁项目总结_嵌入式stm32闪烁led实验总结-程序员宅基地

文章浏览阅读1k次,点赞2次,收藏6次。这个项目是基于STM32的LED闪烁项目,主要目的是让学习者熟悉STM32的基本操作和编程方法。在这个项目中,我们将使用STM32作为控制器,通过对GPIO口的控制实现LED灯的闪烁。这个STM32 LED闪烁的项目是一个非常简单的入门项目,但它可以帮助学习者熟悉STM32的编程方法和GPIO口的使用。在这个项目中,我们通过对GPIO口的控制实现了LED灯的闪烁。LED闪烁是STM32入门课程的基础操作之一,它旨在教学生如何使用STM32开发板控制LED灯的闪烁。_嵌入式stm32闪烁led实验总结

Debezium安装部署和将服务托管到systemctl-程序员宅基地

文章浏览阅读63次。本文介绍了安装和部署Debezium的详细步骤,并演示了如何将Debezium服务托管到systemctl以进行方便的管理。本文将详细介绍如何安装和部署Debezium,并将其服务托管到systemctl。解压缩后,将得到一个名为"debezium"的目录,其中包含Debezium的二进制文件和其他必要的资源。注意替换"ExecStart"中的"/path/to/debezium"为实际的Debezium目录路径。接下来,需要下载Debezium的压缩包,并将其解压到所需的目录。

Android 控制屏幕唤醒常亮或熄灭_android实现拿起手机亮屏-程序员宅基地

文章浏览阅读4.4k次。需求:在诗词曲文项目中,诗词整篇朗读的时候,文章没有读完会因为屏幕熄灭停止朗读。要求:在文章没有朗读完毕之前屏幕常亮,读完以后屏幕常亮关闭;1.权限配置:设置电源管理的权限。

随便推点

目标检测简介-程序员宅基地

文章浏览阅读2.3k次。目标检测简介、评估标准、经典算法_目标检测

记SQL server安装后无法连接127.0.0.1解决方法_sqlserver 127 0 01 无法连接-程序员宅基地

文章浏览阅读6.3k次,点赞4次,收藏9次。实训时需要安装SQL server2008 R所以我上网上找了一个.exe 的安装包链接:https://pan.baidu.com/s/1_FkhB8XJy3Js_rFADhdtmA提取码:ztki注:解压后1.04G安装时Microsoft需下载.NET,更新安装后会自动安装如下:点击第一个傻瓜式安装,唯一注意的是在修改路径的时候如下不可修改:到安装实例的时候就可以修改啦数据..._sqlserver 127 0 01 无法连接

js 获取对象的所有key值,用来遍历_js 遍历对象的key-程序员宅基地

文章浏览阅读7.4k次。1. Object.keys(item); 获取到了key之后就可以遍历的时候直接使用这个进行遍历所有的key跟valuevar infoItem={ name:'xiaowu', age:'18',}//的出来的keys就是[name,age]var keys=Object.keys(infoItem);2. 通常用于以下实力中 <div *ngFor="let item of keys"> <div>{{item}}.._js 遍历对象的key

粒子群算法(PSO)求解路径规划_粒子群算法路径规划-程序员宅基地

文章浏览阅读2.2w次,点赞51次,收藏310次。粒子群算法求解路径规划路径规划问题描述    给定环境信息,如果该环境内有障碍物,寻求起始点到目标点的最短路径, 并且路径不能与障碍物相交,如图 1.1.1 所示。1.2 粒子群算法求解1.2.1 求解思路    粒子群优化算法(PSO),粒子群中的每一个粒子都代表一个问题的可能解, 通过粒子个体的简单行为,群体内的信息交互实现问题求解的智能性。    在路径规划中,我们将每一条路径规划为一个粒子,每个粒子群群有 n 个粒 子,即有 n 条路径,同时,每个粒子又有 m 个染色体,即中间过渡点的_粒子群算法路径规划

量化评价:稳健的业绩评价指标_rar 海龟-程序员宅基地

文章浏览阅读353次。所谓稳健的评估指标,是指在评估的过程中数据的轻微变化并不会显著的影响一个统计指标。而不稳健的评估指标则相反,在对交易系统进行回测时,参数值的轻微变化会带来不稳健指标的大幅变化。对于不稳健的评估指标,任何对数据有影响的因素都会对测试结果产生过大的影响,这很容易导致数据过拟合。_rar 海龟

IAP在ARM Cortex-M3微控制器实现原理_value line devices connectivity line devices-程序员宅基地

文章浏览阅读607次,点赞2次,收藏7次。–基于STM32F103ZET6的UART通讯实现一、什么是IAP,为什么要IAPIAP即为In Application Programming(在应用中编程),一般情况下,以STM32F10x系列芯片为主控制器的设备在出厂时就已经使用J-Link仿真器将应用代码烧录了,如果在设备使用过程中需要进行应用代码的更换、升级等操作的话,则可能需要将设备返回原厂并拆解出来再使用J-Link重新烧录代码,这就增加了很多不必要的麻烦。站在用户的角度来说,就是能让用户自己来更换设备里边的代码程序而厂家这边只需要提供给_value line devices connectivity line devices