webservice是什么（WebService的发布与调用）

时间：2024-07-10 14:30:03

WebService 简介

首先先说一下，什么是webService，webService也是一种CS结构的WEB服务，C呢就是Client(客户端)，S呢就是Server(服务端)，webService的服务端必须通过SOAP协议发布出来，然后通过客户端进行调用，webService必须通过XML格式数据报文进行数据传输，比如A服务器发布一个WebService服务，客户端通过A服务发布出来的WSDL描述进行接口调用，WebService是跨语言的，也就是服务端可以用JAVA语言发布，客户端既可以通过PHP调用也可以通过其他语言进行调用，这就是webService的一个大概的简介，下面介绍下webService的一些常用专业名词。

WebService 的关键名词

1.XML：(Extensible Markup Language)扩展型可标记语言。和Json类似，也是一种标准的数据格式，WebService底层必须通过XML格式进行数据传输，因为SOAP协议底层是基于XML格式的，SOAP是XML文档形式的调用方法的规范。

2.Soap：(Simple Object Access Protocol)简单对象存取协议。是XML Web Service 的通信协议。当用户通过UDDI找到你的WSDL描述文档后，他通过SOAP调用你建立的Web服务中的一个或多个操作。SOAP是XML文档形式的调用方法的规范，它可以支持不同的底层接口，像HTTP(S)或者SMTP。

3.WSDL：(Web Services Description Language) WSDL 文件是一个 XML 文档，用于说明WebService服务端发布出来的接口信息，比如有哪些接口方法，入参的详细信息等。

4.UDDI (Universal Description, Discovery, and Integration) 是一个主要针对Web服务供应商和使用者的新项目。在用户能够调用Web服务之前，必须确定这个服务内包含哪些接口方法，找到被调用的接口定义，UDDI是一种根据描述文档来引导系统查找相应服务的机制。UDDI利用SOAP消息机制（标准的XML/HTTP）来发布，编辑，浏览以及查找注册信息。它采用XML格式来封装各种不同类型的数据，并且发送到注册中心或者由注册中心来返回需要的数据。通俗地说就是用来引导客户端去发现服务端发布了哪些接口方法，然后按照WSDL说明通过SOAP协议进行调用的一个过程。

WebService的常用框架

1.JWS是Java语言对WebService服务的一种实现，用来开发和发布服务。而从服务本身的角度来看JWS服务是没有语言界限的。但是Java语言为Java开发者提供便捷发布和调用WebService服务的一种途径，现在没人使用了，已经成为历史

2.XFire是一个高性能的WebService框架，在Java6之前，它的知名度甚至超过了Apache的Axis2，XFire的优点是开发方便，与现有的Web整合很好，可以融为一体，并且开发也很方便。但是对Java之外的语言，没有提供相关的代码工具。XFire后来被Apache收购了，原因是它太优秀了，收购后，随着Java6 JWS的兴起，开源的WebService引擎已经不再被看好，渐渐地都败落了，现在没人使用了，已经成为历史

3.Axis2是Apache下的一个重量级WebService框架，准确说它是一个Web Services / SOAP / WSDL 的引擎，是WebService框架的集大成者，它能不但能制作和发布WebService，而且可以生成Java和其他语言版WebService客户端和服务端代码。这是它的优势所在。但是，这也不可避免地导致了Axis2的复杂性，使用过的开发者都知道，它所依赖的包数量和大小都是很惊人的，打包部署发布都比较麻烦，不能很好的与现有应用整合为一体

4.CXF是Apache旗下一个重磅的SOA简易框架，它实现了ESB（企业服务总线）。CXF来自于XFire项目，经过改造后形成的，就像目前的Struts2来自WebWork一样。可以看出XFire的命运会和WebWork的命运一样，最终会淡出人们的视线。CXF不但是一个优秀的Web Services / SOAP / WSDL 引擎，也是一个不错的ESB总线，为SOA的实施提供了一种选择方案，当然他不是最好的，它仅仅实现了SOA架构的一部分，提供方便的Spring整合方法，可以通过注解、Spring标签式配置来暴露Web Services和消费Web Services

基于SpringBoot集成WebService

