zoukankan      html  css  js  c++  java
  • Mybatis-Plus

     什么是Mybatis-Plus

    MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变(所以原有的mybatis框架的功能一样不少),为简化开发、提高效率而生。

    为什么要学习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工具,我们只需要将我们定义的抽象接口,继承一个公用的BaseMapper<T>接口,就可以获得一组通用的crud方法,来操作数据库!!!

    使用Mybatis-plus时,甚至都不需要任何的xml映射文件或者接口方法注解,真正dao层零实现

    public interface OrderMapper extends BaseMapper<User> {

       //BaseMapper已经实现了通用的curd的方法了。如果有需要非通用的操作,才在这里自定义

    }

     Mybatis-Plus小结

    Mybatis-Plus只是在Mybatis的基础上,实现了功能增强,让开发更加简洁高效。

    Mybatis-Plus并没有修改Mybatis的任何特性!

     入门示例

    需求

    使用Mybatis-Plus实现对用户的crud操作。

     配置步骤说明

    1)搭建环境(创建项目、导入包)

    2)配置Mybaits-Plus(基于Spring实现)

    3)编写测试代码

     配置步骤

    第一部分:搭建环境

    前提

    已经创建好了数据库环境:

    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`)

    )

    说明

    1Mybatis-Plus并没有提供单独的jar包,而是通过Maven(或者gradle)来管理jar依赖。本教程需要使用Maven构建项目。

    2Mybatis-Plus基于Spring框架实现的,因此使用Mybatis-Plus,必须导入Spring相关依赖。

     第一步:创建一个Maven项目

    因为我们只是测试MybatisPlus框架,所以创建一个jar项目就可以了

     第二步:配置pom.xml构建文件

    --需要导入依赖,并且配置项目的编码,JDK版本等构建信息

    <?xml version="1.0" encoding="UTF-8"?>
    <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>cn.sxt.mybatisPlus</groupId>
        <artifactId>mybatisPlus</artifactId>
        <version>1.0-SNAPSHOT</version>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <version>3.8.1</version>
                    <configuration>
                        <!-- JDK版本 -->
                        <source>1.8</source>
                        <target>1.8</target>
                        <!-- 设置编码 -->
                        <encoding>UTF-8</encoding>
                    </configuration>
                </plugin>
            </plugins>
        </build>
        <dependencies>
            <!-- spring -->
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-context</artifactId>
                <version>4.3.2.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-jdbc</artifactId>
                <version>4.3.2.RELEASE</version>
            </dependency>
            <!-- mybatis plus -->
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus</artifactId>
                <version>2.3</version>
            </dependency>
            <!-- driver -->
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>8.0.11</version>
            </dependency>
            <!-- 连接池 -->
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.1.10</version>
            </dependency>
            <!-- junit -->
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.12</version>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-test</artifactId>
                <version>4.3.2.RELEASE</version>
                <scope>test</scope>
            </dependency>
    
        </dependencies>
    </project>

    第三部分:实现操作功能

    说明:完成实验MybatisPlus对数据库增删改查。

     第一步:编写POJO

    说明:使用Mybatis-Plus不使用xml文件,而是基于一组注解来解决实体类数据库表映射问题。

    @TableName(value="tb_user")

    指定对应的表,表名和类名一致时,可以省略value属性。

    @TableId

    指定表的主键。Value属性指定表的主键字段,和属性名一致时,可以省略。Type指定主键的增长策略。

    @TableField

    指定类的属性映射的表字段,名称一致时可以省略该注解。

    package cn.sxt.mp.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("tb_user")
    public class User {
         //指定ID生成策略
        /*--
           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;
    
    
        //当属性名和数据库的名称不对应 userName - user_name。需要我们手工指定对象关系。
        //@TableField 指定属性与数据库字段的对应关系
        @TableField("name")
        private String userName;
        private Integer age;
        private String email;
        //exist=false:标识数据库不存在该属性对应的字段。忽略
        @TableField(exist = false)
        private Integer typeId;
    
        public Long getId() {
            return id;
        }
    
        public void setId(Long id) {
            this.id = id;
        }
    
        public String getUserName() {
            return userName;
        }
    
        public void setUserName(String userName) {
            this.userName = userName;
        }
    
        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;
        }
    
        public Integer getTypeId() {
            return typeId;
        }
    
        public void setTypeId(Integer typeId) {
            this.typeId = typeId;
        }
    }

    第二步:编写Mapper接口

    package cn.sxt.mp.mapper;
    
    import cn.sxt.mp.pojo.User;
    import com.baomidou.mybatisplus.mapper.BaseMapper;
    import org.apache.ibatis.annotations.Mapper;
    /*@Repository需要在Spring中配置扫描地址,然后生成Dao层的Bean才能被注入到Service层中。
    @Mapper不需要配置扫描地址,通过xml里面的namespace里面的接口地址,生成了Bean后注入到Service层中。
    * */
    @Mapper
    public interface UserMapper extends BaseMapper<User> {
        //BaseMapper接口已经将单表操作的方法写好,所以现在直接继承这个接口就可以了



    //自定义方法
    @Select("select name as userName from tb_user")
    List<User> selectAll();

    }

     第三步:测试增删改查

    package cn.sxt.mp.test;
    
    import cn.sxt.mp.mapper.UserMapper;
    import cn.sxt.mp.pojo.User;
    import com.alibaba.druid.sql.dialect.postgresql.ast.stmt.PGSelectQueryBlock;
    import com.baomidou.mybatisplus.mapper.EntityWrapper;
    import com.baomidou.mybatisplus.mapper.Wrapper;
    import org.apache.ibatis.session.RowBounds;
    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 java.util.HashMap;
    import java.util.List;
    import java.util.Map;
    
    //@WebAppConfiguration //如果是web项目一定要加上
    @RunWith(SpringJUnit4ClassRunner.class)
    @ContextConfiguration(locations = "classpath:spring-data.xml")
    public class MpTest {
        @Autowired
        private UserMapper userMapper;
    
        //
        @Test
        public void insert(){
            User user =new User();
            user.setUserName("张三");
            user.setAge(20);
            user.setEmail("zhangsan@qq.com");
            user.setTypeId(20);
            Integer insert = userMapper.insert(user);
             System.out.println(insert);
    
        }
        //
        @Test
    public void deleteById(){
            Integer integer = userMapper.deleteById(1L);
            System.out.println(integer);
        }
        /**
         * 通过字段名删除,如:删除名字有李字的记录
         */
        @Test
        public void deleteByW(){
    
            Wrapper<User> wrapper=new EntityWrapper<>();
            wrapper.like("name","%三%");
            Integer integer = userMapper.delete(wrapper);
            System.out.println(integer);
        }
    
    /**
     * 通过字段名删除,如:删除名字有李字的记录
     */
    @Test
    public void  deleteByN(){
        Map<String, Object> map=new HashMap<>();
        map.put("name","张三");
        map.put("id",4);
    
        Integer integer = userMapper.deleteByMap(map);
        System.out.println(integer);
    }
    /**
     * 更新
     */
    @Test
    public void update(){
        User user = new User();
        user.setId(5L);
        user.setUserName("wangwg");
        Integer integer = userMapper.updateById(user);
        System.out.println(integer);
    
    }
    @Test// 通过ID查询指定的数据
    public void selectById(){
        User user = userMapper.selectById(5L);
        System.out.println(user.getUserName());
    }
    
    //所有
    @Test
    public void selectByAll(){
        List<User> users = userMapper.selectList(null);
        for (User user:users){
            System.out.println(user.getUserName());
        }
    }
    //条件查询
    @Test
    public void selectLi(){
        Wrapper<User> wrapper=new EntityWrapper<>();
        wrapper.like("name","%w%");
    
        List<User> users = userMapper.selectList(wrapper);
        for (User user:users){
            System.out.println(user.getUserName());
        }
    }
    /**
     * 注意事项:我们需要配置分页插件,否则该分页是逻辑分页,如果配置了分页插件就是物理分页。
     * 逻辑分页:所谓的逻辑分页,就是将数据库表的所有数据先查询到内存中,在通过逻辑代码取出需要的数据。(数据过多,内存溢出)
     * 物理分页:所谓的物理分页,就是在数据库已经分页,仅仅返回分页的数据。
     */
        //条件分页查询
    @Test
        public void selete(){
        //RowBounds:构建方法参数1,开始位置,参数2,是每页记录数
        List<User> users = userMapper.selectPage(new RowBounds(0, 3), null);
        for (User user:users){
            System.out.println(user.getUserName());
        }
    }
    
        //测试自定义操作
        @Test
        public void findAllUserName() {
            List<User> users = userMapper.selectAll();
            for (User user:users){
                System.out.println(user.getUserName());
            }
    
        }
    }

    spring-data.xml 配置文件

    <?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
           xmlns:context="http://www.springframework.org/schema/context"
           xmlns:tx="http://www.springframework.org/schema/tx"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    
           xsi:schemaLocation="http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
            http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
     http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd">
        <!-- 扫描组件 -->
        <context:component-scan base-package="cn.sxt.mp"/>
        <!-- 读取 db.properties数据库配置文件 -->
        <context:property-placeholder location="db.properties"/>
    
        <!-- 配置spring整合Mybatis
        问题:Mybatis整合Spring的含义是什么
        答:所谓的Mybatis整合Spring,就是让Mybatis框架使用Spring容器中的数据源。
        问题:为什么需要配置Mybatis整合Spring:
         答:因为我们希望Mybatis可以使用Spring提供的事务代理机制。
         问题:为什么需要需要一个Mybatis-spring的整合包?
          答:是因为Mybatis框架默认是不支持通过Spring容器获得数据源的,是通过Mybatis的配置文件获得数据源的。所以需要一个整合包提供对Spring容器支持
        问题:明明Spring有扫描组件将对象加入到容器里面,为什么我们还需要配置Mybatis对动态映射接口的扫描?
         答:因为Spring框架的扫描组件只能扫描实现类的对象,不能扫描接口创建对象放在容器里面。而Mybatis就是使用映射接口创建动态类对象的,所以Spring不支持该实现。 既然Spring不同默认支持,Mybatis自己实现将动态类对象加入到Spring容器里面 -->
        <!-- 第一步:配置数据源 --><!-- 配置 druid 连接池 -->
    <bean name="dataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">
        <property name="driverClassName"
                  value="${jdbc.driverClassName}" />
        <property name="url" value="${jdbc.url}" />
        <property name="username" value="${jdbc.username}" />
        <property name="password" value="${jdbc.password}" />
        <property name="maxActive" value="${jdbc.maxActive}" />
    </bean>
        <!-- 第二步:配置会话工厂 -->
        <bean class="com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean" name="sqlSessionFactory">
            <!-- 指定数据源 -->
            <property name="dataSource" ref="dataSource"/>
            <property name="plugins">
                <array>
                    <!-- 配置支持SQL输出 -->
                    <bean class="com.baomidou.mybatisplus.plugins.PerformanceInterceptor"></bean>
                    <!-- 物理分页支持插件 -->
                    <bean class="com.baomidou.mybatisplus.plugins.PaginationInterceptor"/>
                </array>
            </property>
        </bean>
        <!-- 第三步:配置动态映射接口对象扫描 -->
        <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
            <!-- 指定使用的会话工厂 -->
            <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"></property>
            <!-- 扫描的包名 -->
            <property name="basePackage" value="cn.sxt.mp.mapper"></property>
            <!-- 限制只扫描有Mapper注解的接口 -->
            <property name="annotationClass" value="org.apache.ibatis.annotations.Mapper"/>
        </bean>
        <!-- 第四步:配置事务代理 -->
       <bean name="tx" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
           <property name="dataSource" ref="dataSource"/>
       </bean>
    
        <tx:annotation-driven transaction-manager="tx" />
    
    </beans>

    常用配置

    实体类全局配置

    如果在配置文件指定实体类的全局配置,那么可以不需要再配置实体类的关联注解。

    --配置文件spring-data.xml的修改

       <!-- 第二步:获得会话工厂 -->

         <bean name="sqlSessionFactory" class="com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean">

           <!-- 指定数据源 -->

           <property name="dataSource" ref="dataSource"></property>

           <!-- 全局实体类配置 -->

           <property name="globalConfig" >

              <bean class="com.baomidou.mybatisplus.entity.GlobalConfiguration">

                <!--

                AUTO->`0`("数据库ID自增")

                 INPUT->`1`(用户输入ID")

                ID_WORKER->`2`("全局唯一ID")

                UUID->`3`("全局唯一ID")

             -->

                <property name="idType" value="0"></property>

                <!-- 实体类名与表名的关联规则是,忽略前缀 -->

                <property name="tablePrefix" value="tb_"></property>

              </bean>

           </property>

         </bean>

    --实体类就可以去掉关联的注解了

    package org.chu.mybatisplus.pojo;

    public class User {

    private Long id;

    private String name;

    private Integer age;

    private String email;

    //补全getset方法

    }

    插件配置

    Mybatis默认情况下,是不支持物理分页的。默认提供的RowBounds这个分页是逻辑分页来的。

    所谓的逻辑分页,就是将数据库里面的数据全部查询出来后,在根据设置的参数返回对应的记录。(分页是在程序的内存中完成)。【表数据过多时,会溢出】

    所谓的物理分页,就是根据条件限制,返回指定的记录。(分页在数据库里面已经完成)

    MybatisPlus是默认使用RowBounds对象是支持物理分页的。但是需要通过配置Mybatis插件来开启。

    配置代码

         <!-- 第二步:获得会话工厂 -->

         <bean name="sqlSessionFactory" class="com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean">

           <!-- 指定数据源 -->

           <property name="dataSource" ref="dataSource"></property>

           <!-- 全局实体类配置 -->

           <property name="globalConfig" >

              <bean class="com.baomidou.mybatisplus.entity.GlobalConfiguration">

                <!--

                AUTO->`0`("数据库ID自增")

                 INPUT->`1`(用户输入ID")

                ID_WORKER->`2`("全局唯一ID")

                UUID->`3`("全局唯一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">

                   <!-- 方言 -->

                   <!-- 我们使用的是MySQL数据库,所以需要配置MySQL的方言 -->

                   <property name="dialectClazz" value="com.baomidou.mybatisplus.plugins.pagination.dialects.MySqlDialect"></property>

                </bean>

                <!-- 配置支持SQL输出 -->

                <bean class="com.baomidou.mybatisplus.plugins.PerformanceInterceptor">

                   <property name="format" value="true"></property>

                </bean>

              </list>

           </property>

         </bean>

    .自定义SQL语句支持

    --实现代码

    package org.chu.mybatisplus.mapper;

    import java.util.List;

    import org.apache.ibatis.annotations.Select;

    import org.chu.mybatisplus.pojo.User;

    import com.baomidou.mybatisplus.mapper.BaseMapper;

    public interface UserMapper extends BaseMapper<User> {

    @Select(value="select * from tb_user")

    List<User> findAll();

    }

    --测试代码

    package org.chu.test.mapper;

    import java.util.List;

    import org.chu.mybatisplus.mapper.UserMapper;

    import org.chu.mybatisplus.pojo.User;

    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;

    //注意事项:Maven的单元测试包必须放置测试源码包里面

    @RunWith(SpringJUnit4ClassRunner.class)

    @ContextConfiguration(locations="classpath:spring-data.xml")

    public class UserMapperTest {

    @Autowired

    private UserMapper userMapper;

    @Test

    public void findAll() {

    try {

    List<User> users = userMapper.findAll();

    for (User user : users) {

    System.out.println(user.getName());

    }

    } catch (Exception e) {

    e.printStackTrace();

    }

    }

    }

  • 相关阅读:
    DQL-联合查询
    DQL-分页查询
    DQL-子查询
    DQL-分组查询
    DQL-常见的函数
    DQL-排序查询
    DQL-条件查询
    前端底层-js介绍
    HTML8
    HTML7
  • 原文地址:https://www.cnblogs.com/406070989senlin/p/11360109.html
Copyright © 2011-2022 走看看