MyBatis-18MyBatis代码生成器-Example讲解

本文详细介绍了MyBatis代码生成器MBG生成的Example类的使用方法,包括selectByExample、updateByExampleSelective、deleteByExample及countByExample等操作,并通过具体示例展示了如何构建复杂查询。
摘要由CSDN通过智能技术生成

概述

MyBatis-17MyBatis代码生成器(逆向工程)MBG使用中介绍了MBGZ的基本使用。我们知道在MBG的context中将targetRuntime配置为MyBatis3时,MBG会生成和Example相关的对象和方法。 本篇博文我们来介绍下与Example相关的用法。


示例

以country表相关的Example MBG 为例

generatorConfig-country.xml

<?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> 
	 <!-- 引用外部配置文件 -->
	 <properties resource="db.properties" />
	<!-- 
		在MBG工作的时候,需要额外加载的依赖包location属性指明加载jar/zip包的全路径 -->
	<!--
		<classPathEntry location="F:\.m2\repository\mysql\mysql-connector-java\5.1.38\mysql-connector-java-5.1.38.jar"/>
	 -->
	 
    <context id="MySqlContext" targetRuntime="MyBatis3" defaultModelType="flat">
    	<!-- beginningDelimiter/endingDelimiter: 指明数据库的用于标记数据库对象名的符号,比如ORACLE是双引号,MYSQL默认是`反引号  -->
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <!-- 生成的Java文件的编码 -->
        <property name="javaFileEncoding" value="UTF-8"/>
        <commentGenerator>
        	<!-- suppressDate是去掉生成日期那行注释,suppressAllComments是去掉所有的注解 -->
            <property name="suppressDate" value="true"/>
            <!-- 在生成的实体类中附带表字段的注释  MBG1.3.3中新增的功能 -->
            <property name="addRemarkComments" value="true"/>
        </commentGenerator>
	
	
		<!-- 必须存在,使用这个配置链接数据库-->
        <jdbcConnection driverClass="${jdbc.driver}"
                        connectionURL="${jdbc.url}"
                        userId="${jdbc.username}"
                        password="${jdbc.password}">
              <!-- 这里面可以设置property属性,每一个property属性都设置到配置的Driver上 -->
        </jdbcConnection>

        <javaModelGenerator targetPackage="example.model" targetProject="src\main\java">
			<!-- 设置是否在getter方法中,对String类型字段调用trim()方法 -->
			<property name="trimStrings" value="true" />
        </javaModelGenerator>
		
		
        <sqlMapGenerator targetPackage="example.xml"  targetProject="src\main\resources">
        </sqlMapGenerator>
        
        <javaClientGenerator type="XMLMAPPER" targetPackage="example.dao"  targetProject="src\main\java">
        </javaClientGenerator>
        
        <table tableName="country">
            <generatedKey column="id" sqlStatement="MySql"/>
        </table>
     </context>
</generatorConfiguration>

编写Java运行代码

package com.mybatis.generator;

import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;

import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.internal.DefaultShellCallback;

/**
 * 
 * 
 * @ClassName: GeneratorCountry
 * 
 * @Description: 读取 MBG 配置生成代码
 * 
 * @author: Mr.Yang
 * 
 * @date: 2018年4月27日 下午23:31:42
 */
public class GeneratorCountry {

	public static void main(String[] args) throws Exception {
		// MBG 执行过程中的警告信息
		List<String> warnings = new ArrayList<String>();
		// 当生成的代码重复时,覆盖原代码
		boolean overwrite = true;
		// 读取MBG配置文件
		InputStream is = GeneratorCountry.class.getResourceAsStream("/generator/generatorConfig-country.xml");
		ConfigurationParser cp = new ConfigurationParser(warnings);
		Configuration config = cp.parseConfiguration(is);
		is.close();

		DefaultShellCallback callback = new DefaultShellCallback(overwrite);
		// 创建 MBG
		MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
		// 执行生成代码
		myBatisGenerator.generate(null);
		// 输出警告信息
		for (String warning : warnings) {
			System.out.println(warning);
		}
		System.out.println("Finshed");
	}

}

运行获取自动生成的代码

这里写图片描述

先粗略了解下自动生成代码结构

CountryExample实体类的结构
这里写图片描述

CountryMapper接口
这里写图片描述

CountryMapper.xml
这里写图片描述


修改 MyBatis全局配置文件 mybatis-config.xml

这里写图片描述

将配置文件配置到mybatis-config.xml中,因为只有这一个配置文件就直接添加上去了, 如果生成的目录一致,也可以再配置package. 这里mapper.xml和mapper接口目录不一致。所以不采用package的方式了。


修改log4j

这里写图片描述

为了便于查看mybatis的内部执行过程,添加如上代码


编写单元测试了解Example的相关用法

selectByExample

package example.dao;

import java.util.List;

import org.apache.ibatis.session.SqlSession;
import org.junit.Test;

import com.artisan.mybatis.xml.mapper.BaseMapperTest;

import example.model.Country;
import example.model.CountryExample;

public class CountryMapperTest extends BaseMapperTest {

	@Test
	public void countryExampleTest() {
		// 获取sqlSession
		SqlSession sqlSession = getSqlSession();
		try {
			// 获取 CountryMapper 接口
			CountryMapper countryMapper = sqlSession.getMapper(CountryMapper.class);
			// 创建 Example 对象
			CountryExample example = new CountryExample();
			// 设置排序规则
			example.setOrderByClause("id desc, countryname asc");
			// 设置是否 distinct 去重
			example.setDistinct(true);
			// 创建条件,只能有一个 createCriteria
			CountryExample.Criteria criteria = example.createCriteria();
			// id >= 1
			criteria.andIdGreaterThanOrEqualTo(1);
			// id < 4
			criteria.andIdLessThan(4);
			// countrycode like '%U%'
			// 最容易出错的地方,注意 like 必须自己写上通配符的位置,不可能默认两边加 %,like 可以是任何情况
			criteria.andCountrycodeLike("%U%");
			// or 的情况,可以有多个 or
			CountryExample.Criteria or = example.or();
			// countryname = 中国
			or.andCountrynameEqualTo("中国");
			// 执行查询
			List<Country> countryList = countryMapper.selectByExample(example);
			printCountryList(countryList);

		} catch (Exception e) {
			e.printStackTrace();
		} finally {
			// 不要忘记关闭 sqlSession
			sqlSession.close();
		}
	}

	private void printCountryList(List<Country> countryList) {
		for (Country country : countryList) {
			System.out.printf("%-4d%4s%4s\n", country.getId(), country.getCountryname(), country.getCountrycode());
		}
	}

}

除了代码中注释内容外,特别需要注意的地方是or的方法。 当有多个or的时候,SQL语句就是类似 or(…) or(…)这样的SQL,如果一个or都没有,那就只有example.createCriteria()中的查询条件。

日志

2018-04-28 15:43:09,468  INFO [main] (BaseMapperTest.java:26) - sessionFactory bulit successfully
2018-04-28 15:43:09,468  INFO [main] (BaseMapperTest.java:29) - reader close successfully
2018-04-28 15:43:09,677 DEBUG [main] (BaseJdbcLogger.java:145) - ==>  Preparing: select distinct id, countryname, countrycode from country WHERE ( id >= ? and id < ? and countrycode like ? ) or( countryname = ? ) order by id desc, countryname asc 
2018-04-28 15:43:09,777 DEBUG [main] (BaseJdbcLogger.java:145) - ==> Parameters: 1(Integer), 4(Integer), %U%(String), 中国(String)
2018-04-28 15:43:09,817 TRACE [main] (BaseJdbcLogger.java:151) - <==    Columns: id, countryname, countrycode
2018-04-28 15:43:09,817 TRACE [main] (BaseJdbcLogger.java:151) - <==        Row: 3, 俄罗斯, RU
2018-04-28 15:43:09,817 TRACE [main] (BaseJdbcLogger.java:151) - <==        Row: 2, 美国, US
2018-04-28 15:43:09,817 TRACE [main] (BaseJdbcLogger.java:151) - <==        Row: 1, 中国, CN
2018-04-28 15:43:09,817 DEBUG [main] (BaseJdbcLogger.java:145) - <==      Total: 3
3    俄罗斯  RU
2     美国  US
1     中国  CN


updateByExampleSelective

@Test
	public void updateByExampleSelectiveTest() {
		// 获取 sqlSession
		SqlSession sqlSession = getSqlSession();
		try {
			// 获取 CountryMapper 接口
			CountryMapper countryMapper = sqlSession.getMapper(CountryMapper.class);
			// 创建 Example 对象
			CountryExample example = new CountryExample();
			// 创建条件,只能有一个 createCriteria
			CountryExample.Criteria criteria = example.createCriteria();
			// 更新所有 id > 2 的国家
			criteria.andIdGreaterThan(2);
			// 创建一个要设置的对象
			Country country = new Country();
			// 将国家名字设置为 China
			country.setCountryname("China");
			// 执行查询
			countryMapper.updateByExampleSelective(country, example);
			// 在把符合条件的结果输出查看
			printCountryList(countryMapper.selectByExample(example));
		} finally {
			// 为了不影响数据,这里选择回滚
			sqlSession.rollback();
			// 不要忘记关闭 sqlSession
			sqlSession.close();
		}
	}

我们看CountryMapper接口,可以看到有 updateByExample和updateByExampleSelective。 这两个方法的区别是,当对象的属性为空的时候,第一个方法会将值更新为null , 第二个方法不会更新null属性的字段。 通过Example一般都是批量操作,由于country表存在主键id,不能被批量更新, 因此要使用updateByExampleSelective方法进行测试。

日志

2018-04-28 15:47:24,736  INFO [main] (BaseMapperTest.java:26) - sessionFactory bulit successfully
2018-04-28 15:47:24,736  INFO [main] (BaseMapperTest.java:29) - reader close successfully
2018-04-28 15:47:24,967 DEBUG [main] (BaseJdbcLogger.java:145) - ==>  Preparing: update country SET countryname = ? WHERE ( id > ? ) 
2018-04-28 15:47:25,083 DEBUG [main] (BaseJdbcLogger.java:145) - ==> Parameters: China(String), 2(Integer)
2018-04-28 15:47:25,083 DEBUG [main] (BaseJdbcLogger.java:145) - <==    Updates: 3
2018-04-28 15:47:25,093 DEBUG [main] (BaseJdbcLogger.java:145) - ==>  Preparing: select id, countryname, countrycode from country WHERE ( id > ? ) 
2018-04-28 15:47:25,093 DEBUG [main] (BaseJdbcLogger.java:145) - ==> Parameters: 2(Integer)
2018-04-28 15:47:25,123 TRACE [main] (BaseJdbcLogger.java:151) - <==    Columns: id, countryname, countrycode
2018-04-28 15:47:25,123 TRACE [main] (BaseJdbcLogger.java:151) - <==        Row: 3, China, RU
2018-04-28 15:47:25,123 TRACE [main] (BaseJdbcLogger.java:151) - <==        Row: 4, China, GB
2018-04-28 15:47:25,123 TRACE [main] (BaseJdbcLogger.java:151) - <==        Row: 5, China, FR
2018-04-28 15:47:25,123 DEBUG [main] (BaseJdbcLogger.java:145) - <==      Total: 3
3   China  RU
4   China  GB
5   China  FR


deleteByExample+countByExample

@Test
	public void deleteByExampleTest() {
		// 获取 sqlSession
		SqlSession sqlSession = getSqlSession();
		try {
			// 获取 CountryMapper 接口
			CountryMapper countryMapper = sqlSession.getMapper(CountryMapper.class);
			// 创建 Example 对象
			CountryExample example = new CountryExample();
			// 创建条件,只能有一个 createCriteria
			CountryExample.Criteria criteria = example.createCriteria();
			// 删除所有 id > 2 的国家
			criteria.andIdGreaterThan(2);
			// 执行查询
			countryMapper.deleteByExample(example);
			// 使用 countByExample 查询符合条件的数量,因为删除了,所以这里应该是 0
			Assert.assertEquals(0, countryMapper.countByExample(example));
		} finally {
			// 为了不影响数据,这里选择回滚
			sqlSession.rollback();
			// 不要忘记关闭 sqlSession
			sqlSession.close();
		}
	}

日志

2018-04-28 15:49:43,236  INFO [main] (BaseMapperTest.java:26) - sessionFactory bulit successfully
2018-04-28 15:49:43,266  INFO [main] (BaseMapperTest.java:29) - reader close successfully
2018-04-28 15:49:43,503 DEBUG [main] (BaseJdbcLogger.java:145) - ==>  Preparing: delete from country WHERE ( id > ? ) 
2018-04-28 15:49:43,633 DEBUG [main] (BaseJdbcLogger.java:145) - ==> Parameters: 2(Integer)
2018-04-28 15:49:43,643 DEBUG [main] (BaseJdbcLogger.java:145) - <==    Updates: 3
2018-04-28 15:49:43,653 DEBUG [main] (BaseJdbcLogger.java:145) - ==>  Preparing: select count(*) from country WHERE ( id > ? ) 
2018-04-28 15:49:43,653 DEBUG [main] (BaseJdbcLogger.java:145) - ==> Parameters: 2(Integer)
2018-04-28 15:49:43,693 TRACE [main] (BaseJdbcLogger.java:151) - <==    Columns: count(*)
2018-04-28 15:49:43,693 TRACE [main] (BaseJdbcLogger.java:151) - <==        Row: 0
2018-04-28 15:49:43,693 DEBUG [main] (BaseJdbcLogger.java:145) - <==      Total: 1

通过上述几个例子,应该对example有所了解了。 使用Example查询能够解决大部分复杂的单表操作,一定程度上减少工作量。 但是建议在条件很多并且判断很多的情况下,避免使用Example查询, 这种情况下,使用XML方式会更有效。

### 回答1: Mybatis-Plus Generator是一个非常强大的代码生成器工具,可以帮助开发人员快速生成基于Mybatis-Plus框架的CRUD代码。 下面是一个Mybatis-Plus Generator 3.5.1的实例: 首先,需要在pom.xml文件中添加相应的依赖: ``` <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>3.5.1</version> </dependency> ``` 然后,在项目的配置文件(如application.properties或application.yml)中配置数据库连接信息: ``` spring.datasource.url=jdbc:mysql://localhost:3306/my_database spring.datasource.username=root spring.datasource.password=123456 spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver ``` 接下来,创建一个GeneratorConfig类,并在其中进行相应的配置: ```java public class GeneratorConfig { public static void main(String[] args) { // 代码生成器 AutoGenerator autoGenerator = new AutoGenerator(); // 全局配置 GlobalConfig globalConfig = new GlobalConfig(); String outputDir = System.getProperty("user.dir") + "/src/main/java"; globalConfig.setOutputDir(outputDir); globalConfig.setAuthor("your_name"); globalConfig.setOpen(false); autoGenerator.setGlobalConfig(globalConfig); // 数据源配置 DataSourceConfig dataSourceConfig = new DataSourceConfig(); dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/my_database"); dataSourceConfig.setUsername("root"); dataSourceConfig.setPassword("123456"); dataSourceConfig.setDriverName("com.mysql.cj.jdbc.Driver"); autoGenerator.setDataSource(dataSourceConfig); // 包配置 PackageConfig packageConfig = new PackageConfig(); packageConfig.setParent("com.example"); autoGenerator.setPackageInfo(packageConfig); // 策略配置 StrategyConfig strategyConfig = new StrategyConfig(); strategyConfig.setNaming(NamingStrategy.underline_to_camel); strategyConfig.setColumnNaming(NamingStrategy.underline_to_camel); strategyConfig.setRestControllerStyle(true); autoGenerator.setStrategy(strategyConfig); // 执行代码生成器 autoGenerator.execute(); } } ``` 最后,运行GeneratorConfig类中的main方法,即可生成相应的实体类、Mapper接口、Service接口以及Controller类。 这样,使用Mybatis-Plus Generator 3.5.1代码生成器,我们可以快速生成与数据库表对应的Java代码,省去了手写的繁琐工作,提高了开发效率。使用起来非常方便,适用于大部分的项目开发。 ### 回答2: Mybatis-Plus是基于Mybatis的增强工具,可以简化开发过程中对数据库的操作。其中,Mybatis-Plus Generator是一款代码生成器,可以根据数据库表结构自动生成Java实体类、Mapper接口以及XML映射文件。 Mybatis-Plus Generator 3.5.1版本是最新发布的版本,具有一些新的特性和优化,可以更加方便、快捷地生成代码。下面以一个示例来说明如何使用这个代码生成器: 首先,我们需要在项目的pom.xml文件中添加Mybatis-Plus Generator的依赖: ``` <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>3.5.1</version> </dependency> ``` 然后,我们需要在项目的配置文件中配置数据库连接信息、生成代码的包名等相关配置: ``` mybatis-plus: # 数据库连接信息 datasource: url: jdbc:mysql://localhost:3306/testdb username: root password: 123456 driver-class-name: com.mysql.jdbc.Driver # 生成代码的包名 global-config: output-dir: src/main/java author: your_name open: false entity-name: %sEntity mapper-name: %sMapper xml-name: %sMapper service-name: %sService service-impl-name: %sServiceImpl controller-name: %sController ``` 接下来,我们可以使用Mybatis-Plus Generator提供的工具类进行代码生成。可以通过以下方式调用: ``` AutoGenerator generator = new AutoGenerator(); // 设置全局配置 generator.setGlobalConfig(config); // 设置数据源配置 generator.setDataSource(dataSourceConfig); // 设置包名配置 generator.setPackageInfo(packageConfig); // 设置策略配置 generator.setStrategy(strategyConfig); // 执行生成 generator.execute(); ``` 最后,执行代码生成命令,即可完成代码的自动生成。生成的代码会按照配置的包名和格式生成在指定目录下。 通过使用Mybatis-Plus Generator 3.5.1代码生成器,我们可以简化开发过程中的手动编写实体类、Mapper接口和XML映射文件的工作量,提高开发效率。同时,它也提供了丰富的配置选项,可以根据具体项目的需求进行定制,生成符合项目要求的代码。 ### 回答3: mybatis-plus-generator是MyBatis-Plus框架中的一个代码生成器工具,可以根据数据库表结构自动生成对应的实体类、Mapper接口、Service接口以及ServiceImpl类等代码。以下是一个使用mybatis-plus-generator 3.5.1生成代码的示例: 1. 首先,需要在项目的pom.xml文件中添加mybatis-plus-generator的依赖: ```xml <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>3.5.1</version> </dependency> ``` 2. 创建一个配置类,设置代码生成所需的参数,如数据库连接信息、代码输出路径、包名等等。例如: ```java public class GeneratorConfig { public static void main(String[] args) { // 数据源配置 DataSourceConfig dataSourceConfig = new DataSourceConfig(); dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/mybatis_test?useUnicode=true&characterEncoding=utf8&serverTimezone=Asia/Shanghai"); dataSourceConfig.setDriverName("com.mysql.jdbc.Driver"); dataSourceConfig.setUsername("root"); dataSourceConfig.setPassword("password"); // 代码生成器配置 AutoGenerator autoGenerator = new AutoGenerator(); autoGenerator.setDataSource(dataSourceConfig); autoGenerator.setGlobalConfig(new GlobalConfig().setOutputDir("D:/code").setAuthor("mybatis-plus-generator").setOpen(false)); autoGenerator.setPackageInfo(new PackageConfig().setParent("com.example.demo").setModuleName("entity")); autoGenerator.setStrategy(new StrategyConfig().setNaming(NamingStrategy.underline_to_camel).setColumnNaming(NamingStrategy.underline_to_camel)); // 执行生成代码 autoGenerator.execute(); } } ``` 3. 运行配置类的main方法即可生成代码,生成的代码将会按照设置的路径和包名进行输出。 总的来说,使用mybatis-plus-generator能够大大加速开发过程,减少手写代码的工作量,提高项目代码的一致性和规范性。而3.5.1版本是mybatis-plus-generator的一个较新的版本,一般来说,较新的版本往往修复了一些bug并提供了更好的性能和功能。因此,推荐使用mybatis-plus-generator 3.5.1来进行代码生成
评论 9
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

小小工匠

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值