【WebService】wsdl配置详解以及使用注解修改wsdl配置

我就是我 2022-09-24 08:25 518阅读 0赞

欢迎关注我新搭建的博客：[http://www.itcodai.com/][http_www.itcodai.com]

> WebService系列文章：  
> [【WebService】带你走进webservice的世界][WebService_webservice]  
> [【WebService】自定义WebService服务及其调用][WebService_WebService]  
> [【WebService】CXF处理javaBean等复合类型以及Map等复杂类型的数据][WebService_CXF_javaBean_Map]  
> [【WebService】CXF拦截器的设置以及自定义CXF拦截器][WebService_CXF_CXF]

前面分析了一下关于ws的基本知识，我们知道，wsdl是ws中很重要的文档，我们可以通过解析该wsdl文档获取ws的相关信息，其实，如果不了解该文档结构的话，问题也不大，只要会解析即可进行开发。但是如果想要生成一个符合自己项目的，或者比较人性化的一个wsdl的话，或者从可读性角度来说，就需要在编写ws代码时进行一些相应的配置了，比如说ws名称，参数等等，那么就需要对wsdl文档有一定的了解。这篇文章主要从两个角度来展开：一是解释一下wsdl中的相关配置，二是如何在ws程序中通过注解指定这些配置。

## **1. wsdl配置详解** ##

要生成wsdl，首先得有一个ws，我们还是使用前面文章中提到的那个简单的ws，如下：

@WebService //默认静态方法是不能发不成ws服务的
    public class MyWebService { 
    
        public String sayHello(String name) {
            return name + " 你好！";
        }
    
        public static void main(String[] args) {
            String address = "http://192.168.10.1:6666/ws";
            Endpoint.publish(address, new MyWebService());
            System.out.println("访问WSDL的地址为：" + address + "?WSDL");
        }
    }

运行一下，即可开启ws服务，请求[http://192.168.10.1:6666/ws?WSDL][http_192.168.10.1_6666_ws_WSDL]即可看到wsdl页面，接下来分析一下该wsdl文件中与上面程序中的对应关系，看下图（为了清晰的展示，图我就不缩小了）：  
![这里写图片描述][20160728092236567]  
　　我们可以看到，生成的ws服务名称是在原来的类后面有加了个Service而已，服务类型名是在原来的类后面加了个Port，包括参数默认为arg0，返回值为return 等等，这些都能从wsdl文件中看的出来，通过这个wsdl生成的java代码中的类名自然也就是默认的了，如果我们想要修改这些默认的配置，则需要在编写ws的时候通过注解来设置一下。

## **2. 使用注解修改wsdl配置** ##

我们修改一下上面的ws，使用注解来配置我们自己需要的名称，如下

/* * 自定义ws服务, jdk1.6版本仅仅支持 soap1.1格式,jdk1.7及以上版本支持 soap1.2格式 * 发布ws服务只需要@WebService注解即可, 如果想要更好的可维护性,则可以通过注解来实现 * */
    @WebService // 默认静态的方式是不能发布ws服务的
    (
            name="MyWebService1",  // 服务实现类的名称
            serviceName="MyWebServiceService1",  // 默认在发布的服务实现者的名称后面添加Service
            portName="MyWebServicePort1",   // 服务类型的名称: 默认在 发布的服务实现者(MyWebService) 后面添加 port
            targetNamespace="ws.client.test"    // 发布ws服务的命名空间,此空间默认为当前服务包路径的 "倒写"此名称也是 wsimport 命令生成 java类时默认的包路径 -p
    )
    public class MyWebService { 
    
        @WebMethod(exclude=true)  // 默认public方法可以发布为ws服务, 如果要排除则配置 exclude=true
        public String sayHello(String name){
            System.out.println("name:" + name);
            return name + ",你好!";
        }
    
        //可以指定wsdl中的方法名，参数名和返回值
        @WebMethod(operationName="sayHello")
        public @WebResult(name="result") String sayHello2(@WebParam(name="name") String name,@WebParam(name="age") int age){
            System.out.println("name:" + name);
            return name + ",你好!,年龄为:" + age;
        }
    
        public static void main(String[] args) {
            // 一个端口可以发布多个ws服务
            String address="http://192.168.1.105/ws";
            // 创建一个服务端点, banding服务的实现类
            Endpoint.publish(address, new MyWebService());
            System.out.println("访问wsdl的地址为:" + address + "?WSDL");
        }
    }

通过上面这些注解，我将ws服务相关的信息给重新配置了，运行一下，来对比注解看一下生成的wsdl：  
![这里写图片描述][20160728094428771]

![这里写图片描述][20160728094439021]  
　　可以看出，生成的wsdl中的配置完全按照我们自己指定的来，这样通过解析该wsdl文件得到的java代码中的类以及方法也是按照自定义的来，这就能满足实际中具体的要求了。

文末福利：“程序员私房菜”，一个有温度的公众号~  
![程序员私房菜][70]

--------------------

—–乐于分享，共同进步！  
—–我的博客主页：[http://blog.csdn.net/eson\_15][http_blog.csdn.net_eson_15]

[http_www.itcodai.com]: http://www.itcodai.com/
[WebService_webservice]: http://blog.csdn.net/eson_15/article/details/52021319
[WebService_WebService]: http://blog.csdn.net/eson_15/article/details/52050536
[WebService_CXF_javaBean_Map]: http://blog.csdn.net/eson_15/article/details/52052481
[WebService_CXF_CXF]: http://blog.csdn.net/eson_15/article/details/52055549
[http_192.168.10.1_6666_ws_WSDL]: http://192.168.10.1:6666/ws?WSDL
[20160728092236567]: /images/20220719/4b60f80d22b944a0a1bc5fd1bf32fa72.png
[20160728094428771]: /images/20220719/4e245fd664514f528ae3dc97289c2304.png
[20160728094439021]: /images/20220719/f576d9832ee14e9bbf649ee396c7c976.png
[70]: /images/20220719/2849c646229f4327bdfaf5c2cd63a843.png
[http_blog.csdn.net_eson_15]: http://blog.csdn.net/eson_15