Jak uniknąć konieczności określania lokalizacji WSDL w kliencie usługi sieciowej wygenerowanym przez CXF lub JAX-WS?

Kiedy generuję klienta webservice za pomocą wsdl2java z CXF (który generuje coś podobnego do wsimport), za pośrednictwem maven, moje usługi zaczynają się od takich kodów:

@WebServiceClient(name = "StatusManagement", 
                  wsdlLocation = "c:/some_absolute_path_to_a_wsdl_file.wsdl",
                  targetNamespace = "http://tempuri.org/") 
public class StatusManagement extends Service {

    public final static URL WSDL_LOCATION;
    public final static QName SERVICE = new QName("http://tempuri.org/", "StatusManagement");
    public final static QName WSHttpBindingIStatus = new QName("http://tempuri.org/", "WSHttpBinding_IStatus");
    static {
        URL url = null;
        try {
            url = new URL("c:/some_absolute_path_to_a_wsdl_file.wsdl");
        } catch (MalformedURLException e) {
            System.err.println("Can not initialize the default wsdl from c:/some_absolute_path_to_a_wsdl_file.wsdl");
            // e.printStackTrace();
        }
        WSDL_LOCATION = url;
    }

Zakodowana na stałe ścieżka absolutna naprawdę jest do niczego. Wygenerowana klasa nie będzie działać na żadnym innym komputerze niż mój.

Pierwszym pomysłem jest umieszczenie pliku WSDL (plus wszystko, co importuje, inne WSDL i XSD) gdzieś w pliku jar i to w ścieżce klas. Ale chcemy tego uniknąć. Ponieważ wszystko to zostało wygenerowane przez CXF i JAXB oparte na plikach WSDL i XSD, nie widzimy potrzeby znajomości WSDL w czasie wykonywania.

Atrybut wsdlLocation ma na celu przesłonięcie położenia WSDL (przynajmniej to gdzieś przeczytałem) i jego domyślną wartością jest „”. Ponieważ używamy maven, próbowaliśmy dołączyć <wsdlLocation></wsdlLocation>do konfiguracji CXF, aby spróbować zmusić generator źródłowy do pozostawienia pustego miejsca wsdlLocation. Jednak to po prostu powoduje, że ignoruje znacznik XML, ponieważ jest pusty. Zrobiliśmy naprawdę brzydki, haniebny hack, używając <wsdlLocation>" + "</wsdlLocation>.

To zmienia również inne miejsca:

@WebServiceClient(name = "StatusManagement", 
                  wsdlLocation = "" + "",
                  targetNamespace = "http://tempuri.org/") 
public class StatusManagement extends Service {

    public final static URL WSDL_LOCATION;
    public final static QName SERVICE = new QName("http://tempuri.org/", "StatusManagement");
    public final static QName WSHttpBindingIStatus = new QName("http://tempuri.org/", "WSHttpBinding_IStatus");
    static {
        URL url = null;
        try {
            url = new URL("" + "");
        } catch (MalformedURLException e) {
            System.err.println("Can not initialize the default wsdl from " + "");
            // e.printStackTrace();
        }
        WSDL_LOCATION = url;
    }

Więc moje pytania to:

1. Czy naprawdę potrzebujemy lokalizacji WSDL, nawet jeśli wszystkie klasy zostały wygenerowane przez CXF i JAXB? Jeśli tak, dlaczego?

2. Jeśli naprawdę nie potrzebujemy lokalizacji WSDL, jaki jest właściwy i czysty sposób, aby CXF jej nie generował i całkowicie jej unikał?

3. Jakie złe skutki uboczne moglibyśmy uzyskać dzięki temu włamaniu? Nadal nie możemy tego przetestować, aby zobaczyć, co się stanie, więc gdyby ktoś mógł powiedzieć z góry, byłoby miło.

W końcu znalazłem dzisiaj właściwą odpowiedź na to pytanie.

<plugin>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-codegen-plugin</artifactId>
    <version>${cxf.version}</version>
    <executions>
        <execution>
            <id>generate-sources</id>
            <phase>generate-sources</phase>
            <configuration> 
                <sourceRoot>${project.build.directory}/generated-sources/cxf</sourceRoot>
                <wsdlOptions>
                    <wsdlOption>
                        <wsdl>${project.basedir}/src/main/resources/wsdl/FooService.wsdl</wsdl>
                        <wsdlLocation>classpath:wsdl/FooService.wsdl</wsdlLocation>
                    </wsdlOption>
                </wsdlOptions>
            </configuration>
            <goals>
                <goal>wsdl2java</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Zauważ, że ja prefiksem wartość w wsdlLocationzclasspath: . To mówi wtyczce, że wsdl będzie w ścieżce klas, a nie w ścieżce bezwzględnej. Następnie wygeneruje kod podobny do tego:

@WebServiceClient(name = "FooService", 
                  wsdlLocation = "classpath:wsdl/FooService.wsdl",
                  targetNamespace = "http://org/example/foo") 
public class Foo_Service extends Service {

