每天一个注解之 @WebMethod

@WebMethod

@WebMethod 是 Java API for XML Web Services (JAX-WS) 中的注解，用于标识一个方法作为 Web 服务操作（Web Service Operation）。通过使用 @WebMethod 注解，可以明确指定哪些方法应该作为 Web 服务操作，以供客户端远程调用。

以下是 @WebMethod 注解的一些常见用法和示例：

• 基本用法：
  @WebMethod 注解通常用于标识一个方法，以将其暴露为 Web 服务操作。如果方法未显式标记为 @WebMethod，则 JAX-WS 通常会将所有公共方法暴露为 Web 服务操作。

import javax.jws.WebMethod;
import javax.jws.WebService;

@WebService
public class MyWebService {

    @WebMethod
    public String sayHello(String name) {
        return "Hello, " + name + "!";
    }
}
1
2
3
4
5
6
7
8
9
10
11

在上面的示例中，sayHello 方法被标记为 @WebMethod，因此它将作为 Web 服务操作暴露。

• operationName 属性：
  通过 @WebMethod 注解的 operationName 属性，你可以指定 Web 服务操作的名称。如果不指定 operationName 属性，操作名称通常将与方法的名称相同。

@WebMethod(operationName = "greet")
public String sayHello(String name) {
    return "Hello, " + name + "!";
}
1
2
3
4

在上面的示例中，sayHello 方法将作为名为 “greet” 的 Web 服务操作暴露。

• 其他属性：
  @WebMethod 注解还提供了其他属性，如 exclude 和 action，用于进一步控制 Web 服务操作的行为。例如，你可以使用 exclude 属性将方法排除在 Web 服务之外，或者使用 action 属性指定操作的 SOAP 操作名称。

@WebMethod(exclude = true)
public void excludedMethod() {
    // This method will not be exposed as a Web service operation.
}
1
2
3
4

请注意，具体属性的支持和行为取决于 JAX-WS 实现。
@WebMethod 注解用于标识哪些方法应该作为 Web 服务操作暴露，以供客户端远程调用。它允许你控制哪些方法对外可见，并可以自定义操作名称等元数据信息。这对于构建定制的 Web 服务接口非常有用。