Comment partager des propriétés communes entre plusieurs projets Maven?
J'ai plusieurs projets construits par maven, et je veux partager certaines propriétés communes entre eux - version printemps, version du pilote mysql, URL de base svn, etc. - donc je peux les mettre à jour une fois et cela se reflétera sur tous les projets.
J'ai pensé à avoir un seul super pom avec toutes les propriétés, mais si je change l'un des problèmes, j'ai besoin soit d'incrémenter sa version (et de mettre à jour tous les poms qui en héritent) soit de le supprimer de toutes les machines des développeurs qui Je ne veux pas faire.
Peut spécifier ces paramètres en externe au pom? Je veux toujours avoir la définition de l'emplacement externe dans un pom parent.
Notez que l'idée originale que j'ai ici est quelque chose que je fais, mais que j'ai peut-être trouvé une bien meilleure idée que j'ai également énumérée ci-dessous. Je voulais garder les deux idées ici pour être complètes au cas où la nouvelle idée fonctionnerait pas
Je pense que vous pouvez résoudre ce problème en utilisant le pom parent, mais vous devez avoir un référentiel maven et un outil de construction CI.
J'ai plusieurs projets qui héritent tous des propriétés de base d'un POM parent. Nous utilisons Java 1.5, pour que la propriété de construction y soit configurée. Tout est UTF-8. Tous les rapports que je souhaite exécuter, la configuration du sondeur, etc., se trouvent à l'intérieur du POM parent.
En supposant que votre projet est en contrôle de version et que vous disposez d'un outil CI, lorsque vous vous connectez, votre outil CI peut générer un projet POM et déployer le SNAPSHOT dans le référentiel maven. Si vos projets pointent vers la version INSTANTANÉE du POM parent, ils vérifieront le référentiel pour valider qu'ils ont la dernière version ... sinon ils téléchargent la dernière version. Donc, si vous mettez à jour le parent, tous les autres projets seront mis à jour.
L'astuce, je suppose, est de publier avec un INSTANTANÉ. Je dirais que vos sorties vont arriver beaucoup moins souvent que vos changements. Vous effectuez donc une version de votre POM, puis mettez à jour vos POM qui en héritent et vérifiez-les dans le contrôle de version. Faites savoir aux développeurs qu'ils doivent effectuer une mise à jour et partir de là.
Vous pouvez simplement y déclencher des builds forçant les nouveaux POM dans le référentiel, puis demander à tous les développeurs de récupérer automatiquement les modifications lors de la build.
J'ai supprimé l'idée des mots clés LATEST/RELEASE car ils ne fonctionnent pas pour les POM parents. Ils ne fonctionnent que pour les dépendances ou les plugins. La zone à problème se trouve dans DefaultMavenProjectBuilder. Essentiellement, il a du mal à déterminer quel référentiel rechercher le parent pour déterminer quelle est la dernière version ou la version la plus récente. Je ne sais pas pourquoi cela est différent pour les dépendances ou les plugins.
Il semble que ceux-ci seraient moins douloureux que d'avoir à mettre à jour les POM à chaque changement du POM parent.
Ce que vous pouvez faire est d'utiliser le plugin Properties Maven . Cela vous permettra de définir vos propriétés dans un fichier externe et le plugin lira ce fichier.
Avec cette configuration:
<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>properties-maven-plugin</artifactId>
<version>1.0-alpha-1</version>
<executions>
<execution>
<phase>initialize</phase>
<goals>
<goal>read-project-properties</goal>
</goals>
<configuration>
<files>
<file>my-file.properties</file>
</files>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
et si vous en avez, dans votre fichier de propriétés, les lignes suivantes:
spring-version=1.0
mysql-version=4.0.0
alors c'est la même chose que si vous écriviez, dans votre pom.xml, les lignes suivantes:
<properties>
<spring-version>1.0</spring-version>
<mysql-version>4.0.0</mysql-version>
</properties>
En utilisant ce plugin, vous aurez plusieurs avantages:
- Définissez facilement une longue liste de propriétés
- Modifiez les valeurs de ces propriétés sans modifier le parent pom.xml.
Je pense que le plugin properties-maven est la bonne approche à long terme, mais comme vous avez répondu à cette réponse, il ne permet pas d'hériter des propriétés. Il existe certaines fonctionnalités dans maven-shared-io qui vous permettent de découvrir des ressources sur le chemin de classe du projet. J'ai inclus du code ci-dessous qui étend le plugin de propriétés pour trouver des fichiers de propriétés dans les dépendances du plugin.
La configuration déclare un chemin d'accès à un fichier de propriétés, car le projet de descripteur est déclaré dans la configuration du plug-in, il est accessible à ClasspathResourceLocatorStrategy. La configuration peut être définie dans un projet parent et sera héritée par tous les projets enfants (si vous faites cela, évitez de déclarer des fichiers car ils ne seront pas découverts, définissez uniquement la propriété filePaths).
La configuration ci-dessous suppose qu'il existe un autre projet jar nommé name.seller.rich:test-properties-descriptor:0.0.1 qui a un fichier appelé external.properties emballé dans le jar (c'est-à-dire qu'il a été défini dans src/main/resources) .
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>properties-ext-maven-plugin</artifactId>
<version>0.0.1</version>
<executions>
<execution>
<id>read-properties</id>
<phase>initialize</phase>
<goals>
<goal>read-project-properties</goal>
</goals>
</execution>
</executions>
<configuration>
<filePaths>
<filePath>external.properties</filePath>
</filePaths>
</configuration>
<dependencies>
<!-- declare any jars that Host the required properties files here -->
<dependency>
<groupId>name.seller.rich</groupId>
<artifactId>test-properties-descriptor</artifactId>
<version>0.0.1</version>
</dependency>
</dependencies>
</plugin>
Le pom du projet de plugin ressemble à ceci:
<project xmlns="http://maven.Apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.Apache.org/POM/4.0.0 http://maven.Apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.codehaus.mojo</groupId>
<artifactId>properties-ext-maven-plugin</artifactId>
<packaging>maven-plugin</packaging>
<version>0.0.1</version>
<dependencies>
<dependency>
<groupId>org.codehaus.mojo</groupId>
<artifactId>properties-maven-plugin</artifactId>
<version>1.0-alpha-1</version>
</dependency>
<dependency>
<groupId>org.Apache.maven.shared</groupId>
<artifactId>maven-shared-io</artifactId>
<version>1.1</version>
</dependency>
</dependencies>
</project>
Le mojo est une copie des ReadPropertiesMojo du plugin de propriétés, avec une propriété supplémentaire "filePaths" pour vous permettre de définir le chemin relatif vers le fichier de propriétés externes dans le chemin de classe, il rend la propriété files facultative et ajoute les readPropertyFiles () et getLocation () pour localiser les fichiers et fusionner tout chemin de fichier dans le tableau de fichiers avant de continuer. J'ai commenté mes modifications pour les rendre plus claires.
package org.codehaus.mojo.xml;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.Apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import Java.io.File;
import Java.io.FileInputStream;
import Java.io.IOException;
import Java.util.ArrayList;
import Java.util.Enumeration;
import Java.util.List;
import Java.util.Properties;
import org.Apache.maven.plugin.AbstractMojo;
import org.Apache.maven.plugin.MojoExecutionException;
import org.Apache.maven.project.MavenProject;
import org.Apache.maven.shared.io.location.ClasspathResourceLocatorStrategy;
import org.Apache.maven.shared.io.location.FileLocatorStrategy;
import org.Apache.maven.shared.io.location.Location;
import org.Apache.maven.shared.io.location.Locator;
import org.Apache.maven.shared.io.location.LocatorStrategy;
import org.Apache.maven.shared.io.location.URLLocatorStrategy;
import org.codehaus.plexus.util.cli.CommandLineUtils;
/**
* The read-project-properties goal reads property files and stores the
* properties as project properties. It serves as an alternate to specifying
* properties in pom.xml.
*
* @author <a href="mailto:[email protected]">Zarar Siddiqi</a>
* @author <a href="mailto:[email protected]">Krystian Nowak</a>
* @version $Id: ReadPropertiesMojo.Java 8861 2009-01-21 15:35:38Z pgier $
* @goal read-project-properties
*/
public class ReadPropertiesMojo extends AbstractMojo {
/**
* @parameter default-value="${project}"
* @required
* @readonly
*/
private MavenProject project;
/**
* The properties files that will be used when reading properties.
* RS: made optional to avoid issue for inherited plugins
* @parameter
*/
private File[] files;
//Begin: RS addition
/**
* Optional paths to properties files to be used.
*
* @parameter
*/
private String[] filePaths;
//End: RS addition
/**
* If the plugin should be quiet if any of the files was not found
*
* @parameter default-value="false"
*/
private boolean quiet;
public void execute() throws MojoExecutionException {
//Begin: RS addition
readPropertyFiles();
//End: RS addition
Properties projectProperties = new Properties();
for (int i = 0; i < files.length; i++) {
File file = files[i];
if (file.exists()) {
try {
getLog().debug("Loading property file: " + file);
FileInputStream stream = new FileInputStream(file);
projectProperties = project.getProperties();
try {
projectProperties.load(stream);
} finally {
if (stream != null) {
stream.close();
}
}
} catch (IOException e) {
throw new MojoExecutionException(
"Error reading properties file "
+ file.getAbsolutePath(), e);
}
} else {
if (quiet) {
getLog().warn(
"Ignoring missing properties file: "
+ file.getAbsolutePath());
} else {
throw new MojoExecutionException(
"Properties file not found: "
+ file.getAbsolutePath());
}
}
}
boolean useEnvVariables = false;
for (Enumeration n = projectProperties.propertyNames(); n
.hasMoreElements();) {
String k = (String) n.nextElement();
String p = (String) projectProperties.get(k);
if (p.indexOf("${env.") != -1) {
useEnvVariables = true;
break;
}
}
Properties environment = null;
if (useEnvVariables) {
try {
environment = CommandLineUtils.getSystemEnvVars();
} catch (IOException e) {
throw new MojoExecutionException(
"Error getting system envorinment variables: ", e);
}
}
for (Enumeration n = projectProperties.propertyNames(); n
.hasMoreElements();) {
String k = (String) n.nextElement();
projectProperties.setProperty(k, getPropertyValue(k,
projectProperties, environment));
}
}
//Begin: RS addition
/**
* Obtain the file from the local project or the classpath
*
* @throws MojoExecutionException
*/
private void readPropertyFiles() throws MojoExecutionException {
if (filePaths != null && filePaths.length > 0) {
File[] allFiles;
int offset = 0;
if (files != null && files.length != 0) {
allFiles = new File[files.length + filePaths.length];
System.arraycopy(files, 0, allFiles, 0, files.length);
offset = files.length;
} else {
allFiles = new File[filePaths.length];
}
for (int i = 0; i < filePaths.length; i++) {
Location location = getLocation(filePaths[i], project);
try {
allFiles[offset + i] = location.getFile();
} catch (IOException e) {
throw new MojoExecutionException(
"unable to open properties file", e);
}
}
// replace the original array with the merged results
files = allFiles;
} else if (files == null || files.length == 0) {
throw new MojoExecutionException(
"no files or filePaths defined, one or both must be specified");
}
}
//End: RS addition
/**
* Retrieves a property value, replacing values like ${token} using the
* Properties to look them up. Shamelessly adapted from:
* http://maven.Apache.
* org/plugins/maven-war-plugin/xref/org/Apache/maven/plugin
* /war/PropertyUtils.html
*
* It will leave unresolved properties alone, trying for System properties,
* and environment variables and implements reparsing (in the case that the
* value of a property contains a key), and will not loop endlessly on a
* pair like test = ${test}
*
* @param k
* property key
* @param p
* project properties
* @param environment
* environment variables
* @return resolved property value
*/
private String getPropertyValue(String k, Properties p,
Properties environment) {
String v = p.getProperty(k);
String ret = "";
int idx, idx2;
while ((idx = v.indexOf("${")) >= 0) {
// append prefix to result
ret += v.substring(0, idx);
// strip prefix from original
v = v.substring(idx + 2);
idx2 = v.indexOf("}");
// if no matching } then bail
if (idx2 < 0) {
break;
}
// strip out the key and resolve it
// resolve the key/value for the ${statement}
String nk = v.substring(0, idx2);
v = v.substring(idx2 + 1);
String nv = p.getProperty(nk);
// try global environment
if (nv == null) {
nv = System.getProperty(nk);
}
// try environment variable
if (nv == null && nk.startsWith("env.") && environment != null) {
nv = environment.getProperty(nk.substring(4));
}
// if the key cannot be resolved,
// leave it alone ( and don't parse again )
// else prefix the original string with the
// resolved property ( so it can be parsed further )
// taking recursion into account.
if (nv == null || nv.equals(nk)) {
ret += "${" + nk + "}";
} else {
v = nv + v;
}
}
return ret + v;
}
//Begin: RS addition
/**
* Use various strategies to discover the file.
*/
public Location getLocation(String path, MavenProject project) {
LocatorStrategy classpathStrategy = new ClasspathResourceLocatorStrategy();
List strategies = new ArrayList();
strategies.add(classpathStrategy);
strategies.add(new FileLocatorStrategy());
strategies.add(new URLLocatorStrategy());
List refStrategies = new ArrayList();
refStrategies.add(classpathStrategy);
Locator locator = new Locator();
locator.setStrategies(strategies);
Location location = locator.resolve(path);
return location;
}
//End: RS addition
}