Mybatis-Plus的使用

本文轉載自查看原文 2021-03-16 19:21 408 框架

1.什么是Mybatis-Plus

2.為什么要學習Mybatis-Plus

3.入門示例

3.1 說明

3.2 准備工作

3.3 配置步驟

4.常用配置

4.1 實體類全局配置

4.2.插件配置（配置分頁插件）

5.自定義方法

6.Service 層

1.什么是Mybatis-Plus

　　MyBatis-Plus（簡稱 MP）是一個 MyBatis 的增強工具，在 MyBatis 的基礎上只做增強不做改變，為簡化開發、提高效率而生。

2.為什么要學習Mybatis-Plus

　　我們已經學習過Mybatis這個框架，我們只需要在dao層定義抽象接口，基於Mybatis零實現的特性，就可以實現對數據庫的crud操作。

　　如下兩個接口：

　　UserMapper接口

public interface UserMapper {
    int deleteByPrimaryKey(Long id);
    int insert(User user);
    List<User> selectList();
    User selectByPrimaryKey(Long id);
}

　　OrderMapper接口

public interface OrderMapper {
 
    int deleteByPrimaryKey(Long id);
    int insert(Order order);
    List<Order> selectList();
    User selectByPrimaryKey(Long id);
}

　　從上面兩個業務接口中，我們發現：它們定義了一組類似的crud方法。在業務類型比較多的時候，我們就需要重復的定義這組功能類似的接口方法。如何解決這個問題呢？

　　如果使用Mybatis-plus，甚至都不需要任何的xml映射文件或者接口方法注解，只需要讓我們定義的抽象接口繼承一個公用的BaseMapper接口就能完成dao層的一些基本的通用方法（如crud），做到真正的dao層零實現。

public interface UserMapper extends BaseMapper<User> {
   //BaseMapper已經實現了基本的通用方法了。如果有需要非通用的操作，才在這里自定義
}

3.入門示例

3.1 說明

　　1.Mybatis-Plus並沒有提供單獨的jar包，而是通過Maven（或者gradle）來管理jar依賴。所以需要使用Maven構建項目。

　　2.Mybatis-Plus是基於Spring框架實現的，因此使用Mybatis-Plus，必須導入Spring相關依賴。

3.2 准備工作

　　先創建好了數據庫環境

　　建表語句：

CREATE TABLE `tb_user` (
  `id` bigint(20) NOT NULL COMMENT '主鍵ID',
  `name` varchar(30) DEFAULT NULL COMMENT '姓名',
  `age` int(11) DEFAULT NULL COMMENT '年齡',
  `email` varchar(50) DEFAULT NULL COMMENT '郵箱',
  PRIMARY KEY (`id`)
)

3.3 配置步驟

3.3.1 第一步：搭建環境

1.創建一個Maven項目

2.配置pom.xml文件

導入相關依賴，並且配置項目的編碼，JDK版本等構建信息

<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>com.gjs</groupId>
  <artifactId>mybatis-plus-01-start</artifactId>
  <version>1.0</version>
  
  <dependencies>
      <!-- spring依賴 -->
      <dependency>
          <groupId>org.springframework</groupId>
          <artifactId>spring-context</artifactId>
          <version>4.3.20.RELEASE</version>
      </dependency>

      <dependency>
          <groupId>org.springframework</groupId>
          <artifactId>spring-jdbc</artifactId>
          <version>4.3.20.RELEASE</version>
      </dependency>
      
      <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-test</artifactId>
        <version>4.3.20.RELEASE</version>
        <scope>test</scope>
    </dependency>
      
      <!-- mybatis-plus -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus</artifactId>
        <version>2.3</version>
    </dependency>
    
    <!-- Mysql 驅動 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.47</version>
    </dependency>
    
    <!-- 連接池 -->
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>druid</artifactId>
        <version>1.1.9</version>
    </dependency>

    <!-- junit -->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
        <scope>test</scope>
    </dependency>
    
  </dependencies>
  
  <!-- 只要配置了build標簽里面的內容，配置后都需要強制更新項目 -->
  <build>
      <plugins>
          <plugin>
              <groupId>org.apache.maven.plugins</groupId>
              <artifactId>maven-compiler-plugin</artifactId>
              <version>3.8.1</version>
              <configuration>
                  <!-- 設置編碼 -->
                  <encoding>utf-8</encoding>
                  <!-- 設置JDK版本 -->
                  <source>1.8</source>
                  <target>1.8</target>
              </configuration>
          </plugin>
        <!-- 設置安裝install命令的時候跳過單元測試 -->
          <plugin>
              <groupId>org.apache.maven.plugins</groupId>
              <artifactId>maven-surefire-plugin</artifactId>
              <version>2.18.1</version>
              <configuration>
                  <skipTests>true</skipTests>
              </configuration>
          </plugin>
          
      </plugins>
  </build>
</project>

3.3.2 第二步：Mybatis-Plus整合Spring

