mirror of
https://github.com/spring-projects/spring-boot.git
synced 2024-06-30 00:36:49 +08:00
Polish use of the term starter in documentation
Use of the term "starter" was sometimes quoted but sometimes was not, sometimes used proper case and sometimes lowercase. This commit improves consistency by removing quotes and using lowercase.
This commit is contained in:
Scott Frederick
parent
55ac058385
commit
24a8bbd82f
|
|
@ -39,7 +39,7 @@ Ubuntu users can run `sudo apt-get install maven`.
|
|||
Windows users with https://chocolatey.org/[Chocolatey] can run `choco install maven` from an elevated (administrator) prompt.
|
||||
|
||||
Spring Boot dependencies use the `org.springframework.boot` group id.
|
||||
Typically, your Maven POM file inherits from the `spring-boot-starter-parent` project and declares dependencies to one or more xref:reference:using/build-systems.adoc#using.build-systems.starters["`Starters`"].
|
||||
Typically, your Maven POM file inherits from the `spring-boot-starter-parent` project and declares dependencies to one or more xref:reference:using/build-systems.adoc#using.build-systems.starters[starters].
|
||||
Spring Boot also provides an optional xref:maven-plugin:index.adoc[Maven plugin] to create executable jars.
|
||||
|
||||
More details on getting started with Spring Boot and Maven can be found in the xref:maven-plugin:getting-started.adoc[Getting Started section] of the Maven plugin's reference guide.
|
||||
|
|
@ -53,7 +53,7 @@ Spring Boot is compatible with Gradle 7.x (7.5 or later) and 8.x.
|
|||
If you do not already have Gradle installed, you can follow the instructions at https://gradle.org.
|
||||
|
||||
Spring Boot dependencies can be declared by using the `org.springframework.boot` `group`.
|
||||
Typically, your project declares dependencies to one or more xref:reference:using/build-systems.adoc#using.build-systems.starters["`Starters`"].
|
||||
Typically, your project declares dependencies to one or more xref:reference:using/build-systems.adoc#using.build-systems.starters[starters].
|
||||
Spring Boot provides a useful xref:gradle-plugin:index.adoc[Gradle plugin] that can be used to simplify dependency declarations and to create executable jars.
|
||||
|
||||
.Gradle Wrapper
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
= Enabling Production-ready Features
|
||||
|
||||
The {code-spring-boot}/spring-boot-project/spring-boot-actuator[`spring-boot-actuator`] module provides all of Spring Boot's production-ready features.
|
||||
The recommended way to enable the features is to add a dependency on the `spring-boot-starter-actuator` "`Starter`".
|
||||
The recommended way to enable the features is to add a dependency on the `spring-boot-starter-actuator` starter.
|
||||
|
||||
.Definition of Actuator
|
||||
****
|
||||
|
|
@ -10,7 +10,7 @@ An actuator is a manufacturing term that refers to a mechanical device for movin
|
|||
Actuators can generate a large amount of motion from a small change.
|
||||
****
|
||||
|
||||
To add the actuator to a Maven-based project, add the following "`Starter`" dependency:
|
||||
To add the actuator to a Maven-based project, add the following starter dependency:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
|
|
|
|||
|
|
@ -27,11 +27,11 @@ Spring Boot also provides auto-configuration for the InfluxDB client but it is d
|
|||
https://redis.io/[Redis] is a cache, message broker, and richly-featured key-value store.
|
||||
Spring Boot offers basic auto-configuration for the https://github.com/lettuce-io/lettuce-core/[Lettuce] and https://github.com/xetorthio/jedis/[Jedis] client libraries and the abstractions on top of them provided by https://github.com/spring-projects/spring-data-redis[Spring Data Redis].
|
||||
|
||||
There is a `spring-boot-starter-data-redis` "`Starter`" for collecting the dependencies in a convenient way.
|
||||
There is a `spring-boot-starter-data-redis` starter for collecting the dependencies in a convenient way.
|
||||
By default, it uses https://github.com/lettuce-io/lettuce-core/[Lettuce].
|
||||
That starter handles both traditional and reactive applications.
|
||||
|
||||
TIP: We also provide a `spring-boot-starter-data-redis-reactive` "`Starter`" for consistency with the other stores with reactive support.
|
||||
TIP: We also provide a `spring-boot-starter-data-redis-reactive` starter for consistency with the other stores with reactive support.
|
||||
|
||||
|
||||
|
||||
|
|
@ -95,7 +95,7 @@ spring:
|
|||
== MongoDB
|
||||
|
||||
https://www.mongodb.com/[MongoDB] is an open-source NoSQL document database that uses a JSON-like schema instead of traditional table-based relational data.
|
||||
Spring Boot offers several conveniences for working with MongoDB, including the `spring-boot-starter-data-mongodb` and `spring-boot-starter-data-mongodb-reactive` "`Starters`".
|
||||
Spring Boot offers several conveniences for working with MongoDB, including the `spring-boot-starter-data-mongodb` and `spring-boot-starter-data-mongodb-reactive` starters.
|
||||
|
||||
|
||||
|
||||
|
|
@ -220,7 +220,7 @@ TIP: For complete details of Spring Data MongoDB, including its rich object mapp
|
|||
== Neo4j
|
||||
|
||||
https://neo4j.com/[Neo4j] is an open-source NoSQL graph database that uses a rich data model of nodes connected by first class relationships, which is better suited for connected big data than traditional RDBMS approaches.
|
||||
Spring Boot offers several conveniences for working with Neo4j, including the `spring-boot-starter-data-neo4j` "`Starter`".
|
||||
Spring Boot offers several conveniences for working with Neo4j, including the `spring-boot-starter-data-neo4j` starter.
|
||||
|
||||
|
||||
|
||||
|
|
@ -263,7 +263,7 @@ You could take the JPA example from earlier and define `City` as Spring Data Neo
|
|||
|
||||
include-code::CityRepository[]
|
||||
|
||||
The `spring-boot-starter-data-neo4j` "`Starter`" enables the repository support as well as transaction management.
|
||||
The `spring-boot-starter-data-neo4j` starter enables the repository support as well as transaction management.
|
||||
Spring Boot supports both classic and reactive Neo4j repositories, using the `Neo4jTemplate` or `ReactiveNeo4jTemplate` beans.
|
||||
When Project Reactor is available on the classpath, the reactive style is also auto-configured.
|
||||
|
||||
|
|
@ -293,7 +293,7 @@ Spring Boot supports several clients:
|
|||
* The official Java API client
|
||||
* The `ReactiveElasticsearchClient` provided by Spring Data Elasticsearch
|
||||
|
||||
Spring Boot provides a dedicated "`Starter`", `spring-boot-starter-data-elasticsearch`.
|
||||
Spring Boot provides a dedicated starter, `spring-boot-starter-data-elasticsearch`.
|
||||
|
||||
|
||||
|
||||
|
|
@ -419,7 +419,7 @@ You can choose to disable the repositories support with the following property:
|
|||
|
||||
https://cassandra.apache.org/[Cassandra] is an open source, distributed database management system designed to handle large amounts of data across many commodity servers.
|
||||
Spring Boot offers auto-configuration for Cassandra and the abstractions on top of it provided by {url-spring-data-cassandra-site}[Spring Data Cassandra].
|
||||
There is a `spring-boot-starter-data-cassandra` "`Starter`" for collecting the dependencies in a convenient way.
|
||||
There is a `spring-boot-starter-data-cassandra` starter for collecting the dependencies in a convenient way.
|
||||
|
||||
|
||||
|
||||
|
|
@ -520,7 +520,7 @@ TIP: For complete details of Spring Data Cassandra, see the https://docs.spring.
|
|||
|
||||
https://www.couchbase.com/[Couchbase] is an open-source, distributed, multi-model NoSQL document-oriented database that is optimized for interactive applications.
|
||||
Spring Boot offers auto-configuration for Couchbase and the abstractions on top of it provided by https://github.com/spring-projects/spring-data-couchbase[Spring Data Couchbase].
|
||||
There are `spring-boot-starter-data-couchbase` and `spring-boot-starter-data-couchbase-reactive` "`Starters`" for collecting the dependencies in a convenient way.
|
||||
There are `spring-boot-starter-data-couchbase` and `spring-boot-starter-data-couchbase-reactive` starters for collecting the dependencies in a convenient way.
|
||||
|
||||
|
||||
|
||||
|
|
@ -605,14 +605,14 @@ https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol[LDAP] (Light
|
|||
Spring Boot offers auto-configuration for any compliant LDAP server as well as support for the embedded in-memory LDAP server from https://ldap.com/unboundid-ldap-sdk-for-java/[UnboundID].
|
||||
|
||||
LDAP abstractions are provided by https://github.com/spring-projects/spring-data-ldap[Spring Data LDAP].
|
||||
There is a `spring-boot-starter-data-ldap` "`Starter`" for collecting the dependencies in a convenient way.
|
||||
There is a `spring-boot-starter-data-ldap` starter for collecting the dependencies in a convenient way.
|
||||
|
||||
|
||||
|
||||
[[data.nosql.ldap.connecting]]
|
||||
=== Connecting to an LDAP Server
|
||||
|
||||
To connect to an LDAP server, make sure you declare a dependency on the `spring-boot-starter-data-ldap` "`Starter`" or `spring-ldap-core` and then declare the URLs of your server in your application.properties, as shown in the following example:
|
||||
To connect to an LDAP server, make sure you declare a dependency on the `spring-boot-starter-data-ldap` starter or `spring-ldap-core` and then declare the URLs of your server in your application.properties, as shown in the following example:
|
||||
|
||||
[configprops,yaml]
|
||||
----
|
||||
|
|
|
|||
|
|
@ -125,7 +125,7 @@ If HikariCP is available, we always choose it.
|
|||
. Otherwise, if https://commons.apache.org/proper/commons-dbcp/[Commons DBCP2] is available, we use it.
|
||||
. If none of HikariCP, Tomcat, and DBCP2 are available and if Oracle UCP is available, we use it.
|
||||
|
||||
NOTE: If you use the `spring-boot-starter-jdbc` or `spring-boot-starter-data-jpa` "`starters`", you automatically get a dependency to `HikariCP`.
|
||||
NOTE: If you use the `spring-boot-starter-jdbc` or `spring-boot-starter-data-jpa` starters, you automatically get a dependency to `HikariCP`.
|
||||
|
||||
You can bypass that algorithm completely and specify the connection pool to use by setting the configprop:spring.datasource.type[] property.
|
||||
This is especially important if you run your application in a Tomcat container, as `tomcat-jdbc` is provided by default.
|
||||
|
|
|
|||
|
|
@ -585,7 +585,7 @@ If you need a secure way to store credentials and passwords, the https://cloud.s
|
|||
https://yaml.org[YAML] is a superset of JSON and, as such, is a convenient format for specifying hierarchical configuration data.
|
||||
The `SpringApplication` class automatically supports YAML as an alternative to properties whenever you have the https://github.com/snakeyaml/snakeyaml[SnakeYAML] library on your classpath.
|
||||
|
||||
NOTE: If you use "`Starters`", SnakeYAML is automatically provided by `spring-boot-starter`.
|
||||
NOTE: If you use starters, SnakeYAML is automatically provided by `spring-boot-starter`.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ Spring Boot uses https://commons.apache.org/logging[Commons Logging] for all int
|
|||
Default configurations are provided for {apiref-openjdk}/java.logging/java/util/logging/package-summary.html[Java Util Logging], https://logging.apache.org/log4j/2.x/[Log4j2], and https://logback.qos.ch/[Logback].
|
||||
In each case, loggers are pre-configured to use console output with optional file output also available.
|
||||
|
||||
By default, if you use the "`Starters`", Logback is used for logging.
|
||||
By default, if you use the starters, Logback is used for logging.
|
||||
Appropriate Logback routing is also included to ensure that dependent libraries that use Java Util Logging, Commons Logging, Log4J, or SLF4J all work correctly.
|
||||
|
||||
TIP: There are a lot of logging frameworks available for Java.
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ Additionally, {url-spring-boot-for-apache-geode-site}[Spring Boot for Apache Geo
|
|||
TIP: If the `CacheManager` is auto-configured by Spring Boot, it is possible to _force_ a particular cache provider by setting the configprop:spring.cache.type[] property.
|
||||
Use this property if you need to xref:io/caching.adoc#io.caching.provider.none[use no-op caches] in certain environments (such as tests).
|
||||
|
||||
TIP: Use the `spring-boot-starter-cache` "`Starter`" to quickly add basic caching dependencies.
|
||||
TIP: Use the `spring-boot-starter-cache` starter to quickly add basic caching dependencies.
|
||||
The starter brings in `spring-context-support`.
|
||||
If you add dependencies manually, you must include `spring-context-support` in order to use the JCache or Caffeine support.
|
||||
|
||||
|
|
@ -79,7 +79,7 @@ A `CacheManager` wrapping all beans of that type is created.
|
|||
[[io.caching.provider.jcache]]
|
||||
=== JCache (JSR-107)
|
||||
|
||||
https://jcp.org/en/jsr/detail?id=107[JCache] is bootstrapped through the presence of a `javax.cache.spi.CachingProvider` on the classpath (that is, a JSR-107 compliant caching library exists on the classpath), and the `JCacheCacheManager` is provided by the `spring-boot-starter-cache` "`Starter`".
|
||||
https://jcp.org/en/jsr/detail?id=107[JCache] is bootstrapped through the presence of a `javax.cache.spi.CachingProvider` on the classpath (that is, a JSR-107 compliant caching library exists on the classpath), and the `JCacheCacheManager` is provided by the `spring-boot-starter-cache` starter.
|
||||
Various compliant libraries are available, and Spring Boot provides dependency management for Ehcache 3, Hazelcast, and Infinispan.
|
||||
Any other compliant library can be added as well.
|
||||
|
||||
|
|
@ -204,7 +204,7 @@ include-code::MyRedisCacheManagerConfiguration[]
|
|||
=== Caffeine
|
||||
|
||||
https://github.com/ben-manes/caffeine[Caffeine] is a Java 8 rewrite of Guava's cache that supersedes support for Guava.
|
||||
If Caffeine is present, a `CaffeineCacheManager` (provided by the `spring-boot-starter-cache` "`Starter`") is auto-configured.
|
||||
If Caffeine is present, a `CaffeineCacheManager` (provided by the `spring-boot-starter-cache` starter) is auto-configured.
|
||||
Caches can be created on startup by setting the configprop:spring.cache.cache-names[] property and can be customized by one of the following (in the indicated order):
|
||||
|
||||
. A cache spec defined by `spring.cache.caffeine.spec`
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
[[io.quartz]]
|
||||
= Quartz Scheduler
|
||||
|
||||
Spring Boot offers several conveniences for working with the https://www.quartz-scheduler.org/[Quartz scheduler], including the `spring-boot-starter-quartz` "`Starter`".
|
||||
Spring Boot offers several conveniences for working with the https://www.quartz-scheduler.org/[Quartz scheduler], including the `spring-boot-starter-quartz` starter.
|
||||
If Quartz is available, a `Scheduler` is auto-configured (through the `SchedulerFactoryBean` abstraction).
|
||||
|
||||
Beans of the following types are automatically picked up and associated with the `Scheduler`:
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
|
||||
The Advanced Message Queuing Protocol (AMQP) is a platform-neutral, wire-level protocol for message-oriented middleware.
|
||||
The Spring AMQP project applies core Spring concepts to the development of AMQP-based messaging solutions.
|
||||
Spring Boot offers several conveniences for working with AMQP through RabbitMQ, including the `spring-boot-starter-amqp` "`Starter`".
|
||||
Spring Boot offers several conveniences for working with AMQP through RabbitMQ, including the `spring-boot-starter-amqp` starter.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ https://pulsar.apache.org/[Apache Pulsar] is supported by providing auto-configu
|
|||
Spring Boot will auto-configure and register the classic (imperative) Spring for Apache Pulsar components when `org.springframework.pulsar:spring-pulsar` is on the classpath.
|
||||
It will do the same for the reactive components when `org.springframework.pulsar:spring-pulsar-reactive` is on the classpath.
|
||||
|
||||
There are `spring-boot-starter-pulsar` and `spring-boot-starter-pulsar-reactive` "`Starters`" for conveniently collecting the dependencies for imperative and reactive use, respectively.
|
||||
There are `spring-boot-starter-pulsar` and `spring-boot-starter-pulsar-reactive` starters for conveniently collecting the dependencies for imperative and reactive use, respectively.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
[[messaging.spring-integration]]
|
||||
= Spring Integration
|
||||
|
||||
Spring Boot offers several conveniences for working with {url-spring-integration-site}[Spring Integration], including the `spring-boot-starter-integration` "`Starter`".
|
||||
Spring Boot offers several conveniences for working with {url-spring-integration-site}[Spring Integration], including the `spring-boot-starter-integration` starter.
|
||||
Spring Integration provides abstractions over messaging and also other transports such as HTTP, TCP, and others.
|
||||
If Spring Integration is available on your classpath, it is initialized through the `@EnableIntegration` annotation.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
Spring Boot provides a number of utilities and annotations to help when testing your application.
|
||||
Test support is provided by two modules: `spring-boot-test` contains core items, and `spring-boot-test-autoconfigure` supports auto-configuration for tests.
|
||||
|
||||
Most developers use the `spring-boot-starter-test` "`Starter`", which imports both Spring Boot test modules as well as JUnit Jupiter, AssertJ, Hamcrest, and a number of other useful libraries.
|
||||
Most developers use the `spring-boot-starter-test` starter, which imports both Spring Boot test modules as well as JUnit Jupiter, AssertJ, Hamcrest, and a number of other useful libraries.
|
||||
|
||||
[TIP]
|
||||
====
|
||||
|
|
|
|||
|
|
@ -9,6 +9,6 @@ Often, you need to move beyond unit testing and start integration testing (with
|
|||
It is useful to be able to perform integration testing without requiring deployment of your application or needing to connect to other infrastructure.
|
||||
|
||||
The Spring Framework includes a dedicated test module for such integration testing.
|
||||
You can declare a dependency directly to `org.springframework:spring-test` or use the `spring-boot-starter-test` "`Starter`" to pull it in transitively.
|
||||
You can declare a dependency directly to `org.springframework:spring-test` or use the `spring-boot-starter-test` starter to pull it in transitively.
|
||||
|
||||
If you have not used the `spring-test` module before, you should start by reading the {url-spring-framework-docs}/testing.html[relevant section] of the Spring Framework reference documentation.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
[[testing.test-scope-dependencies]]
|
||||
= Test Scope Dependencies
|
||||
|
||||
The `spring-boot-starter-test` "`Starter`" (in the `test` `scope`) contains the following provided libraries:
|
||||
The `spring-boot-starter-test` starter (in the `test` `scope`) contains the following provided libraries:
|
||||
|
||||
* https://junit.org/junit5/[JUnit 5]: The de-facto standard for unit testing Java applications.
|
||||
* {url-spring-framework-docs}/testing/integration.html[Spring Test] & Spring Boot Test: Utilities and integration test support for Spring Boot applications.
|
||||
|
|
|
|||
|
|
@ -273,7 +273,7 @@ When it does so, the orders shown in the following table will be used:
|
|||
== Embedded Reactive Server Support
|
||||
|
||||
Spring Boot includes support for the following embedded reactive web servers: Reactor Netty, Tomcat, Jetty, and Undertow.
|
||||
Most developers use the appropriate “Starter” to obtain a fully configured instance.
|
||||
Most developers use the appropriate starter to obtain a fully configured instance.
|
||||
By default, the embedded server listens for HTTP requests on port 8080.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -506,7 +506,7 @@ Both the servlet and the filter registrations can be given init parameters by us
|
|||
== Embedded Servlet Container Support
|
||||
|
||||
For servlet application, Spring Boot includes support for embedded https://tomcat.apache.org/[Tomcat], https://www.eclipse.org/jetty/[Jetty], and https://github.com/undertow-io/undertow[Undertow] servers.
|
||||
Most developers use the appropriate "`Starter`" to obtain a fully configured instance.
|
||||
Most developers use the appropriate starter to obtain a fully configured instance.
|
||||
By default, the embedded server listens for HTTP requests on port `8080`.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -178,8 +178,8 @@ For simplicity, we continue to use a plain text editor for this example.
|
|||
[[getting-started.first-application.dependencies]]
|
||||
== Adding Classpath Dependencies
|
||||
|
||||
Spring Boot provides a number of "`Starters`" that let you add jars to your classpath.
|
||||
"`Starters`" provide dependencies that you are likely to need when developing a specific type of application.
|
||||
Spring Boot provides a number of starters that let you add jars to your classpath.
|
||||
Starters provide dependencies that you are likely to need when developing a specific type of application.
|
||||
|
||||
|
||||
|
||||
|
|
@ -297,7 +297,7 @@ Since `spring-boot-starter-web` added Tomcat and Spring MVC, the auto-configurat
|
|||
|
||||
.Starters and Auto-configuration
|
||||
****
|
||||
Auto-configuration is designed to work well with "`Starters`", but the two concepts are not directly tied.
|
||||
Auto-configuration is designed to work well with starters, but the two concepts are not directly tied.
|
||||
You are free to pick and choose jar dependencies outside of the starters.
|
||||
Spring Boot still does its best to auto-configure your application.
|
||||
****
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user