X-Git-Url: https://juplo.de/gitweb/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fde%2Fjuplo%2Fplugins%2Fhibernate4%2FHbm2DdlMojo.java;h=a11860ee3a1ed0919440285bb8a1898b0f64bae3;hb=5ebae356beb162e7bdf2feb44b99afe33638e3f7;hp=7c5cc340d10a1d9304f928b697d3b30f82844257;hpb=08c347e44a4eaeb0c5106f6c03c21f8c4282a14b;p=hibernate4-maven-plugin diff --git a/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java b/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java index 7c5cc340..a11860ee 100644 --- a/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java +++ b/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java @@ -17,37 +17,30 @@ package de.juplo.plugins.hibernate4; */ import com.pyx4j.log4j.MavenLogAppender; -import java.io.File; -import java.io.FileInputStream; -import java.io.IOException; -import java.net.URL; -import java.net.URLClassLoader; -import java.sql.Connection; -import java.sql.Driver; -import java.sql.DriverManager; -import java.sql.DriverPropertyInfo; -import java.sql.SQLException; -import java.sql.SQLFeatureNotSupportedException; -import java.util.Enumeration; -import java.util.HashSet; -import java.util.List; -import java.util.Map.Entry; -import java.util.Properties; -import java.util.Set; -import java.util.logging.Logger; -import javax.persistence.Embeddable; -import javax.persistence.Entity; -import javax.persistence.MappedSuperclass; import org.apache.maven.plugin.AbstractMojo; import org.apache.maven.plugin.MojoExecutionException; import org.apache.maven.plugin.MojoFailureException; import org.apache.maven.project.MavenProject; import org.hibernate.cfg.Configuration; +import org.hibernate.envers.configuration.AuditConfiguration; import org.hibernate.tool.hbm2ddl.SchemaExport; import org.hibernate.tool.hbm2ddl.SchemaExport.Type; import org.hibernate.tool.hbm2ddl.Target; import org.scannotation.AnnotationDB; +import javax.persistence.Embeddable; +import javax.persistence.Entity; +import javax.persistence.MappedSuperclass; +import java.io.*; +import java.math.BigInteger; +import java.net.URL; +import java.net.URLClassLoader; +import java.security.MessageDigest; +import java.sql.*; +import java.util.*; +import java.util.Map.Entry; +import java.util.logging.Logger; + /** * Goal which extracts the hibernate-mapping-configuration and @@ -60,15 +53,21 @@ import org.scannotation.AnnotationDB; */ public class Hbm2DdlMojo extends AbstractMojo { + public final static String EXPORT_SKIPPED_PROPERTY = "hibernate.export.skipped"; + public final static String DRIVER_CLASS = "hibernate.connection.driver_class"; public final static String URL = "hibernate.connection.url"; public final static String USERNAME = "hibernate.connection.username"; public final static String PASSWORD = "hibernate.connection.password"; public final static String DIALECT = "hibernate.dialect"; + public final static String ENVERS = "hibernate.export.envers"; + private final static String MD5S = "schema.md5s"; /** - * The project whose project files to create. + * The maven project. + *

