学习总结-MyBatis逆向工程和分页插件

一、逆向工程

MyBatis提供一个便利的插件，可以直接依据数据库的表自动生成相应的实体类、映射文件和接口方法。

1. 导包：点击进入GitHub ，下载MyBatis generator 相应的jar包。建议创建一个Java SE项目专门用于逆向工程生成文件，方便设置路径问题，生成好后也可以直接拷贝走。主要需要导入三个jar包，分别是
逆向工程的核心包 mybatis-generator-core-1.3.2.jar、
数据库连接包 mysql-connector-java-8.0.16.jar、
MyBatis核心包 mybatis-3.5.2.jar。

2. 创建配置文件：

<?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>
	<context id="testTables" targetRuntime="MyBatis3">
		<commentGenerator>
			<!-- 是否去除自动生成的注释 true：是 ： false:否 -->
			<property name="suppressAllComments" value="true" />
		</commentGenerator>
		<!--数据库连接的信息：驱动类、连接地址、用户名、密码 -->
		<jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
			connectionURL="jdbc:mysql://localhost:3306/demo"
			userId="root"
			password="123456">
			<!--使用MySQL8时需要添加，否则会生成多个数据库下的相同表的内容，MySQL5则可以不加-->
			<property name="nullCatalogMeansCurrent" value="true" />
		</jdbcConnection>
		<!-- <jdbcConnection driverClass="oracle.jdbc.OracleDriver"
			connectionURL="jdbc:oracle:thin:@127.0.0.1:1521:yycg" 
			userId="yycg"
			password="yycg">
		</jdbcConnection> -->

		<!-- 默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer，为 true时把JDBC DECIMAL 和 
			NUMERIC 类型解析为java.math.BigDecimal -->
		<javaTypeResolver>
			<property name="forceBigDecimals" value="false" />
		</javaTypeResolver>

		<!-- targetProject:生成实体类的位置 -->
		<javaModelGenerator targetPackage="com.shop.domain"
			targetProject=".\src">
			<!-- enableSubPackages:是否让schema作为包的后缀 -->
			<property name="enableSubPackages" value="false" />
			<!-- 从数据库返回的值被清理前后的空格 -->
			<property name="trimStrings" value="true" />
		</javaModelGenerator>
        <!-- targetProject:mapper映射文件生成的位置 -->
		<sqlMapGenerator targetPackage="com.shop.mapper" 
			targetProject=".\src">
			<!-- enableSubPackages:是否让schema作为包的后缀 -->
			<property name="enableSubPackages" value="false" />
		</sqlMapGenerator>
		<!-- targetPackage：mapper接口生成的位置 -->
		<javaClientGenerator type="XMLMAPPER"
			targetPackage="com.shop.mapper" 
			targetProject=".\src">
			<!-- enableSubPackages:是否让schema作为包的后缀 -->
			<property name="enableSubPackages" value="false" />
		</javaClientGenerator>
		<!-- 指定数据库表 -->
		<!-- <table tableName="items"></table> -->
		<table tableName="tb_user" domainObjectName="User"></table>
		<!-- <table tableName="orderdetail"></table> -->
		
		<!-- 有些表的字段需要指定java类型
		 <table schema="" tableName="">
			<columnOverride column="" javaType="" />
		</table> -->
	</context>
</generatorConfiguration>

一般只需要修改五个地方即可，包括有连接数据库的信息、生成实体类的位置、生成映射文件的位置、生成mapper接口文件的位置、指定数据库表。

3. 编写测试代码生成文件：

	public static void main(String[] args) throws Exception {
		List<String> warnings = new ArrayList<String>();
		boolean overwrite = true;
		//配置文件的位置和名称根据实际情况修改
		File configFile = new File("src/generator.xml"); 
		ConfigurationParser cp = new ConfigurationParser(warnings);
		Configuration config = cp.parseConfiguration(configFile);
		DefaultShellCallback callback = new DefaultShellCallback(overwrite);
		MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config,
				callback, warnings);
		myBatisGenerator.generate(null);
	}

执行测试代码即可生成文件。注意点，不要生成多次，否则代码会进行叠加，导致代码出现奇怪的bug，XXXMapper.xml文件已经存在时，如果进行重新生成则mapper.xml文件内容不被覆盖而是进行内容追加，结果导致mybatis解析失败。

二、分页插件

1. 导包：在官网上下载分页插件所需的 jar 包，主要是两个包，分别是分页插件的jar包和依赖包。
pagehelper-5.2.0.jar
jsqlparser-3.1.jar，这个 jar 包也可以到 Maven 仓库中找到。

2. 在 Mybatis 主配置文件中配置 plugins 标签，内容为：

	<plugins>
        <!-- com.github.pagehelper为PageHelper类所在包名 -->
        <plugin interceptor="com.github.pagehelper.PageInterceptor">
            <!-- 使用下面的方式配置参数 -->
            <property name="helperDialect" value="mysql"/>
        </plugin>
    </plugins>

需要注意的是，MyBatis 配置文件中，标签的前后顺序有严格的规定，一定要按照顺序放置标签的位置，否则会报错，这里的 plugins 标签放置 environment 标签前面。
标签顺序如下:
properties- settings- typeAliases- typeHandlers- objectFactory- objectWrapperFactory- plugins-environments- databaseIdProvider- mappers

3. 使用方式：

• 在执行 SQL 方法之前，先执行 PageHelper.startPage(pageNum, pageSize)，后再执行 SQL 方法时，会自动在 SQL 语句后面添加 limit 内容。
  例如：

		PageHelper.startPage(2, 2);//当前页为第2页，数据条数为2

        List<User> users = mapper.selectUserAll();
		//日志打印信息如下
		//DEBUG [main] - ==>  Preparing: select * from user LIMIT ?, ? 
		//DEBUG [main] - ==> Parameters: 2(Long), 2(Integer)
		//DEBUG [main] - <==      Total: 2

• 注意，SQL 语句一定不要加分号结束，否则会带着分号拼接 limit 内容，然后就会抛出 SQL 语法错误的异常，或者也可能不抛出异常，但就是查不出来数据。
• 还可以使用 PageInfo 对象，该对象会为我们计算分页信息，包括总记录数，总页数等信息。

		PageInfo<User> pageInfo = new PageInfo<>(users);
        System.out.println(pageInfo.toString());
        //打印 PageInfo 内容如下
        //PageInfo{pageNum=2, pageSize=2, size=2, startRow=3, endRow=4, total=6, pages=3, list=Page{count=true, pageNum=2,.....} ......}