Adds new maven plugin configuration property:

Gyula Szalai · Gyula Szalai · commit 49e0f328ebe0 · 2018-11-16T11:39:15.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,6 @@
 /easydao-maven-plugin/target/
 /easydao-samples/easydao-generating-dao/target/
 /easydao-samples/easydao-using-dao/target/
-/easydao-samples/creating-sampledb/target/
+/easydao-samples/creating-sampledb/target/
+.idea
+*.iml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # EasyDao Changelog:
 
+## 3.3.0
+
+Adds new maven plugin configuration property `addDbNameToPackageNames`
+
 ## 3.2.1
 
 * Fixes Dao.update method generation with Oracle virtual columns
diff --git a/README.md b/README.md
@@ -209,7 +209,7 @@ Configuration example:
         </tableNameIncludes>
         <encoding>utf-8</encoding>
         <silent>true</silent>
-
+        <addDbNameToPackageNames>true</addDbNameToPackageNames>
     </configuration>
     <executions>
         <execution>
@@ -353,6 +353,17 @@ Defines the encoding of the generated Java sources. Default: ${project.build.sou
 ## silent
 Indicates whether normal output should be suppressed during code generation. If set, only warnings will be printed.). Default: true
 
+## addDbNameToPackageNames
+If true, database name will be added at the end of the java package names. If you have only one database schema, set it to false.
+Example:
+Let's assume you have a base package of `hu.vanio.easydao.sample` and your database name is `sampledb`
+
+* If you set addDbNameToPackageNames to false, your model and dao packages will be `hu.vanio.easydao.sample.model` and `hu.vanio.easydao.sample.dao`
+
+* If you set addDbNameToPackageNames to true (the default), your model and dao packages will be `hu.vanio.easydao.sample.model.sampledb` and `hu.vanio.easydao.sample.dao.sampledb`
+
+The latter is useful when you have more than one databases, so your model and dao class names won't clash.
+
 # Fields with enumerated vaules
 As of 1.0.9, you can use Java enums for fields with enumerated values. You have two choices: regular and irregular enumerations.
 If you use fields with enumerated values, values stored in the database need to be mapped to the corresponding enum value and vica versa.
