01 mybatis-generator扩展教程系列 -- 自定义配置参数修改DAO,Mapper文件后缀
[url]http://blog.csdn.net/shadowsick/article/details/53425831?_t_t_t=0.9055960364639759[/url]
02 MyBatis Generator 1.3.4 扩展
[url]http://blog.csdn.net/isea533/article/details/52430691[/url]
[color=red]03 Mybatis-generator源码学习和修改[/color]
[url]http://blog.csdn.net/wu6660563/article/details/52093364[/url]
感谢原创:
01转载 mybatis-generator 自定义配置参数DAO,Mapper文件后缀
02转载 MyBatis Generator 1.3.4 扩展
03转载 Mybatis-generator源码学习和修改
===================================================================
03
MyBatis Generator 快速入门指南
参考:
mybatis配置说明:http://generator.sturgeon.mopaas.com/index.html
大象修改博客:http://www.blogjava.net/bolo/archive/2015/03/25/423826.html
Mybatis-Generator详细配置:http://www.jianshu.com/p/e09d2370b796
启动说明
java -jar mybatis-generator-core-x.x.x.jar -configfile \temp\generatorConfig.xml -overwrite
源码方式:运行ShellRunner文件
修改后源码下载地址:https://github.com/wu6660563/MybatisGenerator
1、Mapper.xml空格改成四个空格
修改详情:
org.mybatis.generator.api.dom.OutputUtilities
mybatis-generator 里面我觉得首先最应该改的就是 OutputUtilities 这个类,它里面有个 xmlIndent 方法是用来控制生成的 xml 文件中空格的缩进,默认是两个空格
但四个空格对于我们来说已经深入骨髓了,所以必须改。 在 sb.append( " " ) 里面增加两个空格就可以了。
2、修改dao包下的名称,由原来的XXXMapper改成XXXDao
修改详情:
org.mybatis.generator.api.IntrospectedTable
calculateJavaClientAttributes方法(大概820行)
sb.append("Mapper");注释掉改成 sb.append("Dao");
3、修改Mybatis的Model生成JavaDoc注释内容:
1)generatorConfig.xml配置里面设置成:<property name="suppressAllComments" value="false"/>
代码修改详情:
org.mybatis.generator.internal.DefaultCommentGenerator里面的添加注释代码去掉,改成
------------------------------ code start ----------------------------------------
field.addJavaDocLine("/**");
field.addJavaDocLine(" * @Fields "+field.getName()+" "+introspectedColumn.getRemarks());
field.addJavaDocLine(" */");
------------------------------ code end ---------------------------------------------
4、org.mybatis.generator.internal.DefaultCommentGenerator修改XXXDao.java(XXXMapper.java)的接口方法的Javadoc注释
搜索org.mybatis.generator.internal.DefaultCommentGenerator如下方法,并注释方法里面内容,
public void addGeneralMethodComment(Method method,
IntrospectedTable introspectedTable)
改成:
method.addJavaDocLine("/**");
method.addJavaDocLine(" * @Title " + method.getName());
for (Parameter parameter : method.getParameters()) {
method.addJavaDocLine(" * @param " + parameter.getName());
}
String returnType = method.getReturnType().toString();
returnType = returnType.lastIndexOf(".") != -1 ? returnType.substring(returnType.lastIndexOf(".") + 1) : returnType;
method.addJavaDocLine(" * @return " + returnType);
method.addJavaDocLine(" */");
5、注释掉Model里面Getter和Setter方法的注释,根据需要自己加上配置
搜索org.mybatis.generator.internal.DefaultCommentGenerator如下方法:
public void addGetterComment(Method method,
IntrospectedTable introspectedTable,
IntrospectedColumn introspectedColumn)
public void addSetterComment(Method method,
IntrospectedTable introspectedTable,
IntrospectedColumn introspectedColumn)
6、注释掉Mapper.xml里面的<!-- 注释 -->,实际使用未用到
搜索org.mybatis.generator.internal.DefaultCommentGenerator如下方法:
public void addComment(XmlElement xmlElement)
7、XML里面每个SQL增加一个换行
org.mybatis.generator.api.dom.xml.XmlElement里面getFormattedContent里面加上:
if(indentLevel == 1) {
//每个insert/update/select之间插入一个空行
OutputUtilities.newLine(sb);
}
8、修改mybatis的mapper.xml文件里面insert和update不根据字段判断的非动态SQL
org.mybatis.generator.codegen.mybatis3.xmlmapper.XMLMapperGenerator
里面的getSqlMapElement方法
注释掉:
addInsertElement(answer);
addUpdateByPrimaryKeyWithoutBLOBsElement(answer);
对应的是mapper.xml里面的
<insert id="insert" parameterType="xxx" ></insert>
<update id="updateByPrimaryKey" parameterType="xxx" ></update>
===================================================================
02
MyBatis Generator 1.3.4 扩展
可以设置 Mapper(Dao)后缀
MyBatis Generator 简称 MBG,许多人在看 MyBatis Generator 详解 的时候问过我能不能设置 Mapper 的后缀为 Dao,在当时的情况下是没法解决的。但是到了 1.3.4 版本,MBG 在<table>元素上提供了一个 mapperName 的属性,可以设置生成的 Mapper 名字,使用方法如下:
<table tableName="sys_store" mapperName="StoreDao">
<generatedKey column="id" sqlStatement="Mysql"/>
</table>
本来默认情况下生成的 mapper 名字为StoreMapper,通过上面设置后,就会生成 StroreDao,对于一般情况的用法这就够了。
但是因为 tableName 属性支持通配符 %,在这种情况下就不能使用mapperName属性设置了。为了解决这种情况,提供了一个插件可以用于通配符情况下的配置。
注意必须使用 MBG 1.3.4 或以上版本。
插件的思路很简单,在 MBG 中,使用 mapperName 的地方如下:
if (stringHasValue(tableConfiguration.getMapperName())) {
sb.append(tableConfiguration.getMapperName());
} else {
sb.append(fullyQualifiedTable.getDomainObjectName());
sb.append("Mapper"); //$NON-NLS-1$
}
看 else 中可以发现,默认是用DomainObjectName和Mapper拼接到一起的,所以对于 mapperName 我们可以设置为{0}Dao,然后使用MessageFormat,以DomainObjectName作为一个参数去格式化 mapperName ,这样就能很简单的解决通配符情况下的问题。
mapperName 出现在org.mybatis.generator.api.IntrospectedTable类中的下面两个方法中:
//包含处理 Mapper 接口和 SqlProvider 的代码
protected void calculateJavaClientAttributes() {
//...
}
//包含处理 Mapper.xml 的代码
protected String calculateMyBatis3XmlMapperFileName() {
}
平时我们在<context>
中设置targetRuntime
属性时,使用的是MyBatis3
或MyBatis3Simple
,他们对应的两个类,都是继承自IntrospectedTable
,所以我们修改的时候,要针对这两个继承的类去实现。
这里给出完整的代码:
//MyBatis3 的实现
public class TkMyBatis3Impl extends IntrospectedTableMyBatis3Impl {
@Override
protected String calculateMyBatis3XmlMapperFileName() {
StringBuilder sb = new StringBuilder();
if (stringHasValue(tableConfiguration.getMapperName())) {
String mapperName = tableConfiguration.getMapperName();
int ind = mapperName.lastIndexOf('.');
if (ind != -1) {
mapperName = mapperName.substring(ind + 1);
}
//支持mapperName = "{0}Dao" 等用法
sb.append(MessageFormat.format(mapperName, fullyQualifiedTable.getDomainObjectName()));
sb.append(".xml"); //$NON-NLS-1$
} else {
sb.append(fullyQualifiedTable.getDomainObjectName());
sb.append("Mapper.xml"); //$NON-NLS-1$
}
return sb.toString();
}
@Override
protected void calculateJavaClientAttributes() {
if (context.getJavaClientGeneratorConfiguration() == null) {
return;
}
StringBuilder sb = new StringBuilder();
sb.append(calculateJavaClientImplementationPackage());
sb.append('.');
sb.append(fullyQualifiedTable.getDomainObjectName());
sb.append("DAOImpl"); //$NON-NLS-1$
setDAOImplementationType(sb.toString());
sb.setLength(0);
sb.append(calculateJavaClientInterfacePackage());
sb.append('.');
sb.append(fullyQualifiedTable.getDomainObjectName());
sb.append("DAO"); //$NON-NLS-1$
setDAOInterfaceType(sb.toString());
sb.setLength(0);
sb.append(calculateJavaClientInterfacePackage());
sb.append('.');
if (stringHasValue(tableConfiguration.getMapperName())) {
//支持mapperName = "{0}Dao" 等用法
sb.append(MessageFormat.format(tableConfiguration.getMapperName(), fullyQualifiedTable.getDomainObjectName()));
} else {
sb.append(fullyQualifiedTable.getDomainObjectName());
sb.append("Mapper"); //$NON-NLS-1$
}
setMyBatis3JavaMapperType(sb.toString());
sb.setLength(0);
sb.append(calculateJavaClientInterfacePackage());
sb.append('.');
if (stringHasValue(tableConfiguration.getSqlProviderName())) {
//支持mapperName = "{0}SqlProvider" 等用法
sb.append(MessageFormat.format(tableConfiguration.getSqlProviderName(), fullyQualifiedTable.getDomainObjectName()));
} else {
sb.append(fullyQualifiedTable.getDomainObjectName());
sb.append("SqlProvider"); //$NON-NLS-1$
}
setMyBatis3SqlProviderType(sb.toString());
}
}
另一个和上面代码一样,只是继承的类变了:
//MyBatis3Simple 的实现
public class TkMyBatis3Impl extends IntrospectedTableMyBatis3SimpleImpl {
//内容和上面的一样
}
如何使用?
写个插件很容易,但是如何用对很多人来说都是一个大问题。
先说如何配置,再说如何运行。
配置
配置方式,只是修改<context>
的targetRuntime
属性,如下:
<context id="Mysql" targetRuntime="tk.mybatis.mapper.generator.TkMyBatis3Impl">
</context>
在<table>
中配置的时候如下:
<!-- 注意:原有的用法不变,下面这么写可以省去部分名称 -->
<table tableName="sys_store" mapperName="{0}Dao">
<generatedKey column="id" sqlStatement="Mysql"/>
</table>
<!-- 或者通配符情况 -->
<table tableName="sys%" mapperName="{0}Dao">
<generatedKey column="id" sqlStatement="Mysql"/>
</table>
运行
这里说明两种情况,其他的可以自行尝试。
在 IDE 中通过 Java 代码运行 MBG
如下代码:
List<String> warnings = new ArrayList<String>();
boolean overwrite = true;
ConfigurationParser cp = new ConfigurationParser(warnings);
Configuration config = cp.parseConfiguration(
Surrogate.Generator.class.getResourceAsStream("/generator.xml"));
DefaultShellCallback callback = new DefaultShellCallback(overwrite);
MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
myBatisGenerator.generate(null);
使用这种方式运行代码的时候,只需要保证上面两个实现的代码(或Jar)在当前运行的环境下(classpath)就可以使用。如果不在 classpath 下,就会因为找不到而报错。
在 CMD(命令行)执行
将代码打 jar 包,例如为 tk.mybatis.generator.jar
命令行执行如下:
java -Dfile.encoding=UTF-8 -cp tk.mybatis.generator.jar;mybatis-generator-core-1.3.4.jar org.mybatis.generator.api.ShellRunner -configfile generatorConfig.xml -overwrite
这里通过 -cp
将需要用到的所有 jar 包放到当前的 classpath 下(分号隔开),这样在运行的时候就能找到相应的类。
另外 -Dfile.encoding=UTF-8
可以保证生成代码的编码格式为UTF-8
。
最后
上面两个类已经包含在 通用Mapper 中,通用Mapper地址:
http://git.oschina.net/free/Mapper
上面两个类对应的包地址:
http://git.oschina.net/free/Mapper/tree/master/src/main/java/tk/mybatis/mapper/generator