上面介绍了WebService是什么以及WebService常用专业词汇还有框架，下面用Java语言为例给大家介绍怎么在springBoot框架中集成WebService的CXF，废话不多说，开始操作吧。

1.maven配置文件添加以下配置信息，如果是Gradle，可以按照Gradle进行配置

  <!-- cxf start -->
        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-frontend-jaxws</artifactId>
            <version>3.2.6</version>
        </dependency>
        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-transports-http</artifactId>
            <version>3.2.6</version>
        </dependency>
        <!-- cxf end -->

2.CXF注入配置，在springBoot的启动的时候加载该配置,要重点关注下面dispatchServlet方法配置的路径/ele/webService/*和endpoint的/wb,这两个配置是用来连起来访问WSDL说明的，比如这个WebService服务端发布出来的说明就可以这样访问：http://服务ip地址:springBoot启动端口
/ContentPath/ele/webService/wb?wsdl,ContentPath是spring服务的接口前缀，这个不了解可以自行百度，如果没有可以不用配置ContentPath

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.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;

/**
 *
 * @version v1.0
 * @Description: TODO
 * @author:  guoker
 * @date: 2021/7/5 12:08
 */

@Configuration
public class CxfConfig {

    @Autowired
    private WebServiceTest webServiceTest;

    /**
     * 此方法作用是改变项目中服务名的前缀名，此处127.0.0.1或者localhost不能访问时，请使用ipconfig查看本机ip来访问
     * 此方法被注释后:wsdl访问地址为http://127.0.0.1:8080/services/user?wsdl
     * 去掉注释后：wsdl访问地址为：http://127.0.0.1:8080/soap/user?wsdl
     *
     * @return
     */
    @Bean
    public ServletRegistrationBean dispatchServlet() {
        ServletRegistrationBean servletRegistrationBean = new ServletRegistrationBean(new CXFServlet(), "/ele/webService/*");
        return servletRegistrationBean;
    }

    @Bean(name = Bus.DEFAULT_BUS_ID)
    public SpringBus springBus()
    {
        return new SpringBus();
    }

    /** JAX-WS
     * 站点服务
     * **/
    @Bean
    public Endpoint endpoint() {
        EndpointImpl endpoint = new EndpointImpl(springBus(), webServiceTest);
        endpoint.publish("/wb");
        return endpoint;
    }

3.编写发布的接口服务

import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;


@WebService(name = "WebServiceTest", targetNamespace = "http://service.webservice.kexin.com")
public interface WebServiceTest {

    @WebMethod
    @WebResult(name = "String", targetNamespace = "")
    String getUserByName(@WebParam(name = "username") String username, @WebParam(name = "userpwd") String userpwd, @WebParam(name = "usertype") String usertype) throws Exception;
}

4.编写发布接口的实现类

import org.springframework.stereotype.Component;

import javax.jws.WebService;

/**
 *
 * @version v1.0
 * @Description: TODO
 * @author:  guoker
 * @date: 2021/7/5 11:31
 */
@WebService(endpointInterface = "com.dxhy.bxsdk.business.service.WebServiceTest",
        targetNamespace = "http://service.webservice.kexin.com", serviceName = "WebServiceTest")
@Component
public class WebServiceTestImp implements WebServiceTest {

    @Override
    public String getUserByName(String username, String userpwd, String usertype) throws Exception {
        return "hello WebService";
    }
}

WebService客户端调用示例

    /**
     * 2：动态调用
     */
    public static void main() {
        // 创建动态客户端
        JaxWsDynamicClientFactory dcf = JaxWsDynamicClientFactory.newInstance();
        Client client = dcf.createClient("http://127.0.0.1:8184/bx/ele/webService/wb?wsdl");
        // 需要密码的情况需要加上用户名和密码
        // client.getOutInterceptors().add(new ClientLoginInterceptor(USER_NAME, PASS_WORD));
        Object[] objects = new Object[0];
        try {
            // invoke("方法名",参数1,参数2,参数3....);
            objects = client.invoke("getUserByName", "guoker", "123456", "测试类型");
            System.out.println("返回数据:" + objects[0]);
        } catch (java.lang.Exception e) {
            e.printStackTrace();
        }
    }