Building an application
Maven Central Repository
You can pull the artifacts of the Doma framework from the Maven central repository.
We provide two artifacts, doma-core
and doma-processor
.
The doma-core
artifact is required at runtime and compile-time.
The doma-processor
artifact provides annotation processors and is required at compile-time only.
The group id and artifact id of those artifacts are as follows:
- GroupId:
org.seasar.doma
- ArtifactId:
doma-core
- GroupId:
org.seasar.doma
- ArtifactId:
doma-processor
Build with Gradle
Write your build.gradle(.kts) as follows:
plugins {
id("org.seasar.doma.compile") version "3.0.1"
}
dependencies {
implementation("org.seasar.doma:doma-core:3.0.1")
annotationProcessor("org.seasar.doma:doma-processor:3.0.1")
}
plugins {
id 'org.seasar.doma.compile' version '3.0.1'
}
dependencies {
implementation 'org.seasar.doma:doma-core:3.0.1'
annotationProcessor 'org.seasar.doma:doma-processor:3.0.1'
}
To simplify your build.script(.kts), we recommend that you use the org.seasar.doma.compile plugin.
See build.gradle.kts in the getting-started repository as an example.
Build with Maven
Write your pom.xml as follows:
...
<properties>
<doma.version>3.0.1</doma.version>
</properties>
...
<dependencies>
<dependency>
<groupId>org.seasar.doma</groupId>
<artifactId>doma-core</artifactId>
<version>${doma.version}</version>
</dependency>
</dependencies>
...
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<configuration>
<source>17</source> <!-- depending on your project -->
<target>17</target> <!-- depending on your project -->
<annotationProcessorPaths>
<path>
<groupId>org.seasar.doma</groupId>
<artifactId>doma-processor</artifactId>
<version>${doma.version}</version>
</path>
</annotationProcessorPaths>
<compilerArgs>
<!-- if you are using a Maven project in Eclipse, this argument is required -->
<arg>-Adoma.resources.dir=${project.basedir}/src/main/resources</arg>
</compilerArgs>
</configuration>
</plugin>
</plugins>
</build>
Build with Eclipse
Gradle
Import your project as a Gradle project. To reflect Gradle settings in Eclipse, right-click on your project and select Gradle > Refresh Gradle Project.
See build.gradle.kts in the getting-started repository as an example.
Maven
Import your project as a Maven project.
Right-click on the project, then select Properties > Maven > Annotation Processing. Enable “Enable Project specific settings” and “Automatically configure JDT APT” as shown in the figure below.
To reflect Maven settings in Eclipse, you can right-click on your project then select Maven > Update Project…
Note
You need to add the following argument to the Maven compiler plugin configuration in your pom.xml:
<compilerArgs>
<arg>-Adoma.resources.dir=${project.basedir}/src/main/resources</arg>
</compilerArgs>
Build with IntelliJ IDEA
Gradle
Import your project as a Gradle project. Build and run using Gradle.
Maven
Import your project as a Maven project. Build and run using Maven.