https://github.com/edeandrea/spring-boot-custom-starter-demo

https://github.com/edeandrea/spring-boot-custom-starter-demo

spring spring-boot spring-boot-starter

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/edeandrea/spring-boot-custom-starter-demo
• Owner: edeandrea
• Created: 2019-06-27T21:04:50.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2019-10-04T19:35:20.000Z (over 6 years ago)
• Last Synced: 2025-01-27T08:11:29.519Z (over 1 year ago)
• Topics: spring, spring-boot, spring-boot-starter
• Language: Java
• Size: 147 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
The point of this project is to demonstrate some of the things that a framework library, developed as a custom Spring Boot Starter, could do. This is certainly not exhaustive of things that could be done by a starter library, but its a small "real-world" example of things that are done today within organizations that are looking to put their own organizational opinions on their applications.

These are the things the [custom library](custom-spring-boot-starter) does (see it's own page for specifics):

- Expose a custom set of configurations that applications can use to configure their apps without having to write/maintain any code

- From those configurations

    - Perform all necessary Spring Security configuration on behalf of the application, so the application developer doesn't have to

    - Do some further customization of some of the behavior of the Spring Boot Actuators by setting standard Spring Boot properties

Furthermore, the [custom library](custom-spring-boot-starter) provides all of the above on both the traditional servlet stack as well as the reactive stack. There are 2 sample applications, 1 servlet & 1 reactive, which illustrate this.

## Project Structure

To keep things simple, this repository is set up as a multi-module project. Note that this is really just for ease of use - there aren't any inter-dependencies between the projects. The projects are

- [Servlet Demo](servlet-demo)

    - The servlet version of the Spring Boot application

- [Reactive Demo](reactive-demo)

    - The reactive version of the Spring Boot application

- [Custom Spring Boot Starter](custom-spring-boot-starter)

    - The custom Spring Boot Starter library

- [Custom Tracing Spring Boot Starter](custom-tracing-spring-boot-starter)

    - A custom Spring Boot Starter library implementing distributed tracing via [Zipkin](https://zipkin.io) / [Spring Cloud Sleuth](https://cloud.spring.io/spring-cloud-sleuth/reference/html) / [P6Spy](https://github.com/p6spy/p6spy)

    

Both the [Servlet Demo](servlet-demo) & the [Reactive Demo](reactive-demo) have the exact same behavior. They also have a binary dependency on the [custom Spring Boot Starter](custom-spring-boot-starter) & [custom tracing Spring Boot Starter](custom-tracing-spring-boot-starter). There is no source-level dependency. This is achieved through Gradle's dependency substitution capabilities:

```groovy

configurations.all {

  resolutionStrategy {

    dependencySubstitution {

      substitute module('com.mycompany.myframework:custom-spring-boot-starter:1.0') with project(':custom-spring-boot-starter')

      substitute module('com.mycompany.myframework:custom-tracing-spring-boot-starter:1.0') with project(':custom-tracing-spring-boot-starter')

    }

  }

}

```

The fact that the [custom library](custom-spring-boot-starter) is a child project in the same source tree is irrelevant - its merely for ease of use/distribution so the library didn't have to be published out to some Maven repo in order for it to be consumed.

## Running the applications

Both applications can be run at the same time. They are configured to run on different ports. See the documentation on each application's README for details on curl commands that can be run to demonstrate the functionality.

- [Servlet Demo](servlet-demo)

    - `./gradlew :servlet-demo:bootRun`

    - This will run the application at http://localhost:8080

        - **Actuators**: http://localhost:8080/actuator

- [Reactive Demo](reactive-demo)

    - `./gradlew :reactive-demo:bootRun`

    - This will run the application at http://localhost:8081

        - **Actuators**: http://localhost:8081/actuator