    public final static URL WSDL_LOCATION;

    public final static QName SERVICE = new QName("http://org/example/foo", "Foo");
    public final static QName FooSOAPOverHTTP = new QName("http://org/example/foo", "Foo_SOAPOverHTTP");
    static {
        URL url = Foo_Service.class.getClassLoader().getResource("wsdl/FooService.wsdl");
        if (url == null) {
            java.util.logging.Logger.getLogger(Foo_Service.class.getName())
                .log(java.util.logging.Level.INFO, 
                     "Can not initialize the default wsdl from {0}", "classpath:wsdl/FooService.wsdl");
        }       
        WSDL_LOCATION = url;
    }

Zauważ, że działa to tylko z wersją 2.4.1 lub nowszą wtyczki cxf-codegen-plugin.

Używamy

wsdlLocation = "WEB-INF/wsdl/WSDL.wsdl"

Innymi słowy, użyj ścieżki względnej do ścieżki klas.

Uważam, że WSDL może być potrzebny w czasie wykonywania do sprawdzania poprawności komunikatów podczas marszałka / unmarshal.

Dla tych, którzy używają org.jvnet.jax-ws-commons:jaxws-maven-plugindo generowania klienta z WSDL w czasie kompilacji:

• Umieść WSDL gdzieś w swoim src/main/resources
• Czy nie prefikswsdlLocation zclasspath:
• Zrób prefiks wsdlLocationz/

Przykład:

• WSDL jest przechowywany w /src/main/resources/foo/bar.wsdl
• Skonfiguruj za jaxws-maven-pluginpomocą <wsdlDirectory>${basedir}/src/main/resources/foo</wsdlDirectory>i<wsdlLocation>/foo/bar.wsdl</wsdlLocation>

1) W niektórych przypadkach tak. Jeśli WSDL zawiera takie elementy, jak zasady i takie, które kierują zachowaniem w czasie wykonywania, wówczas WSDL może być wymagany w czasie wykonywania. Artefakty nie są generowane dla rzeczy związanych z polityką i tym podobnych. Ponadto w niektórych niejasnych przypadkach RPC / Literal nie wszystkie potrzebne przestrzenie nazw są wyprowadzane w wygenerowanym kodzie (zgodnie ze specyfikacją). Zatem wsdl byłby dla nich potrzebny. Jednak niejasne przypadki.

2) Myślałem, że coś takiego zadziała. Jaka wersja CXF? To brzmi jak błąd. Możesz tam spróbować pustego łańcucha (tylko spacje). Nie jestem pewien, czy to działa, czy nie. To powiedziawszy, w swoim kodzie możesz użyć konstruktora, który pobiera adres URL WSDL i po prostu przekazuje null. WSDL nie zostanie użyty.

3) Tylko powyższe ograniczenia.

Udało mi się wygenerować

static {
    WSDL_LOCATION = null;
}

