Springboot整合mybatis+mybatis-plus+PageHelper

Mybatis是在国内使用是最广泛的，以前都是使用xml进行映射，说实话真心不太好用，维护起来也不太方便。 从mybatis3.0后开始支持 @Mapper注解，极大方便了开发，几乎不在需要任何xml进行配置了。下面重点就讲下Mybatis的相关整合与@Mapper的使用。

首先，配置pom.xml文件，添加以下配置项

<dependency>

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

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

    <version>2.1.4</version>

</dependency>

<dependency>

    <groupId>com.baomidou</groupId>

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

    <version>3.4.1</version>

</dependency>

第二步，在application.yml配置文件中添加以下配置项

spring:

  datasource:

    platform: mysql

    url: jdbc:mysql://localhost/jeealfa_boot?useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&transformedBitIsBoolean=true&autoReconnect=true&failOverReadOnly=false

    username: root

    password: 123456

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

    initialization-mode: never

    schema: classpath:db/schema.sql

# 配置slq打印日志

mybatis-plus:

  configuration:

    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

    map-underscore-to-camel-case: true

schema.sql文件内容户名测试要用，可以收到创建数据库，然后运行，如下： 也可以把 initialization-mode值设为always, 首次运行后修改为never.

drop table IF exists `user`;

create table `user`(

  `id` int(11) not null auto_increment,

  `name` varchar(60) not null default "" comment "姓名",

  `age` int(11) not null default 0,

  primary key (`id`),

  unique key (`name`)

)engine=InnoDB default charset=utf8;

第三步，创建数据model，内容如下

package com.jeealfa.model;

import lombok.Data;

@Data

public class User {

    private int id;

    private String name;

    private int age;

}

第四步，创建UserMapper，内容如下

package com.jeealfa.mapper;

import com.jeealfa.model.User;

import org.apache.ibatis.annotations.*;

@Mapper

public interface UserMapper {

    @Select("SELECT * FROM user WHERE id = #{id}")

    User queryById(@Param("id") int id);

    @Insert("INSERT INTO user(name,age) VALUES(#{name},#{age})")

    int add(User user);

    @Delete("DELETE FROM user WHERE id = #{id}")

    int delById(int id);

    @Update("UPDATE user SET name=#{name},age=#{age} WHERE id=#{id}")

    int updateById(User user);

}

第五步，在Controller中使用

//省略

@RestController

@RequestMapping("/user")

public class UserController {

    @Autowired

    private UserMapper userMapper;

    @RequestMapping("/querybyid")

    public User queryById(int id){

        return userMapper.queryById(id);

    }

    @RequestMapping("/add")

    public String add(User user){

        return userMapper.add(user) == 1?"success":"failed";

    }

}

第六步，mybatis-plus提供了BaseMapper，提供了一些列通用功能，极大方便了Mapper的开发，使用中可以直接继承此接口。BaseMapper提供的功能有：

package com.baomidou.mybatisplus.core.mapper;

import com.baomidou.mybatisplus.core.conditions.Wrapper;

import com.baomidou.mybatisplus.core.metadata.IPage;

import java.io.Serializable;

import java.util.Collection;

import java.util.List;

import java.util.Map;

import org.apache.ibatis.annotations.Param;

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

    int insert(T entity);

    int deleteById(Serializable id);

    int deleteByMap(@Param("cm") Map<String, Object> columnMap);

    int delete(@Param("ew") Wrapper<T> queryWrapper);

    int deleteBatchIds(@Param("coll") Collection<? extends Serializable> idList);

    int updateById(@Param("et") T entity);

    int update(@Param("et") T entity, @Param("ew") Wrapper<T> updateWrapper);

    T selectById(Serializable id);

    List<T> selectBatchIds(@Param("coll") Collection<? extends Serializable> idList);

    List<T> selectByMap(@Param("cm") Map<String, Object> columnMap);

    T selectOne(@Param("ew") Wrapper<T> queryWrapper);

    Integer selectCount(@Param("ew") Wrapper<T> queryWrapper);

    List<T> selectList(@Param("ew") Wrapper<T> queryWrapper);

    List<Map<String, Object>> selectMaps(@Param("ew") Wrapper<T> queryWrapper);

    List<Object> selectObjs(@Param("ew") Wrapper<T> queryWrapper);

    <E extends IPage<T>> E selectPage(E page, @Param("ew") Wrapper<T> queryWrapper);

    <E extends IPage<Map<String, Object>>> E selectMapsPage(E page, @Param("ew") Wrapper<T> queryWrapper);

}

UserMapper可以改为

@Mapper

public interface UserMapper extends BaseMapper<User>{ 

}

第7步，整合pageHelper, 在pom.xml里添加

<dependency>

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

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

    <version>1.2.3</version>

</dependency>

<dependency>

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

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

    <version>1.2.3</version>

</dependency>

application.yml里新增如下配置

pagehelper:

  helper-dialect: mysql

  reasonable: true

  support-methods-arguments: true

  params: count=countSql

第8步，在控制器中使用分页

@RequestMapping("/user/list")

public Page<User> getMap(@RequestParam(value = "page", defaultValue = "0") int page,

                        @RequestParam(value = "size", defaultValue = "5") int size){

    PageHelper.startPage(page, size, "id desc");

    Page<User> list = userMapper.listAll();

    System.out.println(list);

    return list;

}

注意：PageHelper.startPage执行之后，必须紧跟列表查询方法，不然分页可能会不起作用。

UserMapper中添加listAll接口方法，如下

package com.jeealfa.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;

import com.github.pagehelper.Page;

import com.jeealfa.model.User;

import org.apache.ibatis.annotations.*;

@Mapper

public interface UserMapper2 extends BaseMapper<User> {

    @Select("SELECT * FROM user")

    Page<User> listAll();

}

可通过postman进行测试。

第9步，自定义sql。 Mybatis提供了@SelectProvider注解来进行自定义sql查询。

见下面事例：

package com.jeealfa.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;

import com.github.pagehelper.Page;

import com.jeealfa.model.User;

import org.apache.ibatis.annotations.*;

import org.apache.ibatis.builder.annotation.ProviderContext;

import org.apache.ibatis.jdbc.SQL;

import java.util.List;

import java.util.Map;

@Mapper

public interface UserMapper extends BaseMapper<User> {

    @Select("SELECT * FROM user")

    Page<User> listAll();

    @SelectProvider(type = UserMapper.SelectSql.class, method = "sql")

    List<User> queryByPage(Page page, @Param("orderby") String orderby);


    class SelectSql{

        public String sql(Object object, ProviderContext context){

            Map map = (Map) object;

            Page page = (Page) map.get("page");

            String orderby = (String) map.get("orderby");

            return (new SQL()).SELECT("*").FROM("user").

                    ORDER_BY(orderby).

                    LIMIT(page.getStartRow()+","+page.getPageSize())

                    .toString();

        }

    }

}

自定义sql是灵活的，利用SelectProvider, 甚至可以自己手动写一个BaseMapper。

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

推荐阅读更多精彩内容