MyBatis三剑客

你的名字 2023-02-13 11:07 24阅读 0赞

### 目录 ###

*   *   *  MyBatis Generator（MBG 代码生成器）
         *   *  方式一 maven插件（推荐）
             *  方式二 maven依赖
         *  MyBatis-Plugin mapper接口、xml映射文件之间的跳转
         *  MyBatis-PageHelper 分页

mybatis三剑客

*  MyBatis Generator  mybatis逆向工程，根据数据表自动生成实体类、mapper接口、xml映射文件
 *  MyBatis-Plugin  IDEA插件，可以实现mapper接口方法、xml映射文件元素之间的快速跳转
 *  MyBatis-PageHelper  mybatis的分页组件

### MyBatis Generator（MBG 代码生成器） ###

#### 方式一 maven插件（推荐） ####

1、pom.xml中添加mbg的maven插件

<build>
        <plugins>
        
        	
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.4.0</version>
                <configuration>
                    
                    <overwrite>true</overwrite>
                </configuration>
            </plugin>
            
        </plugins>
    </build>

2、resources下新建mbg的配置文件generatorConfig.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>
        
        <classPathEntry location="F:/maven/repository/mysql/mysql-connector-java/8.0.19/mysql-connector-java-8.0.19.jar" />
    
        
        <context id="myMBG" targetRuntime="MyBatis3">
    
            
            
            <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin"></plugin>
    
            
            <commentGenerator>
                
                <property name="suppressAllComments" value="true"/>
                
                <property name="suppressDate" value="true"/>
            </commentGenerator>
    
            
            <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/db_user?serverTimezone=UTC" userId="chy" password="abcd">
            </jdbcConnection>
    
            
            <javaTypeResolver >
                
                <property name="forceBigDecimals" value="false" />
            </javaTypeResolver>
    
            
            
            <javaModelGenerator targetPackage="com.chy.mall.model" targetProject="src/main/java">
                <property name="enableSubPackages" value="true" />
                
                
            </javaModelGenerator>
    
            
            <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
                <property name="enableSubPackages" value="true" />
            </sqlMapGenerator>
    
            
            <javaClientGenerator type="XMLMAPPER" targetPackage="com.chy.mall.dao" targetProject="src/main/java">
                <property name="enableSubPackages" value="true" />
            </javaClientGenerator>
    
            
            
            
            <table tableName="tb_user" mapperName="UserMapper" domainObjectName="User" enableCountByExample="false" enableDeleteByExample="false" enableSelectByExample="false" enableUpdateByExample="false" selectByExampleQueryId="false" />
            <table tableName="tb_permission" mapperName="PermissionMapper" domainObjectName="Permission" enableCountByExample="false" enableDeleteByExample="false" enableSelectByExample="false" enableUpdateByExample="false" selectByExampleQueryId="false" />
    
        </context>
    </generatorConfiguration>

执行插件时默认加载资源根目录下的generatorConfig.xml，文件名不能是其它的。

数据库驱动添加到classpath中都不行，必须要在配置文件中指定路径。

3、执行maven插件mybatis-generator，生成文件

#### 方式二 maven依赖 ####

1、pom.xml中添加mbg的依赖（需要数据库驱动、mybatis依赖）

<dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.19</version>
    </dependency>
    
    
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.4</version>
    </dependency>
    
    
    <dependency>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-core</artifactId>
        <version>1.3.6</version>
    </dependency>

2、resources下新建mbg的配置文件generatorConfig.xml

*  文件名任意，因为是在java代码中指定mbg配置文件的位置。
 *  配置文件内容和方式一的相同，只是不需要指定数据库驱动的路径。

3、新建并执行主类，生成代码

