Obtenir la version de l'artefact Maven au moment de l'exécution

Question

J'ai remarqué que dans le JAR d'un artefact Maven, l'attribut project.version est inclus dans deux fichiers :

META-INF/maven/${groupId}/${artifactId}/pom.properties
META-INF/maven/${groupId}/${artifactId}/pom.xml

Existe-t-il un moyen recommandé de lire cette version au moment de l'exécution ?

Answer 1

Vous ne devriez pas avoir besoin d'accéder aux fichiers spécifiques à Maven pour obtenir les informations de version d'une bibliothèque/classe donnée.

Vous pouvez simplement utiliser getClass().getPackage().getImplementationVersion() pour obtenir les informations de version stockées dans un fichier .jar. MANIFEST.MF . Heureusement, Maven est assez intelligent Malheureusement, Maven n'écrit pas les informations correctes dans le manifeste par défaut !

Au lieu de cela, il faut modifier le <archive> de l'élément de configuration de l maven-jar-plugin pour fixer addDefaultImplementationEntries y addDefaultSpecificationEntries a true comme ceci :

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <configuration>
        <archive>                   
            <manifest>
                <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
                <addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
            </manifest>
        </archive>
    </configuration>
</plugin>

Idéalement, cette configuration devrait être placée dans la société pom ou une autre base-pom.

Une documentation détaillée de la <archive> se trouve dans l'élément Documentation sur les archives Maven .

Answer 2

Pour faire suite à la réponse ci-dessus, pour un .war je me suis aperçu que je devais appliquer la configuration équivalente à maven-war-plugin plutôt que maven-jar-plugin :

<plugin>
    <artifactId>maven-war-plugin</artifactId>
    <version>2.1</version>
    <configuration>
        <archive>                   
            <manifest>
                <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
                <addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
            </manifest>
        </archive>
    </configuration>
</plugin>

Cela a ajouté l'information sur la version à MANIFEST.MF dans le cadre du projet .jar (inclus dans WEB-INF/lib de la .war )

Answer 3

Voici une méthode pour obtenir la version à partir du pom.properties, en revenant à l'obtenir à partir du manifest.

public synchronized String getVersion() {
    String version = null;

    // try to load from maven properties first
    try {
        Properties p = new Properties();
        InputStream is = getClass().getResourceAsStream("/META-INF/maven/com.my.group/my-artefact/pom.properties");
        if (is != null) {
            p.load(is);
            version = p.getProperty("version", "");
        }
    } catch (Exception e) {
        // ignore
    }

    // fallback to using Java API
    if (version == null) {
        Package aPackage = getClass().getPackage();
        if (aPackage != null) {
            version = aPackage.getImplementationVersion();
            if (version == null) {
                version = aPackage.getSpecificationVersion();
            }
        }
    }

    if (version == null) {
        // we could not compute the version so use a blank
        version = "";
    }

    return version;
}

Answer 4

J'utilise maven-assembly-plugin pour mon packaging maven. L'utilisation de Apache Maven Archiver en La réponse de Joachim Sauer pourrait également fonctionner :

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-assembly-plugin</artifactId>
    <configuration>
        <descriptorRefs>
            <descriptorRef>jar-with-dependencies</descriptorRef>
        </descriptorRefs>
        <archive>
            <manifest>
                <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
                <addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
            </manifest>
        </archive>
    </configuration>
    <executions>
        <execution .../>
    </executions>
</plugin>

Parce que Archiever est l'un des composants partagés maven il pourrait être utilisé par plusieurs plugins de construction maven, ce qui pourrait également entraîner des conflits si deux ou plusieurs plugins sont introduits, notamment archive configuration à l'intérieur.

Answer 5

Si vous utilisez Spring Boot, vous pouvez utiliser la fonction BuildProperties classe.

Prenez l'extrait suivant de notre classe de configuration OpenAPI comme exemple :

@Configuration
@RequiredArgsConstructor // <- lombok
public class OpenApi {

    private final BuildProperties buildProperties; // <- you can also autowire it

    @Bean
    public OpenAPI yourBeautifulAPI() {
        return new OpenAPI().info(new Info()
            .title(buildProperties.getName())
            .description("The description")
            .version(buildProperties.getVersion())
            .license(new License().name("Your company")));
    }
}