Play Framework 2: leggere la versione dell'applicazione definita in Build.scala

Question

Uso Play Framework 2.0 (2.0.3). Ho un progetto Java e voglio leggere la versione dell'applicazione (appVersion) definita in Build.scala.

Quello che ho già visto è che è possibile leggere determinati dettagli di configurazione dall'oggetto Application fornito a Global.java, ma non ha trovato una chiave denominata appVersion o simile.

Answer 1

È possibile definire la versione in application.conf e lasciare Build.scala leggere il valore. L'ho fatto con il numero di versione e il nome dell'applicazione. I seguenti lavori in Play 2.0, c'è un aggiornamento solution for Play 2.1.

In project/Build.scala, caricare la configurazione e ottenere le proprietà:

val conf = play.api.Configuration.load(new File(".")) 
val appName = conf.getString("app.name").getOrElse("unnamed application") 
val appVersion = conf.getString("app.version").getOrElse("0.0.0") 

In conf/application.conf definire le proprietà:

app.version = 1.0 
app.name = My Application 

Infine nella vostra applicazione sarà accessibile con

Play.application().configuration().getString("app.version") 

---

La sintassi di configurazione ha abbastanza alcune caratteristiche, così si può anche andare un po 'più pazzo con i vostri nomi di versione o di applicazione:

app { 
    major = 1 
    minor = 2 
    revision = 3 
    version = ${app.major}.${app.minor}.${app.revision} 
    name = My Application ${app.major}.${app.minor} 
} 

Answer 2

è possibile ottenere la versione attuale del gioco utilizzando:

play.core.PlayVersion.current(); 

Answer 3

uso il SBT BuildInfo plugin per questo scopo:

import sbtbuildinfo.Plugin._ 

val main = PlayProject(appName, appVersion, appDependencies, mainLang = SCALA, settings = Defaults.defaultSettings ++ buildInfoSettings).settings(

    buildInfoKeys := Seq[Scoped](name, appVersion, scalaVersion, sbtVersion), 
    buildInfoPackage := "org.foo.bar", 

    ... 

) 

Questo genera un oggetto org.foo.bar.BuildInfo che è quindi possibile chiamare dal codice sorgente:

org.foo.bar.BuildInfo.version 

È anche possibile definire personalizzato chiavi nella build e aggiungili a buildInfoKeys, che è molto utile se la tua build diventa più complessa.

Answer 4

In questo modo è possibile ottenere la versione dell'applicazione Play e il nome dell'applicazione definiti nel build.sbt

name := "myApp" 
version :="1.0.4" 

Avviso questo funziona solo in modalità PROD. In modalità dev SBT condivide un'istanza JVM con l'applicazione e tali chiamate restituiscono qualcosa di diverso.

Application.class.getPackage().getImplementationTitle());  // returns "myApp" 
Application.class.getPackage().getImplementationVersion()); // returns "1.0.4" 

In questa classe caso di applicazione è una classe definita nel progetto. Può essere qualsiasi classe dal tuo progetto.

UPDATE

ho notato che questo metodo non funziona out of the box for Gioca> = 2.4.x

Per risolvere il problema aggiungere questo alla tua build.sbt

packageOptions += Package.ManifestAttributes(
    "Implementation-Version" -> (version in ThisBuild).value, 
    "Implementation-Title" -> name.value 
) 

Le due proprietà verrà aggiunta al MANIFEST.FM file nel costruire così il titolo del pacchetto e la versione possono essere letti dal codice.

FYI: Io uso SBT confezionatore nativo

addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "1.0.3")