淺談spring-boot-starter-web-servic

一、簡介

spring-boot-starter-web-servic是由Spring Boot官方提供的一個starter，主要用於構建基於SOAP協議的Web Services。它基於Spring Web Services，遵循了JAX-WS和JAXB規範。同時，它也提供了許多方便的特性，例如集成了Spring Security和Actuator。

二、集成使用

為了使用spring-boot-starter-web-servic，我們需要在pom.xml中添加以下依賴：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web-services</artifactId>
</dependency>

接下來，我們可以使用@EnableWs註解開啟WebService支持，並使用@Endpoint註解來定義接口，例如：

@Configuration
@EnableWs
public class WebServiceConfig extends WsConfigurerAdapter {

    @Bean
    public ServletRegistrationBean messageDispatcherServlet(ApplicationContext context) {
        MessageDispatcherServlet servlet = new MessageDispatcherServlet();
        servlet.setApplicationContext(context);
        servlet.setTransformWsdlLocations(true);
        return new ServletRegistrationBean(servlet, "/ws/*");
    }

    @Bean(name = "hello")
    public DefaultWsdl11Definition defaultWsdl11Definition(XsdSchema schema) {
        DefaultWsdl11Definition wsdl11Definition = new DefaultWsdl11Definition();
        wsdl11Definition.setPortTypeName("HelloPort");
        wsdl11Definition.setLocationUri("/ws");
        wsdl11Definition.setTargetNamespace("http://example.com/hello");
        wsdl11Definition.setSchema(schema);
        return wsdl11Definition;
    }

    @Bean
    public XsdSchema helloSchema() {
        return new SimpleXsdSchema(new ClassPathResource("hello.xsd"));
    }
    
    @PayloadRoot(namespace = "http://example.com/hello", localPart = "SayHelloRequest")
    @ResponsePayload
    public SayHelloResponse sayHello(@RequestPayload SayHelloRequest request) {
        SayHelloResponse response = new SayHelloResponse();
        response.setMessage("Hello " + request.getName() + "!");
        return response;
    }
}

以上代碼中，我們配置了一個基於XSD Schema的WebService。通過向/messageDispatcherServlet的URL中添加請求參數，我們可以訪問該Webservice。

三、集成Spring Security

Spring Security可以有效地保護我們的WebService。我們可以使用Spring Security中提供的@Secured註解和@RolesAllowed註解來定義訪問控制。例如：

@Configuration
@EnableWsSecurity
public class WebServiceSecurityConfig extends WssConfigurerAdapter {

    @Autowired
    private UserDetailsService userDetailsService;

    @Autowired
    public void configureGlobal(AuthenticationManagerBuilder auth) throws Exception {
        auth.userDetailsService(userDetailsService).passwordEncoder(passwordEncoder());
    }

    @Bean
    public PasswordEncoder passwordEncoder() {
        return new BCryptPasswordEncoder();
    }

    @Override
    public void configure(WebSecurity web) throws Exception {
        web.ignoring().antMatchers("/ws/**");
    }

    @Override
    public void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests()
                .antMatchers("/ws/**").hasAnyRole("ADMIN", "USER")
                .anyRequest().authenticated()
                .and().httpBasic()
                .and().sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS)
                .and().csrf().disable();
    }
    
    @PayloadRoot(namespace = "http://example.com/hello", localPart = "SayHelloRequest")
    @Secured("ROLE_USER")
    @ResponsePayload
    public SayHelloResponse sayHello(@RequestPayload SayHelloRequest request, @AuthenticationPrincipal User user) {
        SayHelloResponse response = new SayHelloResponse();
        response.setMessage("Hello " + request.getName() + " from " + user.getUsername() + "!");
        return response;
    }
}

以上代碼中，我們配置了基於角色的訪問控制，並使用@AuthenticationPrincipal註解來獲取當前用戶信息。此外，我們還禁用了CSRF保護，並對所有請求啟用了session。

四、集成Actuator

Actuator可以為我們提供一些有用的信息，例如應用程序的健康狀況和運行狀態。我們可以通過在pom.xml中添加對spring-boot-starter-actuator的依賴來啟用Actuator。例如：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

啟用Actuator後，我們可以通過訪問/actuator/health或/actuator/info來獲取應用程序的健康狀況和一些基本信息。例如：

{
    "status": "UP",
    "hello": {
        "status": "UP",
        "helloService": {
            "status": "UP",
            "description": "HelloService is running!"
        }
    },
    "diskSpace": {
        "status": "UP",
        "total": 499963174912,
        "free": 169225228288,
        "threshold": 10485760
    }
}

五、總結

通過本文，我們詳細地介紹了spring-boot-starter-web-servic的使用方法，並且從集成Spring Security和Actuator兩個方面對其進行了更加深入的探討。通過使用spring-boot-starter-web-servic，我們可以輕鬆構建基於SOAP協議的Web Services，並為其提供全面的保護和管理。