springboot整合WebService实现跨服务访问

骑猪看日落 2023-05-30 14:55 22阅读 0赞

# 背景介绍 #

近期在公司里面重构一个之前的老版本项目，这个项目里面有多处调用其它项目里面的接口。采用的技术是webservice,实现跨服务访问。由于这个技术出现时间较早，所以没有了解过，所以记录一下，目前只是简单连接功能，之后会引入json字符串、签名和数字证书。

# 一、创建一个webService #

> 1.jar包引入

<dependency>
    	<groupId>org.apache.cxf</groupId>
    	<artifactId>cxf-spring-boot-starter-jaxws</artifactId>
    	<version>3.2.6</version>
    </dependency>

> 2.controller层

import com.example.webserver.service.WebServerService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @RequestMapping("/hi")
    public class HelloController { 
    
    	@Autowired
    	private WebServerService webServerService;
    
    	@GetMapping("/say")
    	public String sayHello(){ 
    		return webServerService.sayHello("test");
    	}
    }

> 3.service层

import javax.jws.WebMethod;
    import javax.jws.WebParam;
    import javax.jws.WebService;
    
    @WebService(name = "TestService", //暴露服务名称
    	targetNamespace = "http://service.webserver.example.com" //命名空间，一般是包名称的倒写
    )
    public interface WebServerService { 
    	@WebMethod(operationName = "sayHello")
    	String sayHello(@WebParam(name = "name") String name);
    }
    
    
    
    import com.example.webserver.service.WebServerService;
    import org.springframework.stereotype.Service;
    
    import javax.jws.WebMethod;
    import javax.jws.WebParam;
    import javax.jws.WebService;
    
    @Service
    @WebService(serviceName = "TestService",
    	targetNamespace = "http://service.webserver.example.com",//上面都与前面一直
    		endpointInterface = "com.example.webserver.service.WebServerService" //接口的地址
    )
    public class WebServerServiceImpl implements WebServerService { 
    
    	@Override
    	@WebMethod(operationName = "sayHello")
    	public String sayHello(@WebParam(name = "name")String name) { 
    		return name+": hello world";
    	}
    }

> 4.注册webservice服务

import com.example.webserver.service.WebServerService;
    import org.apache.cxf.Bus;
    import org.apache.cxf.jaxws.EndpointImpl;
    import org.apache.cxf.transport.servlet.CXFServlet;
    import org.springframework.beans.factory.annotation.Autowired;
    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 WebServiceConfigure { 
    
    	@Autowired
    	private Bus bus;
    
    	@Autowired
    	private WebServerService webServerService;
    
    	//对应的访问路径：http://localhost:8080/services/WebService?wsdl
    	@Bean
    	public Endpoint endpoint(){ 
    		EndpointImpl endpoint = new EndpointImpl(bus,webServerService);
    		endpoint.publish("/WebService");
    		return endpoint;
    	}
    
    	//这个是用来修改访问路径的 http://localhost:8080/test/WebService?wsdl
    	@Bean
    	public ServletRegistrationBean registrationBean(){ 
    		return new ServletRegistrationBean(new CXFServlet(),"/test/*");
    	}
    }

> 5.访问http://localhost:8080/test/WebService?wsdl

<wsdl:definitions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:tns="http://service.webserver.example.com" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:ns1="http://schemas.xmlsoap.org/soap/http" name="TestService" targetNamespace="http://service.webserver.example.com">
    <wsdl:types>
    <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://service.webserver.example.com" elementFormDefault="unqualified" targetNamespace="http://service.webserver.example.com" version="1.0">
    <xs:element name="sayHello" type="tns:sayHello"/>
    <xs:element name="sayHelloResponse" type="tns:sayHelloResponse"/>
    <xs:complexType name="sayHello">
    <xs:sequence>
    <xs:element minOccurs="0" name="name" type="xs:string"/>
    </xs:sequence>
    </xs:complexType>
    <xs:complexType name="sayHelloResponse">
    <xs:sequence>
    <xs:element minOccurs="0" name="return" type="xs:string"/>
    </xs:sequence>
    </xs:complexType>
    </xs:schema>
    </wsdl:types>
    <wsdl:message name="sayHelloResponse">
    <wsdl:part element="tns:sayHelloResponse" name="parameters"> </wsdl:part>
    </wsdl:message>
    <wsdl:message name="sayHello">
    <wsdl:part element="tns:sayHello" name="parameters"> </wsdl:part>
    </wsdl:message>
    <wsdl:portType name="TestService">
    <wsdl:operation name="sayHello">
    <wsdl:input message="tns:sayHello" name="sayHello"> </wsdl:input>
    <wsdl:output message="tns:sayHelloResponse" name="sayHelloResponse"> </wsdl:output>
    </wsdl:operation>
    </wsdl:portType>
    <wsdl:binding name="TestServiceSoapBinding" type="tns:TestService">
    <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
    <wsdl:operation name="sayHello">
    <soap:operation soapAction="" style="document"/>
    <wsdl:input name="sayHello">
    <soap:body use="literal"/>
    </wsdl:input>
    <wsdl:output name="sayHelloResponse">
    <soap:body use="literal"/>
    </wsdl:output>
    </wsdl:operation>
    </wsdl:binding>
    <wsdl:service name="TestService">
    <wsdl:port binding="tns:TestServiceSoapBinding" name="WebServerServiceImplPort">
    <soap:address location="http://localhost:8080/test/WebService"/>
    </wsdl:port>
    </wsdl:service>
    </wsdl:definitions>

# 二、创建client访问服务 #

访问的方法很多，目前我采用的是动态获取，比较简单方便，测试代码如下(这里是另外一个项目)：

import org.apache.cxf.endpoint.Client;
    import org.apache.cxf.jaxws.endpoint.dynamic.JaxWsDynamicClientFactory;
    import org.apache.cxf.transport.http.HTTPConduit;
    import org.apache.cxf.transports.http.configuration.HTTPClientPolicy;
    import org.junit.jupiter.api.Test;
    
    import java.net.MalformedURLException;
    
    //@SpringBootTest
    class WebserverApplicationTests {
    
    	@Test
    	void contextLoads() throws MalformedURLException {
    		JaxWsDynamicClientFactory factory = JaxWsDynamicClientFactory.newInstance();
    		Client client = factory.createClient("http://localhost:8080/test/WebService?wsdl");
    		HTTPConduit conduit = (HTTPConduit) client.getConduit();
    		HTTPClientPolicy httpClientPolicy = new HTTPClientPolicy();
    		httpClientPolicy.setConnectionTimeout(2000);  //连接超时
    		httpClientPolicy.setAllowChunking(false);    //取消块编码
    		httpClientPolicy.setReceiveTimeout(120000);     //响应超时
    		conduit.setClient(httpClientPolicy);
    
    		try{
    			Object[] objects = new Object[0];
    			// invoke("方法名",参数1,参数2,参数3....);
    			objects = client.invoke("sayHello", "lsr");
    			System.out.println("返回数据:" + objects[0]);
    		}catch (Exception e){
    			e.printStackTrace();
    		}
    
    	}
    
    }
    
    //输出结果
    返回数据:lsr: hello world