Skip to content

About

Modern Gradle plugins for effortless Hibernate and EclipseLink bytecode enhancement.

Topics

Resources

Code of conduct

Contributing

Security policy

Accessibility

Stars

2 stars

Watchers

0 watching

Forks

Latest commit

Β 

History

315 Commits

Folders and files

πŸ“¦ JPersist: Zero-Boilerplate JPA Build Automation for Gradle

Java Gradle CI GitHub Release GitHub License

πŸ“Š Component Status Matrices

Component Release Version Quality Gate Code Coverage
πŸ”Œ Gradle Plugins Gradle Plugin Portal Version Quality gate status Coverage
πŸ“¦ Core Libraries Maven Central Quality gate status Coverage

🧩 What is JPersist?

JPersist is the ultimate developer productivity suite for enterprise Jakarta Persistence API (JPA) on Gradle. Built from the ground up for modern enterprise engineering teams, JPersist delivers a frictionless, zero-boilerplate build automation platform that eliminates manual configuration, accelerates developer onboarding, and guarantees robust, high-performance builds.

From automated descriptor generation and bytecode enhancement to instant schema validation, query linting, and GraalVM native image readiness, JPersist allows developers to focus on delivering business value rather than maintaining fragile build scripts.


πŸ† Why Choose JPersist?

Modern enterprise applications require robust persistence architectures, but standard build configurations are notoriously fragile, slow to set up, and prone to silent runtime failures. JPersist eliminates this friction entirely.

Traditional Build Setup The JPersist Advantage Business Impact
❌ Manual <class> entity tagging βœ… Instant entity discovery via automated bytecode scanning ⚑ Faster Onboarding β€” Zero boilerplate to write
❌ Runtime query & mapping errors βœ… Compile-time query linting & schema validation πŸ›‘οΈ Zero Runtime Surprises β€” Catch bugs in CI
❌ Complex performance tuning setup βœ… Automatic bytecode enhancement & weaving (Hibernate, EclipseLink, OpenJPA) πŸš€ Peak Performance β€” Optimized dirty tracking
❌ Fragile Native & Modular setups βœ… Out-of-the-box GraalVM metadata & JPMS modular support ☁️ Cloud Native Ready β€” Fast boot & low memory
❌ Broken IDE workspace sync βœ… Seamless IDE integration for IntelliJ IDEA and Eclipse Buildship πŸ’» Frictionless DX β€” Developers stay in the flow

⚑ Key Capabilities

  • Zero-Config Descriptor Generation β€” Automatic entity discovery and persistence.xml generation across all source sets.
  • Automated Performance Enhancement β€” Build-time bytecode enhancement for Hibernate, EclipseLink static weaving, and OpenJPA PCEnhancer.
  • Compile-Time Query Safety β€” Static AST validation of @NamedQuery and stored procedure definitions to catch syntax errors during build.
  • Enterprise Schema Validation β€” Automated database schema verification against live databases or multi-tenant database profiles directly in CI/CD.
  • Cloud-Native & Modular Ready β€” Native AOT reflection configuration generation for GraalVM and zero-configuration Java Platform Module System (JPMS) support.
  • Lightning-Fast Builds β€” Fully compatible with Gradle Configuration Cache and incremental builds for maximum throughput.

πŸš€ Getting Started

Apply the plugin matching your JPA provider. The jpa dependency configuration centralizes version management via a BOM platform across all standard Java compilation scopes.

Hibernate Hibernate Setup

Groovy DSL
plugins {
    id 'io.github.jpersist.hibernate-persistence' version '1.9.0'
}

dependencies {
    jpa platform('org.hibernate.orm:hibernate-platform:6.6.56.Final')

    implementation 'org.hibernate.orm:hibernate-core'
}
Kotlin DSL
plugins {
    id("io.github.jpersist.hibernate-persistence") version "1.9.0"
}

dependencies {
    jpa(platform("org.hibernate.orm:hibernate-platform:6.6.56.Final"))

    implementation("org.hibernate.orm:hibernate-core")
}

EclipseLink EclipseLink Setup

Groovy DSL
plugins {
    id 'io.github.jpersist.eclipse-persistence' version '1.9.0'
}

dependencies {
    jpa platform('org.eclipse.persistence:org.eclipse.persistence.parent:4.0.9')

    compileOnly 'jakarta.persistence:jakarta.persistence-api'
    implementation 'org.eclipse.persistence:org.eclipse.persistence.core'
}
Kotlin DSL
plugins {
    id("io.github.jpersist.eclipse-persistence") version "1.9.0"
}

dependencies {
    jpa(platform("org.eclipse.persistence:org.eclipse.persistence.parent:4.0.9"))

    compileOnly("jakarta.persistence:jakarta.persistence-api")
    implementation("org.eclipse.persistence:org.eclipse.persistence.core")
}

OpenJPA OpenJPA Setup

Groovy DSL
plugins {
    id 'io.github.jpersist.openjpa-persistence' version '1.9.0'
}

dependencies {
    jpa 'org.apache.openjpa:openjpa:4.0.0'

    compileOnly 'jakarta.persistence:jakarta.persistence-api:3.1.0'
}
Kotlin DSL
plugins {
    id("io.github.jpersist.openjpa-persistence") version "1.9.0"
}

dependencies {
    jpa("org.apache.openjpa:openjpa:4.0.0")

    compileOnly("jakarta.persistence:jakarta.persistence-api:3.1.0")
}

That's it β€” no additional XML configuration or annotation processing setup is required. The plugin automatically detects your entity classes and generates the appropriate persistence.xml at build time.


πŸ—οΈ Repository Structure

Directory Description
plugins/jakarta-persistence-gradle-plugin Core plugin β€” generates/merges persistence.xml, validates schemas, generates GraalVM metadata, and lints named queries.
plugins/hibernate-persistence-gradle-plugin Hibernate aggregate plugin β€” metamodel generation and compile-time bytecode enhancement.
plugins/eclipse-persistence-gradle-plugin EclipseLink aggregate plugin β€” metamodel generation and compile-time static weaving.
plugins/openjpa-persistence-gradle-plugin OpenJPA aggregate plugin β€” metamodel generation and compile-time PCEnhancer bytecode enhancement.
libraries/persistence-tools-api SPI contract and core interfaces for the named query linter (io.github.jpersist.tools:persistence-tools-api).
libraries/hibernate-orm-persistence-tools Jakarta Persistence (3.x) linter implementation (io.github.jpersist.tools:persistence-tools-jakarta).
libraries/hibernate-persistence-tools Legacy JPA (2.x) linter implementation (io.github.jpersist.tools:persistence-tools-legacy).
libraries/persistence-tools-bom BOM (Bill of Materials) for aligning all persistence-tools library versions.
examples/ Runnable example projects for Hibernate, EclipseLink, and standalone Jakarta Persistence.

πŸ“š Further Information


βš™οΈ Requirements

  • Gradle: 7.4+ or 8.x+ / 9.x+
  • Java: JDK 17 or higher (required by modern Jakarta specifications)

πŸ’– Support the Project

If JPersist is saving your engineering team debugging hours, consider backing us!

πŸ‘‰ Become a GitHub Sponsor

πŸ“„ License

Distributed under the Apache License 2.0. See the LICENSE file for more information.

About

Modern Gradle plugins for effortless Hibernate and EclipseLink bytecode enhancement.

Topics

Resources

Code of conduct

Contributing

Security policy

Accessibility

Stars

2 stars

Watchers

0 watching

Forks

Releases

Sponsor this project

Packages

Contributors

Languages