WebService - 使用JDK开发WebService

最新推荐文章于 2024-11-08 14:58:24 发布

weixin_30722589

最新推荐文章于 2024-11-08 14:58:24 发布

阅读量87

点赞数

文章标签： java

原文链接：http://www.cnblogs.com/frankcui/p/10505024.html

版权

本文详细介绍了使用JDK开发WebService的方法，包括服务器端接口定义、实现类编写及发布方式，同时提供了客户端调用WebService的示例，涵盖手动调用及使用wsimport工具生成客户端代码的过程。

摘要由CSDN通过智能技术生成

一、WebService的开发手段

　　使用Java开发WebService时可以使用以下两种开发手段

　　　　1、使用JDK开发(1.6及以上版本)-->详见：本文

　　　　2、使用CXF框架开发-->详见：其他文章

二、使用JDK开发WebService

2.1、开发WebService服务器端

　　1、定义一个interface，使用@WebService注解标注接口，使用@WebMethod注解标注接口中定义的所有方法，如下所示：

package me.gacl.ws;

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

/**
 * @author gacl
 * 定义SEI(WebService EndPoint Interface(终端))
 */
//使用@WebService注解标注WebServiceI接口
@WebService
public interface WebServiceI {

    //使用@WebMethod注解标注WebServiceI接口中的方法
    @WebMethod
    String sayHello(String name);
    
    @WebMethod
    String save(String name,String pwd);
}

2、编写interface的实现类，使用@WebService注解标注实现类，实现接口中定义的所有方法，如下所示：

package me.gacl.ws;
import javax.jws.WebService;
/**
 * @author gacl
 * SEI的具体实现
 */
//使用@WebService注解标注WebServiceI接口的实现类WebServiceImpl
@WebService(endpointInterface=me.gacl.ws.WebServiceI) 
public class WebServiceImpl implements WebServiceI { 
    @Override 
    public String sayHello(String name) { 
        System.out.println("WebService sayHello "+name); 
        return "sayHello "+name; 
    } 
    @Override 
    public String save(String name, String pwd) { 
        System.out.println("WebService save "+name+"， "+pwd); 
        return "save Success"; 
    } 
}

3.1、如果是普通的java项目，那么可以专门写一个类用于发布WebService。使用Endpoint(终端)类发布webservice，代码如下：

package me.gacl.ws.test;

import javax.xml.ws.Endpoint;

import me.gacl.ws.WebServiceImpl;

/**
 * @author gacl
 *
 * 发布Web Service
 */
public class WebServicePublish {

    public static void main(String[] args) {
        //定义WebService的发布地址，这个地址就是提供给外界访问Webervice的URL地址，URL地址格式为：http://ip:端口号/xxxx
        //String address = "http://192.168.1.100:8989/";这个WebService发布地址的写法是合法的
        //String address = "http://192.168.1.100:8989/Webservice";这个WebService发布地址的是合法的
        String address = "http://192.168.1.100:8989/WS_Server/Webservice";
        //使用Endpoint类提供的publish方法发布WebService，发布时要保证使用的端口号没有被其他应用程序占用
        Endpoint.publish(address , new WebServiceImpl());
        System.out.println("发布webservice成功!");
    }
}

运行WebServicePublish类，就可以将编写好的WebService发布好了，WebService的访问URL是：http://127.0.0.1:8080/WS_Server/Webservice?wsdl

3.2 如果是Web项目，那么可以使用ServletContextListener或者Servlet进行发布：

3.2.1 使用ServletContextListener监听器发布WebService.....将Web应用部署到服务器运行时，在初始化Web应用上下文时，就会发布WebService了。

package me.gacl.listener;

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;
import javax.xml.ws.Endpoint;
import me.gacl.ws.WebServiceImpl;

/**
 * @author gacl
 * 用于发布WebService的监听器
 */
//使用Servlet3.0提供的@WebListener注解将实现了ServletContextListener接口的WebServicePublishListener类标注为一个Listener
@WebListener
public class WebServicePublishListener implements ServletContextListener {

    @Override
    public void contextDestroyed(ServletContextEvent sce) {

    }

