Get Maven artifact version at runtime

Question

I have noticed that in a Maven artifact s JAR  the project version attribute is included in two files   META-INF maven   groupId    artifactId  pom properties META-INF maven   groupId    artifactId  pom xml   Is there a recommended way to read this version at runtime

User · Answer

I am using maven-assembly-plugin for my maven packaging  The usage of Apache Maven Archiver in Joachim Sauer s answer could also work    lt plugin gt       lt groupId gt org apache maven plugins lt  groupId gt       lt artifactId gt maven-assembly-plugin lt  artifactId gt       lt configuration gt           lt descriptorRefs gt               lt descriptorRef gt jar-with-dependencies lt  descriptorRef gt           lt  descriptorRefs gt           lt archive gt               lt manifest gt                   lt addDefaultImplementationEntries gt true lt  addDefaultImplementationEntries gt                   lt addDefaultSpecificationEntries gt true lt  addDefaultSpecificationEntries gt               lt  manifest gt           lt  archive gt       lt  configuration gt       lt executions gt           lt execution      gt       lt  executions gt   lt  plugin gt    Because archiever is one of maven shared components  it could be used by multiple maven building plugins  which could also have conflict if two or more plugins introduced  including archive configuration inside

User · Answer

You should not need to access Maven-specific files to get the version information of any given library class   You can simply use getClass   getPackage   getImplementationVersion   to get the version information that is stored in a  jar-files MANIFEST MF  Luckily Maven is smart enough Unfortunately Maven does not write the correct information to the manifest as well by default   Instead one has to modify the  lt archive gt  configuration element of the maven-jar-plugin to set addDefaultImplementationEntries and addDefaultSpecificationEntries to true  like this    lt plugin gt       lt groupId gt org apache maven plugins lt  groupId gt       lt artifactId gt maven-jar-plugin lt  artifactId gt       lt configuration gt           lt archive gt                                  lt manifest gt                   lt addDefaultImplementationEntries gt true lt  addDefaultImplementationEntries gt                   lt addDefaultSpecificationEntries gt true lt  addDefaultSpecificationEntries gt               lt  manifest gt           lt  archive gt       lt  configuration gt   lt  plugin gt    Ideally this configuration should be put into the company pom or another base-pom   Detailed documentation of the  lt archive gt  element can be found in the Maven Archive documentation

User · Answer

Java 8 variant for EJB in war file with maven project  Tested on EAP 7 0    Log4j    lombok annotation  Startup  Singleton public class ApplicationLogic        public static final String DEVELOPMENT APPLICATION NAME    application        public static final String DEVELOPMENT GROUP NAME    com group        private static final String POM PROPERTIES LOCATION     META-INF maven     DEVELOPMENT GROUP NAME         DEVELOPMENT APPLICATION NAME     pom properties           In case no pom properties file was generated or wrong location is configured  no pom properties loading is done  otherwise VERSION will be assigned later     public static String VERSION    No pom properties file present in folder     POM PROPERTIES LOCATION       private static final String VERSION ERROR    Version could not be determinated                      Optional ofNullable getClass   getResourceAsStream POM PROPERTIES LOCATION   ifPresent p - gt                 Properties properties   new Properties                 try                    properties load p                    VERSION   properties getProperty  version   VERSION ERROR                  catch  Exception e                     VERSION   VERSION ERROR                   log fatal  Unexpected error occured during loading process of pom properties file in META-INF folder

User · Answer

Here s a method for getting the version from the pom properties  falling back to getting it from the 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

User · Answer

I spent some time on the two main approaches here and they didn t work-out for me    I am using Netbeans for the builds  may be there s more going on there   I had some errors and warnings from Maven 3 with some constructs  but I think those were easy to correct   No biggie   I did find an answer that looks maintainable and simple to implement in this article on DZone    Stamping Version Number and Build Time in a Properties File with Maven   I already have a resources config sub-folder  and I named my file  app properties  to better reflect the kind of stuff we may keep there  like a support URL  etc     The only caveat is that Netbeans gives a warning that the IDE needs filtering off   Not sure where how   It has no effect at this point   Perhaps there s a work around for that if I need to cross that bridge   Best of luck

User · Answer

