WebService 注解的使用及解释

来源:互联网 发布:台湾人看待统一知乎 编辑:程序博客网 时间:2024/05/23 17:09

javax.jws.WebService:

当实现 Web Service时,@WebService 注释标记 Java 类;实现 WebService 接口时,标记服务端点接口(SEI)

• 实现 Web Service 的 Java 类必须指定@WebService 或 @WebServiceProvider 注释。不能同时提供这两种注释。

此注释适用于客户机/服务器 SEI 或 JavaBeans端点的服务器端点实现类。

如果注释通过 

endpointInterface 属性引用了某个SEI,那么还必须使用 @WebService 注释来注释该 SEI。

  • 注释目标:类型
  • 属性:
- name
wsdl:portType 的名称。缺省值为Java 类或接口的非限定名称。(字符串)
- targetNamespace
指定从 Web Service 生成的 WSDL 和 XML 元素的XML 名称空间。缺省值为从包含该 Web Service 的包名映射的名称空间。(字符串)
- serviceName
指定 Web Service 的服务名称:wsdl:service。缺省值为Java 类的简单名称 + Service。(字符串)
- endpointInterface
指定用于定义服务的抽象 Web Service约定的服务端点接口的限定名。如果指定了此限定名,那么会使用该服务端点接口来确定抽象 WSDL 约定。(字符串)
- portName
wsdl:portName。缺省值为WebService.name+Port。(字符串)
- wsdlLocation
指定用于定义 Web Service 的 WSDL 文档的 Web地址。Web 地址可以是相对路径或绝对路径。(字符串)




javax.jws.WebMethod:

@WebMethod 注释表示作为一项 Web Service操作的方法。

将此注释应用于客户机或服务器服务端点接口(SEI)上的方法,或者应用于 JavaBeans 端点的服务器端点实现类。

• 仅支持在使用 @WebService注释来注释的类上使用 @WebMethod 注释。


  • 注释目标:方法
  • 属性:
- operationName
指定与此方法相匹配的wsdl:operation 的名称。缺省值为Java 方法的名称。(字符串
- action
定义此操作的行为。对于 SOAP 绑定,此值将确定 SOAPAction头的值。缺省值为 Java 方法的名称。(字符串)
- exclude
指定是否从 Web Service中排除某一方法。缺省值为 false





javax.jws.Oneway:

@Oneway 注释将一个方法表示为只有输入消息而没有输出消息的Web Service 单向操作。

将此注释应用于客户机或服务器服务端点接口(SEI)上的方法,或者应用于 JavaBeans 端点的服务器端点实现类。







javax.jws.WebParam:

@WebParam 注释用于定制从单个参数至 WebService 消息部件和 XML 元素的映射。

将此注释应用于客户机或服务器服务端点接口(SEI)上的方法,或者应用于 JavaBeans 端点的服务器端点实现类。

  • 注释目标:参数
  • 属性:
- name
参数的名称。如果操作是远程过程调用(RPC)类型并且未指定partName 属性,那么这是用于表示参数的 wsdl:part 属性的名称。如果操作是文档类型或者参数映射至某个头,那么 -name 是用于表示该参数的XML 元素的局部名称。如果操作是文档类型、参数类型为 BARE 并且方式为 OUT 或 INOUT,那么必须指定此属性。(字符串)
- partName
定义用于表示此参数的 wsdl:part属性的名称。仅当操作类型为RPC 或者操作是文档类型并且参数类型为BARE 时才使用此参数。(字符串
- targetNamespace
指定参数的 XML 元素的 XML 名称空间。当属性映射至 XML元素时,仅应用于文档绑定。缺省值为 Web Service 的 targetNamespace。(字符串)
- header
指定参数是在消息头还是消息体中。缺省值为 false。(布尔值)




0 0