webservice常⽤注解的说明,最全没有之⼀
⼀.各种注解的详解
1.1 @WebService
1、serviceName: 对外发布的服务名,指定 Web Service 的服务名称:wsdl:service。缺省值为 Java 类的简单名称 + Service。(字符串)
2、endpointInterface: 服务接⼝全路径, 指定做SEI(Service EndPoint Interface)服务端点接⼝,包名+实现类的接⼝的完整路径
接⼝:
实现类:
3、name:此属性的值包含XML Web Service的名称。在默认情况下,该值是实现XML Web Service的类的名称,wsdl:portType 的名称。缺省值为 Java 类的简单名称 + Service。(字符串)
4、portName:  wsdl:portName。缺省值为 WebService.name+Port。
5、targetNamespace:指定你想要的名称空间,默认是使⽤接⼝实现类的包名的反缀
6、wsdlLocation:指定⽤于定义 Web Service 的 WSDL ⽂档的 Web 地址。Web 地址可以是相对路径或绝对路径。(字符串)
注意:实现类上可以不添加Webservice注解
1.2  @WebMethod
注释表⽰作为⼀项 Web Service 操作的⽅法,将此注释应⽤于客户机或服务器服务端点接⼝(SEI)上的⽅法,或者应⽤于 JavaBeans 端点的服务器端点实现类。
要点: 仅⽀持在使⽤ @WebService 注释来注释的类上使⽤ @WebMethod 注释
1、operationName:指定与此⽅法相匹配的wsdl:operation 的名称。缺省值为 Java ⽅法的名称。(字符串)
2、action:定义此操作的⾏为。对于 SOAP 绑定,此值将确定 SOAPAction 头的值。缺省值为 Java ⽅法的名称。(字符串)
3、exclude:指定是否从 Web Service 中排除某⼀⽅法。缺省值为 false。(布尔值)
1.3  @Oneway
注释将⼀个⽅法表⽰为只有输⼊消息⽽没有输出消息的 Web Service 单向操作。
将此注释应⽤于客户机或服务器服务端点接⼝(SEI)上的⽅法,或者应⽤于 JavaBeans 端点的服务器端点实现类
1.4  @WebParam
注释⽤于定制从单个参数⾄ Web Service 消息部件和 XML 元素的映射。
将此注释应⽤于客户机或服务器服务端点接⼝(SEI)上的⽅法,或者应⽤于 JavaBeans 端点的服务器端点实现类。
1、name :参数的名称。如果操作是远程过程调⽤(RPC)类型并且未指定partName 属性,那么这是⽤于表⽰参数的 wsdl:part 属性的名称。如果操作是⽂档类型或者参数映射⾄某个头,那么 -name 是⽤于表⽰该参数的 XML 元素的局部名称。如果操作是⽂档类型、参数类型为 BARE 并且⽅式为 OUT 或 INOUT,那么必须指定此属性。(字符串)
2、partName:定义⽤于表⽰此参数的 wsdl:part属性的名称。仅当操作类型为 RPC 或者操作是⽂档类型并且参数类型为BARE 时才使⽤此参数。(字符串)
3、targetNamespace:指定参数的 XML 元素的 XML 名称空间。当属性映射⾄ XML 元素时,仅应⽤于⽂档绑定。缺省值为 Web Service 的targetNamespace。(字符串)
4、mode:此值表⽰此⽅法的参数流的⽅向。有效值为 IN、INOUT 和 OUT。(字符串)
5、header:指定参数是在消息头还是消息体中。缺省值为 false。(布尔值)
1.5  @WebResult
注释⽤于定制从返回值⾄ WSDL 部件或 XML 元素的映射。将此注释应⽤于客户机或服务器服务端点接⼝(SEI)上的⽅法,或者应⽤于 JavaBeans 端点的服务器端点实现类。
1、name:当返回值列⽰在 WSDL ⽂件中并且在连接上的消息中到该返回值时,指定该返回值的名称。对于 RPC 绑定,这是⽤于表⽰返回值的 wsdl:part属性的名称。对于⽂档绑定,-name参数是⽤于表⽰返回值的 XML 元素的局部名。对于 RPC 和
DOCUMENT/WRAPPED 绑定,缺省值为 return。对于 DOCUMENT/BARE 绑定,缺省值为⽅法名 + Response。(字符串)
2、targetNamespace:指定返回值的 XML 名称空间。仅当操作类型为 RPC 或者操作是⽂档类型并且参数类型为 BARE 时才使⽤此参数。(字符串)
3、header:指定头中是否附带结果。缺省值为false。(布尔值)
4、partName:指定 RPC 或 DOCUMENT/BARE 操作的结果的部件名称。缺省值为@WebResult.name。(字符串)
1.6  @HandlerChain
注释⽤于使 Web Service 与外部定义的处理程序链相关联。只能通过对 SEI 或实现类使⽤ @HandlerChain 注释来配置服务器端的处理程序。
但是可以使⽤多种⽅法来配置客户端的处理程序。可以通过对⽣成的服务类或者 SEI 使⽤ @HandlerChain 注释来配置客户端的处理程序。此外,可以按程序在服务上注册您⾃⼰的 HandlerResolver 接⼝实现,或者按程序在绑定对象上设置处理程序链。
1、file:指定处理程序链⽂件所在的位置。⽂件位置可以是采⽤外部格式的绝对 java.URL,也可以是类⽂件中的相对路径。(字符串)
2、name:指定配置⽂件中处理程序链的名称。
⼆.@WebParam @WebResult注解的作⽤
@WebParam表⽰⽅法的参数,@WebResult表⽰⽅法的返回值,根据下⾯的案例,我们看⼀下,加或者不加这两个注解对发布的⽅法的影响
2.1 不加注解
package com.bonc.xj.webservice.impl;
import javax.jws.WebMethod;
import javax.jws.WebService;
l.ws.Endpoint;
/**
* @ClassName: SayBeijing
* @Description: TODO
* @Author: liujianfu
* @Date: 2021/03/22 11:27:44
* @Version: V1.0
**/
//@WebService(endpointInterface="com.bonc.xj.webservice.SaySomething")
@WebService
public class SayBeijing {
@WebMethod(operationName="sayHello")
public  String sayToBeijing(String name,int i){
i++;
return "hello"+name;
}
@WebMethod(operationName="bye")
public void sayToBeijingBye(boolean f){
System.out.println("bye");
}
}
发布类:
package com.bonc.xj;
import com.bonc.xj.webservice.impl.SayBeijing;
l.ws.Endpoint;
/**
* @ClassName: TestSay
* @Description: TODO
* @Author: liujianfu
* @Date: 2021/03/22 11:29:10
* @Version: V1.0
**/
public class TestSay
{
/**
* main⽅法中发布
* */
public static void main(String[] args) {
String address="localhost:9001/service/sayweb";
Endpoint.publish(address, new SayBeijing());
System.out.println("发布成功");
}
}
发现:  1.两个⽅法的参数都从arg0,开始,随着参数增多,name不断增加为;返回值名字为return            2.发布标签中的名称和operationName="sayHello"的名称对应,并不是和⽅法名(sayToBeijing)对应;
2.2 加注释
调用webservice服务
总结:⽅法参数以及⽅法返回值跟注解保持⼀致
再次访问发布⽂档:

版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。