社内で 2 年使ってきたコードを OSS として Maven Central に公開しました

buildscript {
  dependencies {
    classpath 'com.h2database:h2:1.4.197' // アクセスする DB の JDBC ドライバ
    classpath 'com.smartnews:jpa-entity-generator:0.99.2'
  }
}

// plugin を有効にします
apply plugin: 'entitygen'
entityGen {
  // ツール実行時に使う YAML 設定ファイル
  configPath = 'src/main/resources/entityGenConfig.yml'
}

// 生成したコードは Lombok に依存しています
dependencies {
  providedCompile 'org.projectlombok:lombok:1.16.20'
  providedCompile 'org.hibernate.javax.persistence:hibernate-jpa-2.1-api:1.0.0.Final'
}

// DB への接続情報
jdbcSettings:
  url: "jdbc:h2:file:./db/blog;MODE=MySQL"
  username: "user"
  password: "pass"
  driverClassName: "org.h2.Driver"

// 生成したコードを置く package を指定
packageName: "com.example.entity"

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;
}

# ---------------------------------------------------------
# *** JDBC configuration to fetch metadata ***

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

# ---------------------------------------------------------
# *** Basic/global configuration ***

# If you need to specify non-standard source directory, set the following setting as needed
#   - string value: the relative path from the project root directory.
outputDirectory: "src/main/java"

# The package name used when generating entity classes
#   - string value: full package name
packageName: "com.example.entity"

# If you need to set a specific strategy attribute for @GeneratedValue, specify the name here.
#   - string value: "TABLE", "SEQUENCE", "IDENTITY", "AUTO", or null
generatedValueStrategy: "IDENTITY"

# If you need to generate JPA 1 compatible entity classes as well, set the following attributes
#   - boolean value: true if you need to generate JPA 1 compatible entities as well
jpa1SupportRequired: true
# The package to put JP 1 compatible entity classes.
#   - string value: full package name separate from the "packageName"
packageNameForJpa1: "com.example.entity.jpa1"

# ---------------------------------------------------------
# *** Rules for exclusion ***

# Define the following rules if you'd like to exclude specific tables when generating entity classes
#   - array of TableExclusionRule objects
#     - tableName (string) / tableNames (array): string value that partially matches table names (case sensitive)
tableExclusionRules:
  - tableNames: ["_tmp"]

# ---------------------------------------------------------
# *** Rules for table/class name conversion ***

# If you need some rules that convert table names to entity class names, list the mapping rules as below.
#   - array of ClassNameRule objects
#     - tableName: table name (full name, case sensitive)
#     - className: Java class name to be used (you cannot include package namme in front of the class name)
classNameRules:
  - tableName: "article"
    className: "BlogArticle"
  - tableName: "article_tag"
    className: "BlogArticleTag"
  - tableName: "abtest"
    className: "ABTest"

# ---------------------------------------------------------
# *** Rules on how to attach class annotations ***
#   - array of ClassAnnotationRule objects
#     - (optional) className (string) / classNames (array): target Java class names (case sensitive)
#     - annotations: array of Annotation objects
#       - className: the annotation class name
#       - (optional) attributes (array of AnnotationAttribute objects): attributes if exist
#         - name (string): the name of the attribute
#         - (optional) value (string): the value of the attribute
#         or
#         - code (string): writing code in a string value instead of specifying name + value
#       or
#       - code (string): write the whole code in a string value instead of specifying className + attributes
classAnnotationRules:
  # If you just specify the annotations, all the generated classes'll have them.
  - annotations:
    - className: "lombok.ToString"

  # You can specify the classes to have the class annotations.
  - {classNames: ["ABTest",], annotations: [className: "Deprecated"]}
  - className: "Blog"
    annotations:
      - className: "lombok.Builder"
        attributes:
          - name: "toBuilder"
            value: "true"

# ---------------------------------------------------------
# *** Java interfaces to let generated classes implement ***
#   - array of InterfaceRule objects
#     - (optional) className (string) / classNames (array): target Java class names (case sensitive)
#     - interfaces: array of Interface objects
#       - name: FQDN of the interface
#       - (optional) genericsClassNames: array of string values if the interface has generics
interfaceRules:
  # If you just specify the interfaces, all the generated classes'll implement the interfaces.
  - interfaces: [{name: "java.io.Serializable"}]

  - classNames: ["ABTest"]
    interfaces: [{name: "com.example.util.ExpirationPredicate"}]

# ---------------------------------------------------------
# *** Rules on how to append class comments ***
#   - array of ClassAdditionalCommentRule objects
#     - (optional) className (string) / classNames (array): target Java class names (case sensitive)
#     - comment (string): comment value to be appended to the class definition
classAdditionalCommentRules:
  # If you just specify the classNames, all the generated classes'll have them.
  - comment: "Note: auto-generated by jpa-entity-generator"

  - classNames: [
      "ABTest",
    ]
    comment: "TODO: This A/B testing mechanism is no longer used"

