一、MyBatis分页思想
1.1 使用场景
Mybatis分页应用场景：
MyBatis是一个Java持久层框架，它提供了一种将SQL查询和结果映射到Java对象的简单方式。分页是MyBatis中一个常用的功能，适用于如下场景：
- 数据库查询结果过多时，需要将结果进行分页展示，以提高用户体验。
- 需要在后台进行大数据量的处理，但出于性能等因素，一次性处理全部数据可能不可行，此时可以利用分页功能，逐页进行处理。
- 在一些导出报表等功能中，需要将查询结果按照分页方式输出到文件或者其他存储介质中。
- 针对某些需要按照特定顺序获取数据的业务场景，可以通过分页来实现。
总之，如果你需要在应用中实现查询结果的分页展示或者分批处理大量数据，MyBatis的分页功能将是一个很好的选择。
1.2 代码演示
先找到pom.xml配置文件中增加以下代码 ：
<!-- ********************** Mybatis的分页依赖********************** -->
<dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper</artifactId>
<version>5.1.2</version>
</dependency>
我们找到项目中的pom.xml配置文件，进行增加，增加之后的所有代码如下:
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>org.example</groupId> <artifactId>mybatis01</artifactId> <version>1.0-SNAPSHOT</version> <packaging>war</packaging> <name>mybatis01 Maven Webapp</name> <!-- FIXME change it to the project's website --> <url>http://www.example.com</url> <properties> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> </properties> <dependencies> <!-- ********************** junit单元测试依赖 ********************** --> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.12</version> <!-- <scope>test</scope>--> </dependency> <!-- ********************** Java Servlet API ********************** --> <dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet-api</artifactId> <version>4.0.0</version> <scope>provided</scope> </dependency> <!-- ********************** Mybatis依赖 ********************** --> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> <version>3.4.5</version> </dependency> <!-- ********************** Mybatis的分页依赖********************** --> <dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper</artifactId> <version>5.1.2</version> </dependency> <!-- ********************** Mysql JDBC驱动 ********************** --> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.44</version> </dependency> <!-- ********************** 日志配置 ********************** --> <!--记得修改mybatis.cfg.xml添加如下内容--> <!--<setting name="logImpl" value="LOG4J2"/>--> <!--核心log4j2jar包--> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-core</artifactId> <version>2.9.1</version> </dependency> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-api</artifactId> <version>2.9.1</version> </dependency> <!--web工程需要包含log4j-web，非web工程不需要--> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-web</artifactId> <version>2.9.1</version> </dependency> </dependencies> <build> <finalName>mybatis01</finalName> <resources> <!--解决mybatis-generator-maven-plugin运行时没有将XxxMapper.xml文件放入target文件夹的问题--> <resource> <directory>src/main/java</directory> <includes> <include>**/*.xml</include> </includes> </resource> <!--解决mybatis-generator-maven-plugin运行时没有将jdbc.properites文件放入target文件夹的问题--> <resource> <directory>src/main/resources</directory> <includes> <include>jdbc.properties</include> <include>*.xml</include> </includes> </resource> </resources> <plugins> <plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-maven-plugin</artifactId> <version>1.3.2</version> <dependencies> <!--使用Mybatis-generator插件不能使用太高版本的mysql驱动 --> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.44</version> </dependency> </dependencies> <configuration> <overwrite>true</overwrite> </configuration> </plugin> <plugin> <artifactId>maven-clean-plugin</artifactId> <version>3.1.0</version> </plugin> <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_war_packaging --> <plugin> <artifactId>maven-resources-plugin</artifactId> <version>3.0.2</version> </plugin> <plugin> <artifactId>maven-compiler-plugin</artifactId> <version>3.8.0</version> </plugin> <plugin> <artifactId>maven-surefire-plugin</artifactId> <version>2.22.1</version> </plugin> <plugin> <artifactId>maven-war-plugin</artifactId> <version>3.2.2</version> </plugin> <plugin> <artifactId>maven-install-plugin</artifactId> <version>2.5.2</version> </plugin> <plugin> <artifactId>maven-deploy-plugin</artifactId> <version>2.8.2</version> </plugin> </plugins> </build> </project>
再找到 mybatis.cfg.xml 的配置文件进行增加以下引用配置标签
<plugins>
<!-- 配置分页插件PageHelper, 4.0.0以后的版本支持自动识别使用的数据库 -->
<plugin interceptor="com.github.pagehelper.PageInterceptor">
</plugin>
</plugins>
注意 : 增加的位置需要跟我们增加的位置一样，随便放到一个位置会发生报错。
以下是 增加引用标签后 mybatis.cfg.xml 配置文件 的所有代码：
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd"> <configuration> <!-- 引入外部配置文件 --> <properties resource="jdbc.properties"/> <settings> <setting name="logImpl" value="LOG4J2"/> </settings> <!-- 别名 --> <typeAliases> <typeAlias type="com.Kissship.model.Book" alias="Book"/> </typeAliases> <plugins> <!-- 配置分页插件PageHelper, 4.0.0以后的版本支持自动识别使用的数据库 --> <plugin interceptor="com.github.pagehelper.PageInterceptor"> </plugin> </plugins> <!-- 配置mybatis运行环境 --> <environments default="development"> <environment id="development"> <!-- type="JDBC" 代表使用JDBC的提交和回滚来管理事务 --> <transactionManager type="jdbc"/> <!-- mybatis提供了3种数据源类型，分别是：POOLED,UNPOOLED,JNDI --> <!-- POOLED 表示支持JDBC数据源连接池 --> <!-- UNPOOLED 表示不支持数据源连接池 --> <!-- JNDI 表示支持外部数据源连接池 --> <dataSource type="POOLED"> <property name="driver" value="${jdbc.driver}"/> <property name="url" value="${jdbc.url}"/> <property name="username" value="${jdbc.username}"/> <property name="password" value="${jdbc.password}"/> </dataSource> </environment> </environments> <mappers> <mapper resource="com/Kissship/mapper/BookMapper.xml"/> </mappers> </configuration>
然后我们需要在 utils 包里面写一个名为PageBean的分页工具类
代码如下:
package com.Kissship.utils; import javax.servlet.http.HttpServletRequest; import java.io.Serializable; import java.util.Map; /** * @author Kissship * @site www.Kissship.com * @company xxx公司 * @create 2023-08-15-15:42 */ public class PageBean implements Serializable { private static final long serialVersionUID = 2422581023658455731L; //页码 private int page=1; //每页显示记录数 private int rows=10; //总记录数 private int total=0; //是否分页 private boolean isPagination=true; //上一次的请求路径 private String url; //获取所有的请求参数 private Map<String,String[]> map; public PageBean() { super(); } //设置请求参数 public void setRequest(HttpServletRequest req) { String page=req.getParameter("page"); String rows=req.getParameter("rows"); String pagination=req.getParameter("pagination"); this.setPage(page); this.setRows(rows); this.setPagination(pagination); this.url=req.getContextPath()+req.getServletPath(); this.map=req.getParameterMap(); } public String getUrl() { return url; } public void setUrl(String url) { this.url = url; } public Map<String, String[]> getMap() { return map; } public void setMap(Map<String, String[]> map) { this.map = map; } public int getPage() { return page; } public void setPage(int page) { this.page = page; } public void setPage(String page) { if(null!=page&&!"".equals(page.trim())) this.page = Integer.parseInt(page); } public int getRows() { return rows; } public void setRows(int rows) { this.rows = rows; } public void setRows(String rows) { if(null!=rows&&!"".equals(rows.trim())) this.rows = Integer.parseInt(rows); } public int getTotal() { return total; } public void setTotal(int total) { this.total = total; } public void setTotal(String total) { this.total = Integer.parseInt(total); } public boolean isPagination() { return isPagination; } public void setPagination(boolean isPagination) { this.isPagination = isPagination; } public void setPagination(String isPagination) { if(null!=isPagination&&!"".equals(isPagination.trim())) this.isPagination = Boolean.parseBoolean(isPagination); } /** * 获取分页起始标记位置 * @return */ public int getStartIndex() { //(当前页码-1)*显示记录数 return (this.getPage()-1)*this.rows; } /** * 末页 * @return */ public int getMaxPage() { int totalpage=this.total/this.rows; if(this.total%this.rows!=0) totalpage++; return totalpage; } /** * 下一页 * @return */ public int getNextPage() { int nextPage=this.page+1; if(this.page>=this.getMaxPage()) nextPage=this.getMaxPage(); return nextPage; } /** * 上一页 * @return */ public int getPreivousPage() { int previousPage=this.page-1; if(previousPage<1) previousPage=1; return previousPage; } @Override public String toString() { return "PageBean [page=" + page + ", rows=" + rows + ", total=" + total + ", isPagination=" + isPagination + "]"; } }
再创建一个 BookDto 类，如下：
package com.Kissship.Dto; import com.Kissship.model.Book; /** * @author Kissship * @site www.Kissship.com * @company xxx公司 * @create 2023-08-15-15:42 */ public class BookDto extends Book { private float max; private float min; public float getMax() { return max; } public void setMax(float max) { this.max = max; } public float getMin() { return min; } public void setMin(float min) { this.min = min; } }
在自动生成的BookMapper.xml 配置文件中增加以下动态SQL：
<!-- 分页查询的动态SQL--> <select id="BookListPager" resultType="java.util.Map" parameterType="java.util.Map"> select * from t_mvc_book where bname like concat(concat('%',#{bname}),'%') </select>
在自动生成的BookMapper接口中增加以下代码：
List<Map> BookListPager(Map map);
在创建的对象接口中增加以下代码：
List<Map> BookListPager(Map map, PageBean pageBean);
在接口实现类中增加以下代码：
@Override public List<Map> BookListPager(Map map, PageBean pageBean) { if (pageBean != null && pageBean.isPagination()){ PageHelper.startPage(pageBean.getPage(),pageBean.getRows()); } List<Map> list = bookMapper.BookListPager(map); if(pageBean != null && pageBean.isPagination()){ PageInfo pageInfo = new PageInfo(list); System.out.println("页码:"+pageInfo.getPageNum()); System.out.println("页大小:"+pageInfo.getPageSize()); System.out.println("总记录:"+pageInfo.getTotal()); pageBean.setTotal(pageInfo.getTotal()+""); } return list; }
最后在Demo1中增加以下代码进行测试：
@Test public void BookList(){ Map map = new HashMap(); map.put("bname","圣墟"); PageBean pageBean = new PageBean(); //第几页 pageBean.setPage(1); //显示多少数据 pageBean.setRows(10); bookBiz.BookListPager(map,pageBean); }
效果如下:
二、MyBatis特殊字符
- > (>) < (<) & (&) 空格 ( ) <![CDATA[ <= ]]>
- > (>) ： HTML实体字符编码中的一个字符实体，表示大于号（>）
- <![CDATA[ ]]>：CDATA节，用于包裹SQL语句中的特殊字符，防止被解析为XML标签。例如：`SELECT * FROM table WHERE name = <![CDATA[#{name}]]>`。
- < (<) ：HTML实体字符编码中的一个字符实体，表示小于号（<
2.1代码演示
在自动生成的BookMapper.xml 配置文件中增加以下动态SQL：
<!-- 动态SQL用特殊字符处理 --> <!-- > (>) < (<) & (&) 空格 ( ) <![CDATA[ <= ]]> --> <select id="listPager01" resultType="com.Kissship.model.Book" parameterType="com.Kissship.Dto.BookDto"> select * from t_mvc_book <where> <if test="null != min and min != '' "> <![CDATA[ and #{min} < price ]]> </if> <if test="null != max and max != '' "> <![CDATA[ and #{max} > price ]]> </if> </where> </select> <select id="listPager02" resultType="com.Kissship.model.Book" parameterType="com.Kissship.Dto.BookDto"> select * from t_mvc_book <where> <if test="null != min and min != ''"> and #{min} < price </if> <if test="null != max and max != ''"> and #{max} > price </if> </where> </select>
在自动生成的BookMapper接口中增加以下代码：
List<Book> listPager01(BookDto bookDto); List<Book> listPager02(BookDto bookDto);
在创建的对象接口中增加以下代码：
List<Book> listPager01(BookDto bookDto); List<Book> listPager02(BookDto bookDto);
在接口实现类中增加以下代码：
@Override public List<Book> listPager01(BookDto bookDto) { return bookMapper.listPager01(bookDto); } @Override public List<Book> listPager02(BookDto bookDto) { return bookMapper.listPager02(bookDto); }
在测试类 Demo 中 增加以下代码进行测试：
@Test public void listPager01(){ BookDto bookDto = new BookDto(); bookDto.setMax(80);//最大值 bookDto.setMin(70);//最小值 bookBiz.listPager01(bookDto).forEach(System.out::println); } @Test public void listPager02(){ BookDto bookDto = new BookDto(); bookDto.setMax(100);//最大值 bookDto.setMin(90);//最小值 bookBiz.listPager02(bookDto).forEach(System.out::println); }
List01执行结果如下：
List02执行结果如下：
最后MyBatis分页思想和特殊字符就到这里，祝大家在敲代码的路上一路通畅!