Mybatis-Plus整合Spring和Mybatis整合Spring差不多，只是會話工廠從org.mybatis.spring.SqlSessionFactoryBean換成com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:tx="http://www.springframework.org/schema/tx"
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd
        http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.3.xsd">
    <!-- 1.配置數據源 -->
    <bean name="dataSource" class="com.alibaba.druid.pool.DruidDataSource">
        <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost:3306/mybatis-plus"></property>
          <property name="username" value="root"></property>
           <property name="password" value="1234"></property>
           <!-- 最大連接數 -->
          <property name="maxActive" value="10"></property>
         <!-- 超時毫秒數 -->
           <property name="maxWait" value="30000"></property>
    </bean>
    
    <!-- 2.配置會話工廠 -->
    <bean name="sqlSessionFactory" class="com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean">
        <!-- 指定數據源 -->
        <property name="dataSource" ref="dataSource"/>
    </bean>
    
    <!-- 3.配置映射動態代理對象到spring容器 -->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <!-- 指定會話工廠 -->
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
        <!-- 指定掃描的映射包 -->
        <property name="basePackage" value="com.gjs.mybatisplus.mapper"/>
    </bean>
    <!-- 4.配置事務管理器 -->
    <bean name="tx" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <property name="dataSource" ref="dataSource"></property>
    </bean>
    <tx:annotation-driven transaction-manager="tx"/>
</beans>

3.3.3 第三步：編寫POJO

　　使用Mybatis-Plus不使用xml文件，而是基於一組注解來解決實體類和數據庫表的映射問題。

注解	作用
@TableName(value="tb_user")	指定對應的表，表名和類名一致時，可以省略value屬性。
@TableId	指定表的主鍵。Value屬性指定表的主鍵字段，和屬性名一致時，可以省略。Type指定主鍵的增長策略。
@TableField	指定類的屬性映射的表字段，名稱一致時可以省略該注解。

package com.gjs.mybatisplus.pojo;

import com.baomidou.mybatisplus.annotations.TableField;
import com.baomidou.mybatisplus.annotations.TableId;
import com.baomidou.mybatisplus.annotations.TableName;
import com.baomidou.mybatisplus.enums.IdType;
@TableName(value="tb_user")
public class User {
    /*
    AUTO->`0`("數據庫ID自增")
    INPUT->`1`(用戶輸入ID")
    ID_WORKER->`2`("全局唯一ID")
    UUID->`3`("全局唯一ID")
    NONE-> 4 ("不需要ID")
    */
    @TableId(value="id",type=IdType.AUTO)
    private Long id;
    //如果屬性名與數據庫表的字段名相同可以不寫
    @TableField(value="name")
    private String name;
    @TableField(value="age")
    private Integer age;
    @TableField(value="email")
    private String email;
    public Long getId() {
        return id;
    }
    public void setId(Long id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
    public String getEmail() {
        return email;
    }
    public void setEmail(String email) {
        this.email = email;
    }
}

3.3.4 第四步：編寫Mapper接口

package com.gjs.mybatisplus.mapper;

import org.springframework.stereotype.Repository;

import com.baomidou.mybatisplus.mapper.BaseMapper;
import com.gjs.mybatisplus.pojo.User;

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

3.3.5 編寫測試類

package com.gjs.test;

import java.util.List;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

import com.baomidou.mybatisplus.mapper.EntityWrapper;
import com.gjs.mybatisplus.mapper.UserMapper;
import com.gjs.mybatisplus.pojo.User;

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations="classpath:spring-data.xml")
public class TestUserMapper {
    @Autowired
    private UserMapper userMapper;
    
