webservice的基础知识

版权声明: https://blog.csdn.net/qq_34475529/article/details/83755216

                                                                          WebService 学习笔记

一.如何发布一个web服务:

  1、在类上添加@WebService注解。

这是jdk1.6提供的一个注解。它位于:javax.jws.*包中。

2、通过EndPoint(端点服务)发布一个webService。

Endpoint也是jdk提供的一个专门用于发布服务的类,它的publish方法接收两个参数,一个是本地的服务地址,二是提供服务的类。它位于javax.xml.ws.*包中。

static Endpoint.publish(String address, Object implementor)
          在给定地址处针对指定的实现者对象创建并发布端点。

stop方法用于停止服务。

EndPoint发布完成服务以后,将会独立的线程运行。所以,publish之后的代码,可以正常执行。

其他注意事项:

给类添加上@WebService注解后,类中所有的非静态方法都将会对外公布。

不支持静态方法,final方法。-

如果希望某个方法(非static,非final)不对外公开,可以在方法上添加@WebMethod(exclude=true),阻止对外公开。

如果一个类上,被添加了@WebService注解,则必须此类至少有一个可以公开的方法,否则将会启动失败。

    //1、添加注解

@WebService

public class OneService {

    //2、至少包含一个可以对外公开的服务

    public String sayHello(String name){

System.err.println("invoke "+name);

return "Hello "+name;

    }

    public static void main(String[] args) {

//3、第一个参数称为Binding即绑定地址,

//第二个参数是实现者,即谁提供服务

Endpoint.publish("http://localhost:9999/one", new OneService());

    }

}

 

二 .服务发布成功了,如何调用呢?请看说明书-WSDL:

在地址栏输入(注意后面的参数?wsdl)

http://127.0.0.1:9999/helloworld?wsdl

目前不是访问webService,只是获取一个用于描述WebService的说明文件,即:wsdl文件.

wsdl- WebService Description Language,是以XML文件形式来描述WebService的”说明书”,有了说明书,我们才可以知道如何使用或是调用这个服务.

   

  • 使用wsimport生成本地调用代码:

    说明书看不懂怎么办?别急JDK能看懂:

wsimport是jdk自带的,可以根据wsdl文档生成客户端调用代码的工具.当然,无论服务器端的WebService是用什么语言写的,都将在客户端生成Java代码.服务器端用什么写的并不重要.

wsimport.exe位于JAVA_HOME\bin目录下.

常用参数为:

-d<目录>  - 将生成.class文件。默认参数。

-s<目录> - 将生成.java文件。

-p<生成的新包名> -将生成的类,放于指定的包下。

(wsdlurl) - http://server:port/service?wsdl,必须的参数。

示例:

C:/> wsimport –s . http://192.168.0.100/one?wsdl

注意:-s不能分开,-s后面有个小点,用于指定源代码生成的目录。点即当前目录。

如果使用了-s参数则会在目录下生成两份代码,一份为.class代码。一份为.java代码。

.class代码,可以经过打包以后使用。.java代码可以直接Copy到我们的项目中运行。

 

三 客户端调用WebService的方式

通过wsimport生成客户端代码

通过客户端编程的方式调用

通过ajax调用 (js+XML)  

通过URLConnection调用

1.使用原生的ajax调用web服务:

由于使用ajax – js调用web服务完成不同于使用java代码调用。所以,必须要对SOAP文件非常的了解。

一般使用ajax调用,应该是在已经获知了以下信息以后才去调用:

获知请求(request)的soap文本。

获知响应(response)的soap文本。

我们可以通过WSExplorer获取上面的文本

2 Ajax 调用获取所有用户:

 

2 客户端通过编程的方式访问服务:

    使用javax.xml.ws.Service类用于访问web服务。

关键类Service

方法create – 用户创建Service对象,提供wsdlurl和服务名。

getPort-用于通过指定namespace,portName和接口的范型。

