/mybatis-generator-crud-plugin

A plugin for MyBatis Generator to use crud(create、update、delete、query) controller、dto、service、po、dao、mapper)

Primary LanguageJavaApache License 2.0Apache-2.0

MyBatis Generator Lombok plugin

A plugin for MyBatis Generator to use Lombok annotations instead of getters and setters. Helps to reduce the amount of generated boilerplate code.

Code before applying the Lombok plugin:

package example.dto;

public class Contact {
    
    private Long id;
    
    private String firstName;
    
    private String lastName;
    
    private String phone;
    
    private String email;
    
    public Long getId() {
        return id;
    }
    
    public void setId(Long id) {
        this.id = id;
    }
    
    public String getFirstName() {
        return firstName;
    }
    
    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }
    
    public String getLastName() {
        return lastName;
    }
    
    public void setLastName(String lastName) {
        this.lastName = lastName;
    }
    
    public String getPhone() {
        return phone;
    }
    
    public void setPhone(String phone) {
        this.phone = phone;
    }
    
    public String getEmail() {
        return email;
    }
    
    public void setEmail(String email) {
        this.email = email;
    }
}

Code after applying the Lombok plugin (much shorter):

package example.dto;

import lombok.Data;

@Data
public class Contact {
    
    private Long id;
    
    private String firstName;
    
    private String lastName;
    
    private String phone;
    
    private String email;
}

Using the plugin

In your Maven pom.xml file, set up the MyBatis Generator plugin, and add mybatis-generator-lombok-plugin as a dependency:

<plugin>
  <groupId>org.mybatis.generator</groupId>
  <artifactId>mybatis-generator-maven-plugin</artifactId>
  <version>${mybatis.generator.version}</version>
  <configuration>
    <overwrite>true</overwrite>
  </configuration>
  <dependencies>
    <dependency>
      <groupId>org.ffm.saas</groupId>
      <artifactId>mybatis-generator-crud-plugin</artifactId>
      <version>1.0-SNAPSHOT</version>
    </dependency>
  </dependencies>
</plugin>

Then, in your MyBatis Generator configuration, include the plugin:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
  PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
  "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

<generatorConfiguration>
  <context id="example"
    targetRuntime="MyBatis3Simple"
    defaultModelType="flat">
    <!-- include the plugin -->
    <plugin type="com.softwareloop.mybatis.generator.plugins.LombokPlugin">

      <!-- enable annotations -->
      <property name="builder" value="true"/>
      <!-- annotation's option(boolean) -->
      <property name="builder.fluent" value="true"/>
      <!-- annotation's option(String) -->
      <property name="builder.builderMethodName" value="myBuilder"/>

      <property name="accessors" value="true"/>
      <!-- annotation's option(array of String) -->
      <property name="accessors.prefix" value="m_, _"/>

      <!-- disable annotations -->
      <property name="allArgsConstructor" value="false"/>
    </plugin>
    <plugin type="com.softwareloop.mybatis.generator.plugins.AddSuffixPlugin">
      <property name="javaModelSuffix" value="Po"/>
      <property name="javaMapperSuffix" value="Dao"/>
    </plugin>

    <plugin type="com.softwareloop.mybatis.generator.plugins.GeneratedCrudPlugin">
      <property name="packagePath" value="org.ffm.saas.smarterp.system"/>
      <property name="filterColums" value="CREATE_BY,CREATE_TIME,UPDATE_BY,UPDATE_TIME"/>
    </plugin>
    <!-- other configurations -->

  </context>
</generatorConfiguration>

Authors

Maintainer:

Contributors: