mybatis代码生成器避免生成Example类的配置参数

最新推荐文章于 2020-06-22 19:49:06 发布
最新推荐文章于 2020-06-22 19:49:06 发布
阅读量452 收藏
点赞数
文章标签： SQL XML DAO JDBC Microsoft 
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
  PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
  "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

<generatorConfiguration>
	<classPathEntry location="d://java//sqljdbc4.jar" />

	<context id="DB2Tables" targetRuntime="MyBatis3">

		<property name="suppressTypeWarnings" value="true" />

		<plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin" />
		<plugin type="org.mybatis.generator.plugins.SerializablePlugin" />
		<plugin type="org.mybatis.generator.plugins.CaseInsensitiveLikePlugin" />
		<plugin type="org.mybatis.generator.plugins.RenameExampleClassPlugin">
			<property name="searchString" value="Example$" />
			<property name="replaceString" value="Criteria" />
		</plugin>
		<plugin type="com.shinowit.mybatis.plugin.SelectByPagePlugin" />
		<plugin type="com.shinowit.mybatis.plugin.Struts2ActionPlugin" />
   	<commentGenerator>
			<property name="suppressAllComments" value="true" />
		</commentGenerator>

		<jdbcConnection driverClass="com.microsoft.sqlserver.jdbc.SQLServerDriver"
			connectionURL="jdbc:sqlserver://localhost:1433;databaseName=OSS;"
			userId="sa" password="sasa">
		</jdbcConnection>

		<javaTypeResolver>
			<property name="forceBigDecimals" value="false" />
		</javaTypeResolver>

		<javaModelGenerator targetPackage="com.shinowit.model"
			targetProject="src">
			<property name="enableSubPackages" value="true" />
			<property name="trimStrings" value="true" />
		</javaModelGenerator>

		<sqlMapGenerator targetPackage="com.shinowit.dao.mapper"
			targetProject="src">
			<property name="enableSubPackages" value="true" />
		</sqlMapGenerator>

		<javaClientGenerator type="XMLMAPPER"
			targetPackage="com.shinowit.dao.mapper" targetProject="src">
			<property name="enableSubPackages" value="true" />
		</javaClientGenerator>


		<table tableName="TBa_MemberInfo">
			<generatedKey column="ID" sqlStatement="SqlServer"
				identity="true" />
		</table>
		<table tableName="TBa_SupplyRecordInfo">
			<generatedKey column="ID" sqlStatement="SqlServer"
				identity="true" />
		</table>

	</context>
</generatorConfiguration>

 其实想要mybaits代码生成器生成Example类换个名字，是通过插件实现的，即下面的这个插件配置参数很关键。

		<plugin type="org.mybatis.generator.plugins.RenameExampleClassPlugin">
			<property name="searchString" value="Example$" />
			<property name="replaceString" value="Criteria" />
		</plugin>

 

 

如果不喜欢生成的代码中带有代理的mybatis代码生成器的注解信息，可以配置下面的配置参数关闭注解信息的生成：

 

	<commentGenerator>
			<property name="suppressAllComments" value="true" />
	</commentGenerator>

 

 

上面示例中的分页代码自动生成插件是我自己写的，用于自动生成数据库物理分页的代码。

 

该插件的源码如下：

package com.shinowit.mybatis.plugin;

import static org.mybatis.generator.internal.util.messages.Messages.getString;

import java.util.List;
import java.util.Set;
import java.util.TreeSet;

import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.PluginAdapter;
import org.mybatis.generator.api.dom.java.Field;
import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
import org.mybatis.generator.api.dom.java.Interface;
import org.mybatis.generator.api.dom.java.JavaVisibility;
import org.mybatis.generator.api.dom.java.Method;
import org.mybatis.generator.api.dom.java.Parameter;
import org.mybatis.generator.api.dom.java.TopLevelClass;
import org.mybatis.generator.api.dom.xml.Attribute;
import org.mybatis.generator.api.dom.xml.Document;
import org.mybatis.generator.api.dom.xml.TextElement;
import org.mybatis.generator.api.dom.xml.XmlElement;
import org.mybatis.generator.codegen.mybatis3.MyBatis3FormattingUtilities;

public class SelectByPagePlugin extends PluginAdapter {

	@Override
	public boolean validate(List<String> warnings) {
		return true;
	}

