浅谈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，并为其提供全面的保护和管理。