概述
最近项目用到在Spring boot下搭建WebService服务,对Java语言下的WebService了解甚少,而今抽个时间查阅资料整理下Spring Boot结合CXF打架WebService一般步骤与方法;本文章结合各个博客资料整理而成,如有雷同,谨记转载;
Spring Boot WebService开发
需要依赖Maven的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 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.dbgo</groupId> <artifactId>webservicedemo</artifactId> <version>0.0.1-SNAPSHOT</version> <packaging>jar</packaging> <name>webservicedemo</name> <description>Demo project for Spring Boot</description> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.5.8.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!--WerbService CXF依赖--> <dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-frontend-jaxws</artifactId> <version>3.1.12</version> </dependency> <dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-transports-http</artifactId> <version>3.1.12</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.12</version> </dependency> <dependency> <groupId>commons-io</groupId> <artifactId>commons-io</artifactId> <version>2.5</version> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>
构建并发布服务
构建Model对象
package com.dbgo.webservicedemo.Model; import java.io.Serializable; import java.util.Date; public class User implements Serializable { private static final long serialVersionUID = -5939599230753662529L; private String userId; private String username; private String age; private Date updateTime; public String getUserId() { return userId; } public void setUserId(String userId) { this.userId = userId; } public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public String getAge() { return age; } public void setAge(String age) { this.age = age; } public Date getUpdateTime() { return updateTime; } public void setUpdateTime(Date updateTime) { this.updateTime = updateTime; } }
构建服务接口
package com.dbgo.webservicedemo.service; import com.dbgo.webservicedemo.Model.User; import javax.jws.WebMethod; import javax.jws.WebParam; import javax.jws.WebService; import java.util.ArrayList; @WebService public interface UserService { @WebMethod String getName(@WebParam(name = "userId") String userId); @WebMethod User getUser(String userI); @WebMethod ArrayList<User> getAlLUser(); }
构建接口实现类
package com.dbgo.webservicedemo.service; import com.dbgo.webservicedemo.Model.User; import javax.jws.WebService; import java.util.ArrayList; import java.util.Date; import java.util.HashMap; import java.util.Map; @WebService(targetNamespace="http://service.webservicedemo.dbgo.com/",endpointInterface = "com.dbgo.webservicedemo.service.UserService") public class UserServiceImpl implements UserService { private Map<String, User> userMap = new HashMap<String, User>(); public UserServiceImpl() { System.out.println("向实体类插入数据"); User user = new User(); user.setUserId("411001"); user.setUsername("zhansan"); user.setAge("20"); user.setUpdateTime(new Date()); userMap.put(user.getUserId(), user); user = new User(); user.setUserId("411002"); user.setUsername("lisi"); user.setAge("30"); user.setUpdateTime(new Date()); userMap.put(user.getUserId(), user); user = new User(); user.setUserId("411003"); user.setUsername("wangwu"); user.setAge("40"); user.setUpdateTime(new Date()); userMap.put(user.getUserId(), user); } @Override public String getName(String userId) { return "liyd-" + userId; } @Override public User getUser(String userId) { User user= userMap.get(userId); return user; } @Override public ArrayList<User> getAlLUser() { ArrayList<User> users=new ArrayList<>(); userMap.forEach((key,value)->{users.add(value);}); return users; } }
备注说明:类名称先的注解targetNamespace是当前类文件所在包名称的反序,endpointInterface是当前需要实现接口的全称;@WebService(targetNamespace="http://service.webservicedemo.dbgo.com/",endpointInterface = "com.dbgo.webservicedemo.service.UserService")
服务发布类编写
package com.dbgo.webservicedemo; import com.dbgo.webservicedemo.service.UserService; import com.dbgo.webservicedemo.service.UserServiceImpl; 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 WebServiceConfig { @Bean public ServletRegistrationBean dispatcherServlet(){ return new ServletRegistrationBean(new CXFServlet(),"/service/*");//发布服务名称 } @Bean(name = Bus.DEFAULT_BUS_ID) public SpringBus springBus() { return new SpringBus(); } @Bean public UserService userService() { return new UserServiceImpl(); } @Bean public Endpoint endpoint() { EndpointImpl endpoint=new EndpointImpl(springBus(), userService());//绑定要发布的服务 endpoint.publish("/user"); //显示要发布的名称 return endpoint; } }
运行程序,输入 http://localhost:8080/service/user?wsdl 即可查询发布出去的接口文件
客户端调用服务
客户端调用WebService可以简单概述2中模式:动态调用和协议调用;
package com.dbgo.webservicedemo; import com.dbgo.webservicedemo.Model.User; import com.dbgo.webservicedemo.service.UserService; import org.apache.cxf.endpoint.Client; import org.apache.cxf.frontend.ClientProxy; import org.apache.cxf.jaxws.JaxWsProxyFactoryBean; import org.apache.cxf.jaxws.endpoint.dynamic.JaxWsDynamicClientFactory; import org.apache.cxf.transport.http.HTTPConduit; import org.apache.cxf.transports.http.configuration.HTTPClientPolicy; import java.util.ArrayList; public class webserviceclient { //动态调用 public static void main(String[] args) throws Exception { JaxWsDynamicClientFactory dcflient=JaxWsDynamicClientFactory.newInstance(); Client client=dcflient.createClient("http://localhost:8080/service/user?wsdl"); Object[] objects=client.invoke("getUser","411001"); System.out.println("*******"+objects[0].toString()); Object[] objectall=client.invoke("getAlLUser"); System.out.println("*******"+objectall[0].toString()); main3(args); } //调用方式二,通过接口协议获取数据类型 public static void main2(String[] args) throws Exception { JaxWsProxyFactoryBean jaxWsProxyFactoryBean=new JaxWsProxyFactoryBean(); jaxWsProxyFactoryBean.setAddress("http://localhost:8080/service/user?wsdl"); jaxWsProxyFactoryBean.setServiceClass(UserService.class); UserService userService=(UserService)jaxWsProxyFactoryBean.create(); User userResult= userService.getUser("411001"); System.out.println("UserName:"+userResult.getUsername()); ArrayList<User> users=userService.getAlLUser(); } //调用方式三,通过接口协议获取数据类型,设置链接超时和响应时间 public static void main3(String[] args) throws Exception { JaxWsProxyFactoryBean jaxWsProxyFactoryBean=new JaxWsProxyFactoryBean(); jaxWsProxyFactoryBean.setAddress("http://localhost:8080/service/user?wsdl"); jaxWsProxyFactoryBean.setServiceClass(UserService.class); UserService userService = (UserService) jaxWsProxyFactoryBean.create(); // 创建客户端对象 Client proxy= ClientProxy.getClient(userService); HTTPConduit conduit=(HTTPConduit)proxy.getConduit(); HTTPClientPolicy policy=new HTTPClientPolicy(); policy.setConnectionTimeout(1000); policy.setReceiveTimeout(1000); conduit.setClient(policy); User userResult= userService.getUser("411001"); System.out.println("UserName:"+userResult.getUsername()); ArrayList<User> users=userService.getAlLUser(); } }
参考博客
Spring boot+CXF开发WebService Demo https://www.cnblogs.com/fuxin41/p/6289162.html