2. 程式人生 > 其它 >Mybatis-Plus入門實踐

Mybatis-Plus入門實踐

阿新 • • 發佈：2022-04-19

簡介

Mybatis-Plus 簡稱 MP ，是 Mybatis 的增強工具，提供了一批開箱即用的功能、特性、介面、註解，簡化了應用程式訪問資料庫的相關操作，完善了Mybatis作為ORM僅能做到半自動的不足，提高了開發人員的開發效率。

MP是社群產品，當前原始碼在Github上面進行維護，基於Apache2.0開源協議，可放心在商業專案上使用。

常用註解

  • TableName：表名註解，標識實體類對應的資料庫表
  • TableId：主鍵註解，標識此屬性對應資料庫中的主鍵欄位
  • TableField：欄位註解（非主鍵）

CRUD介面

MP的宗旨就是簡化編碼，所以一般而言，都是儘量直接使用 service 層介面。若確需手寫 sql ， 在 mapper 層中編寫註解，當然也可以編寫xml，更加推薦註解方式，因為xml方式下型別推導和引用會失效。

以下內容摘抄自官網

Service層介面

save

// 插入一條記錄（選擇欄位，策略插入）
boolean save(T entity);
// 插入（批量）
boolean saveBatch(Collection<T> entityList);
// 插入（批量）
boolean saveBatch(Collection<T> entityList, int batchSize);

saveOrUpdate

// TableId 註解存在更新記錄，否插入一條記錄
boolean saveOrUpdate(T entity);
// 根據updateWrapper嘗試更新，否繼續執行saveOrUpdate(T)方法
boolean saveOrUpdate(T entity, Wrapper<T> updateWrapper);
// 批量修改插入
boolean saveOrUpdateBatch(Collection<T> entityList);
// 批量修改插入
boolean saveOrUpdateBatch(Collection<T> entityList, int batchSize);

remove

// 根據 entity 條件，刪除記錄
boolean remove(Wrapper<T> queryWrapper);
// 根據 ID 刪除
boolean removeById(Serializable id);
// 根據 columnMap 條件，刪除記錄
boolean removeByMap(Map<String, Object> columnMap);
// 刪除（根據ID 批量刪除）
boolean removeByIds(Collection<? extends Serializable> idList);

update

// 根據 UpdateWrapper 條件，更新記錄 需要設定sqlset
boolean update(Wrapper<T> updateWrapper);
// 根據 whereWrapper 條件，更新記錄
boolean update(T updateEntity, Wrapper<T> whereWrapper);
// 根據 ID 選擇修改
boolean updateById(T entity);
// 根據ID 批量更新
boolean updateBatchById(Collection<T> entityList);
// 根據ID 批量更新
boolean updateBatchById(Collection<T> entityList, int batchSize);

get

// 根據 ID 查詢
T getById(Serializable id);
// 根據 Wrapper，查詢一條記錄。結果集，如果是多個會丟擲異常，隨機取一條加上限制條件 wrapper.last("LIMIT 1")
T getOne(Wrapper<T> queryWrapper);
// 根據 Wrapper，查詢一條記錄
T getOne(Wrapper<T> queryWrapper, boolean throwEx);
// 根據 Wrapper，查詢一條記錄
Map<String, Object> getMap(Wrapper<T> queryWrapper);
// 根據 Wrapper，查詢一條記錄
<V> V getObj(Wrapper<T> queryWrapper, Function<? super Object, V> mapper);

list

// 查詢所有
List<T> list();
// 查詢列表
List<T> list(Wrapper<T> queryWrapper);
// 查詢（根據ID 批量查詢）
Collection<T> listByIds(Collection<? extends Serializable> idList);
// 查詢（根據 columnMap 條件）
Collection<T> listByMap(Map<String, Object> columnMap);
// 查詢所有列表
List<Map<String, Object>> listMaps();
// 查詢列表
List<Map<String, Object>> listMaps(Wrapper<T> queryWrapper);
// 查詢全部記錄
List<Object> listObjs();
// 查詢全部記錄
<V> List<V> listObjs(Function<? super Object, V> mapper);
// 根據 Wrapper 條件，查詢全部記錄
List<Object> listObjs(Wrapper<T> queryWrapper);
// 根據 Wrapper 條件，查詢全部記錄
<V> List<V> listObjs(Wrapper<T> queryWrapper, Function<? super Object, V> mapper);

page

// 無條件分頁查詢
IPage<T> page(IPage<T> page);
// 條件分頁查詢
IPage<T> page(IPage<T> page, Wrapper<T> queryWrapper);
// 無條件分頁查詢
IPage<Map<String, Object>> pageMaps(IPage<T> page);
// 條件分頁查詢
IPage<Map<String, Object>> pageMaps(IPage<T> page, Wrapper<T> queryWrapper);

