MyBatis Generator插件之ToStringPlugin
2017-08-27 15:01
295 查看
org.mybatis.generator.plugins.ToStringPlugin
示例使用的DDL为:
CREATE TABLE `userinfo` (
`id` bigint(20) NOT NULL AUTO_INCREMENT,
`userName` varchar(255) DEFAULT NULL,
`password` varchar(255) DEFAULT NULL,
`email` varchar(255) DEFAULT NULL,
`age` int(11) DEFAULT NULL,
`DEPT_ID` bigint(20) DEFAULT NULL,
`admin` tinyint(1) DEFAULT NULL,
PRIMARY KEY (`id`)
)
在generatorConfig.xml中加上配置:
<plugin type="org.mybatis.generator.plugins.ToStringPlugin" />
在UserInfo中生成的toString方法:
ToStringPlugin的代码:
public class ToStringPlugin extends PluginAdapter {
......
}
该类确实是继承了插件的适配类。
public boolean validate(List<String> warnings) {
return true;
}
实现了validate方法,validate方法是所有的plugin都必须实现的方法,一般在该方法中对参数进行验证,验证通过则返回为true,否则返回false。因为ToStringPlugin没有参数,所以直接返回了true;
public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass,
IntrospectedTable introspectedTable) {
generateToString(introspectedTable, topLevelClass);
return true;
}
实现了modelBaseRecordClassGenerated方法,在MBG生成record类的时候调用的插件的方法,在该方法中,传入两个参数,
一个是topLevelClass,该类的实例就是表示当前正在生成的类的DOM结构,
第二个introspectedTable是代表的runtime环境,包含了所有context中的配置,一般从这个类中去查询生成对象的一些规则;
可以看到,这个方法仅仅只是调用了generateToString方法,这个方法总是返回了true,让后面的实现了相同方法的插件能正常运行;
实现了modelRecordWithBLOBsClassGenerated方法,也只是调用了generateToString方法;
接下来就是看具体怎么实现了toString方法的:
示例使用的DDL为:
CREATE TABLE `userinfo` (
`id` bigint(20) NOT NULL AUTO_INCREMENT,
`userName` varchar(255) DEFAULT NULL,
`password` varchar(255) DEFAULT NULL,
`email` varchar(255) DEFAULT NULL,
`age` int(11) DEFAULT NULL,
`DEPT_ID` bigint(20) DEFAULT NULL,
`admin` tinyint(1) DEFAULT NULL,
PRIMARY KEY (`id`)
)
在generatorConfig.xml中加上配置:
<plugin type="org.mybatis.generator.plugins.ToStringPlugin" />
在UserInfo中生成的toString方法:
@Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append(getClass().getSimpleName()); sb.append(" ["); sb.append("Hash = ").append(hashCode()); sb.append(", id=").append(id); sb.append(", username=").append(username); sb.append(", password=").append(password); sb.append(", email=").append(email); sb.append(", age=").append(age); sb.append(", deptId=").append(deptId); sb.append(", admin=").append(admin); sb.append(", serialVersionUID=").append(serialVersionUID); sb.append("]"); return sb.toString(); }
ToStringPlugin的代码:
public class ToStringPlugin extends PluginAdapter {
......
}
该类确实是继承了插件的适配类。
public boolean validate(List<String> warnings) {
return true;
}
实现了validate方法,validate方法是所有的plugin都必须实现的方法,一般在该方法中对参数进行验证,验证通过则返回为true,否则返回false。因为ToStringPlugin没有参数,所以直接返回了true;
public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass,
IntrospectedTable introspectedTable) {
generateToString(introspectedTable, topLevelClass);
return true;
}
实现了modelBaseRecordClassGenerated方法,在MBG生成record类的时候调用的插件的方法,在该方法中,传入两个参数,
一个是topLevelClass,该类的实例就是表示当前正在生成的类的DOM结构,
第二个introspectedTable是代表的runtime环境,包含了所有context中的配置,一般从这个类中去查询生成对象的一些规则;
可以看到,这个方法仅仅只是调用了generateToString方法,这个方法总是返回了true,让后面的实现了相同方法的插件能正常运行;
public boolean modelPrimaryKeyClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) { generateToString(introspectedTable, topLevelClass); return true; }实现了modelBaseRecordClassGenerated方法,该方法就是前面提到,在MBG生成key Class类的时候调用的插件的方法,也只是调用了generateToString方法
public boolean modelRecordWithBLOBsClassGenerated( TopLevelClass topLevelClass, IntrospectedTable introspectedTable) { generateToString(introspectedTable, topLevelClass); return true; }
实现了modelRecordWithBLOBsClassGenerated方法,也只是调用了generateToString方法;
接下来就是看具体怎么实现了toString方法的:
/** * 具体生成toString方法 * @param introspectedTable * @param topLevelClass */ private void generateToString(IntrospectedTable introspectedTable, TopLevelClass topLevelClass) { //首先创建一个Method对象,注意,这个Method是org.mybatis.generator.api.dom.java.Method, //这个Method是MBG中对对象DOM的一个抽象;因为我们要添加方法,所以先创建一个; Method method = new Method(); //设置这个方法的可见性为public,代码已经在一步一步构建这个方法了 method.setVisibility(JavaVisibility.PUBLIC); //设置方法的返回类型,这里注意一下的就是,returnType是一个FullyQualifiedJavaType; //这个FullyQualifiedJavaType是MGB中对Java中的类型的一个DOM封装,这个类在整个MBG中大量使用; //FullyQualifiedJavaType提供了几个静态的方法,比如getStringInstance,就直接返回了一个对String类型的封装; method.setReturnType(FullyQualifiedJavaType.getStringInstance()); //设置方法的名称,至此,方法签名已经装配完成; method.setName("toString"); //$NON-NLS-1$ //判断当前MBG运行的环境是否支持Java5(这里就可以看出来IntrospectedTable类的作用了,主要是查询生成环境的作用) if (introspectedTable.isJava5Targeted()) { //如果支持Java5,就在方法上面生成一个@Override标签; method.addAnnotation("@Override"); //$NON-NLS-1$ } //访问上下文对象(这个context对象是在PluginAdapter初始化完成后,通过setContext方法设置进去的, //通过getCommentGenerator方法得到注释生成器,并调用addGeneralMethodComment为当前生成的方法添加注释; //因为我们没有提供自己的注释生成器,所以默认的注释生成器只是说明方法是通过MBG生成的,对应的是哪个表而已; //这句代码其实非常有意义,通过这句代码,我们基本就可能了解到MBG中对于方法注释的生成方式了; context.getCommentGenerator().addGeneralMethodComment(method, introspectedTable); //OK,调用addBodyLine开始为方法添加代码了 //可以看到,确实,只是简单的把要生成的代码通过String拼装到了method的body中而已; //想到了什么?确实,我想到了Servelt的输出方法。MBG默认的方法体具体的实现,就是像Servlet那样通过String输出的; //所以,这才会为我们后面准备用Velocity来重写MBG提供了依据,我们只是给MBG添加一个MVC的概念; method.addBodyLine("StringBuilder sb = new StringBuilder();"); //$NON-NLS-1$ method.addBodyLine("sb.append(getClass().getSimpleName());"); //$NON-NLS-1$ method.addBodyLine("sb.append(\" [\");"); //$NON-NLS-1$ method.addBodyLine("sb.append(\"Hash = \").append(hashCode());"); //$NON-NLS-1$ //接下来要准备拼装类的字段了; StringBuilder sb = new StringBuilder(); //通过topLevelClass得到当前类的所有字段,注意,这里的Field是org.mybatis.generator.api.dom.java.Field //这个Field是MBG对字段的一个DOM封装 for (Field field : topLevelClass.getFields()) { //得到字段的名称; String property = field.getName(); //重置StringBuilder; sb.setLength(0); //添加字段的输出代码; sb.append("sb.append(\"").append(", ").append(property) //$NON-NLS-1$ //$NON-NLS-2$ .append("=\")").append(".append(").append(property) //$NON-NLS-1$ //$NON-NLS-2$ .append(");"); //$NON-NLS-1$ //把这个字段的toString输出到代码中;所以才看到我们最后生成的代码结果中,每一个字段在toString方法中各占一行; method.addBodyLine(sb.toString()); } method.addBodyLine("sb.append(\"]\");"); //$NON-NLS-1$ method.addBodyLine("return sb.toString();"); //$NON-NLS-1$ //把拼装好的方法DOM添加到topLevelClass中,完成方法添加; topLevelClass.addMethod(method); }
相关文章推荐
- MyBatis Generator系列(五)----MyBatis Generator Plugin插件之ToStringPlugin
- mybatis-generator-maven-plugin 插件扩展 增加自定义方法
- MyBatis插件的使用:mybatis-generator、mybatis-plugin、mybatis-pagehelper
- mybatis-generator的maven插件使用异常(mybatis-generator-maven-plugin):generate failed: Exception getting JDBC Driver
- MyBatis Generator插件之MapperConfigPlugin
- mybatis (Ibatis ibator) generator - 1 mysql 分页插件(page/paging/pagination plugin)
- mybatis3-generator-plugin插件地址
- IntelliJ IDEA下使用 mybatis-generator-maven-plugin插件完成Mybatis逆向工程
- MyBatis Generator系列(六)----MyBatis Generator Plugin插件之SerializablePlugin
- 在IDEA下,使用maven的mybatis-generator-maven-plugin插件自动生成实体类
- MyBatis Generator系列(七)----MyBatis Generator Plugin插件之MapperConfigPlugin
- IDEA mybatis-generator-maven-plugin 插件的使用
- mybatis-generator-maven-plugin插件自动生成代码的配置方法
- 在IDEA下,使用maven的mybatis-generator-maven-plugin插件自动生成实体类
- idea + mybatis generator + maven 插件使用
- Eclipse配置MyBatis-Generator插件的方法
- 基于注解的Mybatis Generator插件
- MyBatis Generator作为maven插件自动生成增删改查代码及配置文件例子
- maven插件mybatis-generator自动生成代码
- Mybatis 自动生成对象插件-Generator最完整配置详解