konfigurując plik pom tak, aby miał wartość null dla wsdlurl:

    <plugin>
        <groupId>org.apache.cxf</groupId>
        <artifactId>cxf-codegen-plugin</artifactId>
        <executions>
            <execution>
                <id>generate-sources</id>
                <phase>generate-sources</phase>
                <configuration>
                    <sourceRoot>${basedir}/target/generated/src/main/java</sourceRoot>
                    <wsdlOptions>
                        <wsdlOption>
                            <wsdl>${basedir}/src/main/resources/service.wsdl</wsdl>
                            <extraargs>
                                <extraarg>-client</extraarg>
                                <extraarg>-wsdlLocation</extraarg>
                                <wsdlurl />
                            </extraargs>
                        </wsdlOption>
                    </wsdlOptions>
                </configuration>
                <goals>
                    <goal>wsdl2java</goal>
                </goals>
            </execution>
        </executions>
    </plugin>

Czy to możliwe, że można uniknąć używania wsdl2java? Możesz od razu użyć interfejsów API CXF FrontEnd do wywołania usługi sieci Web SOAP. Jedynym haczykiem jest to, że musisz utworzyć SEI i VO po stronie klienta. Oto przykładowy kod.

package com.aranin.weblog4j.client;

import com.aranin.weblog4j.services.BookShelfService;
import com.aranin.weblog4j.vo.BookVO;
import org.apache.cxf.jaxws.JaxWsProxyFactoryBean;

public class DemoClient {
    public static void main(String[] args){
        String serviceUrl = "http://localhost:8080/weblog4jdemo/bookshelfservice";
        JaxWsProxyFactoryBean factory = new JaxWsProxyFactoryBean();
        factory.setServiceClass(BookShelfService.class);
        factory.setAddress(serviceUrl);
        BookShelfService bookService = (BookShelfService) factory.create();

        //insert book
        BookVO bookVO = new BookVO();
        bookVO.setAuthor("Issac Asimov");
        bookVO.setBookName("Foundation and Earth");

        String result = bookService.insertBook(bookVO);

        System.out.println("result : " + result);

        bookVO = new BookVO();
        bookVO.setAuthor("Issac Asimov");
        bookVO.setBookName("Foundation and Empire");

        result = bookService.insertBook(bookVO);

        System.out.println("result : " + result);

        bookVO = new BookVO();
        bookVO.setAuthor("Arthur C Clarke");
        bookVO.setBookName("Rama Revealed");

        result = bookService.insertBook(bookVO);

        System.out.println("result : " + result);

        //retrieve book

        bookVO = bookService.getBook("Foundation and Earth");

        System.out.println("book name : " + bookVO.getBookName());
        System.out.println("book author : " + bookVO.getAuthor());

    }
}

Możesz zobaczyć pełny samouczek tutaj http://weblog4j.com/2012/05/01/developing-soap-web-service-using-apache-cxf/

Aktualizacja dla CXF 3.1.7

W moim przypadku umieściłem pliki WSDL w src/main/resources i dodałem tę ścieżkę do moich zasobów w Eclipse (Kliknij prawym przyciskiem myszy Projekt-> Ścieżka kompilacji -> Konfiguruj ścieżkę budowania ...-> Źródło [karta] -> Dodaj folder).

Oto jak pomwygląda mój plik i jak widać NIE jest wsdlLocation potrzebna opcja:

       <plugin>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-codegen-plugin</artifactId>
            <version>${cxf.version}</version>
            <executions>
                <execution>
                    <id>generate-sources</id>
                    <phase>generate-sources</phase>
                    <configuration>
                        <sourceRoot>${project.build.directory}/generated/cxf</sourceRoot>
                        <wsdlOptions>
                            <wsdlOption>
                                <wsdl>classpath:wsdl/FOO_SERVICE.wsdl</wsdl>
                            </wsdlOption>
                        </wsdlOptions>
                    </configuration>
                    <goals>
                        <goal>wsdl2java</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>

