JAX-WS之契约优先及隐式声明头信息

package net.csdn.blog.xuanyuv;
import javax.jws.WebService;

/**
 * SIB(Service Implemention Bean)
 * -------------------------------------------------------------------------------------------------------
 * 契约优先的核心
 * 1)其实WebServices开发服务端的过程中，完全可以不写SEI，直接写一个SIB，再把服务对外发布，客户端足矣正常访问
 *   这个时候，也可以在SIB中直接使用@WebParam和@WebResult来指明发布出去的方法中的参数名和返回值名称等等
 * 2)我们写SEI的目的是使用里面配置的@WebResult等注解，而要让SEI中的注解生效，就要在SIB中使用endpointInterface
 *   由于SEI是我们编写的wsdl生成的，所以它里面的注解都是很规范的，我们在SIB中只关注实现即可，可理解为面向接口编程
 *   所以我们在使用wsdl文件生成服务端代码后,就可以把除了SEI外的其它类都删掉
 * -------------------------------------------------------------------------------------------------------
 * 手工编写SIB
 * 1)最好显式的让SIB和SEI的targetNamespace相同
 * 2)当指定serviceName值时，其值应为wsdl文件中的<wsdl:service name="CalculatorServiceImpl">标签的name值
 * 3)不指定serviceName值时，wsdl中的<wsdl:service name="">则应为SIBService，如CalculatorServiceImplService
 *   否则在启动WebService服务时，会报告下面的异常
 *   Exception in thread "main" javax.xml.ws.WebServiceException:
 *   wsdl file:/F:/Tool/Code/JavaSE/ws_contractFirst/bin/META-INF/wsdl/myCalculator.wsdl
 *   has the following services [{https://www.xuanyuv.com/}CalculatorServiceImpl]
 *   but not {https://www.xuanyuv.com/}CalculatorServiceImplService
 *   Maybe you forgot to specify a service name in @WebService/@WebServiceProvider?
 * -------------------------------------------------------------------------------------------------------
 * 隐式声明头信息
 * 1)wsdl文件的<wsdl:input>中增加<soap:header use="...." part="licenseInfo" message="...."/>
 * 2)由于我们在wsdl中声明的是<soap:header>，所以此时wsdl生成的SEI中是找不到我们所声明的licenseInfo的
 *   作为服务端，可在欲验证头信息的方法中增加licenseInfo参数，并注解@WebParam(name="licenseInfo",header=true)
 *   作为客户端，调用时会发现minus()并不用传licenseInfo参数，故直接调用minus()时，服务端收到的licenseInfo=null
 *   所以才称为隐式声明头信息
 * 3)在SIB中对应的方法中增加licenseInfo参数，即可进行业务逻辑验证了(本例中只是将头信息licenseInfo打印输出)
 *   如果SEI中的header=true没有指明的话，那么SIB的方法中是无法获取头信息licenseInfo值的，即便客户端传了
 * -------------------------------------------------------------------------------------------------------
 * Created by 玄玉<https://www.xuanyuv.com/> on 2013/05/20 12:46.
 */
@WebService(serviceName="CalculatorServiceImpl",
            wsdlLocation="META-INF/wsdl/myCalculator.wsdl",
            endpointInterface="net.csdn.blog.xuanyuv.CalculatorService",
            targetNamespace="https://www.xuanyuv.com/")
public class CalculatorServiceImpl implements CalculatorService {
    @Override
    public int add(int a, int b) {
        System.out.println("["+a+"]+["+b+"]=" + (a+b));
        return a + b;
    }

    @Override
    public int minus(int num1, int num2, String licenseInfo) {
        System.out.println("["+num1+"]-["+num2+"]="+(num1-num2) + ", licenseInfo=["+licenseInfo+"]");
        return num1 - num2;
    }
}

package com.xuanyuv.server;
import javax.xml.ws.Endpoint;
import net.csdn.blog.xuanyuv.CalculatorServiceImpl;

