Веб-сервисы SOAP с Apache CXF и Spring Boot

Этот пост основан на том, что я написал несколько лет назад о первых контрактных веб-сервисах с Apache CXF и Spring. В предыдущем посте Spring Boot не использовалась, и большинство настроек Spring и CXF были через XML. Этот пост немного продвигает вперед, используя последнюю версию CXF и Spring Boot.

Образец приложения

Мы собираемся создать простое приложение Spring Boot, которое предоставляет веб-сервис SOAP с использованием Apache CXF. Служба будет иметь одну операцию, которая берет номер счета и возвращает реквизиты банковского счета. Если вы нетерпеливы и хотите выйти вперед, вы можете получить полный исходный код из GitHub .

Определение модели данных

При создании веб-сервисов я всегда использую контракт в первую очередь. Это означает определение контракта на обслуживание как WSDL перед написанием реализации сервиса. Мы начнем этот процесс с создания файла XSD с типами, которые будет использовать служба учетных записей. Первый тип, который мы создадим, Account— диаграмма ниже показывает фрагмент XSD для, Accountа также визуальное представление, взятое из XML Spy. Примечание : вам не нужен XML Spy для определения XSD, но визуальный редактор может быть очень полезен, если вы разрабатываете сложные доменные модели.

Далее мы определим тип запроса для сервиса, который инкапсулирует параметры сервиса. В этом случае у нас есть только один параметр,  accountNumberно рекомендуется определить тип запроса как удобный способ оборачивания нескольких параметров и поддерживать интерфейс в чистоте.

Наконец, мы определим тип ответа, AccountDetailsResponseкоторый представляет собой простую оболочку, которую Accountмы создали ранее. Опять же, мы могли бы просто вернуться, Accountно я думаю, что в общем случае рекомендуется использовать оболочки для типа ответа, поскольку это означает, что в будущем мы можем легко добавить другие данные в оболочку ответа.

Полное определение схемы показано ниже.

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://com/blog/samples/webservices/accountservice" xmlns:account="http://webservices.samples.blog.com" targetNamespace="http://com/blog/samples/webservices/accountservice" elementFormDefault="qualified">
 <xsd:complexType name="Account">
  <xsd:sequence>
   <xsd:element name="AccountNumber" type="xsd:string"/>
   <xsd:element name="AccountName" type="xsd:string"/>
   <xsd:element name="AccountBalance" type="xsd:double"/>
   <xsd:element name="AccountStatus" type="EnumAccountStatus"/>
  </xsd:sequence>
 </xsd:complexType> 
 <xsd:simpleType name="EnumAccountStatus">
  <xsd:restriction base="xsd:string">
   <xsd:enumeration value="Active"/>
   <xsd:enumeration value="Inactive"/>
  </xsd:restriction>
 </xsd:simpleType>
 <xsd:element name="AccountDetailsRequest">
  <xsd:complexType>
   <xsd:sequence>
    <xsd:element name="accountNumber" type="xsd:string"/>
   </xsd:sequence>
  </xsd:complexType>
 </xsd:element>
 <xsd:element name="AccountDetailsResponse">
  <xsd:complexType>
   <xsd:sequence>
    <xsd:element name="AccountDetails" type="Account"/>
   </xsd:sequence>
  </xsd:complexType>
 </xsd:element>
</xsd:schema>

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<wsdl:definitions xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap12/"
 xmlns:tns="http://www.briansjavablog.com/Accounts/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="Accounts"
 targetNamespace="http://www.briansjavablog.com/Accounts/"
 xmlns:accounts="http://com/blog/samples/webservices/accountservice">
 <wsdl:types>
  <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <xsd:import namespace="http://com/blog/samples/webservices/accountservice"
    schemaLocation="../schema/AccountsService.xsd">
   </xsd:import>
  </xsd:schema>
 </wsdl:types>
 <wsdl:message name="AccountDetailsRequest">
  <wsdl:part element="accounts:AccountDetailsRequest" name="parameters" />
 </wsdl:message>
 <wsdl:message name="AccountDetailsResponse">
  <wsdl:part element="accounts:AccountDetailsResponse" name="parameters" />
 </wsdl:message>
 <wsdl:portType name="Accounts">
  <wsdl:operation name="GetAccountDetails">
   <wsdl:input message="tns:AccountDetailsRequest" />
   <wsdl:output message="tns:AccountDetailsResponse" />
  </wsdl:operation>
 </wsdl:portType>
 <wsdl:binding name="AccountsServiceSoapBinding" type="tns:Accounts">
  <soap:binding style="document"
   transport="http://schemas.xmlsoap.org/soap/http" />
  <wsdl:operation name="GetAccountDetails">
   <soap:operation
    soapAction="http://www.briansjavablog.com/Accounts/GetAccountDetails" />
   <wsdl:input>
    <soap:body use="literal" />
   </wsdl:input>
   <wsdl:output>
    <soap:body use="literal" />
   </wsdl:output>
  </wsdl:operation>
 </wsdl:binding>
 <wsdl:service name="AccountsService">
  <wsdl:port binding="tns:AccountsServiceSoapBinding" name="AccountsPort">
   <soap:address
    location="http://localhost:8080/apache-cfx-demo/services/accounts" />
  </wsdl:port>
 </wsdl:service>