A oto wygenerowana usługa. Jak widać, adres URL jest pobierany z ClassLoader, a nie z bezwzględnej ścieżki pliku

@WebServiceClient(name = "EventService", 
              wsdlLocation = "classpath:wsdl/FOO_SERVICE.wsdl",
              targetNamespace = "http://www.sas.com/xml/schema/sas-svcs/rtdm-1.1/wsdl/") 
public class EventService extends Service {

public final static URL WSDL_LOCATION;

public final static QName SERVICE = new QName("http://www.sas.com/xml/schema/sas-svcs/rtdm-1.1/wsdl/", "EventService");
public final static QName EventPort = new QName("http://www.sas.com/xml/schema/sas-svcs/rtdm-1.1/wsdl/", "EventPort");
static {
    URL url = EventService.class.getClassLoader().getResource("wsdl/FOO_SERVICE.wsdl");
    if (url == null) {
        java.util.logging.Logger.getLogger(EventService.class.getName())
            .log(java.util.logging.Level.INFO, 
                 "Can not initialize the default wsdl from {0}", "classpath:wsdl/FOO_SERVICE.wsdl");
    }       
    WSDL_LOCATION = url;   
}

Poważnie, najlepsza odpowiedź nie działa dla mnie. wypróbowano cxf.version 2.4.1 i 3.0.10. i generuj bezwzględną ścieżkę za każdym razem za pomocą wsdlLocation.

Moim rozwiązaniem jest użycie wsdl2javapolecenia w apache-cxf-3.0.10\bin\ with-wsdlLocation classpath:wsdl/QueryService.wsdl .

Szczegół:

    wsdl2java -encoding utf-8 -p com.jeiao.boss.testQueryService -impl -wsdlLocation classpath:wsdl/testQueryService.wsdl http://127.0.0.1:9999/platf/testQueryService?wsdl

Rozwiązanie @Martin Devillers działa dobrze. Aby uzyskać kompletność, wykonaj następujące czynności:

1. Umieść swój wsdl w katalogu zasobów, takim jak: src/main/resource

2. W pliku pom dodaj zarówno wsdlDirectory, jak i wsdlLocation (nie przegap / na początku wsdlLocation), jak poniżej. Podczas gdy wsdlDirectory jest używany do generowania kodu, a wsdlLocation jest używany w czasie wykonywania do tworzenia dynamicznego serwera proxy.

   <wsdlDirectory>src/main/resources/mydir</wsdlDirectory>
   <wsdlLocation>/mydir/my.wsdl</wsdlLocation>

3. Następnie w swoim kodzie java (z konstruktorem no-arg):

   MyPort myPort = new MyPortService().getMyPort();

4. Oto pełna część generowania kodu w pliku pom, z płynnym interfejsem API w generowanym kodzie.

   <plugin>
   <groupId>org.codehaus.mojo</groupId>
   <artifactId>jaxws-maven-plugin</artifactId>
   <version>2.5</version>
   
   <dependencies>
       <dependency>
           <groupId>org.jvnet.jaxb2_commons</groupId>
           <artifactId>jaxb2-fluent-api</artifactId>
           <version>3.0</version>
       </dependency>
       <dependency>
           <groupId>com.sun.xml.ws</groupId>
           <artifactId>jaxws-tools</artifactId>
           <version>2.3.0</version>
       </dependency>
   </dependencies>
   
   <executions>
       <execution>
           <id>wsdl-to-java-generator</id>
           <goals>
               <goal>wsimport</goal>
           </goals>
           <configuration>
               <xjcArgs>
                   <xjcArg>-Xfluent-api</xjcArg>
               </xjcArgs>
               <keep>true</keep>
               <wsdlDirectory>src/main/resources/package</wsdlDirectory>
               <wsdlLocation>/package/my.wsdl</wsdlLocation>
               <sourceDestDir>${project.build.directory}/generated-sources/annotations/jaxb</sourceDestDir>
               <packageName>full.package.here</packageName>
           </configuration>
       </execution>
   </executions>