Spring

https://spring.io/
Admin
Spring is an open-source application framework for Java that provides a comprehensive programming...
Tokens:6,008,598
Snippets:47,120
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### Clone the gs-spring-boot sample repository

Source: https://spring.io/blog/2020/05/13/introduction-to-azure-spring-cloud-with-intellij-idea/

Clones the Spring Boot getting started guide repository, which contains the sample project used throughout the tutorial. The final project is in the 'complete' subfolder.

```bash
git clone [email protected]:spring-guides/gs-spring-boot.git
```

--------------------------------

### Clone the gs-rest-service repository

Source: https://spring.io/guides/gs/intellij-idea/

Use this command to clone the Spring Getting Started guide repository for the REST Service example. This provides the code needed to import into IntelliJ IDEA.

```bash
$ git clone https://github.com/spring-guides/gs-rest-service.git
```

--------------------------------

### Start the demo with docker-compose up

Source: https://spring.io/blog/2019/08/16/securing-services-with-spring-cloud-gateway/

Starts all three servers (Resource Server, Gateway, and UAA) using Docker Compose. Expect a lot of output while the servers start up.

```bash
$> docker-compose up
```

--------------------------------

### Expected startup output

Source: https://spring.io/blog/2020/04/16/spring-tips-the-graalvm-native-image-builder-feature/

Example log output showing the application started in 0.099 seconds, demonstrating the fast startup of a native image.

```text
2020-04-15 23:25:08.826  INFO 7692 --- [           main] c.example.reactive.ReactiveApplication   : Started ReactiveApplication in 0.099 seconds (JVM running for 0.103)
```

--------------------------------

### Gradle build setup for Spring Cloud Brixton

Source: https://spring.io/blog/2016/05/11/spring-cloud-brixton-release-is-available/

Alternative to Maven for getting started with Brixton.RELEASE. Applies the Spring Boot plugin and imports the spring-cloud-dependencies BOM.

```groovy
buildscript {
  dependencies {
    classpath("org.springframework.boot:spring-boot-gradle-plugin:1.3.5.RELEASE")
  }
}
repositories {
  maven {
    mavenCentral()
  }
}
apply plugin: 'spring-boot'

dependencyManagement {
  imports {
    mavenBom 'org.springframework.cloud:spring-cloud-dependencies:Brixton.RELEASE'
  }
}

dependencies {
    compile 'org.springframework.cloud:spring-cloud-starter-config'
    compile 'org.springframework.cloud:spring-cloud-starter-eureka'
    //...
}
```

--------------------------------

### Set up working directory

Source: https://spring.io/blog/2011/07/18/social-coding-pull-requests-what-to-do-when-things-get-complicated/

Clone the main repo into a 'work' directory and checkout origin/master to start making changes.

```bash
$ git clone repo work
$ cd work
$ git checkout origin/master
```

--------------------------------

### Add Jib Gradle plugin with buildscript block

Source: https://spring.io/blog/2018/11/08/spring-boot-in-a-container/

Add the Jib Gradle plugin using the older buildscript style used in Getting Started Guides. Includes repositories and classpath dependencies.

```groovy
buildscript {
    repositories {
      maven {
        url "https://plugins.gradle.org/m2/"
      }
      mavenCentral()
    }
    dependencies {
        classpath('org.springframework.boot:spring-boot-gradle-plugin:2.0.5.RELEASE')
        classpath('com.google.cloud.tools.jib:com.google.cloud.tools.jib.gradle.plugin:0.9.11')
    }
}
```

--------------------------------

### Install the welcome add-on

Source: https://spring.io/blog/2010/07/16/spring-roo-1-1-0-m2-released/

Command to install the welcome add-on using its bundle symbolic name, after untrusting the PGP key.

```bash
osgi obr start --bundleSymbolicName org.springframework.samples.roo.welcome
```

--------------------------------

### Install RabbitMQ Server on Ubuntu

Source: https://spring.io/blog/2010/08/23/rabbitmq-plugin-for-grails-early-access/

Installs RabbitMQ server and configures it to start on boot.

```bash
sudo apt-get install rabbitmq-server
```

--------------------------------

### Checkout and build the configuration-basic sample project

Source: https://spring.io/blog/2009/12/22/configuration-simplifications-in-spring-3-0/

Commands to check out the sample project from SVN and run its tests with Maven. The output shows a successful build with one test run and no failures.

```bash
svn co https://src.springframework.org/svn/spring-samples/configuration-basic/trunk configuration-basic
cd configuration-basic
mvn clean test
```

```text
[...]
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
```

```text
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------------
```

--------------------------------

### Functional web endpoint route example

Source: https://spring.io/blog/2016/09/21/spring-framework-5-0-m2-released/

Teaser example of a functional web endpoint using RouterFunction and route(GET(...), ...) to handle a GET request to /hello-world and return a response with the body 'Hello World'.

```java
RouterFunction<String> route =
    route(GET("/hello-world"),
        request -> Response.ok().body(fromObject("Hello World")));
```