</wsdl:definitions>

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

@WebService(targetNamespace = "http://www.briansdevblog.com/Accounts/", name = "AccountService")
@XmlSeeAlso({com.blog.demo.webservices.accountservice.ObjectFactory.class})
@SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE)
public interface AccountService {

    @WebMethod(operationName = "GetAccountDetails", action = "http://www.briansjavablog.com/Accounts/GetAccountDetails")
    @WebResult(name = "AccountDetailsResponse", targetNamespace = "http://com/blog/demo/webservices/accountservice", partName = "parameters")
    public com.blog.demo.webservices.accountservice.AccountDetailsResponse getAccountDetails(

        @WebParam(partName = "parameters", name = "AccountDetailsRequest", targetNamespace = "http://com/blog/demo/webservices/accountservice")
        com.blog.demo.webservices.accountservice.AccountDetailsRequest parameters
    );
}

@Service
public class AccountServiceEndpoint implements AccountService {

  @Override
  public AccountDetailsResponse getAccountDetails(AccountDetailsRequest parameters) {

    ObjectFactory factory = new ObjectFactory();
    AccountDetailsResponse response = factory.createAccountDetailsResponse();

    Account account = factory.createAccount();
    account.setAccountNumber("12345");
    account.setAccountStatus(EnumAccountStatus.ACTIVE);
    account.setAccountName("Joe Bloggs");
    account.setAccountBalance(3400);

    response.setAccountDetails(account);
    return response;
  }

}

@Configuration
public class ApplicationConfig {

  @Bean
  public ServletRegistrationBean<CXFServlet> dispatcherServlet() {
    return new ServletRegistrationBean<CXFServlet>(new CXFServlet(), "/soap-api/*");
  }

  @Bean
  @Primary
  public DispatcherServletPath dispatcherServletPathProvider() {
      return () -> "";
  }

  @Bean(name=Bus.DEFAULT_BUS_ID)
  public SpringBus springBus(LoggingFeature loggingFeature) {

    SpringBus cxfBus = new  SpringBus();
    cxfBus.getFeatures().add(loggingFeature);

    return cxfBus;
  }

  @Bean
  public LoggingFeature loggingFeature() {

    LoggingFeature loggingFeature = new LoggingFeature();
    loggingFeature.setPrettyLogging(true);

    return loggingFeature;
  }

  @Bean
  public Endpoint endpoint(Bus bus, AccountServiceEndpoint accountServiceEndpoint) {

    EndpointImpl endpoint = new EndpointImpl(bus, accountServiceEndpoint);
    endpoint.publish("/service/accounts");

    return endpoint;
  }

}

@Configuration
@ComponentScan("com.blog.demo.service")
public class TestConfig {

  private static final String SERVICE_URL = "http://localhost:8080/services/accounts";

  @Bean("accountServiceClient")
  public AccountService accountServiceClient() {

    JaxWsProxyFactoryBean jaxWsProxyFactoryBean = new JaxWsProxyFactoryBean();
    jaxWsProxyFactoryBean.setServiceClass(AccountService.class);
    jaxWsProxyFactoryBean.setAddress(SERVICE_URL);    
    return (AccountService) jaxWsProxyFactoryBean.create();
  }

  @Bean(name=Bus.DEFAULT_BUS_ID)
  public SpringBus springBus(LoggingFeature loggingFeature) {

    SpringBus bus = new  SpringBus();
    bus.getFeatures().add(loggingFeature);

    return bus;
  }

  @Bean
  public LoggingFeature loggingFeature() {

    LoggingFeature loggingFeature = new LoggingFeature();
    loggingFeature.setPrettyLogging(true);

    return loggingFeature;
  }

  @Bean
  public Endpoint endpoint(Bus bus, LoggingFeature loggingFeature, AccountServiceEndpoint accountServiceEndpoint) {

    EndpointImpl endpoint = new EndpointImpl(bus, accountServiceEndpoint);
    endpoint.publish(SERVICE_URL);

    return endpoint;
  }

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = { TestConfig.class })
public class AccountServiceEndpointTest {

  @Autowired
  @Qualifier("accountServiceClient")
  private AccountService accountsServiceClient;
  private AccountDetailsRequest accountDetailsRequest;

  @Before
  public void setUp() throws Exception {

    ObjectFactory objectFactory = new ObjectFactory();
    accountDetailsRequest = objectFactory.createAccountDetailsRequest();
    accountDetailsRequest.setAccountNumber("12345");
  }

  @Test
  public void testGetAccountDetails() throws Exception {

    AccountDetailsResponse response = accountsServiceClient.getAccountDetails(accountDetailsRequest);
    assertTrue(response.getAccountDetails()!= null);
    assertTrue(response.getAccountDetails().getAccountNumber().equals("12345"));
    assertTrue(response.getAccountDetails().getAccountName().equals("Joe Bloggs"));
    assertTrue(response.getAccountDetails().getAccountBalance() == 3400);
    assertTrue(response.getAccountDetails().getAccountStatus().equals(EnumAccountStatus.ACTIVE));
  }

}