packageorg.mybatis.generator;import staticorg.mybatis.generator.internal.util.StringUtility.isTrue;importjava.text.SimpleDateFormat;importjava.util.Date;importjava.util.Properties;importorg.mybatis.generator.api.CommentGenerator;importorg.mybatis.generator.api.IntrospectedColumn;importorg.mybatis.generator.api.IntrospectedTable;importorg.mybatis.generator.api.dom.java.CompilationUnit;importorg.mybatis.generator.api.dom.java.Field;importorg.mybatis.generator.api.dom.java.InnerClass;importorg.mybatis.generator.api.dom.java.InnerEnum;importorg.mybatis.generator.api.dom.java.JavaElement;importorg.mybatis.generator.api.dom.java.Method;importorg.mybatis.generator.api.dom.java.Parameter;importorg.mybatis.generator.api.dom.xml.XmlElement;importorg.mybatis.generator.config.MergeConstants;importorg.mybatis.generator.config.PropertyRegistry;/*** 描述:
*@since1.9.10
*@version1.9.10
* @作者:niexiaohui
* @创建时间:2016年11月22日
* @修改记录:*/
public class MyCommentGenerator implementsCommentGenerator{privateProperties properties;privateProperties systemPro;private booleansuppressDate;private booleansuppressAllComments;privateString currentDateStr;publicMyCommentGenerator() {super();
properties= newProperties();
systemPro=System.getProperties();
suppressDate= false;
suppressAllComments= false;
currentDateStr= (new SimpleDateFormat("yyyy-MM-dd")).format(newDate());
}public voidaddJavaFileComment(CompilationUnit compilationUnit) {//add no file level comments by default
return;
}/*** Adds a suitable comment to warn users that the element was generated, and
* when it was generated.*/
public voidaddComment(XmlElement xmlElement) {return;
}public voidaddRootComment(XmlElement rootElement) {//add no document level comments by default
return;
}public voidaddConfigurationProperties(Properties properties) {this.properties.putAll(properties);
suppressDate=isTrue(properties.getProperty(PropertyRegistry.COMMENT_GENERATOR_SUPPRESS_DATE));
suppressAllComments=isTrue(properties.getProperty(PropertyRegistry.COMMENT_GENERATOR_SUPPRESS_ALL_COMMENTS));
}/*** This method adds the custom javadoc tag for. You may do nothing if you do
* not wish to include the Javadoc tag - however, if you do not include the
* Javadoc tag then the Java merge capability of the eclipse plugin will
* break.
*
*@paramjavaElement
* the java element*/
protected void addJavadocTag(JavaElement javaElement, booleanmarkAsDoNotDelete) {
javaElement.addJavaDocLine(" *");
StringBuilder sb= newStringBuilder();
sb.append(" * ");
sb.append(MergeConstants.NEW_ELEMENT_TAG);if(markAsDoNotDelete) {
sb.append(" do_not_delete_during_merge");
}
String s=getDateString();if (s != null) {
sb.append(' ');
sb.append(s);
}
javaElement.addJavaDocLine(sb.toString());
}/*** This method returns a formated date string to include in the Javadoc tag
* and XML comments. You may return null if you do not want the date in
* these documentation elements.
*
*@returna string representing the current timestamp, or null*/
protectedString getDateString() {
String result= null;if (!suppressDate) {
result=currentDateStr;
}returnresult;
}public voidaddClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) {if(suppressAllComments) {return;
}
StringBuilder sb= newStringBuilder();
innerClass.addJavaDocLine("/**");
sb.append(" * ");
sb.append(introspectedTable.getFullyQualifiedTable());
sb.append(" ");
sb.append(getDateString());
innerClass.addJavaDocLine(sb.toString().replace("\n", " "));
innerClass.addJavaDocLine(" */");
}public voidaddEnumComment(InnerEnum innerEnum, IntrospectedTable introspectedTable) {if(suppressAllComments) {return;
}
StringBuilder sb= newStringBuilder();
innerEnum.addJavaDocLine("/**");
sb.append(" * ");
sb.append(introspectedTable.getFullyQualifiedTable());
innerEnum.addJavaDocLine(sb.toString().replace("\n", " "));
innerEnum.addJavaDocLine(" */");
}public voidaddFieldComment(Field field, IntrospectedTable introspectedTable,
IntrospectedColumn introspectedColumn) {if(suppressAllComments) {return;
}
StringBuilder sb= newStringBuilder();
field.addJavaDocLine("/**");
sb.append(" * ");
sb.append(introspectedColumn.getRemarks());
field.addJavaDocLine(sb.toString().replace("\n", " "));
field.addJavaDocLine(" */");
}public voidaddFieldComment(Field field, IntrospectedTable introspectedTable) {if(suppressAllComments) {return;
}
StringBuilder sb= newStringBuilder();
field.addJavaDocLine("/**");
sb.append(" * ");
sb.append(introspectedTable.getFullyQualifiedTable());
field.addJavaDocLine(sb.toString().replace("\n", " "));
field.addJavaDocLine(" */");
}public voidaddGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {if(suppressAllComments) {return;
}
method.addJavaDocLine("/**");
addJavadocTag(method,false);
method.addJavaDocLine(" */");
}public voidaddGetterComment(Method method, IntrospectedTable introspectedTable,
IntrospectedColumn introspectedColumn) {if(suppressAllComments) {return;
}
method.addJavaDocLine("/**");
StringBuilder sb= newStringBuilder();
sb.append(" * ");
sb.append(introspectedColumn.getRemarks());
method.addJavaDocLine(sb.toString().replace("\n", " "));
sb.setLength(0);
sb.append(" * @return ");
sb.append(introspectedColumn.getActualColumnName());
sb.append(" ");
sb.append(introspectedColumn.getRemarks());
method.addJavaDocLine(sb.toString().replace("\n", " "));
method.addJavaDocLine(" */");
}public voidaddSetterComment(Method method, IntrospectedTable introspectedTable,
IntrospectedColumn introspectedColumn) {if(suppressAllComments) {return;
}
method.addJavaDocLine("/**");
StringBuilder sb= newStringBuilder();
sb.append(" * ");
sb.append(introspectedColumn.getRemarks());
method.addJavaDocLine(sb.toString().replace("\n", " "));
Parameter parm= method.getParameters().get(0);
sb.setLength(0);
sb.append(" * @param ");
sb.append(parm.getName());
sb.append(" ");
sb.append(introspectedColumn.getRemarks());
method.addJavaDocLine(sb.toString().replace("\n", " "));
method.addJavaDocLine(" */");
}public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, booleanmarkAsDoNotDelete) {if(suppressAllComments) {return;
}
StringBuilder sb= newStringBuilder();
innerClass.addJavaDocLine("/**");
sb.append(" * ");
sb.append(introspectedTable.getFullyQualifiedTable());
innerClass.addJavaDocLine(sb.toString().replace("\n", " "));
sb.setLength(0);
sb.append(" * @author ");
sb.append(systemPro.getProperty("user.name"));
sb.append(" ");
sb.append(currentDateStr);
innerClass.addJavaDocLine(" */");
}
}