    @Override
    public void contextInitialized(ServletContextEvent sce) {
        //WebService的发布地址
        String address = "http://192.168.1.100:8080/WS_Server/WebService";
        //发布WebService，WebServiceImpl类是WebServie接口的具体实现类
        Endpoint.publish(address , new WebServiceImpl());
        System.out.println("使用WebServicePublishListener发布webservice成功!");
    }
}

3.2.2 使用Servlet发布WebService。将Web应用部署到服务器运行时，在初始化WebServicePublishServlet时，就会发布WebService了。

package me.gacl.web.controller;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.xml.ws.Endpoint;
import me.gacl.ws.WebServiceImpl;

/**
 * @author gacl
 * 用于发布WebService的Servlet
 */
//使用Servlet3.0提供的@WebServlet注解将继承HttpServlet类的普通Java类标注为一个Servlet
//将value属性设置为空字符串，这样WebServicePublishServlet就不提供对外访问的路径
//loadOnStartup属性设置WebServicePublishServlet的初始化时机
@WebServlet(value="",loadOnStartup=0)
public class WebServicePublishServlet extends HttpServlet {

    /* (non-Javadoc)
     * @see javax.servlet.GenericServlet#init()
     * 在WebServicePublishServlet初始化时发布WebService
     */
    public void init() throws ServletException {
        //WebService的发布地址
        String address = "http://192.168.1.100:8888/WebService";
        //发布WebService，WebServiceImpl类是WebServie接口的具体实现类
        Endpoint.publish(address , new WebServiceImpl());
        System.out.println("使用WebServicePublishServlet发布webservice成功!");
    }
}

2.2、开发WebService客户端

此部分参考：https://www.mkyong.com/webservices/jax-ws/jax-ws-hello-world-example/，示例代码和上部分不再衔接。

1、不使用工具

package com.mkyong.client;

import java.net.URL;
import javax.xml.namespace.QName;
import javax.xml.ws.Service;
import com.mkyong.ws.HelloWorld;

public class HelloWorldClient{
    
    public static void main(String[] args) throws Exception {
       
    URL url = new URL("http://localhost:9999/ws/hello?wsdl");
    
        //1st argument service URI, refer to wsdl document above
    //2nd argument is service name, refer to wsdl document above
        QName qname = new QName("http://ws.mkyong.com/", "HelloWorldImplService");

        Service service = Service.create(url, qname);

        HelloWorld hello = service.getPort(HelloWorld.class);

        System.out.println(hello.getHelloWorldAsString("mkyong"));

    }

}

其中，QName的第一个参数和第二个参数在wsdl的这个地方寻找：

2、使用 wsimport tool

借助jdk的wsimport.exe工具生成客户端代码，wsimport.exe工具位于Jdk的bin目录下，如下图所示：

　　执行命令：wsimport -keep url(url为wsdl文件的路径)生成客户端代码。

　　创建一个WebService客户端测试项目，如下图所示：

　　打开命令行窗口，切换到src目录，执行"wsimport -keep http://192.168.1.100:8888/WebService?wsdl"生成客户端代码，如下图所示：

　　执行命令的过程中没有出现任何错误，那么代码就生成成功了，刷新一下src目录，就可以看到生成的代码了，如下图所示：

　　2、借助生成的代码编写调用WebService对外提供的方法

　　wsimport工具帮我们生成了好几个java类，但我们只需要关心WebServiceImplService类和WebServiceImpl接口的使用即可，如下所示：

package me.gacl.ws.client;

import me.gacl.ws.WebServiceImpl;
import me.gacl.ws.WebServiceImplService;

/**
 * @author gacl
 * 调用WebService的客户端
 */
public class WSClient {

    public static void main(String[] args) {
        //创建一个用于产生WebServiceImpl实例的工厂，WebServiceImplService类是wsimport工具生成的
        WebServiceImplService factory = new WebServiceImplService();
        //通过工厂生成一个WebServiceImpl实例，WebServiceImpl是wsimport工具生成的
        WebServiceImpl wsImpl = factory.getWebServiceImplPort();
        //调用WebService的sayHello方法
        String resResult = wsImpl.sayHello("孤傲苍狼");
        System.out.println("调用WebService的sayHello方法返回的结果是："+resResult);
        System.out.println("---------------------------------------------------");
        //调用WebService的save方法
        resResult = wsImpl.save("孤傲苍狼","123");
        System.out.println("调用WebService的save方法返回的结果是："+resResult);
    }
}