WebサービスクイックスタートのSpring Boot cxf実装

近年人気が高まっているWebサービスといえば、従来のSOAP Webサービスに置き換わる傾向がありますが、独自のシステムや比較的古いシステムの中には、航空会社や航空券のクエリインターフェースなどの従来のSOAP Webサービスを使用しているものもあります。この記事では主に、Spring Boot Integration cxf release webserviceサービスとSpring Boot Integration cxf client call webservice serviceについて説明します。

Maven依存

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <exclusions>
            <exclusion>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-tomcat</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-jetty</artifactId>
    </dependency>

    <!-- CXF webservice -->
    <dependency>
        <groupId>org.apache.cxf</groupId>
        <artifactId>cxf-spring-boot-starter-jaxws</artifactId>
        <version>3.2.4</version>
    </dependency>
    <!-- CXF webservice -->

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.hamcrest</groupId>
        <artifactId>hamcrest-all</artifactId>
        <version>1.3</version>
        <scope>test</scope>
    </dependency>
</dependencies>

サービスインターフェース

最初に、単純なユーザークラスUserを定義します。

package com.xncoding.webservice.model;

public class User {
    private Long id;
    private String name;
    private Integer age;

    public User() {
    }

    public User(Long id, String name, Integer age) {
        this.id = id;
        this.name = name;
        this.age = age;
    }

    // getter and setter
}

上記のパッケージ名は、以下のインターフェースで定義されているtargetNamespaceの逆順であることに注意してください。

単純なサービスインターフェイスを作成し、2つのメソッドを定義します。1つは文字列を返し、もう1つはエンティティクラスUserを返します。

package com.xncoding.webservice.service;

import com.xncoding.webservice.model.User;

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

@WebService(name = "CommonService", // 暴露服务名称
        targetNamespace = "http://model.webservice.xncoding.com/"// 命名空间,一般是接口的包名倒序
)
public interface ICommonService {
    @WebMethod
    public String sayHello(@WebParam(name = "userName") String name);

    @WebMethod
    public User getUser(@WebParam(name = "userName") String name);
}

インターフェイスの実装

次に、このインターフェースを実装し、対応するビジネスロジックを記述します。

package com.xncoding.webservice.service.impl;

import com.xncoding.webservice.model.User;
import com.xncoding.webservice.service.ICommonService;
import org.springframework.stereotype.Component;

import javax.jws.WebService;

@WebService(serviceName = "CommonService", // 与接口中指定的name一致
        targetNamespace = "http://model.webservice.xncoding.com/", // 与接口中的命名空间一致,一般是接口的包名倒
        endpointInterface = "com.xncoding.webservice.service.ICommonService"// 接口地址
)
@Component
public class CommonServiceImpl implements ICommonService {

    
    public String sayHello(String name) {
        return "Hello ," + name;
    }

    
    public User getUser(String name) {
        return new User(1000L, name, 23);
    }
}

構成クラス

次に、cxfの構成クラスを記述します。

@Configuration
public class CxfConfig {
    @Autowired
    private Bus bus;

    @Autowired
    ICommonService commonService;

    /**
     * JAX-WS
     **/
    @Bean
    public Endpoint endpoint() {
        EndpointImpl endpoint = new EndpointImpl(bus, commonService);
        endpoint.publish("/CommonService");
        return endpoint;
    }
}

ここで、Commonserviceインターフェイスはパスの下で公開され/services/CommonService、wsdlドキュメントパスはhttp://localhost:{port}/services/CommonService?wsdl

wsdlのアクセスURLをカスタマイズする場合は、application.ymlでカスタマイズできます。

cxf:
  path: /services  # 替换默认的/services路径

直接クライアントにアクセスするための2つの方法があり、クライアントのアクセスが

エージェントファクトリー

このメソッドは、相手のインターフェースを取得する必要があります

@Test
public void cl1() {
    try {
        // 接口地址
        // 代理工厂
        JaxWsProxyFactoryBean jaxWsProxyFactoryBean = new JaxWsProxyFactoryBean();
        // 设置代理地址
        jaxWsProxyFactoryBean.setAddress(wsdlAddress);
        // 设置接口类型
        jaxWsProxyFactoryBean.setServiceClass(ICommonService.class);
        // 创建一个代理接口实现
        ICommonService cs = (ICommonService) jaxWsProxyFactoryBean.create();
        // 数据准备
        String userName = "Leftso";
        // 调用代理接口的方法调用并返回结果
        String result = cs.sayHello(userName);
        System.out.println("返回结果:" + result);
    } catch (Exception e) {
        e.printStackTrace();
    }
}

動的な呼び出し方法 

public void cl3() {
    // 创建动态客户端
    JaxWsDynamicClientFactory dcf = JaxWsDynamicClientFactory.newInstance();
    Client client = dcf.createClient(wsdlAddress);
    Object[] objects;
    try {
        // invoke("方法名",参数1,参数2,参数3....);
        objects = client.invoke("getUser", "张三");
        System.out.println("返回类型：" + objects[0].getClass());
        System.out.println("返回数据:" + objects[0]);
        User user = (User) objects[0];
        System.out.println("返回对象User.name=" + user.getName());
    } catch (java.lang.Exception e) {
        e.printStackTrace();
    }
}

メソッドがオブジェクトを返す場合、オブジェクトのパッケージはtargetNamespaceの逆の順序である必要があることに注意してください。

クライアントコードを生成する

これは、wsdlのアクセスパスに基づいてクライアントコードを生成するための推奨される方法です。2つの生成方法があります

Apacheのwsdl2javaツール

wsdl2java -autoNameResolution http://xxx?wsdl

JDKにはツールが付属しています（推奨）

JDKには組み込みのwsimportツールがあり、これが生成方法として推奨されています。

wsimport -encoding utf-8 -p com.xncoding.webservice.client -keep http://xxx?wsdl -s d:/ws -B-XautoNameResolution

それらの中で： 

-encoding ：指定编码格式（此处是utf-8的指定格式）
-keep：是否生成Java源文件
-s：指定.java文件的输出目录
-d：指定.class文件的输出目录
-p：定义生成类的包名，不定义的话有默认包名
-verbose：在控制台显示输出信息
-b：指定jaxws/jaxb绑定文件或额外的schemas
-extension：使用扩展来支持SOAP1.2

 上記のコマンドはd:/ws、対応するクライアントコードをディレクトリの下に生成します。

クライアントの使用例：

CommonService_Service c = new CommonService_Service();
com.xncoding.webservice.client.User user = c.getCommonServiceImplPort().getUser("Tom");
assertThat(user.getName(), is("Tom"));

GitHubソース

springboot-cxf