环境:Springboot2.4.12
上一篇:《SpringBoot对Spring MVC都做了哪些事?(三)》
JAX-RS(Jersey)支持
JAX-RS是JAVA EE6 引入的一个新技术。 JAX-RS即Java API for RESTful Web Services,是一个Java 编程语言的应用程序接口,支持按照表述性状态转移(REST)架构风格创建Web服务。JAX-RS使用了Java SE5引入的Java注解来简化Web服务的客户端和服务端的开发和部署。
Jersey RESTful Web Services框架是开源,生产质量的,用于在Java中开发RESTful Web服务的框架,该框架提供对JAX-RS API的支持,并充当JAX-RS( JSR 311和JSR 339 )参考实现。 Jersey框架不只是JAX-RS参考实现。 Jersey提供了自己的API,使用其他功能和实用程序扩展了JAX-RS工具包,以进一步简化RESTful服务和客户端开发。
如果你更喜欢REST端点的JAX-RS编程模型,那么可以使用一种可用的实现,而不是Spring MVC。Jersey和Apache CXF在开箱即用的情况下工作得很好。CXF要求您在应用程序上下文中将其Servlet或过滤器注册为@Bean。Jersey有一些本机的Spring支持,因此我们也在 Spring Boot中为其提供自动配置支持,以及一个启动器。简单说就是如果你就是想使用JAX-RS那么SpringBoot为其提供了自动配置的支持。
在SpringBoot中使用的流程:
- 引入依赖
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-jersey</artifactId></dependency>
- 自定义Endpoint
"/hello")public class Endpoint { public String message() { return "Hello"; }}(
- 资源配置
class JerseyConfig extends ResourceConfig { public JerseyConfig() { register(Endpoint.class); }}
以上配置完成后就可以通过http://xxx:port/hello进行方法接口了。
因为端点是一个Spring @Component,它的生命周期由Spring管理,你可以使用@Autowired注释来注入依赖项,并使用@Value注释来注入外部配置。默认情况下,Jersey servlet被注册并映射到/*。您可以通过添加@ApplicationPath到你的ResourceConfig来更改映射。
// 访问路径:http://xxx:port/api-a/hello@ApplicationPath("/api-a")public class JerseyConfig extends ResourceConfig { public JerseyConfig() { register(Endpoint.class); }}
Servlets, Filters, Listeners
当使用嵌入式servlet容器时,你可以通过使用Spring bean或扫描Servlet组件,从Servlet规范中注册Servlet、Filter和所有Listener(例如HttpSessionListener)。
任何作为Spring bean的Servlet、Filter或Servlet *Listener实例都被注册到嵌入式容器中。如果您想要引用应用程序中的值,这将非常方便。在配置属性。
默认情况下,如果上下文只包含单个Servlet,它将被映射到/。在有多个servlet bean的情况下,bean名被用作路径前缀。过滤器映射到/*。这什么意思,看如下示例:
class ServletConfig { public Servlet1 s1() { return new Servlet1() ; } // 如果不定义访问路径,那么会将该bean的名称作为访问路径 // http://xxx:port/servlet1 @Bean public ServletRegistrationBean<Servlet1> servlet1(Servlet1 s1) { ServletRegistrationBean<Servlet1> servlet = new ServletRegistrationBean<>(s1) ; return servlet ; }}
可以通过:ServletRegistrationBean, FilterRegistrationBean, andServletListenerRegistrationBean分别注册Servlet,Filter,Listener。
通常情况下,让Filter bean处于无序状态是安全的。如果需要特定的顺序,您应该用@Order注释Filter,或者让它实现Ordered。您不能通过使用@Order注释其bean方法来配置Filter的顺序。如果您不能更改Filter类以添加@Order或实现Ordered,那么您必须为Filter定义一个FilterRegistrationBean,并使用setOrder(int)方法设置注册bean的订单。避免配置在Ordered读取请求体的Filter。HIGHEST_PRECEDENCE,因为它可能违反应用程序的字符编码配置。如果Servlet筛选器包装了请求,那么它应该配置一个小于或等于OrderedFilter.REQUEST_WRAPPER_FILTER_MAX_ORDER的顺序。
Servlet上下文初始化
嵌入的servlet容器不会直接执行servlet 3.0+javax.servlet.ServletContainerInitializer接口或Spring的org.springframework.web.WebApplicationInitializer接口。这是一个有意的设计决策,旨在降低第三方库在war中运行可能破坏Spring Boot应用程序的风险。
如果你需要在Spring Boot应用程序中执行servlet上下文初始化,你应该注册一个实现org.springframework.boot.web.servlet.ServletContextInitializer接口的bean。单一的onStartup方法提供了对ServletContext的访问,如果有必要,可以很容易地用作现有WebApplicationInitializer的适配器。
当使用嵌入式容器时,可以通过使用@ServletComponentScan来启用带有@WebServlet、@WebFilter和@WebListener注释的类的自动注册。
ServletWebServerApplicationContext
在内部,Spring Boot使用了不同类型的ApplicationContext来嵌入servlet容器支持。ServletWebServerApplicationContext是一种特殊类型的WebApplicationContext,它通过搜索单个ServletWebServerFactory bean来引导自己。通常TomcatServletWebServerFactory,JettyServletWebServerFactory,或UndertowServletWebServerFactory已经被自动配置。
如果需要通过编程方式配置嵌入式servlet容器,可以注册一个实现WebServerFactoryCustomizer接口的Spring bean。WebServerFactoryCustomizer提供对ConfigurableServletWebServerFactory的访问,其中包括许多定制setter方法。下面的例子显示了如何通过编程方式设置端口:
class CustomizationBean implements WebServerFactoryCustomizer<ConfigurableServletWebServerFactory> { public void customize(ConfigurableServletWebServerFactory server) { server.setPort(9000); }}
TomcatServletWebServerFactory,JettyServletWebServerFactory和UndertowServletWebServerFactory是ConfigurableServletWebServerFactory的专用变体,分别为Tomcat, Jetty和Undertow提供额外的定制setter方法。下面的例子展示了如何自定义TomcatServletWebServerFactory来提供对tomcat特定配置选项的访问:
class TomcatServerCustomizerExample implements WebServerFactoryCustomizer<TomcatServletWebServerFactory> { public void customize(TomcatServletWebServerFactory server) { server.addConnectorCustomizers((tomcatConnector) -> { tomcatConnector.setAsyncTimeout(Duration.ofSeconds(20).toMillis()); tomcatConnector.setURIEncoding("UTF-8"); tomcatConnector.setPort(8088); }); }}