MybatisGenerator外掛開發三【Lombok】
摘要：
如果我們專案中使用了Lombok，那通過自定義外掛也能講其作用於生成的與資料庫表對映的Model類上。在這裡，我們會同時把表的欄位以列舉的形式寫到該類中，具體作何使用的話，下一章節會講到。
修改Model類
直接上程式碼：
public class LombokPluginex...
如果我們專案中使用了Lombok，那通過自定義外掛也能講其作用於生成的與資料庫表對映的Model類上。在這裡，我們會同時把表的欄位以列舉的形式寫到該類中，具體作何使用的話，下一章節會講到。
修改Model類
直接上程式碼：
public class LombokPluginextends PluginAdapter{
private final Collection<Annotations> annotations;
public LombokPlugin(){
annotations = new HashSet<Annotations>(Annotations.values().length);
}
@Override
public boolean validate(List<String> warnings){
return true;
}
/**
* Intercepts base record class generation
*
* @param topLevelClass
* @param introspectedTable
* @return
*/
@Override
public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass,
IntrospectedTable introspectedTable) {
addDataAnnotation(topLevelClass, true);
addTableColumn(topLevelClass, introspectedTable);
return true;
}
/**
* Intercepts primary key class generation
*
* @param topLevelClass
* @param introspectedTable
* @return
*/
@Override
public boolean modelPrimaryKeyClassGenerated(TopLevelClass topLevelClass,
IntrospectedTable introspectedTable) {
addDataAnnotation(topLevelClass, false);
addTableColumn(topLevelClass, introspectedTable);
return true;
}
/**
* Intercepts "record with blob" class generation
*
* @param topLevelClass
* @param introspectedTable
* @return
*/
@Override
public boolean modelRecordWithBLOBsClassGenerated(
TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
addDataAnnotation(topLevelClass, true);
addTableColumn(topLevelClass, introspectedTable);
return true;
}
/**
* Prevents all getters from being generated.
* See SimpleModelGenerator
*
* @param method
* @param topLevelClass
* @param introspectedColumn
* @param introspectedTable
* @param modelClassType
* @return
*/
@Override
public boolean modelGetterMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedColumn introspectedColumn,
IntrospectedTable introspectedTable,
ModelClassType modelClassType) {
return false;
}
/**
* Prevents all setters from being generated
* See SimpleModelGenerator
*
* @param method
* @param topLevelClass
* @param introspectedColumn
* @param introspectedTable
* @param modelClassType
* @return
*/
@Override
public boolean modelSetterMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedColumn introspectedColumn,
IntrospectedTable introspectedTable,
ModelClassType modelClassType) {
return false;
}
/**
* Adds the lombok annotations' imports and annotations to the class
*
* @param topLevelClass
*/
private void addDataAnnotation(TopLevelClass topLevelClass,boolean builder){
for (Annotations annotation : annotations) {
if (!builder && annotation.paramName.equals("builder")) {
continue;
}
topLevelClass.addImportedType(annotation.javaType);
topLevelClass.addAnnotation(annotation.name);
}
}
private void addTableColumn(TopLevelClass topLevelClass, IntrospectedTable introspectedTable){
InnerEnum innerEnum = new InnerEnum(new FullyQualifiedJavaType("COLUMNS"));
innerEnum.setVisibility(JavaVisibility.PUBLIC);
innerEnum.setStatic(true);
Field columnField = new Field("column", FullyQualifiedJavaType.getStringInstance());
columnField.setVisibility(JavaVisibility.PRIVATE);
columnField.addAnnotation(Annotations.GETTER.name);
innerEnum.addField(columnField);
introspectedTable.getAllColumns().forEach(introspectedColumn -> {
StringBuilder sb = new StringBuilder();
sb.append(introspectedColumn.getActualColumnName().toUpperCase());
sb.append("(\"");
sb.append(introspectedColumn.getActualColumnName());
sb.append("\")");
innerEnum.addEnumConstant(sb.toString());
});
innerEnum.addAnnotation(Annotations.ALL_ARGS_CONSTRUCTOR.name);
topLevelClass.addInnerEnum(innerEnum);
}
@Override
public void setProperties(Properties properties){
super.setProperties(properties);
// 要新增到類上的註解
annotations.add(Annotations.DATA);
annotations.add(Annotations.GETTER);
annotations.add(Annotations.BUILDER);
annotations.add(Annotations.ALL_ARGS_CONSTRUCTOR);
for (Entry<Object, Object> entry : properties.entrySet()) {
boolean isEnable = Boolean.parseBoolean(entry.getValue().toString());
if (isEnable) {
String paramName = entry.getKey().toString().trim();
Annotations annotation = Annotations.getValueOf(paramName);
if (annotation != null) {
annotations.add(annotation);
annotations.addAll(Annotations.getDependencies(annotation));
}
}
}
}
private enum Annotations {
GETTER("getter", "@Getter", "lombok.Getter"),
SETTER("setter", "@Setter", "lombok.Setter"),
DATA("data", "@Data", "lombok.Data"),
BUILDER("builder", "@Builder", "lombok.Builder"),
ALL_ARGS_CONSTRUCTOR("allArgsConstructor", "@AllArgsConstructor", "lombok.AllArgsConstructor"),
NO_ARGS_CONSTRUCTOR("noArgsConstructor", "@NoArgsConstructor", "lombok.NoArgsConstructor"),
TO_STRING("toString", "@ToString", "lombok.ToString");
private final String paramName;
private final String name;
private final FullyQualifiedJavaType javaType;
Annotations(String paramName, String name, String className) {
this.paramName = paramName;
this.name = name;
this.javaType = new FullyQualifiedJavaType(className);
}
private static Annotations getValueOf(String paramName){
for (Annotations annotation : Annotations.values()){
if (String.CASE_INSENSITIVE_ORDER.compare(paramName, annotation.paramName) == 0) {
return annotation;
}
}
return null;
}
private static Collection<Annotations> getDependencies(Annotations annotation){
if (annotation == ALL_ARGS_CONSTRUCTOR) {
return Collections.singleton(NO_ARGS_CONSTRUCTOR);
} else {
return Collections.emptyList();
}
}
}
}
上述程式碼的邏輯就是去掉原來的getter、setter，然後在類上添加註解，以及生成表字段列舉。
檢視生成檔案
將外掛新增到專案中，並且執行完MybatisGenerator，我們來檢視下生成的相關檔案：
Model類：
@Data
@AllArgsConstructor
@Getter
@Builder
public class Administrator{
private Long id;
private String mobile;
private String pwd;
private Byte role;
private Integer deleted;
private Long createTime;
private Long updateTime;
@AllArgsConstructor
public enum COLUMNS {
ID("id"),
MOBILE("mobile"),
PWD("pwd"),
ROLE("role"),
DELETED("deleted"),
CREATE_TIME("create_time"),
UPDATE_TIME("update_time");
@Getter
private String column;
}
}
如何使用
使用方式如下：
Administrator administrator = Administrator.builder() .id(globalIdService.nextId()) .mobile(mobile) .pwd((MD5Util.generate(password))) .role(role) .createTime(now) .updateTime(now).build();
本章節就到這裡了。