    /**
     * 添加
     */
    @Test
    public void insert() {
        try {
            User user=new User();
            user.setName("zhangsan");
            user.setAge(20);
            user.setEmail("zhangsan@163.com");
            Integer insert = userMapper.insert(user);
            System.out.println(insert);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
    
    /**
     * 通過id刪除
     */
    @Test
    public void deleteById() {
        try {
            Integer count = userMapper.deleteById(1L);
            System.out.println(count);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
    /**
     * 通過條件刪除
     */
    @Test
    public void deleteByCondition() {
        try {
            //設置條件
            EntityWrapper<User> wrapper=new EntityWrapper<>();
            wrapper.like("name", "%wang%");
            Integer count = userMapper.delete(wrapper);
            System.out.println(count);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
    
    /**
     * 更新非空字段,通過id
     */
    @Test
    public void update() {
        User user=new  User();
        user.setName("lisi");
        user.setEmail("lisi@163.com");
        user.setId(2L);
        userMapper.updateById(user);
        
    }
    
    /**
     * 查詢所有
     */
    @Test
    public void findAll() {
        //查詢條件為空時，查詢所有
        List<User> users = userMapper.selectList(null);
        for (User user : users) {
            System.out.println(user.getName());
        }
    }
}

4.常用配置

4.1 實體類全局配置

　　如果在配置文件指定實體類的全局配置，那么可以不需要再配置實體類的關聯注解。

<!-- 2.配置會話工廠 -->
    <bean name="sqlSessionFactory" class="com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean">
        <!-- 指定數據源 -->
        <property name="dataSource" ref="dataSource"/>
        <property name="globalConfig">
            <bean class="com.baomidou.mybatisplus.entity.GlobalConfiguration">
                <!-- 
                    AUTO->`0`("數據庫ID自增")
                    INPUT->`1`(用戶輸入ID")
                    ID_WORKER->`2`("全局唯一ID")
                    UUID->`3`("全局唯一ID")
                    NONE-> 4 ("不需要ID")
                 -->
                <property name="idType" value="0"></property>
                <!-- 實體類名與數據庫表名的關聯規則是，忽略前綴 -->
                <property name="tablePrefix" value="tb_"></property>
            </bean>
        </property>
    </bean>

實體類就可以去掉關聯的注解了

package com.gjs.mybatisplus.pojo;

public class User {
    
    private Long id;
    private String name;
    private Integer age;
    private String email;
    public Long getId() {
        return id;
    }
    public void setId(Long id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
    public String getEmail() {
        return email;
    }
    public void setEmail(String email) {
        this.email = email;
    }
}

4.2.插件配置

　　Mybatis默認情況下，是不支持物理分頁的。默認提供的RowBounds這個分頁是邏輯分頁來的。

　　邏輯分頁：將數據庫里面的數據全部查詢出來后，在根據設置的參數返回對應的記錄。（分頁是在程序的內存中完成）。【表數據過多時，會溢出】

　　物理分頁：根據條件限制，返回指定的記錄。（分頁在數據庫里面已經完成）

　　MybatisPlus是默認使用RowBounds對象是支持物理分頁的。但是需要通過配置Mybatis插件來開啟。

　　配置：

<!-- 2.配置會話工廠 -->
    <bean name="sqlSessionFactory" class="com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean">
        <!-- 指定數據源 -->
        <property name="dataSource" ref="dataSource"/>
        <property name="globalConfig">
            <bean class="com.baomidou.mybatisplus.entity.GlobalConfiguration">
                <!-- 
                    AUTO->`0`("數據庫ID自增")
                    INPUT->`1`(用戶輸入ID")
                    ID_WORKER->`2`("全局唯一ID")
                    UUID->`3`("全局唯一ID")
                    NONE-> 4 ("不需要ID")
                 -->
                <property name="idType" value="0"></property>
                <!-- 實體類名與數據庫表名的關聯規則是，忽略前綴 -->
                <property name="tablePrefix" value="tb_"></property>
            </bean>
        </property>
        <property name="plugins">
            <list>
                <!-- 分頁的支持 -->
                <bean class="com.baomidou.mybatisplus.plugins.PaginationInterceptor">
                    <!-- 數據庫方言  -->
                    <!-- 不同的數據庫對sql標准未制定的功能不一樣，比如分頁，所以需要指定數據庫方言 -->
                    <property name="dialectClazz" value="com.baomidou.mybatisplus.plugins.pagination.dialects.MySqlDialect"></property>
                </bean>
                <!-- 配置日志輸出（SQL語句） -->
                <bean class="com.baomidou.mybatisplus.plugins.PerformanceInterceptor">
                    <!-- 配置sql語句輸出格式，true為折疊，false為平鋪，不配默認為false -->
                    <property name="format" value="true"></property>
                </bean>
            </list>
        </property>
    </bean>

　　測試方法：

/**
     * 分頁查詢
     */
    @Test
    public void findPage() {
        try {
            List<User> users = userMapper.selectPage(new RowBounds(0, 5), null);
            for (User user : users) {
                System.out.println(user.getName());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

5.自定義方法

　　MyBatis-Plus只是在MyBatis的基礎上做了增強，不做改變。所以MyBatis-Plus定義的基礎方法不能滿足需求時，可以通過MyBatis的語法定義方法，但最好不要用MyBatis-Plus以及定義的方法名。

6.Service 層

　　MyBatis-Plus 不僅提供了持久層的基礎通用方法，它還提供了一套業務層的通用方法。

　　想要使用這些方法，只需讓我們定義的service層的接口繼承MyBatis-Plus定義的IService接口，並讓實現類繼承MyBatis-Plus定義的ServiceImpl類。

public interface UserService extends IService<User>{
    
}

@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService{
    
}

原文鏈接：https://www.cnblogs.com/gaojinshun/p/14545345.html

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 Mybatis-plus的使用 MyBatis-Plus使用 MyBatis-Plus And和Or的使用 MyBatis-Plus 的使用 MyBatis-Plus的簡單使用 springboot使用mybatis-plus Springboot使用mybatis-plus Java MyBatis-Plus 基本使用 mybatis-plus的集成與使用 Mybatis-Plus: QueryWrapper的使用