在客户端需要一个与服务器接口完全相同的类。(仍然使用工具生成。但只需要一个接口。并需要简单修改。如果返回的是复杂数据类型如POJO,还需要将POJO一并放到项目中)   -   不要试图通过-p来修改包名,会出错的。

关键类QName – 被称为完全限定名即:Qualified Name的缩写。

QName 的值包含名称空间 URI、本地部分和前缀

 

五.使用WebServiceExplorer只可以看到SOAP的XML数据,并看不到HTTP协议的头。

既然是用HTTP发XML数据,就一定会有HTTP头,为了获取HTTP头,我们使用TCP/IP Monitor.

使用TCP/IP   Monitor-拦截HTTP请求头和响应头及Body部分:

    此工具位于:window>show view>other>MyEclipse Common(常用工具)>TCP/IP Monitor

    前面的WSExplorer只参获取消息体部分。为了获取HTTP请求的具体信息,我们可以

使用monitor;

因为SOAP是在HTTP的基础上发XML数据,前面的XML数据已经可以获取到了,那么,既然是在HTTP上收发消息,就一定会有HTTP的头信息,那HTTP头信息又

是怎么样的呢?

六 SOAP请求过程分析:

   第一步:使用get方式获取wsdl文件,称为握手。对于JDK1.6生成的ws服务,由于内部有一两个配置文件,所以会发出两次get请求。其他的一般为一次。

第二步:用户发出请求将使用post方式。

第三步:服务器响应成功。

 

  发出去的XML文本:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:q0="http://server.itcast.cn/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

  <soapenv:Body>    //SOAP协议必须拥有body元素

    <q0:sayHello>    //SOAP协议必须通过第一个节点指明需要调用的方法

      <arg0>aaa</arg0>

    </q0:sayHello>

  </soapenv:Body>

</soapenv:Envelope>

 

拦截到的返回信息:

  <?xml version="1.0" ?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">

    <S:Body>

       <ns2:sayHiResponse xmlns:ns2="http://ws.itcast.cn/">

           <return>HelloWorld</return>

      </ns2:sayHiResponse>

   </S:Body>

</S:Envelope>

深入分析说明书WSDL:

wsdl – WebService Description Language(WS描述语言)

它主要定义了三个方面的问题:

What?即服务是什么?

(portType,types,message)

How?如何调用服务?

通过binding元素说明调用服务的方式:soap,soap12,post,get.

Where?在哪儿调用服务?

Service元素,soap:address.

 七:修改wsdl文件的内容

     WSDL文件的内容,一般由服务默认生成,但为了更好的向开发人员提供使用说明书,一般应做一些简单的修改。至少不应该暴露我们的包结构。而targetNamespace默认情况下为倒置的包名,这已经暴露了我们的包结构。

通过在类文件上添加以下注解,可以修改wsdl生成的各元素,而不是直接去修改wsdl文件,直接去修改wsdl文件是无效的。

WebService的注解包括:

@WebService-定义服务   --类上

@WebMethod-定义方法   - 方法

@WebResult-定义返回值 – 返回值

@WebParam-定义参数 – 参数

八:注解的作用

   通过WebService的注解,可以更加形像的描述Web服务。从而生成WSDL文档。

当修改了WebService注解之后,同时会影响客户端生成的代码。调用的方法名和参数名也发生了变化。即使是没有修改源代码,只修改了注解,客户端的代码也必须要重新生成(注意是生成而不是下载)。否则调用将会失败。生成本地调用代码,依然使用wsimport工具

  @WebService注解:

  @WebService注解,作用在具体类上。而不是接口。

一个类只有添加了此注解才可以通过Endpoint发布为一个web服务。

一个添加了此注解的类,必须要至少包含一个实例方法。

静态方法和final方法不能被发布为服务方法

 

WebService注解包含以下参数

 @WebMethod

   此注解用在方法上,用于修改对外暴露的方法。

   

 

@WebResult用于定制返回值到WSDL的映射:

@WebParam用于定义WSDL中的参数映射:

 

从wsdl中分析出类的关系:

  

 

猜你喜欢

转载自blog.csdn.net/qq_34475529/article/details/83755216