	private void addField(String fieldName, FullyQualifiedJavaType fieldType,
			TopLevelClass topLevelClass) {
		Field tmpField = new Field(fieldName, fieldType);
		tmpField.setVisibility(JavaVisibility.PRIVATE);
		topLevelClass.addField(tmpField);

		Method setMethod = new Method();
		setMethod.setName("set" + fieldName.toUpperCase().substring(0, 1)
				+ fieldName.substring(1));
		Parameter param = new Parameter(fieldType, fieldName);
		setMethod.addParameter(param);
		setMethod.setVisibility(JavaVisibility.PUBLIC);
		setMethod.addBodyLine("this." + fieldName + "=" + fieldName + ";");

		topLevelClass.addMethod(setMethod);

		Method getMethod = new Method();
		getMethod.setName("get" + fieldName.toUpperCase().substring(0, 1)
				+ fieldName.substring(1));

		getMethod.setReturnType(fieldType);
		getMethod.setVisibility(JavaVisibility.PUBLIC);
		getMethod.addBodyLine("return this." + fieldName + ";");

		topLevelClass.addMethod(getMethod);

	}

	@Override
	public boolean modelExampleClassGenerated(TopLevelClass topLevelClass,
			IntrospectedTable introspectedTable) {
		FullyQualifiedJavaType intType = FullyQualifiedJavaType
				.getIntInstance();
		addField("pageIndex", intType, topLevelClass);
		addField("pageSize", intType, topLevelClass);

		Method getSkipCountMethod = new Method();
		getSkipCountMethod.setName("getSkipRecordCount");

		getSkipCountMethod.setReturnType(intType);
		getSkipCountMethod.setVisibility(JavaVisibility.PUBLIC);
		getSkipCountMethod
				.addBodyLine("return (this.pageIndex-1)*this.pageSize;");

		topLevelClass.addMethod(getSkipCountMethod);
		
		Method getEndRecordIndexMethod = new Method();
		getEndRecordIndexMethod.setName("getEndRecordCount");

		getEndRecordIndexMethod.setReturnType(intType);
		getEndRecordIndexMethod.setVisibility(JavaVisibility.PUBLIC);
		getEndRecordIndexMethod
				.addBodyLine("return this.pageIndex*this.pageSize;");

		topLevelClass.addMethod(getEndRecordIndexMethod);
		

		Method newConstructorMethod = new Method();
		newConstructorMethod.setConstructor(true);
		newConstructorMethod.addParameter(new Parameter(intType, "pageSize"));
		newConstructorMethod.addParameter(new Parameter(intType, "pageIndex"));
		newConstructorMethod.addBodyLine("this();");
		newConstructorMethod.addBodyLine("this.pageSize=pageSize;");
		newConstructorMethod.addBodyLine("this.pageIndex=pageIndex;");
		newConstructorMethod.setVisibility(JavaVisibility.PUBLIC);
		newConstructorMethod.setName(topLevelClass.getType().getShortName());

		topLevelClass.addMethod(newConstructorMethod);
		return true;
	}

	@Override
	public boolean clientGenerated(Interface interfaze,
			TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {

		Set<FullyQualifiedJavaType> importedTypes = new TreeSet<FullyQualifiedJavaType>();
		FullyQualifiedJavaType type = new FullyQualifiedJavaType(
				introspectedTable.getExampleType());
		importedTypes.add(type);
		importedTypes.add(FullyQualifiedJavaType.getNewListInstance());

		Method method = new Method();
		method.setVisibility(JavaVisibility.PUBLIC);

		FullyQualifiedJavaType returnType = FullyQualifiedJavaType
				.getNewListInstance();
		FullyQualifiedJavaType listType;
		if (introspectedTable.getRules().generateBaseRecordClass()) {
			listType = new FullyQualifiedJavaType(introspectedTable
					.getBaseRecordType());
		} else if (introspectedTable.getRules().generatePrimaryKeyClass()) {
			listType = new FullyQualifiedJavaType(introspectedTable
					.getPrimaryKeyType());
		} else {
			throw new RuntimeException(getString("RuntimeError.12")); //$NON-NLS-1$
		}

		importedTypes.add(listType);
		returnType.addTypeArgument(listType);
		method.setReturnType(returnType);

		method.setName("selectPage");
		method.addParameter(new Parameter(type, "example")); //$NON-NLS-1$

		interfaze.addImportedTypes(importedTypes);
		interfaze.addMethod(method);

		return true;
	}

	@Override
	public boolean sqlMapDocumentGenerated(Document document,
			IntrospectedTable introspectedTable) {

		XmlElement parentElement = document.getRootElement();

		XmlElement newResultMapElement = new XmlElement("resultMap");
		newResultMapElement
				.addAttribute(new Attribute("id", "selectPageResult"));
		newResultMapElement.addAttribute(new Attribute("extends",
				"BaseResultMap"));
		
	    String returnType;
        if (introspectedTable.getRules().generateBaseRecordClass()) {
            returnType = introspectedTable.getBaseRecordType();
        } else {
            returnType = introspectedTable.getPrimaryKeyType();
        }
		
		newResultMapElement.addAttribute(new Attribute("type",
				returnType));
		newResultMapElement
				.addElement(new TextElement(
						"<!--\r\n<association property=\"\" column=\"\" javaType=\"\">\r\n"
								+ "   <id column=\"\" property=\"\" jdbcType=\"\" />\r\n"
								+ "   <result column=\"\" property=\"\" jdbcType=\"\" />\r\n"
								+ " </association>\r\n-->"));

		parentElement.addElement(newResultMapElement);
		
		
		//以下代码用于生成支持分页的sql片段
		/**
		 *注意千万不要随意删除代码中的空格 ！
		 *do not remove spaces 
		 */
		
		XmlElement outter_where_sql=new XmlElement("sql");
		outter_where_sql.addAttribute(new Attribute("id", "select_by_page_outter_where_sql"));
		
		StringBuilder sb = new StringBuilder();
		sb.append("  <if test=\"oredCriteria.size>0\">");
		sb.append("     <if test=\"_parameter != null\" > <include refid=\"Example_Where_Clause\"/> </if>");
		sb.append("    and ");
		sb.append("  </if>");
		sb.append("  <if test=\"oredCriteria.size==0\"> ");
		sb.append("    where ");
		sb.append("  </if> ");
		outter_where_sql.addElement(new TextElement(sb.toString()));
		parentElement.addElement(outter_where_sql);
		
		XmlElement inner_where_sql=new XmlElement("sql");
		inner_where_sql.addAttribute(new Attribute("id", "select_by_page_inner_where_and_orderby_sql"));
		sb.setLength(0);
		sb.append("  <if test=\"oredCriteria.size>0\">");
		sb.append("     <if test=\"_parameter != null\" > <include refid=\"Example_Where_Clause\"/> </if>");
		sb.append("  </if>");
		sb.append("   <if test=\"orderByClause != null\">");
		sb.append("    order by ${orderByClause} ");
		sb.append("  </if> ");
		inner_where_sql.addElement(new TextElement(sb.toString()));
		parentElement.addElement(inner_where_sql);
		
		
		XmlElement outter_orderby_sql=new XmlElement("sql");
		outter_orderby_sql.addAttribute(new Attribute("id", "select_by_page_outter_orderby_sql"));
		sb.setLength(0);
		sb.append("   <if test=\"orderByClause != null\">");
		sb.append("    order by ${orderByClause} ");
		sb.append("  </if> ");
		outter_orderby_sql.addElement(new TextElement(sb.toString()));
		parentElement.addElement(outter_orderby_sql);
		
		//以上代码用于生成支持分页的sql片段

		String fqjt = introspectedTable.getExampleType();

		XmlElement answer = new XmlElement("select"); //$NON-NLS-1$

		answer.addAttribute(new Attribute("id", //$NON-NLS-1$
				"selectPage"));
		answer.addAttribute(new Attribute(
				"resultMap","selectPageResult")); //$NON-NLS-1$
		answer.addAttribute(new Attribute("parameterType", fqjt)); //$NON-NLS-1$

		
		sb.setLength(0);
		sb.append("select a.* from ");
		sb.append(introspectedTable
				.getAliasedFullyQualifiedTableNameAtRuntime());

		sb.append(" a where a.");

		List<IntrospectedColumn> pks=introspectedTable.getPrimaryKeyColumns();
		
		if (pks.size()==1){
			sb.append(MyBatis3FormattingUtilities.getAliasedEscapedColumnName(pks.get(0)));
		}else{
			sb.append(" #your_primary_key_name ");
		}
		sb.append(" in \r\n (select top ${pageSize} ");
		if (pks.size()==1){
			sb.append(MyBatis3FormattingUtilities.getAliasedEscapedColumnName(pks.get(0)));
		}else{
			sb.append(" #your_primary_key_name ");
		}
		sb.append(" from "+introspectedTable.getAliasedFullyQualifiedTableNameAtRuntime()+" ");
		sb.append("\r\n<include refid=\"select_by_page_outter_where_sql\"/> \r\n");
		if (pks.size()==1){
			sb.append(MyBatis3FormattingUtilities.getAliasedEscapedColumnName(pks.get(0)));
		}else{
			sb.append(" #your_primary_key_name ");
		}
		sb.append(" not in (select top ${skipRecordCount} " );
		if (pks.size()==1){
			sb.append(MyBatis3FormattingUtilities.getAliasedEscapedColumnName(pks.get(0)));
		}else{
			sb.append(" #your_primary_key_name ");
		}
		sb.append(" from "+introspectedTable.getAliasedFullyQualifiedTableNameAtRuntime()+" ");
		sb.append(" \r\n<include refid=\"select_by_page_inner_where_and_orderby_sql\"/> \r\n");
		sb.append(" )");
		sb.append(" \r\n<include refid=\"select_by_page_outter_orderby_sql\"/> \r\n");
		sb.append(" )");
		
		
		answer.addElement(new TextElement(sb.toString()));

		parentElement.addElement(answer);

		return true;
	}

}

 

peihexian
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
5.6 Mybatis代码生成器Mybatis Generator (MBG)实战详解
天罡gg的专栏
05-14 2万+
本文我们主要实战Mybatis官方的代码生成器：Mybatis Generator(MBG)，掌握它以后，可以简化大部分手写代码，我们只需要写复杂逻辑代码！创建与MySQL表对应的Java PO对象，字段一一对应；创建Mapper接口，和对应的XML映射文件(或注解)。首先是PO对象，我们往往创建与数据库表字段一一对应的PO对象;其次在Mapper里，通常都会写基本的增删改查代码。本文就带大家实战一下Mybatis Generator，用它生成实战项目全部表的PO对象和基本增删改查代码！
MyBatisPLus3.x中代码生成器自定义数据库表字段类型转换
kanglong129的博客
08-03 7538
场景 MyBatisPlus3.x中使用代码生成器(全注释)： https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/89518466 数据库字段为 [available_flag] tinyintNULL, [deleted_flag] tinyintNULL, [sync_flag] tinyint...
配置Mybatis Generator不要生成Example类
yewei11的专栏
12-14 9654
配置Mybatis Generator不要生成Example类 December 19, 2013DatabaseJava Mybatis Generator默认设置会生成一大堆罗哩罗嗦的Example类,主要是用各种不同的条件来操作数据库,大部分是用不到的,用到的时候手工修改mapper和接口文件就行了。 1 2 3 4 5 t
Mybatis generator不生成example
ghostxbh‘s blog
09-11 4674
Mybatis Generator默认设置会生成一大堆罗哩罗嗦的Example类,主要是用各种不同的条件来操作数据库,大部分是用不到的,用到的时候手工修改mapper和接口文件就行了。 &lt;table schema="general" tableName="tb_table_name" domainObjectName="EntityName" enableCountByExamp...
避免mybatis generator生成Example类的配置方法
gayung的博客
12-19 471
mybatis generator代码生成器在默认的情况下会生成对于表实体类的一个Examle类, 可以更改生成器的配置可避免生成Examle类, &lt;table schema="minghan" tableName="sys_admin" domainObjectName="Admin" enableCountByExample="false" enableUpdateByExampl...
mybatis-generator扩展教程系列 -- mapper xml文件增加自定义sql
shadowsick的专栏
12-19 1万+
今天我教大家如何在mapper.xml文件里增加我们自定义的sql节点,还是老规矩沿用之前的项目用例,如有看不懂的同学可以翻看下上几篇的教程1.打开IntrospectedTable.java找到enum InternalAttribute这个枚举定义增加一行我们的sql id ATTR_SELECT_BY_CONDITION_STATEMENT_IDprotected enum Internal
扩展mybatis-generator-core支持Example生成目录的指定
weixin_33722405的博客
06-27 989
2019独角兽企业重金招聘Python工程师标准>>> ...
Mybatis代码生成器
11-27
Mybatis代码生成器是一款强大的工具，它极大地提高了开发效率，特别是在处理大量的数据库操作时。这款工具主要用于自动生成MyBatis框架所需的SQL映射文件（sqlmapping系列文件）以及与数据库表对应的实体类，从而...
mybatis-plus代码生成器模版代码
最新发布
08-17
本资源包含的是Mybatis-Plus的代码生成器模板代码，用于自动生成符合项目规范的Java实体类、Mapper接口及XML配置文件，提高开发效率。 代码生成器是开发中的利器，它能够根据数据库表结构快速生成对应的Java代码，...
MyBatis代码生成工具
07-31
MyBatis代码生成工具则是为了进一步提高开发效率，自动生成常见的增删改查（CRUD）操作所需的XML配置文件、DAO接口、Service接口及其实现类、Entity实体类，以及一些实用工具类。这些自动生成的代码可以极大地减少...
mybatis代码生成器不生成example的方法
weixin_34206899的博客
08-16 1559
我用mybatis生成器，生成时总有两个model类，一个是PO类，一个是example,但example我不想要了，想去掉，查一下，修改相关配置即可. 原来配置为 <table tableName="zeus_org_role" domainObjectName="ZeusOrgRole">...
使用mybatis-generator生成的Example,快速分页查询模板代码
一点光辉的博客
06-22 2039
controller接口 /** * 分页列表查询 * * @param pageNum 页号 * @param pageSize 页面大小 * @param sortType 排序 * @return BaseResult */ @GetMapping(value = "/getCustomerByPage") public BaseResult getCustomerByPage(@RequestParam("pageNum") Integer pageNum, @RequestPa
Mybatis Generator源码：Generator自动生成框架
博客园
10-20 997
目录 0. 使用方法 1. 配置文件定义 2. Generator框架解析过程分析 2.1 ConfigurationParser配置文件解析 2.2 MyBatisGenerator自动生成过程分析 我们都知道mybatis对于Dao接口中的方法具体实现方式有两种： 一种是基于注解的方式 另一种是以及xml 动态SQL的方式 其中基于xml实现的方式，自己手写麻烦复杂，很容易出问......
mybatis 之 generator插件使用 集成到了eclipse 自动生成实体,example,mapper
热门推荐
darrenzhong的专栏
05-14 1万+
之前没用mybatis正式做过公司项目，最近自己搭建了一个集成了mybatis项目，
[mybatis]Example的用法 ...
weixin_34148340的博客
05-21 1493
Example类是什么？ Example类指定如何构建一个动态的where子句. 表中的每个non-BLOB列可以被包括在where子句中. 例子是展示此类用法的最好方式. Example类可以用来生成一个几乎无限的where子句. Example类包含一个内部静态类 Criteria 包含一个用 anded 组合在where子句中的条件列表. Example类包含一个 ...
mybatis 之 generator插件使用 集成到了eclipse 自动生成实体,example,mapper
sunshine
05-05 1356
之前没用mybatis正式做过公司项目，最近自己搭建了一个集成了mybatis项目，然后一直不知道怎么可以类似hibernate一样自动生成一些代码，后来百度了下 了解了generator        这个插件还是不错的，我是将他集成到了eclipse里面，首先其实这就是个xml，然后用eclipse install一下这个插件http://mybatis.googlecode.com/s
Mybatis Generator自定义扩展
qq_28191897的博客
02-28 1005
哈哈自己真懒 转自 https://www.cnblogs.com/se7end/p/9293755.html
用mybatis-generator-core自动生成pojoExample，mapper和xml
cherry_xiu的博客
07-29 2149
前言 准备工具 开始自动生成 1.使用 cmd 执行 jar 包 1.1 放置 jar 包与 xml 文件 1.2 编辑 generatorConfig.xml文件 1.3 运行 generatorConfig.xml文件 2.使用 maven 的 plugin 2.1 在pom.xml中加入jar包与plugin 2.2 修改generator.xml文件 2.3 双击mybatis...
idea使用mybatis-generator插件自动生成eitity,dao,mapper
风的专栏
03-01 1359
一、maven项目的使用方式1、生成文件的最终结果如下2、pom generator插件的配置3、generatorConfig的配置&lt;?xml version="1.0" encoding="UTF-8" ?&gt; &lt;!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Confi...
MyBatis-Plus代码生成器配置详解
"mybatis-plus代码生成器是一个强大的工具，用于自动根据数据库中的表结构生成对应的Java实体类、Mapper接口及XML配置文件等，极大地提高了开发效率。在配置mybatis-plus代码生成器时，需要关注以下几个核心配置项，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值