Springboot整合Mybatis+Mapper+Pagehelper

本文知识点：

springboot如何集成mybatis

springboot如何集成通用mapper

springboot如何集成pagehelper分页插件

如何通过xml、通用mapper和注解这三种方式查询数据库

注[1]：本文（本系列）所有涉及到数据库的内容，默认使用MySQL5.6，高于或低于这个版本时可能会存在兼容问题，具体问题，请自行查阅相关资料。

注[2]：本文例子中涉及到Freemarker相关内容，请参考springboot整合Freemark模板(修订-详尽版)

准备工作

目录结构

└─me

    └─zhyd

        └─springboot

            └─mybatis

                ├─config

                ├─controller

                ├─entity

                ├─mapper

                ├─service

                │  └─impl

                └─util

准备数据库

DROP TABLE IF EXISTS `message`;

CREATE TABLE `message`  (

  `id` int(10) NOT NULL AUTO_INCREMENT COMMENT 'ID',

  `nick_name` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '昵称',

  `ip` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT 'IP',

  `insert_time` datetime(0) NULL DEFAULT NULL COMMENT '提交时间',

  PRIMARY KEY (`id`) USING BTREE

) ENGINE = InnoDB AUTO_INCREMENT = 1 CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Compact;

注：为方便测试，此处可以使用存储过程批量插入一些测试例子

DROP PROCEDURE IF EXISTS `autoInsert`;

delimiter ;;

CREATE DEFINER=`root`@`localhost` PROCEDURE `autoInsert`()

BEGIN

DECLARE

i INT DEFAULT 0 ; -- 开始

SET autocommit = 0 ; -- 结束

WHILE (i <= 100) DO

REPLACE INTO message (

`id`,

`nick_name`,

`ip`,

`insert_time`

)

VALUE

(

i,

'码一码',

'127.0.0.1',

NOW()

) ;

SET i = i + 1 ;

END

WHILE ;

SET autocommit = 1 ; COMMIT ;

END

;;

delimiter ;

使用call autoInsert();调用存储过程即可。本例使用100条数据作为测试

添加依赖

<!--springboot数据持久化所需jar配置 start -->

<!--支持使用 JDBC 访问数据库 -->

<dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-jdbc</artifactId>

</dependency>

<!--mybatis-->

<dependency>

<groupId>org.mybatis.spring.boot</groupId>

<artifactId>mybatis-spring-boot-starter</artifactId>

<version>1.3.1</version>

</dependency>

<!--mapper-->

<dependency>

<groupId>tk.mybatis</groupId>

<artifactId>mapper-spring-boot-starter</artifactId>

<version>1.1.4</version>

</dependency>

<!--pagehelper-->

<dependency>

<groupId>com.github.pagehelper</groupId>

<artifactId>pagehelper-spring-boot-starter</artifactId>

<version>1.2.9</version>

</dependency>

<!--mysql-->

<dependency>

<groupId>mysql</groupId>

<artifactId>mysql-connector-java</artifactId>

<scope>runtime</scope>

</dependency>

<!--springboot数据持久化所需jar配置 end -->

配置属性文件

spring:

    datasource:

        driver-class-name: com.mysql.jdbc.Driver

        url: jdbc:mysql://localhost:3306/springboot_learning?useUnicode=true&characterEncoding=utf-8&autoReconnect=true&zeroDateTimeBehavior=convertToNull&allowMultiQueries=true&useSSL=false&allowPublicKeyRetrieval=true

        username: root

        password: root

# MyBatis

