Minimize Jetty and Tomcat runtimes' dependencies

wilkinsona · wilkinsona · commit f3d41bfddb7b · 2025-11-19T11:29:40.000Z
diff --git a/build-plugin/spring-boot-gradle-plugin/src/docs/antora/modules/gradle-plugin/examples/packaging/war-container-dependency.gradle b/build-plugin/spring-boot-gradle-plugin/src/docs/antora/modules/gradle-plugin/examples/packaging/war-container-dependency.gradle
@@ -24,6 +24,6 @@ apply plugin: 'io.spring.dependency-management'
 // tag::dependencies[]
 dependencies {
 	implementation('org.springframework.boot:spring-boot-starter-web')
-	providedRuntime('org.springframework.boot:spring-boot-tomcat-runtime')
+	providedRuntime('org.springframework.boot:spring-boot-starter-tomcat-runtime')
 }
 // end::dependencies[]
diff --git a/build-plugin/spring-boot-gradle-plugin/src/docs/antora/modules/gradle-plugin/examples/packaging/war-container-dependency.gradle.kts b/build-plugin/spring-boot-gradle-plugin/src/docs/antora/modules/gradle-plugin/examples/packaging/war-container-dependency.gradle.kts
@@ -8,6 +8,6 @@ apply(plugin = "io.spring.dependency-management")
 // tag::dependencies[]
 dependencies {
 	implementation("org.springframework.boot:spring-boot-starter-web")
-	providedRuntime("org.springframework.boot:spring-boot-tomcat-runtime")
+	providedRuntime("org.springframework.boot:spring-boot-starter-tomcat-runtime")
 }
 // end::dependencies[]
