mybatisgenerator自定义注释

一般在生成java bean的时候，希望把 sql中的备注信息全都生成出来。这时需要自己定义注释生成。写一个类继承

DefaultCommentGenerator 把DefaultCommentGenerator 

然后对addFieldComment方法进行重写，并且把其他的加注解的方法根据需要是否添加，如果只希望在java bean上有注解存在，那么把期他方法不实现。
public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {

}

在generatorConfig.xml的配置文件中加入这样的配置

<!-- optional，旨在创建class时，对注释进行控制 -->
<commentGenerator type="generator.MyCommentGenerator">
<property name="suppressDate" value="true"/>
<!-- <property name="suppressAllComments" value="true"/>-->
</commentGenerator>

下面是MyCommentGenerator的代码：

public class MyCommentGenerator extends DefaultCommentGenerator {
private Properties properties = new Properties();
private boolean suppressDate = false;
private boolean suppressAllComments = false;
private boolean addRemarkComments = false;
private SimpleDateFormat dateFormat;
public MyCommentGenerator() {
}
public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
if (!this.suppressAllComments) {
field.addJavaDocLine("//"+introspectedColumn.getRemarks());
//
field.addJavaDocLine(" *");
// field.addJavaDocLine(" * This field was generated by MyBatis Generator.");
// StringBuilder sb = new StringBuilder();
// sb.append(" * This field corresponds to the database column ");
// sb.append(introspectedTable.getFullyQualifiedTable());
//sb.append('.');
//sb.append(introspectedColumn.getActualColumnName());
//
sb.append();
// field.addJavaDocLine(sb.toString());
// this.addJavadocTag(field, false);
//
field.addJavaDocLine(" */");
}
}
public void addFieldComment(Field field, IntrospectedTable introspectedTable) {
if (!this.suppressAllComments) {
StringBuilder sb = new StringBuilder();
field.addJavaDocLine("/**");
field.addJavaDocLine(" * This field was generated by MyBatis Generator.");
sb.append(" * This field corresponds to the database table ");
sb.append(introspectedTable.getFullyQualifiedTable());
sb.append(introspectedTable.getRemarks());
field.addJavaDocLine(sb.toString());
this.addJavadocTag(field, false);
field.addJavaDocLine(" */");
}
}
public void addJavaFileComment(CompilationUnit compilationUnit) {
}
public void addComment(XmlElement xmlElement) {
//
if (!this.suppressAllComments) {
//
xmlElement.addElement(new TextElement("<!--"));
//
StringBuilder sb = new StringBuilder();
//
sb.append("
WARNING - ");
//
sb.append("@mbg.generated");
//
xmlElement.addElement(new TextElement(sb.toString()));
//
xmlElement.addElement(new TextElement("
This element is automatically generated by MyBatis Generator, do not modify."));
//
String s = this.getDateString();
//
if (s != null) {
//
sb.setLength(0);
//
sb.append("
This element was generated on ");
//
sb.append(s);
//
sb.append('.');
//
xmlElement.addElement(new TextElement(sb.toString()));
//
}
//
//
xmlElement.addElement(new TextElement("-->"));
//
}
}
public void addRootComment(XmlElement rootElement) {
}
public void addConfigurationProperties(Properties properties) {
this.properties.putAll(properties);
this.suppressDate = StringUtility.isTrue(properties.getProperty("suppressDate"));
this.suppressAllComments = StringUtility.isTrue(properties.getProperty("suppressAllComments"));
this.addRemarkComments = StringUtility.isTrue(properties.getProperty("addRemarkComments"));
String dateFormatString = properties.getProperty("dateFormat");
if (StringUtility.stringHasValue(dateFormatString)) {
this.dateFormat = new SimpleDateFormat(dateFormatString);
}
}
protected void addJavadocTag(JavaElement javaElement, boolean markAsDoNotDelete) {
javaElement.addJavaDocLine(" *");
StringBuilder sb = new StringBuilder();
sb.append(" * ");
sb.append("@mbg.generated");
if (markAsDoNotDelete) {
sb.append(" do_not_delete_during_merge");
}
String s = this.getDateString();
if (s != null) {
sb.append(' ');
sb.append(s);
}
javaElement.addJavaDocLine(sb.toString());
}
protected String getDateString() {
if (this.suppressDate) {
return null;
} else {
return this.dateFormat != null ? this.dateFormat.format(new Date()) : (new Date()).toString();
}
}
public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) {
if (!this.suppressAllComments) {
StringBuilder sb = new StringBuilder();
innerClass.addJavaDocLine("/**");
innerClass.addJavaDocLine(" * This class was generated by MyBatis Generator.");
sb.append(" * This class corresponds to the database table ");
sb.append(introspectedTable.getFullyQualifiedTable());
innerClass.addJavaDocLine(sb.toString());
this.addJavadocTag(innerClass, false);
innerClass.addJavaDocLine(" */");
}
}
public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean markAsDoNotDelete) {
if (!this.suppressAllComments) {
StringBuilder sb = new StringBuilder();
innerClass.addJavaDocLine("/**");
innerClass.addJavaDocLine(" * This class was generated by MyBatis Generator.");
sb.append(" * This class corresponds to the database table ");
sb.append(introspectedTable.getFullyQualifiedTable());
innerClass.addJavaDocLine(sb.toString());
this.addJavadocTag(innerClass, markAsDoNotDelete);
innerClass.addJavaDocLine(" */");
}
}
public void addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
if (!this.suppressAllComments && this.addRemarkComments) {
topLevelClass.addJavaDocLine("/**");
String remarks = introspectedTable.getRemarks();
if (this.addRemarkComments && StringUtility.stringHasValue(remarks)) {
topLevelClass.addJavaDocLine(" * Database Table Remarks:");
String[] remarkLines = remarks.split(System.getProperty("line.separator"));
String[] var5 = remarkLines;
int var6 = remarkLines.length;
for(int var7 = 0; var7 < var6; ++var7) {
String remarkLine = var5[var7];
topLevelClass.addJavaDocLine(" *
" + remarkLine);
}
}
topLevelClass.addJavaDocLine(" *");
topLevelClass.addJavaDocLine(" * This class was generated by MyBatis Generator.");
StringBuilder sb = new StringBuilder();
sb.append(" * This class corresponds to the database table ");
sb.append(introspectedTable.getFullyQualifiedTable());
topLevelClass.addJavaDocLine(sb.toString());
topLevelClass.addJavaDocLine(" */");
}
}
public void addEnumComment(InnerEnum innerEnum, IntrospectedTable introspectedTable) {
if (!this.suppressAllComments) {
StringBuilder sb = new StringBuilder();
innerEnum.addJavaDocLine("/**");
innerEnum.addJavaDocLine(" * This enum was generated by MyBatis Generator.");
sb.append(" * This enum corresponds to the database table ");
sb.append(introspectedTable.getFullyQualifiedTable());
innerEnum.addJavaDocLine(sb.toString());
this.addJavadocTag(innerEnum, false);
innerEnum.addJavaDocLine(" */");
}
}
public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {
//
if (!this.suppressAllComments) {
//
StringBuilder sb = new StringBuilder();
//
method.addJavaDocLine("/**");
//
method.addJavaDocLine(" * This method was generated by MyBatis Generator.");
//
sb.append(" * This method corresponds to the database table ");
//
sb.append(introspectedTable.getFullyQualifiedTable());
//
method.addJavaDocLine(sb.toString());
//
this.addJavadocTag(method, false);
//
method.addJavaDocLine(" */");
//
}
}
public void addGetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
//
if (!this.suppressAllComments) {
//
StringBuilder sb = new StringBuilder();
//
method.addJavaDocLine("/**");
//
method.addJavaDocLine(" * This method was generated by MyBatis Generator.");
//
sb.append(" * This method returns the value of the database column ");
//
sb.append(introspectedTable.getFullyQualifiedTable());
//
sb.append('.');
//
sb.append(introspectedColumn.getActualColumnName());
//
method.addJavaDocLine(sb.toString());
//
method.addJavaDocLine(" *");
//
sb.setLength(0);
//
sb.append(" * @return the value of ");
//
sb.append(introspectedTable.getFullyQualifiedTable());
//
sb.append('.');
//
sb.append(introspectedColumn.getActualColumnName());
//
method.addJavaDocLine(sb.toString());
//
this.addJavadocTag(method, false);
//
method.addJavaDocLine(" */");
//
}
}
public void addSetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
//
if (!this.suppressAllComments) {
//
StringBuilder sb = new StringBuilder();
//
method.addJavaDocLine("/**");
//
method.addJavaDocLine(" * This method was generated by MyBatis Generator.");
//
sb.append(" * This method sets the value of the database column ");
//
sb.append(introspectedTable.getFullyQualifiedTable());
//
sb.append('.');
//
sb.append(introspectedColumn.getActualColumnName());
//
method.addJavaDocLine(sb.toString());
//
method.addJavaDocLine(" *");
//
Parameter parm = (Parameter)method.getParameters().get(0);
//
sb.setLength(0);
//
sb.append(" * @param ");
//
sb.append(parm.getName());
//
sb.append(" the value for ");
//
sb.append(introspectedTable.getFullyQualifiedTable());
//
sb.append('.');
//
sb.append(introspectedColumn.getActualColumnName());
//
method.addJavaDocLine(sb.toString());
//
this.addJavadocTag(method, false);
//
method.addJavaDocLine(" */");
//
}
}
public void addGeneralMethodAnnotation(Method method, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> imports) {
imports.add(new FullyQualifiedJavaType("javax.annotation.Generated"));
String comment = "Source Table: " + introspectedTable.getFullyQualifiedTable().toString();
method.addAnnotation(this.getGeneratedAnnotation(comment));
}
public void addGeneralMethodAnnotation(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn, Set<FullyQualifiedJavaType> imports) {
imports.add(new FullyQualifiedJavaType("javax.annotation.Generated"));
String comment = "Source field: " + introspectedTable.getFullyQualifiedTable().toString() + "." + introspectedColumn.getActualColumnName();
method.addAnnotation(this.getGeneratedAnnotation(comment));
}
public void addFieldAnnotation(Field field, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> imports) {
imports.add(new FullyQualifiedJavaType("javax.annotation.Generated"));
String comment = "Source Table: " + introspectedTable.getFullyQualifiedTable().toString();
field.addAnnotation(this.getGeneratedAnnotation(comment));
}
public void addFieldAnnotation(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn, Set<FullyQualifiedJavaType> imports) {
imports.add(new FullyQualifiedJavaType("javax.annotation.Generated"));
String comment = "Source field: " + introspectedTable.getFullyQualifiedTable().toString() + "." + introspectedColumn.getActualColumnName();
field.addAnnotation(this.getGeneratedAnnotation(comment));
if (!this.suppressAllComments && this.addRemarkComments) {
String remarks = introspectedColumn.getRemarks();
if (this.addRemarkComments && StringUtility.stringHasValue(remarks)) {
field.addJavaDocLine("/**");
field.addJavaDocLine(" * Database Column Remarks:");
String[] remarkLines = remarks.split(System.getProperty("line.separator"));
String[] var8 = remarkLines;
int var9 = remarkLines.length;
for(int var10 = 0; var10 < var9; ++var10) {
String remarkLine = var8[var10];
field.addJavaDocLine(" *
" + remarkLine);
}
field.addJavaDocLine(" */");
}
}
}
public void addClassAnnotation(InnerClass innerClass, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> imports) {
imports.add(new FullyQualifiedJavaType("javax.annotation.Generated"));
String comment = "Source Table: " + introspectedTable.getFullyQualifiedTable().toString();
innerClass.addAnnotation(this.getGeneratedAnnotation(comment));
}
private String getGeneratedAnnotation(String comment) {
StringBuilder buffer = new StringBuilder();
buffer.append("@Generated(");
if (this.suppressAllComments) {
buffer.append('"');
} else {
buffer.append("value="");
}
buffer.append(MyBatisGenerator.class.getName());
buffer.append('"');
if (!this.suppressDate && !this.suppressAllComments) {
buffer.append(", date="");
buffer.append(DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(ZonedDateTime.now()));
buffer.append('"');
}
if (!this.suppressAllComments) {
buffer.append(", comments="");
buffer.append(comment);
buffer.append('"');
}
buffer.append(')');
return buffer.toString();
}

最后

以上就是懦弱猎豹为你收集整理的mybatisgenerator自定义注释的全部内容，希望文章能够帮你解决mybatisgenerator自定义注释所遇到的程序开发问题。

如果觉得靠谱客网站的内容还不错，欢迎将靠谱客网站推荐给程序员好友。