/**
 * 契约优先开发及隐式声明头信息
 * --------------------------------------------------------------------------------------------------
 * 开发流程
 * 1)创建\\src\\META-INF\\wsdl\\myCalculator.wsdl文件,并编写其内容
 *   File--New--Other--MyEclipse--Web Services--WSDL--输入文件名后Next
 *   这一步保持Protocol为默认的SOAP不变,SOAP Binding Options为默认document literal不变即可
 * 2)根据wsdl文件生成服务端代码(wsimport -d d:/Download/ -keep -verbose myCalculator.wsdl)
 *   它会生成很多的代码,而作为服务端的我们,只需保留一个接口类(SEI)即可............如果是客户端,就不能删了
 *   若SEI报告ObjectFactory cannot be resolved to a type,则删除@XmlSeeAlso({ObjectFactory.class})
 * 3)编写实现类
 *   在实现类上指定@WebService(serviceName="", wsdlLocation="", endpointInterface="", targetNamespace="")
 * 4)发布服务
 *   发布时的address可任意指定,不要求一定要与myCalculator.wsdl中的<soap:address location=""/>相同
 *   但发布后在浏览器中查看wsdl时会发现,其<soap:address location=""/>值始终与发布时指定的address相同
 * --------------------------------------------------------------------------------------------------
 * Created by 玄玉<https://www.xuanyuv.com/> on 2013/05/17 11:33.
 */
public class ServerApp {
    public static void main(String[] args) {
        Endpoint.publish("http://127.0.0.1:8088/calculatorQuery", new CalculatorServiceImpl());
    }
}

package com.xuanyuv.client;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import javax.xml.namespace.QName;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPBody;
import javax.xml.soap.SOAPBodyElement;
import javax.xml.soap.SOAPEnvelope;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPHeader;
import javax.xml.soap.SOAPMessage;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import net.csdn.blog.xuanyuv.CalculatorService;
import net.csdn.blog.xuanyuv.CalculatorServiceImpl;

public class ClientApp {
    //服务端提供服务的端口是8088
    //若使用Eclipse提供的TCP/IPMonitor，则此处需将8088改为TCP/IPMonitor监听的本地端口
    private static final String wsdlLocation = "http://127.0.0.1:8088/calculatorQuery?wsdl";
    //取自wsdl文件中定义的<wsdl:definitions targetNamespace=""/>的值
    private static final String nameSpace = "https://www.xuanyuv.com/";
    //取自wsdl文件中定义的<wsdl:service name="">的值
    private static final String serviceName = "CalculatorServiceImpl";
    //取自wsdl文件中定义的<wsdl:port name="">的值
    private static final String portName = "CalculatorServiceImplPort";

    /**
     * 隐式声明头信息(使用SAAJ)
     * @see 本例中,服务端提供的minus()在访问时需要提供头信息
     * @see 如果没提供的话,也可正常访问并接收应答,因为本例中服务端并没有强制验证头信息(只是输出,顶多输出个null)
     * @see 通常有三种方式可以让客户端访问服务端时附带头信息,分别为Handler,SAAJ,代理类
     */
    private static void soapInvoke() throws SOAPException, IOException{
        SOAPMessage message = MessageFactory.newInstance().createMessage();
        SOAPEnvelope envelope = message.getSOAPPart().getEnvelope();
        SOAPBody body = envelope.getBody();
        SOAPHeader header = envelope.getHeader();
        if(null == header){
            header = envelope.getHeader();
        }
        //添加头信息
        header.addHeaderElement(new QName(nameSpace,"licenseInfo","ns")).setValue("theClientLicenseInfo");
        //添加体信息
        SOAPBodyElement sbe = body.addBodyElement(new QName(nameSpace, "minus", "ns"));
        sbe.addChildElement("num1").setValue("4");
        sbe.addChildElement("num2").setValue("1");
        System.out.println("invoke begin......");
        message.writeTo(System.out);
        System.out.println("");
        Service service = Service.create(new URL(wsdlLocation), new QName(nameSpace, serviceName));
        Dispatch<SOAPMessage> dispatch = service.createDispatch(new QName(nameSpace, portName), SOAPMessage.class, Service.Mode.MESSAGE);
        SOAPMessage respMsg = dispatch.invoke(message);
        respMsg.writeTo(System.out);
        System.out.println("\ninvoke end......");
    }

    private static void wsimportInvoke() throws MalformedURLException{
        CalculatorServiceImpl csl = new CalculatorServiceImpl(new URL(wsdlLocation), new QName(nameSpace, serviceName));
        CalculatorService cs = csl.getCalculatorServiceImplPort();
        System.out.println(cs.add(2, 3));
        System.out.println(cs.minus(2, 1));
    }

    public static void main(String[] args) throws SOAPException, IOException {
        wsimportInvoke();
        soapInvoke();
    }
}