/doma-codegen-plugin

Generates Java, Kotlin, and SQL files from Database

Primary LanguageJavaApache License 2.0Apache-2.0

Doma CodeGen Plugin

Doma CodeGen Plugin is a gradle plugin.
It generates Java, Kotlin, and SQL files from Database.

Java CI with Gradle project chat Twitter

Check latest version

How to use

The basic build.gradle example is as follows:

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        // specify your JDBC driver
        classpath 'com.h2database:h2:1.3.175'
    }
}

plugins {
    id 'java'
    // specify the Doma CodeGen Plugin with correct version
    id 'org.domaframework.doma.codegen' version '2.x.x'
}

domaCodeGen {
    // make an arbitrary named block
    dev {
        // JDBC url
        url = '...'
        // JDBC user
        user = '...'
        // JDBC password
        password = '...'
        // configuration for generated entity source files
        entity {
          packageName = 'org.example.entity'
        }
        // configuration for generated DAO source files
        dao {
          packageName = 'org.example.dao'
        }
    }
}

The above code is equivalent to the following build.gradle.kts:

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath("com.h2database:h2:1.3.175")
    }
}

plugins {
    id("java")
    // specify the Doma CodeGen Plugin with correct version
    id("org.domaframework.doma.codegen") version "2.x.x"
}

domaCodeGen {
    register("dev") {
        url.set("...")
        user.set("...")
        password.set("...")
        entity {
            packageName.set("org.example.entity")
        }
        dao {
            packageName.set("org.example.dao")
        }
    }
}

To generate all files, run domaCodeGenDevAll task:

$ ./gradlew domaCodeGenDevAll

Sample Project

Gradle Tasks

The Doma CodeGen Plugin provides following tasks:

  • domaCodeGenNameAll - Generates all.
  • domaCodeGenNameDao - Generates DAO source files.
  • domaCodeGenNameDto - Reads resultSet metadata and generate a DTO source file.
  • domaCodeGenNameEntity - Generates entity source files.
  • domaCodeGenNameSql - Generates SQL files.
  • domaCodeGenNameSqlTest - Generates SQL test source files.

Note that each Name part in the above task names is replaced with the block name defined under the domaCodeGen block.
In the above usage example, the Dev part is corresponding to the dev block.

To check all defined task names, run the tasks task:

$ ./gradlew tasks

Config Options

named config

A named config must be under the domaCodeGen block.
The name of the config is arbitrary.
You can make multiple configs under the domaCodeGen block.

In the following example, we define two configs - sales and account:

domaCodeGen {
  sales {   
    url = "jdbc:h2:mem:sales" 
  }
  account {
    url = "jdbc:h2:mem:account" 
  }
}
Option Description Values Default
url JDBC url
user JDBC user
password JDBC password
dataSource database data source inferred by the url
codeGenDialect database dialect inferred by the url
catalogName database catalog name
schemaName database schema name
tableNamePattern database table pattern (Regex) ".*"
ignoredTableNamePattern database ignored table pattern (Regex) ".$."
tableTypes database table type such as "TABLE", "VIEW", and so on "TABLE"
versionColumnNamePattern database version column pattern (Regex) "VERSION([_]?NO)?"
languageType language of generation code (*1) LanguageType.JAVA, LanguageType.KOTLIN LanguageType.JAVA
languageClassResolver class resolver for language dedicated classes depends on languageType
templateEncoding encoding for freeMarker template files "UTF-8"
templateDir directory for user customized template files
encoding encoding for generated Java source files "UTF-8"
sourceDir directory for generated Java source files depends on languageType
testSourceDir directory for generated Java test source files depends on languageType
resourceDir directory for generated SQL files "src/main/resources"
globalFactory entry point to customize plugin behavior (*2) The instance of GlobalFactory
  • (*1) The FQN of LanguageType is org.seasar.doma.gradle.codegen.desc.LanguageType
  • (*2) The FQN of GlobalFactory is org.seasar.doma.gradle.codegen.GlobalFactory

entity

An entity block must be under a named config:

domaCodeGen {
  sales {
    entity {
      useAccessor = false
    }
  }
}
Option Description Values Default
overwrite where to overwrite generated entity files or not true
overwriteListener allow to overwrite listeners or not false
superclassName common superclass for generated entity classes
listenerSuperclassName common superclass for generated entity listener classes
packageName package name for generated entity class "example.entity"
generationType generation type for entity identities (*1) enum value of GenerationType
namingType naming convention (*2) enum value of NamingType
initialValue initial value for entity identities
allocationSize allocation size for entity identities
showCatalogName whether to show catalog names or not false
showSchemaName whether to show schema names or not false
showTableName whether to show table names or not true
showColumnName whether to show column names or not true
showDbComment whether to show database comments or not true
useAccessor whether to use accessors or not true
useListener whether to use listeners or not true
useMetamodel whether to use metamodels or not true
useMappedSuperclass whether to use mapped superclasses or not true
originalStatesPropertyName property to be annotated with @OriginalStates
entityPropertyClassNamesFile file used to resolve entity property classes
prefix prefix for entity classes
suffix suffix for entity classes
  • (*1) The FQN of GenerationType is org.seasar.doma.gradle.codegen.desc.GenerationType
  • (*2) The FQN of NamingType is org.seasar.doma.gradle.codegen.NamingType

dao

A dao block must be under a named config:

domaCodeGen {
  sales {
    dao {
      packageName = 'org.example.sales.dao'
    }
  }
}
Option Description Values Default
overwrite whether to overwrite generated DAO files or not false
packageName package name for generated DAO classes "example.dao"
suffix suffix for Dao classes "Dao"
configClassName org.seasar.doma.jdbc.Config implemented class name. Tha name is used at @Dao false

sql

A sql block must be under a named config:

domaCodeGen {
  sales {
    sql {
      overwrite = false
    }
  }
}
Option Description Values Default
overwrite whether to overwrite generated sql files or not true

Customization

Generating Kotlin code

To generate Kotlin code, specify LanguageType.KOTLIN to the languageType option as follows:

import org.seasar.doma.gradle.codegen.desc.LanguageType

...

domaCodeGen {
    dev {
        url = '...'
        user = '...'
        password = '...'
        languageType = LanguageType.KOTLIN
        entity {
          packageName = 'org.example.entity'
        }
        dao {
          packageName = 'org.example.dao'
        }
    }
}

Using custom template files

Default template files are located in the source code repository of the Doma CodeGen Plugin.
They are listed as follows:

Template File Data Model Class Generated Files
entity.ftl org.seasar.doma.gradle.codege.desc.EntityDesc entity source files
entityListener.ftl org.seasar.doma.gradle.codege.desc.EntityListenerDesc entity listener source files
dao.ftl org.seasar.doma.gradle.codege.desc.DaoDesc DAO source files
sqlTest.ftl org.seasar.doma.gradle.codege.desc.SqlTestDesc test source files for SQL
selectById.sql.ftl org.seasar.doma.gradle.codege.desc.SqlDesc SQL files
selectByIdAndVersion.sql.ftl org.seasar.doma.gradle.codege.desc.SqlDesc SQL files

To create custom template files, copy them and modify their contents without changing file names. Then put them in the directory which is specified to the templateDir option.

domaCodeGen {
    dev {
        url = '...'
        user = '...'
        password = '...'
        // specify the directory including your custom template files
        templateDir = file("$projectDir/template")
        entity {
          packageName = 'org.example.entity'
        }
        dao {
          packageName = 'org.example.dao'
        }
    }
}

The Doma CodeGen Plugin uses Apache FreeMarker to process the template files.