diff --git a/documentation/spring-boot-docs/src/docs/antora/modules/how-to/pages/deployment/traditional-deployment.adoc b/documentation/spring-boot-docs/src/docs/antora/modules/how-to/pages/deployment/traditional-deployment.adoc
@@ -41,6 +41,11 @@ If you use Maven, the following example marks the servlet runtime (Tomcat, in th
 ----
 <dependencies>
 	<!-- ... -->
+	<dependency>
+		<groupId>org.springframework.boot</groupId>
+		<artifactId>spring-boot-starter-tomcat-runtime</artifactId>
+		<scope>provided</scope>
+	</dependency>
 	<dependency>
 		<groupId>org.springframework.boot</groupId>
 		<artifactId>spring-boot-tomcat-runtime</artifactId>
@@ -50,17 +55,21 @@ If you use Maven, the following example marks the servlet runtime (Tomcat, in th
 </dependencies>
 ----
 
+NOTE: If you are not using Spring Boot's starters, only `spring-boot-tomcat-runtime` needs to be declared in `provided` scope.
+
 If you use Gradle, the following example marks the servlet runtime (Tomcat, in this case) as being provided:
 
 [source,gradle]
 ----
 dependencies {
 	// ...
-	providedRuntime 'org.springframework.boot:spring-boot-tomcat-runtime'
+	providedRuntime 'org.springframework.boot:spring-boot-starter-tomcat-runtime'
 	// ...
 }
 ----
 
+NOTE: If you are not using Spring Boot's starters, declare a `providedRuntime` dependency on `spring-boot-tomcat-runtime` instead.
+
 TIP: `providedRuntime` is preferred to Gradle's `compileOnly` configuration.
 Among other limitations, `compileOnly` dependencies are not on the test classpath, so any web-based integration tests fail.
 
diff --git a/module/spring-boot-jetty-runtime/build.gradle b/module/spring-boot-jetty-runtime/build.gradle
@@ -35,14 +35,4 @@ dependencies {
 	api("org.eclipse.jetty.ee11:jetty-ee11-webapp") {
 		exclude group: "org.slf4j",  module: "slf4j-api"
 	}
-	api("org.eclipse.jetty.ee11.websocket:jetty-ee11-websocket-jakarta-server") {
-		exclude group: "jakarta.el",  module: "jakarta.el-api"
-		exclude group: "org.eclipse.jetty", module: "jetty-jndi"
-		exclude group: "org.slf4j",  module: "slf4j-api"
-	}
-	api("org.eclipse.jetty.ee11.websocket:jetty-ee11-websocket-jetty-server") {
-		exclude group: "jakarta.el",  module: "jakarta.el-api"
-		exclude group: "org.eclipse.jetty", module: "jetty-jndi"
-		exclude group: "org.slf4j",  module: "slf4j-api"
-	}
 }
diff --git a/module/spring-boot-jetty/build.gradle b/module/spring-boot-jetty/build.gradle
@@ -36,6 +36,16 @@ dependencies {
 	optional(project(":module:spring-boot-micrometer-metrics"))
 	optional("org.apache.tomcat.embed:tomcat-embed-jasper")
 	optional("org.eclipse.jetty:jetty-alpn-conscrypt-server")
+	optional("org.eclipse.jetty.ee11.websocket:jetty-ee11-websocket-jakarta-server") {
+		exclude group: "jakarta.el",  module: "jakarta.el-api"
+		exclude group: "org.eclipse.jetty", module: "jetty-jndi"
+		exclude group: "org.slf4j",  module: "slf4j-api"
+	}
+	optional("org.eclipse.jetty.ee11.websocket:jetty-ee11-websocket-jetty-server") {
+		exclude group: "jakarta.el",  module: "jakarta.el-api"
+		exclude group: "org.eclipse.jetty", module: "jetty-jndi"
+		exclude group: "org.slf4j",  module: "slf4j-api"
+	}
 	optional("org.eclipse.jetty.http2:jetty-http2-server")
 	optional("org.springframework:spring-webflux")
 
diff --git a/module/spring-boot-tomcat-runtime/build.gradle b/module/spring-boot-tomcat-runtime/build.gradle
@@ -25,8 +25,4 @@ dependencies {
 	api("org.apache.tomcat.embed:tomcat-embed-core") {
 		exclude group: "org.apache.tomcat", module: "tomcat-annotations-api"
 	}
-	api("org.apache.tomcat.embed:tomcat-embed-el")
-	api("org.apache.tomcat.embed:tomcat-embed-websocket") {
-		exclude group: "org.apache.tomcat", module: "tomcat-annotations-api"
-	}
 }
diff --git a/module/spring-boot-tomcat/build.gradle b/module/spring-boot-tomcat/build.gradle
@@ -39,6 +39,9 @@ dependencies {
 	optional(project(":module:spring-boot-micrometer-metrics"))
 	optional("io.micrometer:micrometer-core")
 	optional("org.apache.tomcat.embed:tomcat-embed-jasper")
+	optional("org.apache.tomcat.embed:tomcat-embed-websocket") {
+		exclude group: "org.apache.tomcat", module: "tomcat-annotations-api"
+	}
 	optional("org.springframework:spring-webflux")
 
 	runtimeOnly("jakarta.annotation:jakarta.annotation-api")
diff --git a/platform/spring-boot-dependencies/build.gradle b/platform/spring-boot-dependencies/build.gradle
@@ -2185,6 +2185,7 @@ bom {
 				"spring-boot-starter-jersey",
 				"spring-boot-starter-jersey-test",
 				"spring-boot-starter-jetty",
+				"spring-boot-starter-jetty-runtime",
 				"spring-boot-starter-jms",
 				"spring-boot-starter-jms-test",
 				"spring-boot-starter-jooq",
@@ -2250,6 +2251,7 @@ bom {
 				"spring-boot-starter-thymeleaf",
 				"spring-boot-starter-thymeleaf-test",
 				"spring-boot-starter-tomcat",
+				"spring-boot-starter-tomcat-runtime",
 				"spring-boot-starter-validation",
 				"spring-boot-starter-validation-test",
 				"spring-boot-starter-web",
diff --git a/settings.gradle b/settings.gradle
@@ -283,6 +283,7 @@ include "starter:spring-boot-starter-jdbc-test"
 include "starter:spring-boot-starter-jersey"
 include "starter:spring-boot-starter-jersey-test"
 include "starter:spring-boot-starter-jetty"
+include "starter:spring-boot-starter-jetty-runtime"
 include "starter:spring-boot-starter-jms"
 include "starter:spring-boot-starter-jms-test"
 include "starter:spring-boot-starter-jooq"
@@ -349,6 +350,7 @@ include "starter:spring-boot-starter-test-classic"
 include "starter:spring-boot-starter-thymeleaf"
 include "starter:spring-boot-starter-thymeleaf-test"
 include "starter:spring-boot-starter-tomcat"
+include "starter:spring-boot-starter-tomcat-runtime"
 include "starter:spring-boot-starter-validation"
 include "starter:spring-boot-starter-validation-test"
 include "starter:spring-boot-starter-web"
diff --git a/smoke-test/spring-boot-smoke-test-tomcat-jsp/build.gradle b/smoke-test/spring-boot-smoke-test-tomcat-jsp/build.gradle
@@ -29,7 +29,7 @@ configurations {
 dependencies {
 	implementation(project(":starter:spring-boot-starter-webmvc"))
 
-	providedRuntime(project(":module:spring-boot-tomcat-runtime"))
+	providedRuntime(project(":starter:spring-boot-starter-tomcat-runtime"))
 	providedRuntime("org.glassfish.web:jakarta.servlet.jsp.jstl")
 	providedRuntime("org.apache.tomcat.embed:tomcat-embed-jasper")
 
diff --git a/smoke-test/spring-boot-smoke-test-traditional/build.gradle b/smoke-test/spring-boot-smoke-test-traditional/build.gradle
@@ -29,7 +29,7 @@ configurations {
 dependencies {
 	implementation(project(":starter:spring-boot-starter-webmvc"))
 
-	providedRuntime(project(":module:spring-boot-tomcat-runtime"))
+	providedRuntime(project(":starter:spring-boot-starter-tomcat-runtime"))
 	providedRuntime("org.apache.tomcat.embed:tomcat-embed-jasper")
 
 	testImplementation(project(":module:spring-boot-resttestclient"))
diff --git a/smoke-test/spring-boot-smoke-test-web-jsp/build.gradle b/smoke-test/spring-boot-smoke-test-web-jsp/build.gradle
@@ -29,7 +29,7 @@ configurations {
 dependencies {
 	implementation(project(":starter:spring-boot-starter-webmvc"))
 
-	providedRuntime(project(":module:spring-boot-tomcat-runtime"))
+	providedRuntime(project(":starter:spring-boot-starter-tomcat-runtime"))
 	providedRuntime("org.apache.tomcat.embed:tomcat-embed-jasper")
 	providedRuntime("org.glassfish.web:jakarta.servlet.jsp.jstl")
 
diff --git a/smoke-test/spring-boot-smoke-test-web-static/build.gradle b/smoke-test/spring-boot-smoke-test-web-static/build.gradle
@@ -29,7 +29,7 @@ configurations {
 dependencies {
 	implementation(project(":starter:spring-boot-starter-webmvc"))
 
-	providedRuntime(project(":module:spring-boot-tomcat-runtime"))
+	providedRuntime(project(":starter:spring-boot-starter-tomcat-runtime"))
 
 	runtimeOnly("org.webjars:bootstrap:3.0.3")
 	runtimeOnly("org.webjars:jquery:2.0.3-1")
diff --git a/starter/spring-boot-starter-jetty-runtime/build.gradle b/starter/spring-boot-starter-jetty-runtime/build.gradle
@@ -0,0 +1,47 @@
+/*
+ * Copyright 2012-present the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+plugins {
+	id "org.springframework.boot.starter"
+}
+
+description = "Starter for Jetty Runtime"
+
+dependencies {
+	api("org.apache.tomcat.embed:tomcat-embed-el")
+	api("org.eclipse.jetty.compression:jetty-compression-gzip") {
+		exclude group: "org.slf4j",  module: "slf4j-api"
+	}
+	api("org.eclipse.jetty.compression:jetty-compression-server") {
+		exclude group: "org.slf4j",  module: "slf4j-api"
+	}
+	api("org.eclipse.jetty.ee11:jetty-ee11-servlets") {
+		exclude group: "org.slf4j",  module: "slf4j-api"
+	}
+	api("org.eclipse.jetty.ee11:jetty-ee11-webapp") {
+		exclude group: "org.slf4j",  module: "slf4j-api"
+	}
+	api("org.eclipse.jetty.ee11.websocket:jetty-ee11-websocket-jakarta-server") {
+		exclude group: "jakarta.el",  module: "jakarta.el-api"
+		exclude group: "org.eclipse.jetty", module: "jetty-jndi"
+		exclude group: "org.slf4j",  module: "slf4j-api"
+	}
+	api("org.eclipse.jetty.ee11.websocket:jetty-ee11-websocket-jetty-server") {
+		exclude group: "jakarta.el",  module: "jakarta.el-api"
+		exclude group: "org.eclipse.jetty", module: "jetty-jndi"
+		exclude group: "org.slf4j",  module: "slf4j-api"
+	}
+}
diff --git a/starter/spring-boot-starter-jetty/build.gradle b/starter/spring-boot-starter-jetty/build.gradle
@@ -22,5 +22,6 @@ description = "Starter for using Jetty as the embedded servlet container"
 
 dependencies {
 	api(project(":starter:spring-boot-starter"))
+	api(project(":starter:spring-boot-starter-jetty-runtime"))
 	api(project(":module:spring-boot-jetty"))
 }
diff --git a/starter/spring-boot-starter-tomcat-runtime/build.gradle b/starter/spring-boot-starter-tomcat-runtime/build.gradle
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2012-present the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+plugins {
+	id "org.springframework.boot.starter"
+}
+
+description = "Starter for Tomcat Runtime"
+
+dependencies {
+	api("jakarta.annotation:jakarta.annotation-api")
+	api("org.apache.tomcat.embed:tomcat-embed-core") {
+		exclude group: "org.apache.tomcat", module: "tomcat-annotations-api"
+	}
+	api("org.apache.tomcat.embed:tomcat-embed-el")
+	api("org.apache.tomcat.embed:tomcat-embed-websocket") {
+		exclude group: "org.apache.tomcat", module: "tomcat-annotations-api"
+	}
+}
diff --git a/starter/spring-boot-starter-tomcat/build.gradle b/starter/spring-boot-starter-tomcat/build.gradle
@@ -22,6 +22,6 @@ description = "Starter for using Tomcat"
 
 dependencies {
 	api(project(":starter:spring-boot-starter"))
+	api(project(":starter:spring-boot-starter-tomcat-runtime"))
 	api(project(":module:spring-boot-tomcat"))
-	api("jakarta.annotation:jakarta.annotation-api")
 }
diff --git a/system-test/spring-boot-image-system-tests/src/systemTest/resources/org/springframework/boot/image/paketo/PaketoBuilderTests-executableWarApp.gradle b/system-test/spring-boot-image-system-tests/src/systemTest/resources/org/springframework/boot/image/paketo/PaketoBuilderTests-executableWarApp.gradle
@@ -38,7 +38,7 @@ repositories {
 
 dependencies {
 	implementation("org.springframework.boot:spring-boot-starter-webmvc:{bootVersion}")
-	providedRuntime("org.springframework.boot:spring-boot-tomcat-runtime:{bootVersion}")
+	providedRuntime("org.springframework.boot:spring-boot-starter-tomcat-runtime:{bootVersion}")
 }
 
 bootWar {
diff --git a/system-test/spring-boot-image-system-tests/src/systemTest/resources/org/springframework/boot/image/paketo/PaketoBuilderTests-plainWarApp.gradle b/system-test/spring-boot-image-system-tests/src/systemTest/resources/org/springframework/boot/image/paketo/PaketoBuilderTests-plainWarApp.gradle
@@ -38,6 +38,7 @@ repositories {
 
 dependencies {
 	implementation("org.springframework.boot:spring-boot-starter-webmvc:{bootVersion}")
+	providedRuntime("org.springframework.boot:spring-boot-starter-tomcat-runtime:{bootVersion}")
 }
 
 war {

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,6 @@ apply plugin: 'io.spring.dependency-management'`
`24`	`24`	`// tag::dependencies[]`
`25`	`25`	`dependencies {`
`26`	`26`	`implementation('org.springframework.boot:spring-boot-starter-web')`
`27`		`- providedRuntime('org.springframework.boot:spring-boot-tomcat-runtime')`
	`27`	`+ providedRuntime('org.springframework.boot:spring-boot-starter-tomcat-runtime')`
`28`	`28`	`}`
`29`	`29`	`// end::dependencies[]`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,6 @@ apply(plugin = "io.spring.dependency-management")`
`8`	`8`	`// tag::dependencies[]`
`9`	`9`	`dependencies {`
`10`	`10`	`implementation("org.springframework.boot:spring-boot-starter-web")`
`11`		`- providedRuntime("org.springframework.boot:spring-boot-tomcat-runtime")`
	`11`	`+ providedRuntime("org.springframework.boot:spring-boot-starter-tomcat-runtime")`
`12`	`12`	`}`
`13`	`13`	`// end::dependencies[]`
Original file line number	Diff line number	Diff line change
`@@ -25,8 +25,4 @@ dependencies {`
`25`	`25`	`api("org.apache.tomcat.embed:tomcat-embed-core") {`
`26`	`26`	`exclude group: "org.apache.tomcat", module: "tomcat-annotations-api"`
`27`	`27`	`}`
`28`		`- api("org.apache.tomcat.embed:tomcat-embed-el")`
`29`		`- api("org.apache.tomcat.embed:tomcat-embed-websocket") {`
`30`		`- exclude group: "org.apache.tomcat", module: "tomcat-annotations-api"`
`31`		`- }`
`32`	`28`	`}`