Java Spring Boot project version

Question

I need to take the version value in my spring boot project to create a service that returns that value, the value in question would be version in build.Radle.

group = 'br.com.xxxxx'
version = '0.0.2'
sourceCompatibility = 1.8

I have tried several ways as for example:

ProjectInfoProperties.Build.class.getPackage().getImplementationVersion()

follows below my Gradle:

buildscript {

ext {
    springBootVersion = '1.5.9.RELEASE'
}
repositories {
    mavenCentral()
}
dependencies {
    classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
    classpath "io.spring.gradle:dependency-management-plugin:1.0.3.RELEASE"
}

But that only brings me to the spring boot version. Anyone who can help me, thank you.

Answer 1

Yes, it is possible. Spring has a bean called BuildProperties, that has some project information, such as version number.

For that, you need the following:

1) a) If the project is Maven, add the following to the pom.xml:

<plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    <executions>
        <execution>
            <id>build-info</id>
            <goals>
                <goal>build-info</goal>
            </goals>
        </execution>
    </executions>
</plugin>

b) If the project is Gradle, add the following to the build.gradle:

springBoot {
    buildInfo()
}

When building the project, Spring will generate on the way \build\resources\main\META-INF the file build-info.properties and make available for injection the bean BuildProperties, which, among other methods, has the method getVersion(), that returns the version.

That’s what code is about, however, if you run the project through the IDE (which is most likely), you may get a bean error not found. To resolve this, if your IDE is Intellij, go to Edit > Settings > Build, Execution, Deployment > Gradle (ou Maven, depende do seu projeto) > Runner and click the option Delegate IDE build/run actions to Gradle (or Maven). That’s because the Gradle/Maven task that generates the file build-info.properties is the bootBuildInfo, which is not the standard task that Intellij uses, hence the error.

When executing System.out.println(build.getVersion()); in a test project following the steps I described, I received as output the version that is informed in build.gradle of the project:

//0.0.1-SNAPSHOT

A useful article can be found here.

Answer 2

An interesting alternative to this situation is the following:

Add to build.gradle:

springBoot {    
    buildInfo() 
}

At source, to get the information:

@Autowired
private BuildProperties buildProperties;

For example, to get the version:

String version = buildProperties.getVersion();