# ---------------------------------------------------------
# *** Rules to convert types of the fields in generated classes ***
#   - array of FieldTypeRule objects
#     - (optional) className (string) / classNames (array): target Java class names (case sensitive)
#     - fieldName (string) / fieldNames (array): the field name to convert its type
#     - typeName (string): the type name to be converted
fieldTypeRules:
  - {classNames: ["ABTest"], fieldName: "config", typeName: "String"}

  # If you don't specify classNames in a rule, all the generated classes will be affected.
  - {                        fieldName: "active", typeName: "boolean"}

# ---------------------------------------------------------
# *** Rules on how to attach field annotations ***
#   - array of FieldAnnotationRule objects
#     - (optional) className (string) / classNames (array): target Java class names (case sensitive)
#     - fieldName (string) / fieldNames (array): the field name to attach annotations
#     - annotations: array of Annotation objects
#       - className: the annotation class name
#       - (optional) attributes (array of AnnotationAttribute objects): attributes if exist
#         - name (string): the name of the attribute
#         - (optional) value (string): the value of the attribute
#         or
#         - code (string): writing code in a string value instead of specifying name + value
#       or
#       - code (string): write the whole code in a string value instead of specifying className + attributes
fieldAnnotationRules:
  - className: "BlogArticle"
    fieldNames: ["tags"]
    annotations: [{className: "Deprecated"}]

  - classNames: ["ABTest"]
    fieldNames: ["config"]
    annotations: [{
      className: "com.example.annotation.Experimental",
      attributes: [{name: "comment", value: '"The expected data format is JSON"'}],
      # code: '@com.example.annotation.Experimental(comment = "The expected data format is JSON")',
    }]

# ---------------------------------------------------------
# *** Rules on how to set default values to the fields ***
#   - array of FieldDefaultValueRule objects
#     - (optional) className (string) / classNames (array): target Java class names (case sensitive)
#     - fieldName (string) / fieldNames (array): the field name to attach annotations
#     - defaultValue (string): the default value part in source code (specify '"something"' if you have a string value)
fieldDefaultValueRules:
  # If you don't specify classNames in a rule, all the generated classes will be affected.
  - {                        fieldNames: ["name"],   defaultValue: '"Anonymous"'}
  - {classNames: ["ABTest"], fieldNames: ["active"], defaultValue: "0"}

# ---------------------------------------------------------
# *** Rules to append additional code to generated classes ***
#   - array of AdditionalCodeRule objects
#     - (optional) className (string) / classNames (array): target Java class names (case sensitive)
#     - code (string): writing code in a string value
#     - (optional) position (string): "Top" or "Bottom" (default: "Bottom")
#     - (optional) jpa1Code (string): writing code in a string value if you need to overwrite code only for JPA 1 compatible entities
additionalCodeRules:
  - classNames: ["BlogArticle", "BlogArticleTag"]
    position: "Top"
    code: |
            public Integer getId() { return this.id; }
  - className: "BlogArticle"
    # position: "Bottom"
    code: |
            @ManyToOne
            @JoinColumn(name = "`blog_id`", insertable = false, updatable = false)
            private Blog blog;
    jpa1Code: |
            @lombok.Setter(lombok.AccessLevel.NONE)
            @ManyToOne
            @JoinColumn(name = "\"blog_id\"", referencedColumnName = "\"id\"", insertable = false, updatable = false)
            private Blog blog;

# ---------------------------------------------------------
# *** JDBC configuration to fetch metadata ***
jdbcSettings:
  url: "jdbc:mysql://127.0.0.1:3306/wordpress?useSSL=false&useInformationSchema=true"
  username: "wordpress"
  password: "wordpress"
  driverClassName: "com.mysql.jdbc.Driver"

# ---------------------------------------------------------
# *** Basic/global configuration ***

# The package name used when generating entity classes
#   - string value: full package name
packageName: "com.example.entity"

# ---------------------------------------------------------
# *** Rules for table/class name conversion ***

# If you need some rules that convert table names to entity class names, list the mapping rules as below.
#   - array of ClassNameRule objects
#     - tableName: table name (full name, case sensitive)
#     - className: Java class name to be used (you cannot include package namme in front of the class name)
classNameRules:
  - tableName: "wp_commentmeta"
    className: "CommentMeta"
  - tableName: "wp_comments"
    className: "Comment"
  - tableName: "wp_ec3_schedule"
    className: "Ec3Schedule"
  - tableName: "wp_links"
    className: "Link"
  - tableName: "wp_options"
    className: "Option"
  - tableName: "wp_postmeta"
    className: "PostMeta"
  - tableName: "wp_posts"
    className: "Post"
  - tableName: "wp_terms"
    className: "Term"
  - tableName: "wp_term_relationships"
    className: "TermRelationship"
  - tableName: "wp_term_taxonomy"
    className: "TermTaxonomy"
  - tableName: "wp_usermeta"
    className: "UserMeta"
  - tableName: "wp_users"
    className: "User"

