每天一个注解之@WebService

@WebService

@WebService 是 Java API for XML Web Services（JAX-WS）中的注解，用于标识一个类或接口作为一个可通过网络访问的 Web 服务。通过使用 @WebService 注解，你可以将普通的 Java 类转换成可发布为 Web 服务的类。
以下是 @WebService 注解的一些常见用法和示例：

• 基本用法：
  @WebService 注解通常用于标识一个类或接口，该类或接口包含了要发布为 Web 服务的操作。通常，你需要在类上或接口上使用此注解，并在其中的方法上使用 @WebMethod 注解来指定哪些方法应该暴露为 Web 服务操作。

import javax.jws.WebService;

@WebService
public class MyWebService {

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

在上面的示例中，MyWebService 类被标记为一个 Web 服务，并包含一个 sayHello 方法，该方法可以通过 Web 服务进行访问。

• serviceName 和 portName 属性：
  @WebService 注解还提供了 serviceName 和 portName 属性，用于指定生成的 WSDL 中的服务名称和端口名称。

@WebService(serviceName = "MyHelloService", portName = "HelloPort")
public class MyWebService {
    // ...
}
1
2
3
4

在生成的 WSDL 中，服务的名称将是 “MyHelloService”，端口的名称将是 “HelloPort”。

targetNamespace 属性：
@WebService 注解的 targetNamespace 属性用于指定生成的 WSDL 中的目标命名空间。这是在描述 Web 服务时使用的命名空间。

@WebService(targetNamespace = "http://example.com/hello")
public class MyWebService {
    // ...
}
1
2
3
4

在生成的 WSDL 中，命名空间将是 “http://example.com/hello”。

endpointInterface 属性：
如果你希望将 Web 服务的实现与其接口分开，可以使用 endpointInterface 属性来指定 Web 服务接口的完全限定名。

@WebService(endpointInterface = "com.example.HelloWebService")
public class MyWebServiceImpl {
    // ...
}
1
2
3
4

在上面的示例中，MyWebServiceImpl 类实现了 HelloWebService 接口，而 @WebService 注解指定了接口的完全限定名。

@WebService 注解用于标识一个类或接口作为可通过网络访问的 Web 服务，并用于配置生成的 WSDL 文档的一些元数据。通过使用此注解，你可以轻松地将现有的 Java 类转换成可发布为 Web 服务的类，并为其配置一些基本属性。注意，与 @WebMethod 注解一起使用可以更精确地控制哪些方法应该成为 Web 服务操作。