package test;
    
    import org.mybatis.generator.api.MyBatisGenerator;
    import org.mybatis.generator.config.Configuration;
    import org.mybatis.generator.config.xml.ConfigurationParser;
    import org.mybatis.generator.exception.InvalidConfigurationException;
    import org.mybatis.generator.exception.XMLParserException;
    import org.mybatis.generator.internal.DefaultShellCallback;
    import java.io.IOException;
    import java.io.InputStream;
    import java.sql.SQLException;
    import java.util.ArrayList;
    import java.util.List;
    
    public class Test { 
        
        public static void main(String[] args) throws IOException, XMLParserException, InvalidConfigurationException, SQLException, InterruptedException { 
            List<String> warnings = new ArrayList<String>();
            //生成文件时如果已存在同名文件，会覆盖
            boolean overwrite = true;
            //指定mbg配置文件的位置
            InputStream configFile = Test.class.getResourceAsStream("/generatorConfig.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);
        }
    
    }

### MyBatis-Plugin mapper接口、xml映射文件之间的跳转 ###

IDEA的一个插件，可以实现mapper接口中的方法、xml映射文件中相应元素之间的快速定位。

直接搜索 mybatis plugin ，安装下载次数最多的那个，目前该插件全名是 Free MyBatis plugin。

### MyBatis-PageHelper 分页 ###

国人开源的mybatis分页组件，方便易用，兼容mysql、oracle、sql server、db2、sqlite等多种主流数据库。

pom.xml

<dependency>
        <groupId>com.github.pagehelper</groupId>
        <artifactId>pagehelper</artifactId>
        <version>5.2.0</version>
    </dependency>
    
    
    <dependency>
        <groupId>com.github.pagehelper</groupId>
        <artifactId>pagehelper-spring-boot-starter</artifactId>
        <version>1.2.3</version>
    </dependency>

service

@Service
    public class UserService { 
    
        @Autowired
        private UserMapper userMapper;
    
        /** * 普通分页 * * @param pageNum 页码，从1开始 * @param pageSize 每页条数 * @return 指定页的结果集数据 */
        public List<User> findAll1(int pageNum, int pageSize) { 
            //在调用mapper之前使用PageHelper进行分页
            PageHelper.startPage(pageNum, pageSize);
            List<User> userList = userMapper.findAll();
            return userList;
        }
    
        /** * 带有计数功能的分页 * * @param pageNum 页码 * @param pageSize 每页条数 * @return 封装好的查询结果 */
        public Map<String, Object> findAll2(int pageNum, int pageSize) { 
            //Page<Object> 泛型也可以声明为具体类型，eg.Page<User>。true 开启计数
            Page<Object> page = PageHelper.startPage(pageNum, pageSize, true);
            List<User> userList = userMapper.findAll();
    
            HashMap<String, Object> map = new HashMap<>(5);
            //总记录数
            map.put("total", page.getTotal());
            //总页数
            map.put("pages", page.getPages());
            //当前页的结果集数据
            map.put("list", userList);
    
            return map;
        }
    
    }

**说明**

1、可以在yml中指定数据库类型，也可以不指定，缺省时会自动根据数据库连接信息中的url自动识别数据库类型

pagehelper:
      helper-dialect: mysql

2、 Page<E>

public class Page<E> extends ArrayList<E> implements Closeable{ 
    	
    	//...
    	
        public List<E> getResult() { 
            return this;
        }
    	
    	//...
    	
    }

*  Page<E>继承了ArrayList，用list来存储当前页的记录
 *  getResult()获取的不是结果集，而整个Page对象
 *  Page|getResult()包含了内部list存储的当前页记录，以及

{ 
      count=true,  //是否开启计数
      pageNum=2, pageSize=10,  //页码、每页记录数
      startRow=10, endRow=20,  //当前页在结果集中的其实位置、结束位置，均为下标，[start,end)
      total=21, pages=3,  //总记录数，总页数
      reasonable=false, pageSizeZero=false
    }

但打印Page|getResult()时只会打印出以上部分、不会打印list；返回Page|getResult()给前端时，不返回以上部分、只会返回list。

**原理**

调用mapper中的方法时进行拦截，先查询满足条件的总记录数

--保持查询条件不变，查询总记录数，根据总记录数确定Page中的参数值
    SELECT count(0) FROM tb_xxx WHERE ...

然后在目标sql末尾根据数据库类型追加limit或top，再执行目标sql。

**总结**\*

*  要应用PageHelper进行分页的sql末尾不要写分号，PageHelper是直接加在sql末尾的，不会自动去除原sql末尾的分号。
 *  相比于直接在sql中用limit或top分页，PageHelper多查了一次，性能有损耗，但数据库无关性不错，切换mysql、oracle时无需修改代码。