Mybatis-Plus入門實踐

Naylor發表於2022-05-10

MyBatis

簡介

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, 'test1@baomidou.com', NULL);
INSERT INTO `user` VALUES (2, 'Jack', 20, 'test2@baomidou.com', NULL);
INSERT INTO `user` VALUES (3, 'Tom', 28, 'test3@baomidou.com', NULL);
INSERT INTO `user` VALUES (4, 'Sandy', 21, 'test4@baomidou.com', NULL);
INSERT INTO `user` VALUES (5, 'Billie', 24, 'test5@baomidou.com', 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;
    }
}




    /**
     * 構造查詢包裝器，lambda 鏈式查詢，不用手寫欄位名稱，通過資料庫實體對映
     *
     * @param param
     * @return
     */
    private LambdaQueryWrapper<TagInfo> buildQueryWrapper(TagInfoParam param) {
        LambdaQueryWrapper<TagInfo> query = new LambdaQueryWrapper<>();
        if (null == param) {
            return query;
        }
        query.like(StringUtils.isNotEmpty(param.getTagCode()), TagInfo::getTagCode, param.getTagCode())
                .like(StringUtils.isNotEmpty(param.getTagName()), TagInfo::getTagName, param.getTagName())
                .like(StringUtils.isNotEmpty(param.getTagSimpleName()), TagInfo::getTagSimpleName, param.getTagSimpleName())
                .eq(null != param.getTagId(), TagInfo::getId, param.getTagId()).eq(TagInfo::getIsDeleted, 0);
        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

引用

官網：https://baomidou.com/pages/24112f/#特性
mybatis-plus-samples：https://github.com/baomidou/mybatis-plus-samples

MyBatis-Plus——實踐篇
2021-10-08
MyBatis
MyBatis-Plus筆記(入門)
2021-04-17
MyBatis筆記
BoltDB 入門實踐
2019-10-02
MQ 入門實踐
2021-04-19
MQ
Docker入門實踐
2018-08-07
Docker
TypeScript入門與實踐
2018-08-25
TypeScript
redux 入門到實踐
2018-12-10
Redux
GitHub Actions 入門實踐
2020-11-11
Github
locsut 入門與實踐
2021-01-05
Kafka 入門與實踐
2018-04-12
Kafka
Docker 入門與實踐
2018-04-18
Docker
SASS入門與實踐
2017-12-14
CoffeeScript入門實踐
2014-12-16
Docker實踐(1)—入門
2014-07-24
Docker
Docker入門實踐（三）
2024-09-23
Docker
Docker入門實踐（四）
2024-09-23
Docker
Nginx入門實踐（二）
2024-09-10
Nginx
GraphQL 從入門到實踐
2019-03-12
Nacos入門學習&實踐
2021-07-18
Redis從入門到實踐
2018-02-24
Redis
nginx從入門到實踐
2017-12-05
Nginx
GitOps快速入門與實踐
2020-04-07
Git
Dubbo入門(2) – 簡單實踐
2019-03-04
系統思維實踐入門
2021-07-27
Android入門（五）：實踐技巧
2018-09-21
Android
Mobx入門和較佳實踐
2018-12-19
Git與Github入門實踐（上）
2020-12-25
Github
RPC協議實踐入門
2020-11-17
RPC協議
Open Policy Agent(OPA) 入門實踐
2021-12-07
PM2入門實踐指南
2018-06-26
微信小程式入門與實踐
2018-04-26
微信小程式
Puppeteer的入門教程和實踐
2017-10-26
Dubbo入門(2) - 簡單實踐
2018-05-18
GraphQL 搭配 Koa 最佳入門實踐
2018-01-08
MyBatis-Plus 實現多租戶管理的實踐
2024-05-16
MyBatis
【docker】Docker入門到實踐筆記
2019-03-17
Docker筆記
Docker從入門到動手實踐
2019-05-12
Docker
GDB除錯-從入門到實踐
2022-01-05
除錯

Mybatis-Plus入門實踐

簡介

常用註解

CRUD介面

Service層介面

save

saveOrUpdate

remove

update

get

list

page

count

chain

Mapper層介面

insert

delete

update

select

實踐

pom

配置檔案

資料來源配置

日誌配置

資料庫表

實體model

repository

service

Mapper層註解語法

基礎語法

程式碼

引用

相關文章