count

// 查詢總記錄數
int count();
// 根據 Wrapper 條件，查詢總記錄數
int count(Wrapper<T> queryWrapper);

chain

// 鏈式查詢 普通
QueryChainWrapper<T> query();
// 鏈式查詢 lambda 式。注意：不支援 Kotlin
LambdaQueryChainWrapper<T> lambdaQuery();

// 示例：
query().eq("column", value).one();
lambdaQuery().eq(Entity::getId, value).list();

Mapper層介面

insert

// 插入一條記錄
int insert(T entity);

delete

// 根據 entity 條件，刪除記錄
int delete(@Param(Constants.WRAPPER) Wrapper<T> wrapper);
// 刪除（根據ID 批量刪除）
int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
// 根據 ID 刪除
int deleteById(Serializable id);
// 根據 columnMap 條件，刪除記錄
int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

update

// 根據 whereWrapper 條件，更新記錄
int update(@Param(Constants.ENTITY) T updateEntity, @Param(Constants.WRAPPER) Wrapper<T> whereWrapper);
// 根據 ID 修改
int updateById(@Param(Constants.ENTITY) T entity);

select

// 根據 ID 查詢
T selectById(Serializable id);
// 根據 entity 條件，查詢一條記錄
T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

// 查詢（根據ID 批量查詢）
List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
// 根據 entity 條件，查詢全部記錄
List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 查詢（根據 columnMap 條件）
List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
// 根據 Wrapper 條件，查詢全部記錄
List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根據 Wrapper 條件，查詢全部記錄。注意： 只返回第一個欄位的值
List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

// 根據 entity 條件，查詢全部記錄（並翻頁）
IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根據 Wrapper 條件，查詢全部記錄（並翻頁）
IPage<Map<String, Object>> selectMapsPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根據 Wrapper 條件，查詢總記錄數
Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

實踐

pom

需要新增的maven依賴：

  • mysql-connector-java：Mysql 官方的jdbc驅動器
  • spring-boot-starter-jdbc：資料來源自動配置；提供一個JdbcTemplate 簡化使用；事物管理。
  • druid-spring-boot-starter：資料庫連線池管理
  • mybatis-plus-boot-starter：MP的依賴，引入MP之後無需再次引入mybatis。
  • springfox-boot-starter：swagger3.0，介面自測工具

jdbc是Java提供的一種標準規範，具體的實現由各個資料庫廠商去實現。對開發者來說遮蔽了不同資料庫之間的區別，可以使用相同的方式(Java API)去操作不同的資料庫。兩個裝置之間要進行通訊需要驅動，不同資料庫廠商對jdbc的實現類就是去連線資料庫的驅動，如mysql-connector-java連線mysql資料庫的驅動。

配置檔案

資料來源配置

spring:
  application:
    name: mp-service
  datasource:
    #url: jdbc:mysql://192.168.1.152:3306/test?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8
    #username: root
    #password: 123456
    #driver-class-name: com.mysql.cj.jdbc.Driver
    druid:
      #或 spring.datasource.url
      url: jdbc:mysql://192.168.1.152:3306/test?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8
      #或 spring.datasource.username
      username: dev-luyubo
      #或 spring.datasource.password
      password: KjJhAjXJ
      #或 spring.datasource.driver-class-name
      driver-class-name: com.mysql.cj.jdbc.Driver

日誌配置


#配置mp日誌列印到輸出。此配置若和logging.level.org.apache.ibatis.logging: debug 同時存在，後者將不生效
#mybatis-plus:
#configuration:
#log-impl: org.apache.ibatis.logging.stdout.StdOutImpl


logging:
  level:
    com.ramble: debug
    #配置mp日誌列印到專案配置的日誌實現框架，預設為logback
    org.apache.ibatis.logging: debug

資料庫表



SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;
-- ----------------------------
-- Table structure for user
-- ----------------------------
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user`  (
  `id` bigint NOT NULL COMMENT '主鍵ID',
  `name` varchar(30) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '姓名',
  `age` int NULL DEFAULT NULL COMMENT '年齡',
  `email` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '郵箱',
  `create_time` datetime NULL DEFAULT CURRENT_TIMESTAMP,
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8mb4 COLLATE = utf8mb4_0900_ai_ci ROW_FORMAT = Dynamic;
-- ----------------------------
-- Records of user
-- ----------------------------
INSERT INTO `user` VALUES (1, 'Jone', 18, '[email protected]', NULL);
INSERT INTO `user` VALUES (2, 'Jack', 20, '[email protected]', NULL);
INSERT INTO `user` VALUES (3, 'Tom', 28, '[email protected]', NULL);
INSERT INTO `user` VALUES (4, 'Sandy', 21, '[email protected]', NULL);
INSERT INTO `user` VALUES (5, 'Billie', 24, '[email protected]', NULL);
SET FOREIGN_KEY_CHECKS = 1;

實體model


@TableName("user")
@Data
@Accessors(chain = true)
public class User implements Serializable {
    @TableId
    private Long id;
    @TableField("name")
    private String name;
    private Integer age;
    private String email;
}

repository

若使用 Repository 註解，需手動設定掃描路徑，建議使用 Mapper 註解


@Mapper
public interface UserMapper extends BaseMapper<User> {
}

service

UserService：


public interface UserService  extends IService<User> {
    List<User> findList(UserConditionDto condition);
    Page<User> search(UserConditionDto condition);
}

UserServiceImpl：


@Slf4j
@Service
@AllArgsConstructor
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
    /**
     * 獲取列表資料
     *
     * @param condition
     * @return
     */
    @Override
    public List<User> findList(UserConditionDto condition) {
        return this.list(this.buildQueryWrapper(condition));
    }
    /**
     * 搜尋資料
     *
     * @param condition
     * @return
     */
    @Override
    public Page<User> search(UserConditionDto condition) {
        QueryWrapper<User> query = this.buildQueryWrapper(condition);
        Page<User> page = new Page<>(condition.getPageNum(), condition.getPageSize());
        return this.page(page, query);
    }
    /**
     * 構造 queryWrapper
     *
     * @param condition
     * @return
     */
    private QueryWrapper<User> buildQueryWrapper(UserConditionDto condition) {
        Assert.notNull(condition, CommonErrorMsgEnum.PARAM_IS_NULL.toString());
        QueryWrapper<User> query = new QueryWrapper<>();
        //name 模糊匹配
        if (StringUtils.hasText(condition.getName())) {
            query.like("name", condition.getName());
        }
        if (StringUtils.hasText(condition.getEmail())) {
            query.like("email", condition.getEmail());
        }
        //id 精確查詢
        if (null != condition.getId() && condition.getId() > 0) {
            query.eq("id", condition.getId());
        }
        //時間範圍
        if (null != condition.getStartTime()) {
            if (null != condition.getEndTime()) {
                query.in("create_time", condition.getStartTime(), condition.getEndTime());
            } else {
                LocalDateTime now = LocalDateTime.now();
                query.in("create_time", condition.getStartTime(), now);
            }
        } else {
            if (null != condition.getEndTime()) {
                query.ge("create_time", condition.getEndTime());
            }
        }
        //預設時間倒序
        query.orderByDesc("create_time");
        return query;
    }
}

Mapper層註解語法

基礎語法

  • script
  • where
  • if
  • foreach
  • choose-when-otherwise（if-else ；switch-case-default）

package com.ramble.mybatisplus.repository;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.ramble.mybatisplus.model.User;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.Select;
import java.util.List;
import java.util.Set;
@Mapper
public interface UserMapper extends BaseMapper<User> {
    @Select({
            "<script>",
            " select * from user ",
            "<where>",
            "<if test=\" user.id !=null and user.id !=0 \" >",
            "   and id=#{user.id}",
            "</if>",
            "</where>",
            "</script>"
    })
    User findUserById(@Param("user") User user);
    @Select({
            "<script>",
            " select * from user ",
            "<where>",
            "   <foreach collection='ids' item='item' open=' id in (' close=')' separator=','>",
            "       #{item}",
            "   </foreach>",
            "</where>",
            "</script>"
    })
    List<User> findUserByIds(@Param("ids") Set<Long> ids);
    @Select({
            "<script>",
            " select * from user ",
            "<where>",
            "<choose>",
            "   <when  test=\" user.name !=null and user.name !='' \" >",
            "       and name like CONCAT('%' , #{user.name} , '%')",
            "   </when>",
            "   <otherwise>",
            "       and name =#{currentUserName} ",
            "   </otherwise>",
            "</choose>",
            "</where>",
            "</script>"
    })
    List<User> findUser(@Param("user") User user, @Param("currentUserName") String currentUserName);
}

程式碼

https://gitee.com/naylor_personal/ramble-spring-cloud/tree/master/mybatisplus

引用

相關推薦

Mybatis-Plus入門實踐

簡介 Mybatis-Plus 簡稱 MP ，是 Mybatis 的增強工具，提供了一批開箱即用的功能、特性、介面、註解，簡化了應用程式訪問資料庫的相關操作，完善了Mybatis作為ORM僅能做到半自動的不足，提高了開發人員的開發效率。

SpringBoot 整合 MyBatis-Plus 入門體驗

一、前言 本文小編將基於 SpringBoot 整合 MyBatis-Plus ， MyBatis-Plus 是一個 MyBatis 的增強工具，在 MyBatis 的基礎上做增強並且不改變原本功能 ~

MyBatis-Plus入門及基本用法

MyBatis-Plus入門及基本用法 需要的基礎：學習過MyBatis、Spring、SpringMVC就可以學習這個了！

MyBatis Plus 入門使用詳細教程

一、MyBatis Plus 介紹 MyBatis Plus 是國內人員開發的 MyBatis 增強工具，在 MyBatis 的基礎上只做增強不做改變，為簡化開發、提高效率而生。

springboot+swagger2.10.5+mybatis-plus 入門詳解

最新idea2020安裝部署超詳細教程 懂得懂的 2020.3 2020.2.4 2020.2.3 2020.2.2 20.2.1 2019.3 2018.3

MyBatis-Plus 入門程式碼，一個強大的單表查詢工具包

一 mybatis的一個強大的單表查詢工具包，官網 https://baomidou.com/guide/ 主要理解條件構造器queryWrapper、updateWrapper即可

mybatis-plus入門

技術標籤：mybatis-plus入門mybatisspring MyBatisPlus概述 需要的基礎：把我的MyBatis、Spring、SpringMVC就可以學習這個了！ MyBatisPlus就是在Mybatis基礎上簡化MyBatis 學習MyBatisPlus可以節省我們大量工作

Mybatis-Plus入門學習筆記（一）

本文內容 瞭解Mybatis-Plus 整合Mybatis-Plus 1、瞭解Mybatis-plus 1.1、Mybatis-Plus介紹 MyBatis-Plus（簡稱 MP）是一個 MyBatis 的增強工具，在 MyBatis 的基礎上只做增強不做改變，為簡化開發、提高

mybatis-plus 入門使用

mybatis-plus 入門使用 資料庫環境搭建 建表程式碼 DROP TABLE IF EXISTS user; CREATE TABLE user

MyBatis-Plus 快速入門案例(小白教程)

一、引言 學習MyBatis-Plus前提需要掌握：資料庫相關操作、java等相關知識，最好熟悉Mybatis。

mybatis-plus的使用 ------ 入門(轉載)

原作：https://www.jianshu.com/p/ceb1df475021 前言： mybatis在持久層框架中還是比較火的，一般專案都是基於ssm。雖然mybatis可以直接在xml中通過SQL語句操作資料庫，很是靈活。但正其操作都要通過SQL語句進行，

SpringBoot實踐（五）：mybatis-plus中的BaseMapper，Iservice和ServiceImpl

技術標籤：Springboot後端開發javaspringspring boot mybatis-plus中包含BaseMapper，Iservice兩個介面和ServiceImpl類，BaseMapper 針對dao層的方法封裝 CRUD，IService 針對業務邏輯層的封裝，需要指定Dao層類

Mybatis Plus 快速入門

一、快速入門 1、建庫建表 #建立使用者表 CREATE TABLE user ( id BIGINT(20) PRIMARY KEY NOT NULL COMMENT \'主鍵\',

SpringBoot+Mybatis-Plus的入門搭建與配置測試

引言 mybatis需要寫很多Mapper.xml檔案，這是大大降低了開發效率，後期增刪欄位還需要手動去修改xml檔案，Mybatis-plus誕生之後，把一些簡單的對資料庫的操作都整合成方法，直接呼叫方法就可以操作資料庫，不需要寫

mybatis-plus 程式碼生成工具-CURD 實踐

工欲善其事，必先利其器！！！ 1、pom 依賴 dao 模組 Pom 依賴 <!--如果專案引入了，要去掉

實踐丨SpringBoot整合Mybatis-Plus專案存在Mapper時報錯

摘要：在SpringBoot執行測試Mybatis-Plus測試的時候報錯的問題分析與修復 本文分享自華為雲社群《SpringBoot整合MybatisPlus專案存在Mapper時執行報錯的問題分析與修復》，作者：攻城獅Chova 。

mybatis-plus的BaseMapper入門使用

mybatis-plus的BaseMapper入門使用 具體教程參考官網文件: https://baomidou.com/ 入門使用BaseMapper完成增刪改查

專門為小白準備的入門級mybatis-plus-generator程式碼自動生成器，提高開發效率。值得收藏

引入依賴 <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId>

Mybatis 入門實戰(4)--Mybatis-Plus 使用

MyBatis-Plus 是一個 MyBatis 的增強工具，在 MyBatis 的基礎上只做增強不做改變，為簡化開發、提高效率而生。本文主要介紹 Mybatis-Plus 的基本使用，相關的環境及軟體資訊如下：Spring Boot 2.6.12、Mybatis-Pl

Mybatis快速入門指南

搭建mybatis的環境 匯入相關jar包 mybatis-3.5.3.jar commons-logging-1.1.1.jar log4j-1.2.16.jar cglib-2.2.2.jar