README.md

jpa-entity-generator

This is a Java library which generates Lombok-wired JPA entity source code. The project provides Gradle plugin and Maven plugin.

Getting Started

build.gradle

apply plugin: 'java'

buildscript {
  dependencies {
    classpath 'com.h2database:h2:1.4.197'
    classpath 'com.smartnews:jpa-entity-generator:0.99.8'
  }
}

configurations { providedCompile }
sourceSets.main.compileClasspath += configurations.providedCompile
sourceSets.test.compileClasspath += configurations.providedCompile
sourceSets.test.runtimeClasspath += configurations.providedCompile

repositories {
  mavenCentral()
}
dependencies {
  providedCompile 'org.projectlombok:lombok:1.18.2'
  providedCompile 'org.hibernate.javax.persistence:hibernate-jpa-2.1-api:1.0.0.Final'
}

apply plugin: 'entitygen'
entityGen {
    configPath = 'src/main/resources/entityGenConfig.yml'
}

For Maven users

Maven plugin to run the code generator is also available.

<plugin>
  <groupId>com.smartnews</groupId>
  <artifactId>maven-jpa-entity-generator-plugin</artifactId>
  <version>0.99.8</version>
  <dependencies>
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>5.1.46</version>
    </dependency>
  </dependencies>
</plugin>

Put src/main/resources/entityGenConfig.yml, and then run the following command:

mvn jpa-entity-generator:generateAll

src/main/resources/entityGenConfig.yml

jdbcSettings:
  url: "jdbc:h2:file:./db/blog;MODE=MySQL"
  username: "user"
  password: "pass"
  driverClassName: "org.h2.Driver"

packageName: "com.example.entity"

If you need more examples, check the sample entityGenConfig.yml in this repository.

• https://github.com/smartnews/jpa-entity-generator/tree/master/src/test/resources/entityGenConfig.yml

entityGen task

./gradlew entityGen compileJava

entityGen task generates entity classes for all the existing tables in the database.

package com.example.entity;

import java.sql.*;
import javax.persistence.*;
import lombok.Data;

@Data
@Entity(name = "com.example.entity.Blog")
@Table(name = "blog")
public class Blog {

  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  @Column(name = "\"id\"")
  private Integer id;
  @Column(name = "\"name\"")
  private String name;
  @Column(name = "\"active\"")
  private Byte active;
  @Column(name = "\"created_at\"")
  private Timestamp createdAt;
}

How to develop on your local machine

This repo contains 3 parts, src, sample and sample-wordpress.

src

• Source code of this repo, any changes should be made in here

sample

• Sample project use h2 and latest local code work
• Code under com.example.entity is auto generated class
  • You can delete them when you make any break changes and recreate through ./gradlew entityGen

Setup for running ./gradlew entityGen for this project

#In repo root directory
./test.sh

After running ./test.sh successfully, a h2 file database will be created locally. And project is able to retrieve database scheme.

If you need to make sure if your latest code works with sample project or your existing projects, run the following command to publish the latest build to the local Maven repository.

./gradlew uploadArchives -Plocal

sample-wordpress

• Sample project use mysql and latest published library
• Code under com.example.entity is auto generated class
  • You can delete them when you make any break changes and recreate through ./gradlew entityGen

Setup for running ./gradlew entityGen for this project

# Install mysql 5.7
cd sample-wordpress
./bin/create_local_database.sh # If no permission to run, run chmod +x first

How to test on your local machine

To run the unit tests, simply run the following script as the TravisCI build does.

./test.sh

If you make any break change that make test fail, you can try to delete classes under com.example.entity(2 | 3 | 4) in test folder. And re-run this script to create new entity classes that include your changes.

How to release new version

./gradlew clean uploadArchives     // This will publish new version of library
mvn deploy -Dmaven.test.skip=true  // This will publish new version of plugin

After run above commands successfully, please go through this release process if it is your first time.