--------------------------------

### Composing request predicates with and()

Source: https://spring.io/blog/2016/09/22/new-in-spring-5-functional-web-framework/

Shows composing request predicates using and() to require both HTTP method GET and a specific path. The example routes GET '/hello-world' and GET '/the-answer'.

```java
RouterFunction<?> route =
  route(method(HttpMethod.GET).and(path("/hello-world")), 
    request -> Response.ok().body(fromObject("Hello World")))
  .and(route(method(HttpMethod.GET).and(path("/the-answer")), 
    request -> Response.ok().body(fromObject("42"))));
```

--------------------------------

### Build and run with Maven

Source: https://spring.io/guides/gs/multi-module/

Run these two commands in sequence to build the library and then start the application using Maven. The application will be available at http://localhost:8080/.

```bash
$ ./mvnw install && ./mvnw spring-boot:run -pl application
```

--------------------------------

### Maven build log showing stub jar installation

Source: https://spring.io/blog/2016/07/25/spring-cloud-contract-1-0-0-m1-released/

Example output from the Maven build. The key line is the installation of the http-server-0.0.1-SNAPSHOT-stubs.jar to the local repository, confirming that the stubs have been installed.

```text
[INFO] --- spring-cloud-contract-maven-plugin:1.0.0.BUILD-SNAPSHOT:generateStubs (default-generateStubs) @ http-server ---
[INFO] Building jar: /some/path/http-server/target/http-server-0.0.1-SNAPSHOT-stubs.jar
[INFO]
[INFO] --- maven-jar-plugin:2.6:jar (default-jar) @ http-server ---
[INFO] Building jar: /some/path/http-server/target/http-server-0.0.1-SNAPSHOT.jar
[INFO]
[INFO] --- spring-boot-maven-plugin:1.4.0.BUILD-SNAPSHOT:repackage (default) @ http-server ---
[INFO]
[INFO] --- maven-install-plugin:2.5.2:install (default-install) @ http-server ---
[INFO] Installing /some/path/http-server/target/http-server-0.0.1-SNAPSHOT.jar to /path/to/your/.m2/repository/com/example/http-server/0.0.1-SNAPSHOT/http-server-0.0.1-SNAPSHOT.jar
[INFO] Installing /some/path/http-server/pom.xml to /path/to/your/.m2/repository/com/example/http-server/0.0.1-SNAPSHOT/http-server-0.0.1-SNAPSHOT.pom
[INFO] Installing /some/path/http-server/target/http-server-0.0.1-SNAPSHOT-stubs.jar to /path/to/your/.m2/repository/com/example/http-server/0.0.1-SNAPSHOT/http-server-0.0.1-SNAPSHOT-stubs.jar
```

--------------------------------

### Application Startup Logs

Source: https://spring.io/guides/gs/spring-boot-docker/

Example output showing the application starting with the 'spring' user, confirming the non-root user configuration.

```text
 :: Spring Boot ::                (v4.1.1)

2026-09-30T12:47:53.827Z  INFO 1 --- [           main] hello.Application                        : Starting Application v0.0.1-SNAPSHOT using Java 17.0.19 with PID 1 (/app.jar started by spring in /)
...
```

--------------------------------

### Build and run with Gradle

Source: https://spring.io/guides/gs/multi-module/

Run these two commands in sequence to build the library and then start the application using Gradle. The application will be available at http://localhost:8080/.

```bash
$ ./gradlew build && ./gradlew :application:bootRun
```

--------------------------------

### Enable Feign Clients and Define a Simple Client

Source: https://spring.io/projects/spring-cloud-openfeign/

Use @EnableFeignClients on a Spring Boot application to scan for Feign client interfaces. The @FeignClient("name") annotation declares a client for the service named 'name', and the @RequestMapping("/") method maps to the root path. This example is from the Getting Started section.

```java
@SpringBootApplication
@EnableFeignClients
public class WebApplication {

	public static void main(String[] args) {
		SpringApplication.run(WebApplication.class, args);
	}

	@FeignClient("name")
	static interface NameService {
		@RequestMapping("/")
		public String getName();
	}
}

```

--------------------------------

### Install and run Scripted with npm

Source: https://spring.io/blog/2013/03/05/scripted-0-4-released/

Quick start for Scripted 0.4: install globally via npm and run a file. Requires node/npm.

```bash
  npm install -g scripted
scr foo.js
```

--------------------------------

### Starter project tree

Source: https://spring.io/blog/2014/03/07/deploying-spring-boot-applications/

Shows the unzipped starter project structure with pom.xml and the demo package containing Application.java and ApplicationTests.java.

```sh
➜  pwd
/Users/jlong/Downloads/starter
➜  starter  tree
.
├── pom.xml
└── src
    ├── main
    │   └── java
    │       └── demo
    │           └── Application.java
    └── test
        └── java
            └── demo
                └── ApplicationTests.java

7 directories, 3 files
➜  starter  
```
Tokens:
Raw