diff --git a/easydao-maven-plugin/src/main/java/hu/vanio/easydao/Engine.java b/easydao-maven-plugin/src/main/java/hu/vanio/easydao/Engine.java
@@ -154,11 +154,11 @@ private void generateMetadataFile() throws IOException, TemplateException {
     private void generateModelClasses() throws IOException, TemplateException {
         List<Table> tableList = engineConfiguration.getDatabase().getTableList();
         // create directory for java package
-        Path dir = Paths.get(engineConfiguration.getGeneratedSourcePath()
+        String dirPath = engineConfiguration.getGeneratedSourcePath()
                 + fileSeparator
                 + engineConfiguration.getPackageOfJavaModel().replace(".", fileSeparator)
-                + fileSeparator
-                + engineConfiguration.getDatabase().getName());
+                + ( engineConfiguration.isAddDbNameToPackageNames() ? fileSeparator + engineConfiguration.getDatabase().getName() : "" );
+        Path dir = Paths.get(dirPath);
         Files.createDirectories(dir);
         if (!engineConfiguration.isSilent()) {
             System.out.println("\nWrite model classes into " + dir.toAbsolutePath());
@@ -185,11 +185,11 @@ private void generateModelClasses() throws IOException, TemplateException {
     private void generateDaoInterfaces() throws IOException, TemplateException {
         List<Table> tableList = engineConfiguration.getDatabase().getTableList();
         // create directory for java package
-        Path dir = Paths.get(engineConfiguration.getGeneratedSourcePath()
+        String dirPath = engineConfiguration.getGeneratedSourcePath()
                 + fileSeparator
                 + engineConfiguration.getPackageOfJavaDao().replace(".", fileSeparator)
-                + fileSeparator
-                + engineConfiguration.getDatabase().getName());
+                + ( engineConfiguration.isAddDbNameToPackageNames() ? fileSeparator + engineConfiguration.getDatabase().getName() : "" );
+        Path dir = Paths.get(dirPath);
         Files.createDirectories(dir);
         if (!engineConfiguration.isSilent()) {
             System.out.println("\nWrite dao interfaces into " + dir.toAbsolutePath());
@@ -217,11 +217,11 @@ private void generateDaoInterfaces() throws IOException, TemplateException {
     private void generateDaoClasses() throws IOException, TemplateException {
         List<Table> tableList = engineConfiguration.getDatabase().getTableList();
         // create directory for java package
-        Path dir = Paths.get(engineConfiguration.getGeneratedSourcePath()
+        String dirPath = engineConfiguration.getGeneratedSourcePath()
                 + fileSeparator
                 + engineConfiguration.getPackageOfJavaDao().replace(".", fileSeparator)
-                + fileSeparator
-                + engineConfiguration.getDatabase().getName());
+                + ( engineConfiguration.isAddDbNameToPackageNames() ? fileSeparator + engineConfiguration.getDatabase().getName() : "" );
+        Path dir = Paths.get(dirPath);
         Files.createDirectories(dir);
         if (!engineConfiguration.isSilent()) {
             System.out.println("\nWrite dao classes into " + dir.toAbsolutePath());
diff --git a/easydao-maven-plugin/src/main/java/hu/vanio/easydao/EngineConfiguration.java b/easydao-maven-plugin/src/main/java/hu/vanio/easydao/EngineConfiguration.java
@@ -116,6 +116,8 @@ static public enum SEQUENCE_NAME_CONVENTION {
     protected String encoding;
     /** Indicates whether normal output should be suppressed during code generation. If set, only warnings will be printed. */
     protected boolean silent;
+    /** If true, database name will be added at the end of the java package names */
+    private final boolean addDbNameToPackageNames;
     
     /** Map of Java class names and database table names. Names not included in this list will be auto-generated.
      *  e.g.: APPUSERS = User -> (User and UserDao) instead of (Appusers and AppusersDao)
@@ -196,6 +198,7 @@ static public enum SEQUENCE_NAME_CONVENTION {
      * @param tableNameIncludes
      * @param encoding Encoding of the generated source files
      * @param silent Indicates whether normal output should be suppressed during code generation. If set, only warnings will be printed.
+     * @param addDbNameToPackageNames If true, database name will be added at the end of the java package names
      * @throws java.io.IOException
      */
     public EngineConfiguration(
@@ -209,7 +212,8 @@ public EngineConfiguration(
             String licenseFilename,
             List<String> tableNameIncludes,
             String encoding,
-            boolean silent) throws IOException {
+            boolean silent,
+            boolean addDbNameToPackageNames) throws IOException {
         
         this.database = new Database(databaseName);
         this.databaseType = databaseType;
@@ -234,6 +238,7 @@ public EngineConfiguration(
         this.tableNameIncludes = tableNameIncludes;
         this.encoding = encoding;
         this.silent = silent;
+        this.addDbNameToPackageNames = addDbNameToPackageNames;
         
         if (encoding == null) {
             throw new IllegalArgumentException("Encoding cannot be null");
@@ -301,7 +306,8 @@ static public EngineConfiguration createFromProperties(Properties props) throws
                 props.getProperty("licenseFilename"),
                 getPropertyAsList(props, "tableNameIncludes"),
                 props.getProperty("encoding"),
-                Boolean.valueOf(props.getProperty("silent", "true"))
+                Boolean.valueOf(props.getProperty("silent", "true")),
+                Boolean.valueOf(props.getProperty("addDbNameToPackageNames", "true"))
         );
         
         String languageCode = props.getProperty("language");
@@ -457,7 +463,15 @@ public boolean isFieldSuffix() {
     public boolean isSilent() {
         return silent;
     }
-    
+
+    /**
+     * If true, database name will be added at the end of the java package names
+     * @return the addDbNameToPackageNames
+     */
+    public boolean isAddDbNameToPackageNames() {
+        return addDbNameToPackageNames;
+    }
+
     /**
      * File system directory for generated source files
      * @return the generatedSourcePath
diff --git a/easydao-maven-plugin/src/main/java/hu/vanio/maven/plugins/easydao/Generator.java b/easydao-maven-plugin/src/main/java/hu/vanio/maven/plugins/easydao/Generator.java
@@ -244,6 +244,13 @@ public class Generator extends AbstractMojo {
     @Parameter(required = false, defaultValue = "true")
     protected String silent;
 
+    /**
+     * Optional, default: true. If true, database name will be added at the end of the java package names
+     */
+    @Parameter(required = false, defaultValue = "true")
+    protected String addDbNameToPackageNames;
+
+
     public void execute() throws MojoExecutionException {
         getLog().info("easydao-maven-plugin has started. Generating classes from database.");
 
@@ -302,7 +309,8 @@ public void execute() throws MojoExecutionException {
                     licenseFilename,
                     tableNameIncludes,
                     encoding,
-                    Boolean.parseBoolean(silent)
+                    Boolean.parseBoolean(silent),
+                    Boolean.parseBoolean(addDbNameToPackageNames)
             );
             if (language != null) {
                 ec.setLocale(new Locale(language));
diff --git a/easydao-maven-plugin/src/main/resources/hu/vanio/easydao/templates/dao.ftl b/easydao-maven-plugin/src/main/resources/hu/vanio/easydao/templates/dao.ftl
@@ -1,6 +1,6 @@
 // GENERATED FILE, DO NOT MODIFY! YOUR MODIFICATION WILL BE LOST!
 ${e.licenseText}
-package ${e.packageOfJavaDao}.${e.database.name};
+package ${e.packageOfJavaDao}<#if e.addDbNameToPackageNames>.${e.database.name}</#if>;
 
 import java.math.BigDecimal;
 <#if t.hasBlobField>import java.sql.Blob;${'\n'}</#if><#if t.hasClobField>import java.sql.Clob;${'\n'}</#if><#if t.hasArrayField>import java.sql.Array;${'\n'}</#if>
@@ -19,7 +19,7 @@ import org.springframework.jdbc.core.RowCallbackHandler;
 import org.springframework.jdbc.core.RowMapper;
 import org.springframework.stereotype.Repository;
 
-import ${e.packageOfJavaModel}.${e.database.name}.${t.javaName};
+import ${e.packageOfJavaModel}<#if e.addDbNameToPackageNames>.${e.database.name}</#if>.${t.javaName};
 
 <#list t.fieldList as field><#if field.enumerated || field.customType>import ${field.javaType};${'\n'}</#if></#list>
 
diff --git a/easydao-maven-plugin/src/main/resources/hu/vanio/easydao/templates/dao_interface.ftl b/easydao-maven-plugin/src/main/resources/hu/vanio/easydao/templates/dao_interface.ftl
@@ -1,11 +1,11 @@
 // GENERATED FILE, DO NOT MODIFY! YOUR MODIFICATION WILL BE LOST!
 ${e.licenseText}
-package ${e.packageOfJavaDao}.${e.database.name};
+package ${e.packageOfJavaDao}<#if e.addDbNameToPackageNames>.${e.database.name}</#if>;
 
 import java.sql.Timestamp;
 import java.util.List;
 
-import ${e.packageOfJavaModel}.${e.database.name}.${t.javaName};
+import ${e.packageOfJavaModel}<#if e.addDbNameToPackageNames>.${e.database.name}</#if>.${t.javaName};
 
 <#list t.fieldList as field><#if field.enumerated>import ${field.javaType};${'\n'}</#if></#list>
 /**
diff --git a/easydao-maven-plugin/src/main/resources/hu/vanio/easydao/templates/model.ftl b/easydao-maven-plugin/src/main/resources/hu/vanio/easydao/templates/model.ftl
@@ -1,6 +1,6 @@
 // GENERATED FILE, DO NOT MODIFY! YOUR MODIFICATION WILL BE LOST!
 ${e.licenseText}
-package ${e.packageOfJavaModel}.${e.database.name};
+package ${e.packageOfJavaModel}<#if e.addDbNameToPackageNames>.${e.database.name}</#if>;
 
 import java.sql.Timestamp;
 import java.math.BigDecimal;
diff --git a/easydao-maven-plugin/src/test/java/hu/vanio/easydao/EngineConfigurationTest.java b/easydao-maven-plugin/src/test/java/hu/vanio/easydao/EngineConfigurationTest.java
@@ -87,6 +87,7 @@ private void assertProperties(EngineConfiguration conf) {
         assertEquals(Locale.getDefault(), conf.getLocale());
         assertEquals(Arrays.asList("IR_.+", "KR_.+"), conf.getTableNameIncludes());
         assertEquals("utf-8", conf.getEncoding());
+        assertEquals(true, conf.isAddDbNameToPackageNames());
     }
 
     /**
diff --git a/easydao-maven-plugin/src/test/resources/test-config-oracle11.properties b/easydao-maven-plugin/src/test/resources/test-config-oracle11.properties
@@ -52,3 +52,5 @@ sequenceNameConvention = SUFFIXED_TABLE_NAME
 #language=hu
 tableNameIncludes=IR_.+,KR_.+
 encoding=utf-8
+addDbNameToPackageNames=true
+
diff --git a/easydao-maven-plugin/src/test/resources/test-config-postgresql9.properties b/easydao-maven-plugin/src/test/resources/test-config-postgresql9.properties
@@ -47,3 +47,4 @@ replacementFieldFilename = replacement-field
 enumFieldFilename = enum-field
 sequenceNameConvention = SUFFIXED_TABLE_NAME
 encoding=utf-8
+addDbNameToPackageNames=true
diff --git a/easydao-samples/easydao-generating-dao/pom.xml b/easydao-samples/easydao-generating-dao/pom.xml
@@ -145,6 +145,19 @@
                 </configuration>
                 <executions>
                     <execution>
+                        <id>with_addDbNameToPackageNames_true</id>
+                        <configuration>
+                            <addDbNameToPackageNames>true</addDbNameToPackageNames>
+                        </configuration>
+                        <goals>
+                            <goal>generate</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>with_addDbNameToPackageNames_false</id>
+                        <configuration>
+                            <addDbNameToPackageNames>false</addDbNameToPackageNames>
+                        </configuration>
                         <goals>
                             <goal>generate</goal>
                         </goals>
diff --git a/easydao-samples/easydao-using-dao/src/main/java/hu/vanio/easydao/sample/App.java b/easydao-samples/easydao-using-dao/src/main/java/hu/vanio/easydao/sample/App.java
@@ -44,6 +44,8 @@ public class App {
     public static void main(String[] args) {
         ApplicationContext context = new AnnotationConfigApplicationContext(App.class);
         MyService myService = (MyService) context.getBean("myService");
-        System.out.println("\nPostal code: " + myService.getPostalCode(1L) + "\n");
+        System.out.println("\nPostal code with MyService: " + myService.getPostalCode(1L) + "\n");
+        MyService myService2 = (MyService) context.getBean("myService2");
+        System.out.println("\nPostal code with MyService2: " + myService2.getPostalCode(1L) + "\n");
     }
 }
diff --git a/easydao-samples/easydao-using-dao/src/main/java/hu/vanio/easydao/sample/service/MyService2.java b/easydao-samples/easydao-using-dao/src/main/java/hu/vanio/easydao/sample/service/MyService2.java
@@ -0,0 +1,49 @@
+/*
+ * The MIT License
+ *
+ * Copyright 2013 Vanio Informatika Kft.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package hu.vanio.easydao.sample.service;
+
+import hu.vanio.easydao.sample.dao.AddressDao;
+import hu.vanio.easydao.sample.model.Address;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+/**
+ * An ordinary service example with spring annotation.
+ * Transactional annotation hasn't created on Dao classes,
+ * but on services!
+ * @author Istvan Pato <istvan.pato@vanio.hu>
+ */
+@Service
+@Transactional
+public class MyService2 {
+
+    @Autowired
+    private AddressDao addressDao;
+
+    public String getPostalCode(Long pk) {
+        Address address = addressDao.read(pk);
+        return address.getPostalCode();
+    }
+}
diff --git a/pom.xml b/pom.xml
@@ -3,7 +3,7 @@
 
     <groupId>hu.vanio.easydao</groupId>
     <artifactId>easydao</artifactId>
-    <version>3.2.2-SNAPSHOT</version>
+    <version>3.3.0-SNAPSHOT</version>
     <packaging>pom</packaging>
 
     <name>easydao</name>

Original file line number	Diff line number	Diff line change
`@@ -87,6 +87,7 @@ private void assertProperties(EngineConfiguration conf) {`
`87`	`87`	`assertEquals(Locale.getDefault(), conf.getLocale());`
`88`	`88`	`assertEquals(Arrays.asList("IR_.+", "KR_.+"), conf.getTableNameIncludes());`
`89`	`89`	`assertEquals("utf-8", conf.getEncoding());`
	`90`	`+ assertEquals(true, conf.isAddDbNameToPackageNames());`
`90`	`91`	`}`
`91`	`92`
`92`	`93`	`/**`