# ---------------------------------------------------------
# *** Rules to append additional code to generated classes ***
#   - array of AdditionalCodeRule objects
#     - (optional) className (string) / classNames (array): target Java class names (case sensitive)
#     - code (string): writing code in a string value
#     - (optional) position (string): "Top" or "Bottom" (default: "Bottom")
#     - (optional) jpa1Code (string): writing code in a string value if you need to overwrite code only for JPA 1 compatible entities
additionalCodeRules:
  - className: "Post"
    code: |
            @OneToMany(fetch = FetchType.EAGER, mappedBy = "post", cascade = CascadeType.ALL)
            private java.util.List<PostMeta> postMetaList;
  - className: "PostMeta"
    code: |
            @ManyToOne
            @JoinColumn(name = "\"post_id\"", insertable = false, updatable = false)
            private Post post;

package com.example.entity;

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

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

  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  @Column(name = "\"ID\"")
  private Long id;
  @Column(name = "\"post_author\"")
  private Long postAuthor;
  @Column(name = "\"post_date\"")
  private Timestamp postDate;
  @Column(name = "\"post_date_gmt\"")
  private Timestamp postDateGmt;
  @Column(name = "\"post_content\"")
  private String postContent;
  @Column(name = "\"post_title\"")
  private String postTitle;
  @Column(name = "\"post_excerpt\"")
  private String postExcerpt;
  @Column(name = "\"post_status\"")
  private String postStatus;
  @Column(name = "\"comment_status\"")
  private String commentStatus;
  @Column(name = "\"ping_status\"")
  private String pingStatus;
  @Column(name = "\"post_password\"")
  private String postPassword;
  @Column(name = "\"post_name\"")
  private String postName;
  @Column(name = "\"to_ping\"")
  private String toPing;
  @Column(name = "\"pinged\"")
  private String pinged;
  @Column(name = "\"post_modified\"")
  private Timestamp postModified;
  @Column(name = "\"post_modified_gmt\"")
  private Timestamp postModifiedGmt;
  @Column(name = "\"post_content_filtered\"")
  private String postContentFiltered;
  @Column(name = "\"post_parent\"")
  private Long postParent;
  @Column(name = "\"guid\"")
  private String guid;
  @Column(name = "\"menu_order\"")
  private Integer menuOrder;
  @Column(name = "\"post_type\"")
  private String postType;
  @Column(name = "\"post_mime_type\"")
  private String postMimeType;
  @Column(name = "\"comment_count\"")
  private Long commentCount;

  @OneToMany(fetch = FetchType.EAGER, mappedBy = "post", cascade = CascadeType.ALL)
  private java.util.List<PostMeta> postMetaList;
}

$ ls src/main/java/com/example/entity/
Comment.java		Ec3Schedule.java	Option.java		PostMeta.java		TermRelationship.java	User.java
CommentMeta.java	Link.java		Post.java		Term.java		TermTaxonomy.java	UserMeta.java

dependencies {
  compile 'mysql:mysql-connector-java:5.1.46'
  compile 'org.hibernate.javax.persistence:hibernate-jpa-2.1-api:1.0.0.Final'
  providedCompile 'org.projectlombok:lombok:1.16.20'

  testCompile 'org.springframework.data:spring-data-jpa:2.0.6.RELEASE'
  testCompile 'org.springframework.boot:spring-boot-starter-data-jpa:2.0.1.RELEASE'
  testCompile 'org.springframework.boot:spring-boot-starter-test:2.0.1.RELEASE'
}

package com.example.repository;

// -------------------------------------------------------------------
@Repository
public interface PostMetaRepository extends CrudRepository<PostMeta, Long> {
}

// -------------------------------------------------------------------
@Repository
public interface PostRepository extends CrudRepository<Post, Long> {
}

// -------------------------------------------------------------------
@Configuration
@PropertySource("application.properties")
@EnableAutoConfiguration
@EntityScan("com.example.entity")
@EnableJpaRepositories("com.example.repository")
public class TestConfig {
}

// -------------------------------------------------------------------
@SpringBootTest
@RunWith(SpringRunner.class)
@ContextConfiguration(classes = TestConfig.class)
public class RepositoriesTest {

    @Autowired
    private PostRepository postRepository;
    @Autowired
    private PostMetaRepository postMetaRepository;

    @Test
    public void testPosts() {
        Post p = new Post();
        // 値の設定部分は省略
        postRepository.save(p);

        PostMeta pm = new PostMeta();
        pm.setPostId(p.getId());
        // 値の設定部分は省略
        postMetaRepository.save(pm);

        Optional<Post> foundPost = postRepository.findById(p.getId());
        assertThat(foundPost.isPresent(), is(true));
        foundPost.ifPresent(post -> {
            assertThat(post.getPostMetaList().size(), is(greaterThan(0)));
        });
        long count = postRepository.count();
        assertThat(count, is(greaterThan(0L)));
    }
}