+ * Only needed internally. * * @parameter expression="${project}" * @required @@ -77,19 +76,76 @@ public class Hbm2DdlMojo extends AbstractMojo private MavenProject project; /** - * Directories to scan. + * Build-directory. + *

+ * Only needed internally. + * + * @parameter expression="${project.build.directory}" + * @required + * @readonly + */ + private String buildDirectory; + + /** + * Classes-Directory to scan. + *

+ * This parameter defaults to the maven build-output-directory for classes. + * Additonally, all dependencies are scanned for annotated classes. * * @parameter expression="${project.build.outputDirectory}" */ private String outputDirectory; + /** + * Wether to scan test-classes too, or not. + *

+ * If this parameter is set to true the test-classes of the + * artifact will be scanned for hibernate-annotated classes additionally. + * + * @parameter expression="${hibernate.export.scann_testclasses}" default-value="false" + */ + private boolean scanTestClasses; + + /** + * Test-Classes-Directory to scan. + *

+ * This parameter defaults to the maven build-output-directory for + * test-classes. + *

+ * This parameter is only used, when scanTestClasses is set + * to true! + * + * @parameter expression="${project.build.testOutputDirectory}" + */ + private String testOutputDirectory; + /** * Skip execution + *

+ * If set to true, the execution is skipped. + *

+ * A skipped excecution is signaled via the maven-property + * ${hibernate.export.skipped}. + *

+ * The excecution is skipped automatically, if no modified or newly added + * annotated classes are found and the dialect was not changed. * - * @parameter expression="${maven.test.skip}" + * @parameter expression="${maven.test.skip}" default-value="false" */ private boolean skip; + /** + * Force execution + *

+ * Force execution, even if no modified or newly added annotated classes + * where found and the dialect was not changed. + *

+ * skip takes precedence over force. + * + * @parameter expression="${hibernate.export.force}" default-value="false" + */ + private boolean force; + /** * SQL-Driver name. * @@ -126,7 +182,7 @@ public class Hbm2DdlMojo extends AbstractMojo private String hibernateDialect; /** - * Hibernate configuration file. + * Path to Hibernate configuration file. * * @parameter default-value="${project.build.outputDirectory}/hibernate.properties" */ @@ -135,48 +191,61 @@ public class Hbm2DdlMojo extends AbstractMojo /** * Target of execution: *

- * @parameter default-value="EXPORT" + * + * @parameter expression="${hibernate.export.target}" default-value="EXPORT" */ private String target; /** - * Type of export. + * Type of execution. * - * @parameter default-value="BOTH" + * + * @parameter expression="${hibernate.export.type}" default-value="BOTH" */ private String type; /** * Output file. * - * @parameter default-value="${project.build.outputDirectory}/schema.sql" + * @parameter expression="${hibernate.export.schema.filename}" default-value="${project.build.directory}/schema.sql" */ private String outputFile; /** * Delimiter in output-file. * - * @parameter default-value=";" + * @parameter expression="${hibernate.export.schema.delimiter}" default-value=";" */ private String delimiter; /** * Format output-file. * - * @parameter default-value="true" + * @parameter expression="${hibernate.export.schema.format}" default-value="true" */ private boolean format; + /** + * Generate envers schema for auditing tables. + * + * @parameter expression="${hibernate.export.envers}" default-value="false" + */ + private Boolean envers; + + /** + * Transient attribute, used only for knowing if the schema has changed since it was last run. + */ + private boolean modified; @Override public void execute() @@ -185,34 +254,68 @@ public class Hbm2DdlMojo extends AbstractMojo MojoExecutionException { if (skip) + { + getLog().info("Exectuion of hibernate4-maven-plugin:export was skipped!"); + project.getProperties().setProperty(EXPORT_SKIPPED_PROPERTY, "true"); return; + } File dir = new File(outputDirectory); if (!dir.exists()) throw new MojoExecutionException("Cannot scan for annotated classes in " + outputDirectory + ": directory does not exist!"); + Map md5s; + modified = false; + File saved = new File(buildDirectory + File.separator + MD5S); - Set classes = new HashSet(); + if (saved.exists()) + { + try + { + FileInputStream fis = new FileInputStream(saved); + ObjectInputStream ois = new ObjectInputStream(fis); + md5s = (HashMap)ois.readObject(); + ois.close(); + } + catch (Exception e) + { + md5s = new HashMap(); + getLog().warn("Cannot read timestamps from saved: " + e); + } + } + else + { + md5s = new HashMap(); + try + { + saved.createNewFile(); + } + catch (IOException e) + { + getLog().warn("Cannot create saved for timestamps: " + e); + } + } + + ClassLoader classLoader; try { - AnnotationDB db = new AnnotationDB(); - getLog().info("Scanning directory " + outputDirectory + " for annotated classes..."); - URL dirUrl = dir.toURI().toURL(); - db.scanArchives(dirUrl); - if (db.getAnnotationIndex().containsKey(Entity.class.getName())) - classes.addAll(db.getAnnotationIndex().get(Entity.class.getName())); - if (db.getAnnotationIndex().containsKey(MappedSuperclass.class.getName())) - classes.addAll(db.getAnnotationIndex().get(MappedSuperclass.class.getName())); - if (db.getAnnotationIndex().containsKey(Embeddable.class.getName())) - classes.addAll(db.getAnnotationIndex().get(Embeddable.class.getName())); + getLog().debug("Creating ClassLoader for project-dependencies..."); + List classpathFiles = project.getCompileClasspathElements(); + if (scanTestClasses) + classpathFiles.addAll(project.getTestClasspathElements()); + URL[] urls = new URL[classpathFiles.size()]; + for (int i = 0; i < classpathFiles.size(); ++i) + { + getLog().debug("Dependency: " + classpathFiles.get(i)); + urls[i] = new File(classpathFiles.get(i)).toURI().toURL(); + } + classLoader = new URLClassLoader(urls, getClass().getClassLoader()); } - catch (IOException e) + catch (Exception e) { - getLog().error("Error while scanning!", e); - throw new MojoFailureException(e.getMessage()); + getLog().error("Error while creating ClassLoader!", e); + throw new MojoExecutionException(e.getMessage()); } - if (classes.isEmpty()) - throw new MojoFailureException("No annotated classes found in directory " + outputDirectory); Properties properties = new Properties(); @@ -226,7 +329,7 @@ public class Hbm2DdlMojo extends AbstractMojo properties.load(new FileInputStream(file)); } else - getLog().info("No hibernate-properties-file found! Checked path: " + hibernateProperties); + getLog().info("No hibernate-properties-file found! (Checked path: " + hibernateProperties + ")"); } catch (IOException e) { @@ -241,14 +344,10 @@ public class Hbm2DdlMojo extends AbstractMojo getLog().debug( "Overwriting property " + DRIVER_CLASS + "=" + properties.getProperty(DRIVER_CLASS) + - " with the value " + driverClassName + - " from the plugin-configuration-parameter driverClassName!" + " with the value " + driverClassName ); else - getLog().debug( - "Using the value " + driverClassName + - " from the plugin-configuration-parameter driverClassName!" - ); + getLog().debug("Using the value " + driverClassName); properties.setProperty(DRIVER_CLASS, driverClassName); } if (url != null) @@ -257,14 +356,10 @@ public class Hbm2DdlMojo extends AbstractMojo getLog().debug( "Overwriting property " + URL + "=" + properties.getProperty(URL) + - " with the value " + url + - " from the plugin-configuration-parameter url!" + " with the value " + url ); else - getLog().debug( - "Using the value " + url + - " from the plugin-configuration-parameter url!" - ); + getLog().debug("Using the value " + url); properties.setProperty(URL, url); } if (username != null) @@ -273,14 +368,10 @@ public class Hbm2DdlMojo extends AbstractMojo getLog().debug( "Overwriting property " + USERNAME + "=" + properties.getProperty(USERNAME) + - " with the value " + username + - " from the plugin-configuration-parameter username!" + " with the value " + username ); else - getLog().debug( - "Using the value " + username + - " from the plugin-configuration-parameter username!" - ); + getLog().debug("Using the value " + username); properties.setProperty(USERNAME, username); } if (password != null) @@ -289,14 +380,10 @@ public class Hbm2DdlMojo extends AbstractMojo getLog().debug( "Overwriting property " + PASSWORD + "=" + properties.getProperty(PASSWORD) + - " with the value " + password + - " from the plugin-configuration-parameter password!" + " with the value " + password ); else - getLog().debug( - "Using the value " + password + - " from the plugin-configuration-parameter password!" - ); + getLog().debug("Using the value " + password); properties.setProperty(PASSWORD, password); } if (hibernateDialect != null) @@ -305,66 +392,72 @@ public class Hbm2DdlMojo extends AbstractMojo getLog().debug( "Overwriting property " + DIALECT + "=" + properties.getProperty(DIALECT) + - " with the value " + hibernateDialect + - " from the plugin-configuration-parameter hibernateDialect!" + " with the value " + hibernateDialect ); else - getLog().debug( - "Using the value " + hibernateDialect + - " from the plugin-configuration-parameter hibernateDialect!" - ); + getLog().debug("Using the value " + hibernateDialect); properties.setProperty(DIALECT, hibernateDialect); } - getLog().info("Gathered hibernate-configuration (turn on debugging for details):"); - if (properties.isEmpty()) + /** The generated SQL varies with the dialect! */ + if (md5s.containsKey(DIALECT)) { - getLog().error("No properties set!"); - throw new MojoFailureException("Hibernate-Configuration is missing!"); - } - for (Entry entry : properties.entrySet()) - getLog().info(" " + entry.getKey() + " = " + entry.getValue()); - - ClassLoader classLoader = null; - try - { - getLog().debug("Creating ClassLoader for project-dependencies..."); - List classpathFiles = project.getCompileClasspathElements(); - URL[] urls = new URL[classpathFiles.size()]; - for (int i = 0; i < classpathFiles.size(); ++i) + String dialect = properties.getProperty(DIALECT); + if (md5s.get(DIALECT).equals(dialect)) + getLog().debug("SQL-dialect unchanged."); + else { - getLog().debug("Dependency: " + classpathFiles.get(i)); - urls[i] = new File(classpathFiles.get(i)).toURI().toURL(); + getLog().debug("SQL-dialect changed: " + dialect); + modified = true; + md5s.put(DIALECT, dialect); } - classLoader = new URLClassLoader(urls, getClass().getClassLoader()); } - catch (Exception e) + else { - getLog().error("Error while creating ClassLoader!", e); - throw new MojoExecutionException(e.getMessage()); + modified = true; + md5s.put(DIALECT, properties.getProperty(DIALECT)); } - Configuration config = new Configuration(); - config.setProperties(properties); - try + if (md5s.containsKey(ENVERS)) { - getLog().debug("Adding annotated classes to hibernate-mapping-configuration..."); - for (String annotatedClass : classes) + String envers = properties.getProperty(ENVERS); + if (md5s.get(ENVERS).equals(envers)) + getLog().debug("Envers unchanged."); + else { - getLog().debug("Class " + annotatedClass); - config.addAnnotatedClass(classLoader.loadClass(annotatedClass)); + getLog().debug("Envers changed: " + envers); + modified = true; + md5s.put(ENVERS, envers.toString()); } } - catch (ClassNotFoundException e) + else { - getLog().error("Error while adding annotated classes!", e); - throw new MojoExecutionException(e.getMessage()); + modified = true; + md5s.put(ENVERS, properties.getProperty(ENVERS)); + } + + if (envers != null) { + if (properties.containsKey(ENVERS)) + getLog().debug( + "Overwriting property " + + ENVERS + "=" + properties.getProperty(ENVERS) + + " with the value " + envers + ); + else + getLog().debug("Using the value " + envers); + properties.setProperty(ENVERS, envers.toString()); } - Target target = null; + if (properties.isEmpty()) + { + getLog().error("No properties set!"); + throw new MojoFailureException("Hibernate-Configuration is missing!"); + } + + Target target; try { - target = Target.valueOf(this.target); + target = Target.valueOf(this.target.toUpperCase()); } catch (IllegalArgumentException e) { @@ -372,10 +465,10 @@ public class Hbm2DdlMojo extends AbstractMojo getLog().error("Valid values are: NONE, SCRIPT, EXPORT, BOTH"); throw new MojoExecutionException("Invalid value for configuration-option \"target\""); } - Type type = null; + Type type; try { - type = Type.valueOf(this.type); + type = Type.valueOf(this.type.toUpperCase()); } catch (IllegalArgumentException e) { @@ -384,6 +477,27 @@ public class Hbm2DdlMojo extends AbstractMojo throw new MojoExecutionException("Invalid value for configuration-option \"type\""); } + if (target.equals(Target.SCRIPT) || target.equals(Target.NONE)) + { + project.getProperties().setProperty(EXPORT_SKIPPED_PROPERTY, "true"); + } + if ( + !modified + && !target.equals(Target.SCRIPT) + && !target.equals(Target.NONE) + && !force + ) + { + getLog().info("No modified annotated classes found and dialect unchanged."); + getLog().info("Skipping schema generation!"); + project.getProperties().setProperty(EXPORT_SKIPPED_PROPERTY, "true"); + return; + } + + getLog().info("Gathered hibernate-configuration (turn on debugging for details):"); + for (Entry entry : properties.entrySet()) + getLog().info(" " + entry.getKey() + " = " + entry.getValue()); + Connection connection = null; try { @@ -401,17 +515,28 @@ public class Hbm2DdlMojo extends AbstractMojo case CREATE: case DROP: case BOTH: - Class driverClass = classLoader.loadClass(driverClassName); + Class driverClass = classLoader.loadClass(properties.getProperty(DRIVER_CLASS)); getLog().debug("Registering JDBC-driver " + driverClass.getName()); DriverManager.registerDriver(new DriverProxy((Driver)driverClass.newInstance())); - getLog().debug("Opening JDBC-connection to " + url + " as " + username + " with password " + password); - connection = DriverManager.getConnection(url, username, password); + getLog().debug( + "Opening JDBC-connection to " + + properties.getProperty(URL) + + " as " + + properties.getProperty(USERNAME) + + " with password " + + properties.getProperty(PASSWORD) + ); + connection = DriverManager.getConnection( + properties.getProperty(URL), + properties.getProperty(USERNAME), + properties.getProperty(PASSWORD) + ); } } } catch (ClassNotFoundException e) { - getLog().error("Dependency for driver-class " + driverClassName + " is missing!"); + getLog().error("Dependency for driver-class " + properties.getProperty(DRIVER_CLASS) + " is missing!"); throw new MojoExecutionException(e.getMessage()); } catch (Exception e) @@ -435,6 +560,23 @@ public class Hbm2DdlMojo extends AbstractMojo */ Thread.currentThread().setContextClassLoader(classLoader); + Set> classes = scanForAnnotations(dir, classLoader, md5s); + + Configuration config = new Configuration(); + config.setProperties(properties); + getLog().debug("Adding annotated classes to hibernate-mapping-configuration..."); + for (Class annotatedClass : classes) + { + getLog().debug("Class " + annotatedClass); + config.addAnnotatedClass(annotatedClass); + } + config.buildMappings(); + if ("true".equals(properties.getProperty(ENVERS))) + { + getLog().debug("Using envers"); + AuditConfiguration.getFor(config); + } + SchemaExport export = new SchemaExport(config, connection); export.setOutputFile(outputFile); export.setDelimiter(delimiter); @@ -455,20 +597,35 @@ public class Hbm2DdlMojo extends AbstractMojo /** Close the connection */ try { - connection.close(); + if (connection != null) + connection.close(); } catch (SQLException e) { getLog().error("Error while closing connection: " + e.getMessage()); } } + + /** Write md5-sums for annotated classes to file */ + try + { + FileOutputStream fos = new FileOutputStream(saved); + ObjectOutputStream oos = new ObjectOutputStream(fos); + oos.writeObject(md5s); + oos.close(); + fos.close(); + } + catch (Exception e) + { + getLog().error("Cannot write md5-sums to file: " + e); + } } /** * Needed, because DriverManager won't pick up drivers, that were not * loaded by the system-classloader! * See: - * http://stackoverflow.com/questions/288828/how-to-use-a-jdbc-driver-from-an-arbitrary-location + * http://stackoverflow.com/questions/288828/how-to-use-a-jdbc-driver-fromodifiedm-an-arbitrary-location */ static final class DriverProxy implements Driver { @@ -562,4 +719,77 @@ public class Hbm2DdlMojo extends AbstractMojo return this.target.equals(other.target); } } + + public Set> scanForAnnotations(File dir, ClassLoader classLoader, Map md5s) throws MojoExecutionException, MojoFailureException { + Set> classes = new TreeSet>( + new Comparator>() { + @Override + public int compare(Class a, Class b) { + return a.getName().compareTo(b.getName()); + } + } + ); + + try { + AnnotationDB db = new AnnotationDB(); + getLog().info("Scanning directory " + outputDirectory + " for annotated classes..."); + URL dirUrl = dir.toURI().toURL(); + db.scanArchives(dirUrl); + if (scanTestClasses) { + dir = new File(testOutputDirectory); + if (!dir.exists()) + throw new MojoExecutionException("Cannot scan for annotated test-classes in " + testOutputDirectory + ": directory does not exist!"); + getLog().info("Scanning directory " + testOutputDirectory + " for annotated classes..."); + dirUrl = dir.toURI().toURL(); + db.scanArchives(dirUrl); + } + + Set classNames = new HashSet(); + if (db.getAnnotationIndex().containsKey(Entity.class.getName())) + classNames.addAll(db.getAnnotationIndex().get(Entity.class.getName())); + if (db.getAnnotationIndex().containsKey(MappedSuperclass.class.getName())) + classNames.addAll(db.getAnnotationIndex().get(MappedSuperclass.class.getName())); + if (db.getAnnotationIndex().containsKey(Embeddable.class.getName())) + classNames.addAll(db.getAnnotationIndex().get(Embeddable.class.getName())); + + MessageDigest digest = java.security.MessageDigest.getInstance("MD5"); + for (String name : classNames) { + Class annotatedClass = classLoader.loadClass(name); + classes.add(annotatedClass); + InputStream is = + annotatedClass + .getResourceAsStream(annotatedClass.getSimpleName() + ".class"); + byte[] buffer = new byte[1024*4]; // copy data in 4MB-chunks + int i; + while((i = is.read(buffer)) > -1) + digest.update(buffer, 0, i); + is.close(); + byte[] bytes = digest.digest(); + BigInteger bi = new BigInteger(1, bytes); + String newMd5 = String.format("%0" + (bytes.length << 1) + "x", bi); + String oldMd5 = !md5s.containsKey(name) ? "" : md5s.get(name); + if (!newMd5.equals(oldMd5)) + { + getLog().debug("Found new or modified annotated class: " + name); + modified = true; + md5s.put(name, newMd5); + } + else + { + getLog().debug(oldMd5 + " -> class unchanged: " + name); + } + } + } catch (Exception e) { + getLog().error("Error while scanning!", e); + throw new MojoFailureException(e.getMessage()); + } + + if (classes.isEmpty()) + throw new MojoFailureException("No annotated classes found in directory " + outputDirectory); + + getLog().debug("Detected classes with mapping-annotations:"); + for (Class annotatedClass : classes) + getLog().debug(" " + annotatedClass.getName()); + return classes; + } }