mybatis:

  type-aliases-package: com.zyd.mybatis.com.rest.entity

  mapper-locations: classpath:/mybatis/*.xml

# mapper

mapper:

  mappers:

  - me.zhyd.springboot.mybatis.util.BaseMapper

  not-empty: false

  identity: MYSQL

# pagehelper

pagehelper:

  helper-dialect: mysql

  reasonable: "true"

  support-methods-arguments: "true"

  params: count=countSql

配置mybatis

@Component

@MapperScan("me.zhyd.springboot.mybatis.mapper")

public class MybatisConfig {

}

配置BaseMapper

public interface BaseMapper<T> extends Mapper<T>, MySqlMapper<T> {

}

bean实体

public class Message implements Serializable {

    @Id

    @GeneratedValue(strategy = GenerationType.IDENTITY)

    private Integer id;

    private String nickName;

    private String ip;

    private Date insertTime;

    // getter setter 略

}

编写mapper.xml

mapper.xml主要用来解决通用mapper无法处理的查询请求。比如模糊搜索，比如多表关联查询等

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE mapper PUBLIC "-//testMybatis.org//DTD Mapper 3.0//EN"

        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="me.zhyd.springboot.mybatis.mapper.MessageMapper">

    <resultMap id="message_map" type="me.zhyd.springboot.mybatis.bean.Message">

        <id property="id" column="ID" jdbcType="INTEGER"></id>

        <result property="ip" column="IP" jdbcType="VARCHAR"></result>

        <result property="insertTime" column="INSERT_TIME" jdbcType="DATE"></result>

        <result property="nickName" column="NICK_NAME" jdbcType="VARCHAR"></result>

    </resultMap>

    <select id="listByMapperXml" resultMap="message_map">

select * from message

</select>

</mapper>

编写自己的mapper

@Repository

public interface MessageMapper extends BaseMapper<Message> {

    List<Message> listByMapperXml();

}

当继承了BaseMapper后，表示当前mapper已经集成了通用mapper所有的功能（具体功能请参考官方帮助文档）。

当通用mapper已不能满足自己的查询需求时，可以自定义sql方法，通过在mapper.xml中实现即可，比如例子中的listByMapperXml方法。

使用注解方式开发mapper

@Mapper

@Repository

public interface MessageAnnotationMapper {

    @Select("SELECT * FROM message")

    @Results({

            @Result(property = "id", column = "id", javaType = Integer.class, jdbcType = JdbcType.INTEGER),

            @Result(property = "nickName", column = "nick_name", javaType = String.class, jdbcType = JdbcType.VARCHAR),

            @Result(property = "ip", column = "ip", javaType = String.class, jdbcType = JdbcType.VARCHAR),

            @Result(property = "insertTime", column = "INSERT_TIME", javaType = Date.class, jdbcType = JdbcType.DATE)

    })

    List<Message> list();

}

注：具体的service层实现，由于过于简单，本文不做赘述。可参考文末源码查看具体内容。

编写controller

本例就三种实现方式分别测试

@Controller

public class MybatisController {

    @Autowired

    private IMessageService messageService;

    /**

    * 通过自定义的mapper xml查询

    *

    * @param model

    * @param currentPage

    * @param pageSize

    * @return

    */

    @RequestMapping("/listByMapperXml/{currentPage}/{pageSize}")

    public String listByMapperXml(Model model, @PathVariable("currentPage") int currentPage,

                                  @PathVariable("pageSize") int pageSize) {

        PageHelper.startPage(currentPage, pageSize);

        model.addAttribute("selectTypeMsg", "通过自定义的mapper xml查询");

        model.addAttribute("selectType", "listByMapperXml");

        model.addAttribute("page", new PageInfo<>(messageService.listByMapperXml()));

        return "index";

    }

    /**

    * 通过通用mapper查询

    *

    * @param model

    * @param currentPage

    * @param pageSize

    * @return

    */

    @RequestMapping("/listByMapper/{currentPage}/{pageSize}")

    public String listByMapper(Model model, @PathVariable("currentPage") int currentPage,

                              @PathVariable("pageSize") int pageSize) {

        PageHelper.startPage(currentPage, pageSize);

        model.addAttribute("selectTypeMsg", "通过通用mapper查询");

        model.addAttribute("selectType", "listByMapper");

        model.addAttribute("page", new PageInfo<>(messageService.listByMapper()));

        return "index";

    }

    /**

    * 通过注解查询

    *

    * @param model

    * @param currentPage

    * @param pageSize

    * @return

    */

    @RequestMapping("/listByAnnotation/{currentPage}/{pageSize}")

    public String listByAnnotation(Model model, @PathVariable("currentPage") int currentPage,

                                  @PathVariable("pageSize") int pageSize) {

        PageHelper.startPage(currentPage, pageSize);

        model.addAttribute("selectTypeMsg", "通过注解查询");

        model.addAttribute("selectType", "listByAnnotation");

        model.addAttribute("page", new PageInfo<>(messageService.listByAnnotation()));

        return "index";

    }

}

编写页面

<!DOCTYPE html>

<html lang="en">

<head>

    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>

    <title>Spring Boot 集成Mybatis + Mapper + Pagehelper 测试例子</title>

</head>

<body>

<h1>Spring Boot 集成Mybatis + Mapper + Pagehelper 测试例子</h1>

<em>${.now?string("yyyy-MM-dd HH:mm:ss.sss")}</em>

<br>

<strong>${selectTypeMsg}</strong>

<#if page.list?exists>

<br>

当前页共 <b>${page.list?size }</b>条记录，总共${page.total!(0)}条记录

<table style="border: 1px solid lightgray;width: 100%">

    <#assign index = 1> <#list page.list as message>

    <tr

        <#if index%2 == 0>style="background-color: lightgray;"</#if>>

        <td>${message.id}</td>

        <td>${message.ip}</td>

        <td>${message.nickName}</td>

        <td>${message.insertTime?string('yyyy-MM-dd HH:mm:ss.SSS')}</td>

    </tr>

    <#assign index = index + 1> </#list>

    <tr>

        <td colspan="4">

            <ul>

                <#list 1..page.pages as pageNumber>

                    <li style="float: left;width: 20px;list-style: none;">

                        <a href="http://localhost:8080/${selectType}/${pageNumber }/${page.pageSize}"

                          style="${(currentPage == pageNumber)?string('color:red;font-size:17px;font-weight: bold;','')}">${pageNumber }</a>

                    </li>

                </#list>

            </ul>

        </td>

    </tr>

</table>

</#if>

<p>Author: <a href="https://www.zhyd.me" target="_blank">https://www.zhyd.me</a> @码一码</p>

</body>

</html>

运行测试

listByMapperXml

listByMapper

listByAnnotation

到此为止，本篇已详细介绍了在springboot中如何整合Mybatis + Mapper，以及使用Pagehelper实现分页的使用方法。

作者：慕冬雪

链接：http://www.imooc.com/article/259252

来源：慕课网

本文首次发布于慕课网 ，转载请注明出处，谢谢合作

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 211,948评论 6赞 492
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 90,371评论 3赞 385
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 157,490评论 0赞 348
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 56,521评论 1赞 284
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 65,627评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 49,842评论 1赞 290
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,997评论 3赞 408
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,741评论 0赞 268
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,203评论 1赞 303
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,534评论 2赞 327
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,673评论 1赞 341
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,339评论 4赞 330
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,955评论 3赞 313
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,770评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,000评论 1赞 266
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,394评论 2赞 360
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,562评论 2赞 349

推荐阅读更多精彩内容