To get this running in Eclipse  as well as in a Maven build  you should add the addDefaultImplementationEntries and addDefaultSpecificationEntries pom entries as described in other replies  then use the following code   public synchronized static final String getVersion            Try to get version number from pom xml  available in Eclipse      try           String className   getClass   getName            String classfileName         className replace               class           URL classfileResource   getClass   getResource classfileName           if  classfileResource    null                Path absolutePackagePath   Paths get classfileResource toURI                         getParent                int packagePathSegments   className length                       - className replace          length                   Remove package segments from path  plus two more levels                for  target classes   which is the standard location for                classes in Eclipse              Path path   absolutePackagePath              for  int i   0  segmentsToRemove   packagePathSegments   2                      i  lt  segmentsToRemove  i                      path   path getParent                              Path pom   path resolve  pom xml                try  InputStream is   Files newInputStream pom                     Document doc   DocumentBuilderFactory newInstance                            newDocumentBuilder   parse is                   doc getDocumentElement   normalize                    String version    String  XPathFactory newInstance                            newXPath   compile   project version                            evaluate doc  XPathConstants STRING                   if  version    null                        version   version trim                        if   version isEmpty                              return version                                                                        catch  Exception e               Ignore               Try to get version number from maven properties in jar s META-INF     try  InputStream is   getClass            getResourceAsStream   META-INF maven     MAVEN PACKAGE                         MAVEN ARTIFACT     pom properties              if  is    null                Properties p   new Properties                p load is               String version   p getProperty  version       trim                if   version isEmpty                      return version                                catch  Exception e               Ignore               Fallback to using Java API to get version from MANIFEST MF     String version   null      Package pkg   getClass   getPackage        if  pkg    null            version   pkg getImplementationVersion            if  version    null                version   pkg getSpecificationVersion                        version   version    null        version trim        return version isEmpty      unknown    version      If your Java build puts target classes somewhere other than  target classes   then you may need to adjust the value of segmentsToRemove

User · Answer

A simple solution which is Maven compatible and works for any  thus also third party  class       private static Optional lt String gt  getVersionFromManifest Class lt   gt  clazz            try               File file   new File clazz getProtectionDomain   getCodeSource   getLocation   toURI                 if  file isFile                      JarFile jarFile   new JarFile file                   Manifest manifest   jarFile getManifest                    Attributes attributes   manifest getMainAttributes                    final String version   attributes getValue  Bundle-Version                    return Optional of version                           catch  Exception e                   ignore                   return Optional empty

User · Answer

If you happen to use Spring Boot you can make use of the BuildProperties class  Take the following snippet from our OpenAPI configuration class as an example   Configuration  RequiredArgsConstructor     lt - lombok public class OpenApi        private final BuildProperties buildProperties      lt - you can also autowire it       Bean     public OpenAPI yourBeautifulAPI             return new OpenAPI   info new Info                title buildProperties getName                 description  quot The description quot                version buildProperties getVersion                 license new License   name  quot Your company quot

User · Answer

On my spring boot application  the solution from the accepted answer worked until I recently updated my jdk to version 12  Tried all the other answers as well and couldn t get that to work   At that point  I added the below line to the first class of my spring boot application  just after the annotation  SpringBootApplication   PropertySources             PropertySource   META-INF maven com my group my-artefact pom properties        Later I use the below to get the value from the properties file in whichever class I want to use its value and appVersion gets the project version to me    Value    version    private String appVersion    Hope that helps someone

User · Answer

I know it s a very late answer but I d like to share what I did as per this link  I added the below code to the pom xml           lt plugin gt               lt groupId gt org springframework boot lt  groupId gt               lt artifactId gt spring-boot-maven-plugin lt  artifactId gt               lt executions gt                   lt execution gt                       lt id gt build-info lt  id gt                       lt goals gt                           lt goal gt build-info lt  goal gt                       lt  goals gt                   lt  execution gt               lt  executions gt           lt  plugin gt   And this Advice Controller in order to get the version as model attribute  import java io IOException  import org slf4j Logger  import org slf4j LoggerFactory  import org springframework beans factory annotation Autowired  import org springframework boot info BuildProperties  import org springframework web bind annotation ControllerAdvice  import org springframework web bind annotation ModelAttribute    ControllerAdvice public class CommonControllerAdvice           Autowired        BuildProperties buildProperties               ModelAttribute  quot version quot          public String getVersion   throws IOException                    String version   buildProperties getVersion              return version

User · Answer

To follow up the answer above  for a  war artifact  I found I had to apply the equivalent configuration to maven-war-plugin  rather than maven-jar-plugin    lt plugin gt       lt artifactId gt maven-war-plugin lt  artifactId gt       lt version gt 2 1 lt  version gt       lt configuration gt           lt archive gt                                  lt manifest gt                   lt addDefaultImplementationEntries gt true lt  addDefaultImplementationEntries gt                   lt addDefaultSpecificationEntries gt true lt  addDefaultSpecificationEntries gt               lt  manifest gt           lt  archive gt       lt  configuration gt   lt  plugin gt    This added the version information to MANIFEST MF in the project s  jar  included in WEB-INF lib of the  war

[java] Get Maven artifact version at runtime

Examples related to java

Examples related to maven-2