• 首页 首页 icon
  • 工具库 工具库 icon
    • IP查询 IP查询 icon
  • 内容库 内容库 icon
    • 快讯库 快讯库 icon
    • 精品库 精品库 icon
    • 问答库 问答库 icon
  • 更多 更多 icon
    • 服务条款 服务条款 icon

黑马程序员笔记----Mybatis-Plus使用

武飞扬头像
JAVA成神
帮助1

一、纯Mybatis与Mybatis-Plus整合。

1.导入依赖

  1.  
    <?xml version="1.0" encoding="UTF-8"?>
  2.  
    <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.  
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.  
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.  
    <modelVersion>4.0.0</modelVersion>
  6.  
     
  7.  
    <groupId>org.example</groupId>
  8.  
    <artifactId>cn.itcast.mp</artifactId>
  9.  
    <packaging>pom</packaging>
  10.  
    <version>1.0-SNAPSHOT</version>
  11.  
    <modules>
  12.  
    <module>itcast-mybatis-plus-simple</module>
  13.  
    <module>itcast-mabatis-plus-spring</module>
  14.  
    </modules>
  15.  
     
  16.  
    <properties>
  17.  
    <maven.compiler.source>8</maven.compiler.source>
  18.  
    <maven.compiler.target>8</maven.compiler.target>
  19.  
    </properties>
  20.  
     
  21.  
    <dependencies>
  22.  
    <!-- mybatis-plus插件依赖 -->
  23.  
    <dependency>
  24.  
    <groupId>com.baomidou</groupId>
  25.  
    <artifactId>mybatis-plus</artifactId>
  26.  
    <version>3.1.1</version>
  27.  
    </dependency>
  28.  
     
  29.  
    <!-- MySql -->
  30.  
    <dependency>
  31.  
    <groupId>mysql</groupId>
  32.  
    <artifactId>mysql-connector-java</artifactId>
  33.  
    <version>8.0.25</version>
  34.  
    </dependency>
  35.  
    <!-- 连接池 -->
  36.  
    <dependency>
  37.  
    <groupId>com.alibaba</groupId>
  38.  
    <artifactId>druid</artifactId>
  39.  
    <version>1.1.24</version>
  40.  
    </dependency>
  41.  
     
  42.  
    <!--简化bean代码的工具包-->
  43.  
    <dependency>
  44.  
    <groupId>org.projectlombok</groupId>
  45.  
    <artifactId>lombok</artifactId>
  46.  
    <optional>true</optional>
  47.  
    <version>1.18.4</version>
  48.  
    </dependency>
  49.  
    <dependency>
  50.  
    <groupId>junit</groupId>
  51.  
    <artifactId>junit</artifactId>
  52.  
    <version>4.12</version>
  53.  
    </dependency>
  54.  
    <dependency>
  55.  
    <groupId>org.slf4j</groupId>
  56.  
    <artifactId>slf4j-log4j12</artifactId>
  57.  
    <version>1.6.4</version>
  58.  
    </dependency>
  59.  
    </dependencies>
  60.  
    <build>
  61.  
    <plugins>
  62.  
    <plugin>
  63.  
    <groupId>org.apache.maven.plugins</groupId>
  64.  
    <artifactId>maven-compiler-plugin</artifactId>
  65.  
    <configuration>
  66.  
    <source>1.8</source>
  67.  
    <target>1.8</target>
  68.  
    </configuration>
  69.  
    </plugin>
  70.  
    </plugins>
  71.  
    </build>
  72.  
    </project>
学新通

2.创建配置文件

log4j.properties:

  1.  
    log4j.rootLogger=DEBUG,A1
  2.  
     
  3.  
    log4j.appender.A1=org.apache.log4j.ConsoleAppender
  4.  
    log4j.appender.A1.layout=org.apache.log4j.PatternLayout
  5.  
    log4j.appender.A1.layout.ConversionPattern=[%t] [%c]-[%p] %m%n

jdbc.properties:

  1.  
    jdbc.username=
  2.  
    jdbc.password=
  3.  
    jdbc.url=jdbc:mysql://localhost:3306/mabatis-puls
  4.  
    jdbc.driverClassName=com.mysql.jdbc.Driver
  5.  
    jdbc.initialSize=5
  6.  
    jdbc.maxActive=10

3.编写mybatis-config.xml文件:

  1.  
    <?xml version="1.0" encoding="UTF-8" ?>
  2.  
    <!DOCTYPE configuration
  3.  
    PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  4.  
    "http://mybatis.org/dtd/mybatis-3-config.dtd">
  5.  
    <configuration>
  6.  
    <!-- 加载外部文件-->
  7.  
    <properties resource="jdbc.properties"></properties>
  8.  
    <!-- 数据源环境-->
  9.  
    <environments default="development">
  10.  
    <environment id="development">
  11.  
    <transactionManager type="JDBC"></transactionManager>
  12.  
    <dataSource type="POOLED">
  13.  
    <property name="driver" value="${jdbc.driverClassName}"></property>
  14.  
    <property name="url" value="${jdbc.url}"></property>
  15.  
    <property name="username" value="${jdbc.username}"></property>
  16.  
    <property name="password" value="${jdbc.password}"></property>
  17.  
    </dataSource>
  18.  
    </environment>
  19.  
    </environments>
  20.  
    <mappers>
  21.  
    <mapper resource="UserMapper.xml"></mapper>
  22.  
    </mappers>
  23.  
    </configuration>
学新通

4.编写User实体对象:(这里使用lombok进行了进化bean操作)

  1.  
    import com.baomidou.mybatisplus.annotation.TableName;
  2.  
    import lombok.AllArgsConstructor;
  3.  
    import lombok.Data;
  4.  
    import lombok.NoArgsConstructor;
  5.  
     
  6.  
    /* 用lombok
  7.  
    * @Data :注解在类上;提供类所有属性的 getting 和 setting 方法,此外还提供了equals、canEqual、hashCode、toString 方法
  8.  
    @Setter:注解在属性上;为属性提供 setting 方法
  9.  
    @Getter:注解在属性上;为属性提供 getting 方法
  10.  
    @Log4j :注解在类上;为类提供一个 属性名为log 的 log4j 日志对象
  11.  
    @NoArgsConstructor:注解在类上;为类提供一个无参的构造方法
  12.  
    @AllArgsConstructor:注解在类上;为类提供一个全参的构造方法
  13.  
    * 在User对象中添加@TableName,指定数据库表名
  14.  
    */
  15.  
    @Data
  16.  
    @NoArgsConstructor
  17.  
    @AllArgsConstructor
  18.  
    @TableName("tb_user")
  19.  
    public class User {
  20.  
    private Long id;
  21.  
    private String user_name;
  22.  
    private String password;
  23.  
    private String name;
  24.  
    private Integer age;
  25.  
    private String email;
  26.  
     
  27.  
    @Override
  28.  
    public String toString() {
  29.  
    return "User{"
  30.  
    "id=" id
  31.  
    ", userName='" user_name '\''
  32.  
    ", password='" password '\''
  33.  
    ", name='" name '\''
  34.  
    ", age=" age
  35.  
    ", email='" email '\''
  36.  
    '}';
  37.  
    }
  38.  
    }
学新通

5.将UserMapper继承BaseMapper,将拥有了BaseMapper中的所有方法:

  1.  
    import cn.itcast.mp.pojo.User;
  2.  
    import com.baomidou.mybatisplus.core.mapper.BaseMapper;
  3.  
     
  4.  
     
  5.  
    import java.util.List;
  6.  
     
  7.  
    public interface UserMapper extends BaseMapper<User> {
  8.  
    public List<User> findAll();
  9.  
     
  10.  
    }

6.使用MP中的MybatisSqlSessionFactoryBuilder进程构建

  1.  
     
  2.  
     
  3.  
    import cn.itcast.mp.mapper.UserMapper;
  4.  
    import cn.itcast.mp.pojo.User;
  5.  
    import com.baomidou.mybatisplus.core.MybatisSqlSessionFactoryBuilder;
  6.  
    import org.apache.ibatis.io.Resources;
  7.  
    import org.apache.ibatis.session.SqlSession;
  8.  
    import org.apache.ibatis.session.SqlSessionFactory;
  9.  
     
  10.  
    import org.junit.Test;
  11.  
     
  12.  
    import java.io.IOException;
  13.  
    import java.io.InputStream;
  14.  
    import java.util.List;
  15.  
     
  16.  
    public class MybatistTest {
  17.  
    @Test
  18.  
    public void testFindAll() throws IOException {
  19.  
    InputStream resourceAsFile = Resources.getResourceAsStream("mybatis-config.xml");
  20.  
    //这里使用的是MP中的MybatisSqlSessionFactoryBuilder
  21.  
    SqlSessionFactory sqlSessionFactory = new MybatisSqlSessionFactoryBuilder().build(resourceAsFile);
  22.  
    SqlSession sqlSession = sqlSessionFactory.openSession();
  23.  
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
  24.  
     
  25.  
    // 可以调用BaseMapper中定义的方法
  26.  
    List<User> users = mapper.selectList(null);
  27.  
    System.out.println(users);
  28.  
    sqlSession.close();
  29.  
     
  30.  
    }
  31.  
    }
学新通

注:

如运行报错:学新通

解决:在User对象中添加@TableName,指定数据库表名

学新通

二、Spring Mybatis MP

引入了Spring框架,数据源、构建等工作就交给了Spring管理。

 1.导入依赖

  1.  
    <?xml version="1.0" encoding="UTF-8"?>
  2.  
    <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.  
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.  
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.  
    <modelVersion>4.0.0</modelVersion>
  6.  
     
  7.  
    <groupId>org.example</groupId>
  8.  
    <artifactId>cn.itcast.mp</artifactId>
  9.  
    <packaging>pom</packaging>
  10.  
    <version>1.0-SNAPSHOT</version>
  11.  
    <modules>
  12.  
    <module>itcast-mybatis-plus-simple</module>
  13.  
    <module>itcast-mabatis-plus-spring</module>
  14.  
    </modules>
  15.  
     
  16.  
    <properties>
  17.  
    <maven.compiler.source>8</maven.compiler.source>
  18.  
    <maven.compiler.target>8</maven.compiler.target>
  19.  
    </properties>
  20.  
     
  21.  
    <dependencies>
  22.  
    <!-- mybatis-plus插件依赖 -->
  23.  
    <dependency>
  24.  
    <groupId>com.baomidou</groupId>
  25.  
    <artifactId>mybatis-plus</artifactId>
  26.  
    <version>3.1.1</version>
  27.  
    </dependency>
  28.  
     
  29.  
    <!-- MySql -->
  30.  
    <dependency>
  31.  
    <groupId>mysql</groupId>
  32.  
    <artifactId>mysql-connector-java</artifactId>
  33.  
    <version>8.0.25</version>
  34.  
    </dependency>
  35.  
    <!-- 连接池 -->
  36.  
    <dependency>
  37.  
    <groupId>com.alibaba</groupId>
  38.  
    <artifactId>druid</artifactId>
  39.  
    <version>1.1.24</version>
  40.  
    </dependency>
  41.  
     
  42.  
    <!--简化bean代码的工具包-->
  43.  
    <dependency>
  44.  
    <groupId>org.projectlombok</groupId>
  45.  
    <artifactId>lombok</artifactId>
  46.  
    <optional>true</optional>
  47.  
    <version>1.18.4</version>
  48.  
    </dependency>
  49.  
    <dependency>
  50.  
    <groupId>junit</groupId>
  51.  
    <artifactId>junit</artifactId>
  52.  
    <version>4.12</version>
  53.  
    </dependency>
  54.  
    <dependency>
  55.  
    <groupId>org.slf4j</groupId>
  56.  
    <artifactId>slf4j-log4j12</artifactId>
  57.  
    <version>1.6.4</version>
  58.  
    </dependency>
  59.  
    <!--Spring相关坐标-->
  60.  
    <dependency>
  61.  
    <groupId>org.springframework</groupId>
  62.  
    <artifactId>spring-webmvc</artifactId>
  63.  
    <version>5.0.5.RELEASE</version>
  64.  
    </dependency>
  65.  
    <dependency>
  66.  
    <groupId>org.springframework</groupId>
  67.  
    <artifactId>spring-jdbc</artifactId>
  68.  
    <version>5.0.5.RELEASE</version>
  69.  
    </dependency>
  70.  
    <dependency>
  71.  
    <groupId>org.springframework</groupId>
  72.  
    <artifactId>spring-test</artifactId>
  73.  
    <version>5.0.5.RELEASE</version>
  74.  
    </dependency>
  75.  
    </dependencies>
  76.  
    <build>
  77.  
    <plugins>
  78.  
    <plugin>
  79.  
    <groupId>org.apache.maven.plugins</groupId>
  80.  
    <artifactId>maven-compiler-plugin</artifactId>
  81.  
    <configuration>
  82.  
    <source>1.8</source>
  83.  
    <target>1.8</target>
  84.  
    </configuration>
  85.  
    </plugin>
  86.  
    </plugins>
  87.  
    </build>
  88.  
    </project>
学新通

2.编写jdbc.properties

  1.  
    log4j.rootLogger=DEBUG,A1
  2.  
     
  3.  
    log4j.appender.A1=org.apache.log4j.ConsoleAppender
  4.  
    log4j.appender.A1.layout=org.apache.log4j.PatternLayout
  5.  
    log4j.appender.A1.layout.ConversionPattern=[%t] [%c]-[%p] %m%n

3. 编写applicationContext.xml

  1.  
    <?xml version="1.0" encoding="UTF-8"?>
  2.  
    <beans xmlns="http://www.springframework.org/schema/beans"
  3.  
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.  
    xmlns:context="http://www.springframework.org/schema/context"
  5.  
    xsi:schemaLocation="http://www.springframework.org/schema/beans
  6.  
    http://www.springframework.org/schema/beans/spring-beans.xsd
  7.  
    http://www.springframework.org/schema/context
  8.  
    http://www.springframework.org/schema/context/spring-context.xsd">
  9.  
     
  10.  
    <!-- 扫包-->
  11.  
    <context:property-placeholder location="classpath:jdbc.properties"/>
  12.  
     
  13.  
    <!-- 定义数据源 -->
  14.  
    <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource"
  15.  
    destroy-method="close">
  16.  
    <property name="url" value="${jdbc.url}"/>
  17.  
    <property name="username" value="${jdbc.username}"/>
  18.  
    <property name="password" value="${jdbc.password}"/>
  19.  
    <property name="driverClassName" value="${jdbc.driverClassName}"/>
  20.  
    <property name="maxActive" value="10"/>
  21.  
    <property name="minIdle" value="5"/>
  22.  
    </bean>
  23.  
    <!--这里使用MP提供的sessionFactory 完成MP和Spring的整合-->
  24.  
    <bean id="sessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
  25.  
    <property name="dataSource" ref="dataSource"/>
  26.  
    </bean>
  27.  
     
  28.  
    <!--扫描mapper接口,使用的依然是Mybatis原生的扫描器-->
  29.  
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
  30.  
    <property name="basePackage" value="mapper"/>
  31.  
    </bean>
  32.  
     
  33.  
    </beans>
学新通

4.编写User对象以及UserMapper接口:

  1.  
    package pojo;
  2.  
     
  3.  
    import com.baomidou.mybatisplus.annotation.TableName;
  4.  
    import lombok.AllArgsConstructor;
  5.  
    import lombok.Data;
  6.  
    import lombok.NoArgsConstructor;
  7.  
     
  8.  
    @Data
  9.  
    @NoArgsConstructor
  10.  
    @AllArgsConstructor
  11.  
    @TableName("tb_user")
  12.  
    public class User {
  13.  
    private Long id;
  14.  
    private String user_name;
  15.  
    private String password;
  16.  
    private String name;
  17.  
    private Integer age;
  18.  
    private String email;
  19.  
     
  20.  
     
  21.  
    }
学新通
  1.  
    package mapper;
  2.  
     
  3.  
    import com.baomidou.mybatisplus.core.mapper.BaseMapper;
  4.  
    import pojo.User;
  5.  
     
  6.  
    /**
  7.  
    * @Description: // 类说明
  8.  
    * @ClassName: UserMapper // 类名
  9.  
    * @Author: 曾伟鸿 // 创建者
  10.  
    * @Date: 2022/1/30 11:59 // 时间
  11.  
    * @Version: 1.0 // 版本
  12.  
    */
  13.  
    public interface UserMapper extends BaseMapper<User> {
  14.  
     
  15.  
    }
学新通

5.测试

  1.  
    @RunWith(SpringJUnit4ClassRunner.class)
  2.  
    @ContextConfiguration(locations = "classpath:applicationContext.xml")
  3.  
    public class TestSpringMP {
  4.  
     
  5.  
    @Autowired
  6.  
    private UserMapper userMapper;
  7.  
     
  8.  
    @Test
  9.  
    public void testSelectList(){
  10.  
    List<User> users = this.userMapper.selectList(null);
  11.  
    for (User user : users) {
  12.  
    System.out.println(user);
  13.  
    }
  14.  
    }
  15.  
    }
学新通

三、SpringBoot Mybatis MP

        使用SpringBoot将进一步的简化MP的整合,需要注意的是,使用SpringBoot需要继承parent。

 1.导入依赖

  1.  
    <?xml version="1.0" encoding="UTF-8"?>
  2.  
    <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.  
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.  
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.  
    <modelVersion>4.0.0</modelVersion>
  6.  
     
  7.  
    <parent>
  8.  
    <groupId>org.springframework.boot</groupId>
  9.  
    <artifactId>spring-boot-starter-parent</artifactId>
  10.  
    <version>2.1.4.RELEASE</version>
  11.  
    </parent>
  12.  
     
  13.  
    <groupId>cn.itcast.mp</groupId>
  14.  
    <artifactId>itcast-mp-springboot</artifactId>
  15.  
    <version>1.0-SNAPSHOT</version>
  16.  
     
  17.  
    <dependencies>
  18.  
    <dependency>
  19.  
    <groupId>org.springframework.boot</groupId>
  20.  
    <artifactId>spring-boot-starter</artifactId>
  21.  
    <exclusions>
  22.  
    <exclusion>
  23.  
    <groupId>org.springframework.boot</groupId>
  24.  
    <artifactId>spring-boot-starter-logging</artifactId>
  25.  
    </exclusion>
  26.  
    </exclusions>
  27.  
    </dependency>
  28.  
    <dependency>
  29.  
    <groupId>org.springframework.boot</groupId>
  30.  
    <artifactId>spring-boot-starter-test</artifactId>
  31.  
    <scope>test</scope>
  32.  
    </dependency>
  33.  
     
  34.  
    <!--简化代码的工具包-->
  35.  
    <dependency>
  36.  
    <groupId>org.projectlombok</groupId>
  37.  
    <artifactId>lombok</artifactId>
  38.  
    <optional>true</optional>
  39.  
    </dependency>
  40.  
    <!--mybatis-plus的springboot支持-->
  41.  
    <dependency>
  42.  
    <groupId>com.baomidou</groupId>
  43.  
    <artifactId>mybatis-plus-boot-starter</artifactId>
  44.  
    <version>3.1.1</version>
  45.  
    </dependency>
  46.  
    <!--mysql驱动-->
  47.  
    <dependency>
  48.  
    <groupId>mysql</groupId>
  49.  
    <artifactId>mysql-connector-java</artifactId>
  50.  
    <version>8.0.25</version>
  51.  
    </dependency>
  52.  
    <dependency>
  53.  
    <groupId>org.slf4j</groupId>
  54.  
    <artifactId>slf4j-log4j12</artifactId>
  55.  
    </dependency>
  56.  
     
  57.  
    </dependencies>
  58.  
     
  59.  
    <build>
  60.  
    <plugins>
  61.  
    <plugin>
  62.  
    <groupId>org.springframework.boot</groupId>
  63.  
    <artifactId>spring-boot-maven-plugin</artifactId>
  64.  
    </plugin>
  65.  
    </plugins>
  66.  
    </build>
  67.  
     
  68.  
     
  69.  
    </project>
学新通

2.编写配置文件

log4j.properties:

  1.  
    log4j.rootLogger=DEBUG,A1
  2.  
     
  3.  
    log4j.appender.A1=org.apache.log4j.ConsoleAppender
  4.  
    log4j.appender.A1.layout=org.apache.log4j.PatternLayout
  5.  
    log4j.appender.A1.layout.ConversionPattern=[%t] [%c]-[%p] %m%n

3.编写application.properties

  1.  
    spring.application.name = itcast-mp-springboot
  2.  
    spring.datasource.driver-class-name=com.mysql.jdbc.Driver
  3.  
    spring.datasource.url=jdbc:mysql://127.0.0.1:3306/mp?
  4.  
    useUnicode=true&characterEncoding=utf8&autoReconnect=true&allowMultiQueries=true&useSSL=false
  5.  
    spring.datasource.username=root
  6.  
    spring.datasource.password=Zwh1174946082!

4.编写pojo

  1.  
     
  2.  
    import com.baomidou.mybatisplus.annotation.TableName;
  3.  
    import lombok.AllArgsConstructor;
  4.  
    import lombok.Data;
  5.  
    import lombok.NoArgsConstructor;
  6.  
     
  7.  
     
  8.  
    @Data
  9.  
    @NoArgsConstructor
  10.  
    @AllArgsConstructor
  11.  
    @TableName("tb_user")
  12.  
    public class User {
  13.  
    private Long id;
  14.  
    private String userName;
  15.  
    private String password;
  16.  
    private String name;
  17.  
    private Integer age;
  18.  
    private String email;
  19.  
    }
学新通

5.编写mapper

  1.  
    import cn.itcast.mp.pojo.User;
  2.  
    import com.baomidou.mybatisplus.core.mapper.BaseMapper;
  3.  
     
  4.  
    public interface UserMapper extends BaseMapper<User> {
  5.  
    }

6.编写启动类

  1.  
    package cn.itcast.mp;
  2.  
    import org.mybatis.spring.annotation.MapperScan;
  3.  
    import org.springframework.boot.SpringApplication;
  4.  
    import org.springframework.boot.WebApplicationType;
  5.  
    import org.springframework.boot.autoconfigure.SpringBootApplication;
  6.  
    import org.springframework.boot.builder.SpringApplicationBuilder;
  7.  
     
  8.  
    @MapperScan("cn.itcast.mp.mapper") //设置mapper接口的扫描包
  9.  
    @SpringBootApplication
  10.  
    public class MyApplication {
  11.  
     
  12.  
    public static void main(String[] args) {
  13.  
    SpringApplication.run(MyApplication.class, args);
  14.  
    }
  15.  
    }
学新通

7.编写测试

  1.  
    import cn.itcast.mp.mapper.UserMapper;
  2.  
    import cn.itcast.mp.pojo.User;
  3.  
    import org.junit.Test;
  4.  
    import org.junit.runner.RunWith;
  5.  
    import org.springframework.beans.factory.annotation.Autowired;
  6.  
    import org.springframework.boot.test.context.SpringBootTest;
  7.  
    import org.springframework.test.context.junit4.SpringRunner;
  8.  
    import java.util.List;
  9.  
     
  10.  
    @RunWith(SpringRunner.class)
  11.  
    @SpringBootTest
  12.  
    public class UserMapperTest {
  13.  
     
  14.  
    @Autowired
  15.  
    private UserMapper userMapper;
  16.  
     
  17.  
    @Test
  18.  
    public void testSelect() {
  19.  
     
  20.  
    List<User> userList = userMapper.selectList(null);
  21.  
    for (User user : userList) {
  22.  
    System.out.println(user);
  23.  
    }
  24.  
    }
  25.  
    }
学新通

四、通用CRUD详解

1)注解详解

1.设置id的生成策略——@TableId详解

@TableId 是设置id的生成策略

        ①AUTO---数据库ID自增

        ②NONE---该类型为未设置主键类型

        ③INPUT---用户输入ID ****该类型可以通过自己注册自动填充插件进行填充*****

        

        以下3种类型、只有当插入对象ID 为空,才自动填充。

        ①ID_WORKER---全局唯一ID (idWorker)

        ②UUID---全局唯一ID (UUID)

        ③ID_WORKER_STR---字符串全局唯一ID (idWorker 的字符串表示)

        例如:

        学新通 

2.@TableField

在MP中通过@TableField注解可以指定字段的一些属性,常常解决的问题有3个:

        1、对象中的属性名和字段名不一致的问题(非驼峰)

        学新通

        2、对象中的属性字段在表中不存在的问题

        学新通

        3、不希望某个属性值出现在查询结果中

        学新通

2) 增删改查操作

1.插入操作

测试用例:

  1.  
    import cn.itcast.mp.mapper.UserMapper;
  2.  
    import cn.itcast.mp.pojo.User;
  3.  
    import org.junit.Test;
  4.  
    import org.junit.runner.RunWith;
  5.  
    import org.springframework.beans.factory.annotation.Autowired;
  6.  
    import org.springframework.boot.test.context.SpringBootTest;
  7.  
    import org.springframework.test.context.junit4.SpringRunner;
  8.  
     
  9.  
    import java.util.List;
  10.  
     
  11.  
    @RunWith(SpringRunner.class)
  12.  
    @SpringBootTest
  13.  
    public class TestUserMapper {
  14.  
     
  15.  
    @Autowired
  16.  
    private UserMapper userMapper;
  17.  
     
  18.  
    @Test
  19.  
    public void testInsert() {
  20.  
    User user = new User();
  21.  
    user.setMail("2@itcast.cn");
  22.  
    user.setAge(301);
  23.  
    user.setUserName("caocao1");
  24.  
    user.setName("曹操1");
  25.  
    user.setPassword("123456");
  26.  
    user.setAddress("北京");
  27.  
     
  28.  
    int result = this.userMapper.insert(user); //result数据库受影响的行数
  29.  
    System.out.println("result => " result);
  30.  
     
  31.  
    //获取自增长后的id值, 自增长后的id值会回填到user对象中
  32.  
    System.out.println("id => " user.getId());
  33.  
    }
学新通

2.更新操作

①根据id更新

方法定义:

  1.  
    /**
  2.  
    * 根据 ID 修改
  3.  
    *
  4.  
    * @param entity 实体对象
  5.  
    */
  6.  
    int updateById(@Param(Constants.ENTITY) T entity);

         映射出来的SQL语句:UPDATE tb_user SET age=? WHERE id=? 

  1.  
     
  2.  
    @RunWith(SpringRunner.class)
  3.  
    @SpringBootTest
  4.  
    public class TestUserMapper {
  5.  
     
  6.  
    @Autowired
  7.  
    private UserMapper userMapper;
  8.  
     
  9.  
    @Test
  10.  
    public void testUpdateById() {
  11.  
    User user = new User();
  12.  
    user.setId(1L); //条件,根据id更新
  13.  
    user.setAge(19); //更新的字段
  14.  
    user.setPassword("666666");
  15.  
     
  16.  
    int result = this.userMapper.updateById(user);
  17.  
    System.out.println("result => " result);
  18.  
    }
  19.  
    }
学新通

②根据条件更新

方法定义:

  1.  
    /**
  2.  
    * 根据 whereEntity 条件,更新记录
  3.  
    *
  4.  
    * @param entity 实体对象 (set 条件值,可以为 null)
  5.  
    * @param updateWrapper 实体对象封装操作类(可以为 null,里面的 entity 用于生成 where 语句)
  6.  
    */
  7.  
    int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T>
  8.  
    updateWrapper);

       映射出来的SQL语句:  UPDATE tb_user SET age=? WHERE id = ?

  1.  
    import cn.itcast.mp.mapper.UserMapper;
  2.  
    import cn.itcast.mp.pojo.User;
  3.  
    import com.baomidou.mybatisplus.core.conditions.Wrapper;
  4.  
    import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  5.  
    import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;
  6.  
    import net.minidev.json.writer.UpdaterMapper;
  7.  
    import org.junit.Test;
  8.  
    import org.junit.runner.RunWith;
  9.  
    import org.springframework.beans.factory.annotation.Autowired;
  10.  
    import org.springframework.boot.test.context.SpringBootTest;
  11.  
    import org.springframework.test.context.junit4.SpringRunner;
  12.  
     
  13.  
    import java.util.List;
  14.  
     
  15.  
    @RunWith(SpringRunner.class)
  16.  
    @SpringBootTest
  17.  
    public class UserMapperTest {
  18.  
     
  19.  
    @Autowired
  20.  
    private UserMapper userMapper;
  21.  
     
  22.  
     
  23.  
    //通过 QueryWrapper进行更新
  24.  
    @Test
  25.  
    public void testUpdate() {
  26.  
    User user = new User();
  27.  
    user.setAge(20); //更新的字段
  28.  
    user.setPassword("8888888");
  29.  
     
  30.  
    //更新条件
  31.  
    QueryWrapper<User> wrapper = new QueryWrapper<>();
  32.  
    wrapper.eq("user_name", "zhangsan"); //匹配user_name = zhangsan 的用户数据
  33.  
     
  34.  
    //根据条件做更新
  35.  
    int result = this.userMapper.update(user, wrapper);
  36.  
    System.out.println("result => " result);
  37.  
    }
  38.  
     
  39.  
     
  40.  
    //或者,通过UpdateWrapper进行更新
  41.  
    @Test
  42.  
    public void testUpdate2() {
  43.  
     
  44.  
    UpdateWrapper<User> wrapper = new UpdateWrapper<>();
  45.  
    wrapper.set("age", 21).set("password", "999999") //更新的字段,设置的是字段的名字,而不是实体的属性
  46.  
    .eq("user_name", "zhangsan"); //更新的条件
  47.  
     
  48.  
    //根据条件做更新
  49.  
    int result = this.userMapper.update(null, wrapper);
  50.  
    System.out.println("result => " result);
  51.  
    }
  52.  
     
  53.  
    }
  54.  
     
学新通

3.删除操作

①通过id删除---deleteById

方法定义:

  1.  
    /**
  2.  
    * 根据 ID 删除
  3.  
    *
  4.  
    * @param id 主键ID
  5.  
    */
  6.  
    int deleteById(Serializable id);

        映射出来的SQL语句:DELETE FROM tb_user WHERE id=?

  1.  
    import cn.itcast.mp.mapper.UserMapper;
  2.  
    import org.junit.Test;
  3.  
    import org.junit.runner.RunWith;
  4.  
    import org.springframework.beans.factory.annotation.Autowired;
  5.  
    import org.springframework.boot.test.context.SpringBootTest;
  6.  
    import org.springframework.test.context.junit4.SpringRunner;
  7.  
     
  8.  
    @RunWith(SpringRunner.class)
  9.  
    @SpringBootTest
  10.  
    public class UserMapperTest {
  11.  
     
  12.  
    @Autowired
  13.  
    private UserMapper userMapper;
  14.  
     
  15.  
    @Test
  16.  
    public void testDeleteById(){
  17.  
    // 根据id删除数据
  18.  
    int result = this.userMapper.deleteById(9L);
  19.  
    System.out.println("result => " result);
  20.  
    }
  21.  
    }
学新通

②根据id批量删除数据---deleteBatchIds

方法定义:

  1.  
    /**
  2.  
    * 删除(根据ID 批量删除)
  3.  
    *
  4.  
    * @param idList 主键ID列表(不能为 null 以及 empty)
  5.  
    */
  6.  
    int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable>
  7.  
    idList);

        映射出来的SQL语句:DELETE FROM tb_user WHERE id IN ( ? , ? , ? )

  1.  
    import cn.itcast.mp.mapper.UserMapper;
  2.  
    import org.junit.Test;
  3.  
    import org.junit.runner.RunWith;
  4.  
    import org.springframework.beans.factory.annotation.Autowired;
  5.  
    import org.springframework.boot.test.context.SpringBootTest;
  6.  
    import org.springframework.test.context.junit4.SpringRunner;
  7.  
    import java.util.Arrays;
  8.  
     
  9.  
    @RunWith(SpringRunner.class)
  10.  
    @SpringBootTest
  11.  
    public class UserMapperTest {
  12.  
     
  13.  
    @Autowired
  14.  
    private UserMapper userMapper;
  15.  
     
  16.  
     
  17.  
    @Test
  18.  
    public void testDeleteBatchIds(){
  19.  
    // 根据id批量删除数据
  20.  
    int result = this.userMapper.deleteBatchIds(Arrays.asList(10L, 11L));
  21.  
    System.out.println("result => " result);
  22.  
    }
学新通

③通过map封装条件删除---deleteByMap

方法定义: 

  1.  
    /**
  2.  
    * 根据 columnMap 条件,删除记录
  3.  
    *
  4.  
    * @param columnMap 表字段 map 对象
  5.  
    */
  6.  
    int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

      映射出来的SQL语句:  DELETE FROM tb_user WHERE name = ? AND age = ?

  1.  
    import cn.itcast.mp.mapper.UserMapper;
  2.  
    import org.junit.Test;
  3.  
    import org.junit.runner.RunWith;
  4.  
    import org.springframework.beans.factory.annotation.Autowired;
  5.  
    import org.springframework.boot.test.context.SpringBootTest;
  6.  
    import org.springframework.test.context.junit4.SpringRunner;
  7.  
    import java.util.HashMap;
  8.  
    import java.util.Map;
  9.  
     
  10.  
    @RunWith(SpringRunner.class)
  11.  
    @SpringBootTest
  12.  
    public class UserMapperTest {
  13.  
     
  14.  
    @Autowired
  15.  
    private UserMapper userMapper;
  16.  
     
  17.  
    @Test
  18.  
    public void testDeleteByMap(){
  19.  
     
  20.  
    Map<String,Object> map = new HashMap<>();
  21.  
    map.put("user_name", "zhangsan");
  22.  
    map.put("password", "999999");
  23.  
     
  24.  
    // 根据map删除数据,多条件之间是and关系
  25.  
    int result = this.userMapper.deleteByMap(map);
  26.  
    System.out.println("result => " result);
  27.  
    }
学新通

④通过实体对象封装条件删除---delete

方法定义: 

  1.  
    /**
  2.  
    * 根据 entity 条件,删除记录
  3.  
    *
  4.  
    * @param wrapper 实体对象封装操作类(可以为 null)
  5.  
    */
  6.  
    int delete(@Param(Constants.WRAPPER) Wrapper<T> wrapper);

         映射出来的SQL语句: DELETE FROM tb_user WHERE name=? AND age=?

  1.  
    import cn.itcast.mp.mapper.UserMapper;
  2.  
    import cn.itcast.mp.pojo.User;
  3.  
    import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  4.  
    import org.junit.Test;
  5.  
    import org.junit.runner.RunWith;
  6.  
    import org.springframework.beans.factory.annotation.Autowired;
  7.  
    import org.springframework.boot.test.context.SpringBootTest;
  8.  
    import org.springframework.test.context.junit4.SpringRunner;
  9.  
    import java.util.HashMap;
  10.  
    import java.util.Map;
  11.  
     
  12.  
    @RunWith(SpringRunner.class)
  13.  
    @SpringBootTest
  14.  
    public class UserMapperTest {
  15.  
     
  16.  
    @Autowired
  17.  
    private UserMapper userMapper;
  18.  
     
  19.  
    @Test
  20.  
    public void testDelete(){
  21.  
     
  22.  
    //用法一:
  23.  
    // QueryWrapper<User> wrapper = new QueryWrapper<>();
  24.  
    // wrapper.eq("user_name", "caocao1")
  25.  
    // .eq("password", "123456");
  26.  
     
  27.  
    //用法二(推荐使用):
  28.  
    User user = new User();
  29.  
    user.setPassword("123456");
  30.  
    user.setUserName("caocao");
  31.  
     
  32.  
    QueryWrapper<User> wrapper = new QueryWrapper<>(user);
  33.  
     
  34.  
    // 根据包装条件做删除
  35.  
    int result = this.userMapper.delete(wrapper);
  36.  
    System.out.println("result => " result);
  37.  
    }
学新通

4.查询操作

        MP提供了多种查询操作,包括根据id查询、批量查询、查询单条数据、查询列表、分页查询等操作。

①通过id查询---selectById

方法定义:

  1.  
    /**
  2.  
    * 根据 ID 查询
  3.  
    *
  4.  
    * @param id 主键ID
  5.  
    */
  6.  
    T selectById(Serializable id);

        映射出来的SQL语句:

        SELECT id,user_name,password,name,age,email FROM tb_user WHERE id=?

  1.  
    import cn.itcast.mp.mapper.UserMapper;
  2.  
    import cn.itcast.mp.pojo.User;
  3.  
    import org.junit.Test;
  4.  
    import org.junit.runner.RunWith;
  5.  
    import org.springframework.beans.factory.annotation.Autowired;
  6.  
    import org.springframework.boot.test.context.SpringBootTest;
  7.  
    import org.springframework.test.context.junit4.SpringRunner;
  8.  
     
  9.  
    @RunWith(SpringRunner.class)
  10.  
    @SpringBootTest
  11.  
    public class UserMapperTest {
  12.  
     
  13.  
    @Autowired
  14.  
    private UserMapper userMapper;
  15.  
     
  16.  
    @Test
  17.  
    public void testSelectById() {
  18.  
     
  19.  
    //根据id查询数据
  20.  
    User user = this.userMapper.selectById(2L);
  21.  
    System.out.println("result = " user);
  22.  
    }
  23.  
    }
  24.  
     
学新通

②根据id批量查询数据----selectBatchIds()

方法定义: 

  1.  
    /**
  2.  
    * 查询(根据ID 批量查询)
  3.  
    *
  4.  
    * @param idList 主键ID列表(不能为 null 以及 empty)
  5.  
    */
  6.  
    List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable>
  7.  
    idList);

         映射出来的SQL语句:

SELECT id,user_name,password,name,age,email FROM tb_user WHERE id IN ( ? , ? , ? )

  1.  
    import cn.itcast.mp.mapper.UserMapper;
  2.  
    import cn.itcast.mp.pojo.User;
  3.  
    import org.junit.Test;
  4.  
    import org.junit.runner.RunWith;
  5.  
    import org.springframework.beans.factory.annotation.Autowired;
  6.  
    import org.springframework.boot.test.context.SpringBootTest;
  7.  
    import org.springframework.test.context.junit4.SpringRunner;
  8.  
    import java.util.Arrays;
  9.  
    import java.util.List;
  10.  
     
  11.  
    @RunWith(SpringRunner.class)
  12.  
    @SpringBootTest
  13.  
    public class UserMapperTest {
  14.  
     
  15.  
    @Autowired
  16.  
    private UserMapper userMapper;
  17.  
     
  18.  
    @Test
  19.  
    public void testSelectBatchIds(){
  20.  
    // 根据id批量查询数据
  21.  
    List<User> users = this.userMapper.selectBatchIds(Arrays.asList(2L, 3L, 4L, 100L));
  22.  
    for (User user : users) {
  23.  
    System.out.println(user);
  24.  
    }
  25.  
    }
  26.  
    }
学新通

③根据查询条件查询并返回一条数据(查询结果只有一条数据,若查出多条则报错)----selectOne()

方法定义:

  1.  
    /**
  2.  
    * 根据 entity 条件,查询一条记录
  3.  
    *
  4.  
    * @param queryWrapper 实体对象封装操作类(可以为 null)
  5.  
    */
  6.  
    T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

         映射出来的SQL语句:

SELECT id,user_name,password,name,age,email FROM tb_user WHERE name = ?

  1.  
    import cn.itcast.mp.mapper.UserMapper;
  2.  
    import cn.itcast.mp.pojo.User;
  3.  
    import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  4.  
    import org.junit.Test;
  5.  
    import org.junit.runner.RunWith;
  6.  
    import org.springframework.beans.factory.annotation.Autowired;
  7.  
    import org.springframework.boot.test.context.SpringBootTest;
  8.  
    import org.springframework.test.context.junit4.SpringRunner;
  9.  
     
  10.  
    @RunWith(SpringRunner.class)
  11.  
    @SpringBootTest
  12.  
    public class UserMapperTest {
  13.  
     
  14.  
    @Autowired
  15.  
    private UserMapper userMapper;
  16.  
     
  17.  
    @Test
  18.  
    public void testSelectOne(){
  19.  
    QueryWrapper<User> wrapper = new QueryWrapper<>();
  20.  
    //查询条件
  21.  
    wrapper.eq("password", "123456");
  22.  
    // 查询的数据超过一条时,会抛出异常
  23.  
    User user = this.userMapper.selectOne(wrapper);
  24.  
    System.out.println(user);
  25.  
    }
  26.  
    }
学新通

④根据条件查询数据的总数据条数----selectCount()

方法定义:

  1.  
    /**
  2.  
    * 根据 Wrapper 条件,查询总记录数
  3.  
    *
  4.  
    * @param queryWrapper 实体对象封装操作类(可以为 null)
  5.  
    */
  6.  
    Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

          映射出来的SQL语句:

        SELECT COUNT( 1 ) FROM tb_user WHERE age > ?

  1.  
    import cn.itcast.mp.mapper.UserMapper;
  2.  
    import cn.itcast.mp.pojo.User;
  3.  
    import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  4.  
    import org.junit.Test;
  5.  
    import org.junit.runner.RunWith;
  6.  
    import org.springframework.beans.factory.annotation.Autowired;
  7.  
    import org.springframework.boot.test.context.SpringBootTest;
  8.  
    import org.springframework.test.context.junit4.SpringRunner;
  9.  
     
  10.  
    @RunWith(SpringRunner.class)
  11.  
    @SpringBootTest
  12.  
    public class UserMapperTest {
  13.  
     
  14.  
    @Autowired
  15.  
    private UserMapper userMapper;
  16.  
     
  17.  
     
  18.  
    @Test
  19.  
    public void testSelectCount(){
  20.  
     
  21.  
    QueryWrapper<User> wrapper = new QueryWrapper<>();
  22.  
    wrapper.gt("age", 20); // 条件:年龄大于20岁的用户
  23.  
     
  24.  
    // 根据条件查询数据条数
  25.  
    Integer count = this.userMapper.selectCount(wrapper);
  26.  
    System.out.println("count => " count);
  27.  
    }
  28.  
    }
学新通

⑤根据条件查询并返回全部记录列表----selectList()

方法定义:

  1.  
    /**
  2.  
    * 根据 entity 条件,查询全部记录
  3.  
    *
  4.  
    * @param queryWrapper 实体对象封装操作类(可以为 null)
  5.  
    */
  6.  
    List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

   映射出来的SQL语句:

     SELECT id,user_name,password,name,age,email FROM tb_user WHERE age > ?

  1.  
    import cn.itcast.mp.mapper.UserMapper;
  2.  
    import cn.itcast.mp.pojo.User;
  3.  
    import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  4.  
    import org.junit.Test;
  5.  
    import org.junit.runner.RunWith;
  6.  
    import org.springframework.beans.factory.annotation.Autowired;
  7.  
    import org.springframework.boot.test.context.SpringBootTest;
  8.  
    import org.springframework.test.context.junit4.SpringRunner;
  9.  
    import java.util.List;
  10.  
    @RunWith(SpringRunner.class)
  11.  
    @SpringBootTest
  12.  
    public class UserMapperTest {
  13.  
     
  14.  
    @Autowired
  15.  
    private UserMapper userMapper;
  16.  
     
  17.  
     
  18.  
    @Test
  19.  
    public void testSelectList(){
  20.  
    QueryWrapper<User> wrapper = new QueryWrapper<>();
  21.  
    //设置查询条件
  22.  
    wrapper.like("email", "itcast");
  23.  
     
  24.  
    List<User> users = this.userMapper.selectList(wrapper);
  25.  
    for (User user : users) {
  26.  
    System.out.println(user);
  27.  
    }
  28.  
    }
  29.  
    }
学新通

⑥根据条件查询并返回全部数据(并且翻页)----selectPage()

方法定义: 

  1.  
    /**
  2.  
    * 根据 entity 条件,查询全部记录(并翻页)
  3.  
    *
  4.  
    * @param page 分页查询条件(可以为 RowBounds.DEFAULT)
  5.  
    * @param queryWrapper 实体对象封装操作类(可以为 null)
  6.  
    */
  7.  
    IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

        映射出来的SQL语句:

        SELECT COUNT(1) FROM tb_user WHERE age > ?

        SELECT id,user_name,password,name,age,email FROM tb_user WHERE age > ? LIMIT ?,?

配置分页插件:

  1.  
    import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
  2.  
    import org.mybatis.spring.annotation.MapperScan;
  3.  
    import org.springframework.context.annotation.Bean;
  4.  
    import org.springframework.context.annotation.Configuration;
  5.  
     
  6.  
    @Configuration
  7.  
    @MapperScan("cn.itcast.mp.mapper") //设置mapper接口的扫描包
  8.  
    public class MybatisPlusConfig {
  9.  
     
  10.  
    /**
  11.  
    * 分页插件
  12.  
    */
  13.  
    @Bean
  14.  
    public PaginationInterceptor paginationInterceptor() {
  15.  
     
  16.  
    return new PaginationInterceptor();
  17.  
    }
  18.  
    }
  19.  
     
学新通
  1.  
    import cn.itcast.mp.mapper.UserMapper;
  2.  
    import cn.itcast.mp.pojo.User;
  3.  
    import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  4.  
    import com.baomidou.mybatisplus.core.metadata.IPage;
  5.  
    import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
  6.  
    import org.junit.Test;
  7.  
    import org.junit.runner.RunWith;
  8.  
    import org.springframework.beans.factory.annotation.Autowired;
  9.  
    import org.springframework.boot.test.context.SpringBootTest;
  10.  
    import org.springframework.test.context.junit4.SpringRunner;
  11.  
    import java.util.List;
  12.  
     
  13.  
    @RunWith(SpringRunner.class)
  14.  
    @SpringBootTest
  15.  
    public class UserMapperTest {
  16.  
     
  17.  
    @Autowired
  18.  
    private UserMapper userMapper;
  19.  
     
  20.  
     
  21.  
    // 测试分页查询
  22.  
    @Test
  23.  
    public void testSelectPage(){
  24.  
     
  25.  
    Page<User> page = new Page<>(3,1); //查询第一页,查询1条数据
  26.  
     
  27.  
    QueryWrapper<User> wrapper = new QueryWrapper<>();
  28.  
    //设置查询条件
  29.  
    wrapper.like("email", "itcast");
  30.  
     
  31.  
    IPage<User> iPage = this.userMapper.selectPage(page, wrapper);
  32.  
    System.out.println("数据总条数: " iPage.getTotal());
  33.  
    System.out.println("数据总页数: " iPage.getPages());
  34.  
    System.out.println("当前页数: " iPage.getCurrent());
  35.  
     
  36.  
    List<User> records = iPage.getRecords();
  37.  
    for (User record : records) {
  38.  
    System.out.println(record);
  39.  
    }
  40.  
     
  41.  
    }
学新通

五、SQL注入的原理

        在MP中,ISqlInjector负责SQL的注入工作,它是一个接口,AbstractSqlInjector是它的实现类,实现关系如下:

学新通

         在AbstractSqlInjector中,主要是由inspectInject()方法进行注入的,如下:

  1.  
    @Override
  2.  
    public void inspectInject(MapperBuilderAssistant builderAssistant, Class<?>
  3.  
    mapperClass) {
  4.  
    Class<?> modelClass = extractModelClass(mapperClass);
  5.  
    if (modelClass != null) {
  6.  
    String className = mapperClass.toString();
  7.  
    Set<String> mapperRegistryCache =
  8.  
    GlobalConfigUtils.getMapperRegistryCache(builderAssistant.getConfiguration());
  9.  
    if (!mapperRegistryCache.contains(className)) {
  10.  
    List<AbstractMethod> methodList = this.getMethodList();
  11.  
    if (CollectionUtils.isNotEmpty(methodList)) {
  12.  
    TableInfo tableInfo = TableInfoHelper.initTableInfo(builderAssistant,
  13.  
    modelClass);
  14.  
    // 循环注入自定义方法
  15.  
    methodList.forEach(m -> m.inject(builderAssistant, mapperClass,modelClass, tableInfo));
  16.  
    } else {
  17.  
    logger.debug(mapperClass.toString() ", No effective injection method was found.");
  18.  
    }
  19.  
    mapperRegistryCache.add(className);
  20.  
    }
  21.  
    }
  22.  
    }
学新通

        在实现方法中, methodList.forEach(m -> m.inject(builderAssistant, mapperClass, modelClass, tableInfo)); 是关键,循环遍历方法,进行注入。

        最终调用抽象方法injectMappedStatement进行真正的注入:

  1.  
    /**
  2.  
    * 注入自定义 MappedStatement
  3.  
    *
  4.  
    * @param mapperClass mapper 接口
  5.  
    * @param modelClass mapper 泛型
  6.  
    * @param tableInfo 数据库表反射信息
  7.  
    * @return MappedStatement
  8.  
    */
  9.  
    public abstract MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo);

        查看该方法的实现:

学新通

        以SelectById为例查看:

  1.  
    public class SelectById extends AbstractMethod {
  2.  
     
  3.  
    @Override
  4.  
    public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
  5.  
    SqlMethod sqlMethod = SqlMethod.LOGIC_SELECT_BY_ID;
  6.  
    SqlSource sqlSource = new RawSqlSource(configuration,
  7.  
    String.format(sqlMethod.getSql(),
  8.  
    sqlSelectColumns(tableInfo, false),
  9.  
    tableInfo.getTableName(), tableInfo.getKeyColumn(),tableInfo.getKeyProperty(),
  10.  
    tableInfo.getLogicDeleteSql(true, false)), Object.class);
  11.  
     
  12.  
    return this.addSelectMappedStatement(mapperClass, sqlMethod.getMethod(),sqlSource, modelClass, tableInfo);
  13.  
    }
  14.  
    }

         可以看到,生成了SqlSource对象,再将SQL通过addSelectMappedStatement方法添加到meppedStatements中。

六、配置

1)基本配置

1.configLocation----声名配置文件的位置

        MyBatis 配置文件位置,如果您有单独的 MyBatis 配置,请将其路径配置到 configLocation 中。 MyBatis Configuration 的具体内容请参考MyBatis 官方文档。

Spring Boot: 

 mybatis-plus.config-location = classpath:mybatis-config.xml

Spring MVC:

  1.  
    <bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
  2.  
    <property name="configLocation" value="classpath:mybatis-config.xml"/>
  3.  
    </bean>

2.mapperLocations----配置自定义方法的位置

        MyBatis Mapper 所对应的 XML 文件位置,如果您在 Mapper 中有自定义方法(XML 中有自定义实现),需要进行 该配置,告诉 Mapper 所对应的 XML 文件位置。

 Spring Boot:

 mybatis-plus.mapper-locations = classpath*:mybatis/*.xml

Maven 多模块项目的扫描路径需以 classpath*: 开头 (即加载多个 jar 包下的 XML 文件)

Spring MVC:

  1.  
    <bean id="sqlSessionFactory"
  2.  
    class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
  3.  
    <property name="mapperLocations" value="classpath*:mybatis/*.xml"/>
  4.  
    </bean>

3.typeAliasesPackage---配置别名包扫描路径,配置后可直接用类名

        MyBaits 别名包扫描路径,通过该属性可以给包中的类注册别名,注册后在 Mapper 对应的 XML 文件中可以直接使 用类名,而不用使用全限定的类名(即 XML 中调用的时候不用包含包名)。

 Spring Boot:

mybatis-plus.type-aliases-package = cn.itcast.mp.pojo

Spring MVC:

  1.  
    <bean id="sqlSessionFactory"
  2.  
    class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
  3.  
    <property name="typeAliasesPackage" value="com.baomidou.mybatisplus.samples.quickstart.entity"/>
  4.  
    </bean>

2)进阶配置

        本部分(Configuration)的配置大都为 MyBatis 原生支持的配置,这意味着您可以通过 MyBatis XML 配置文件的形 式进行配置。

        

         1.mapUnderscoreToCamelCase----配置是否开启自动驼峰命名规则映射

  • 类型: boolean
  • 默认值: true

        是否开启自动驼峰命名规则(camel case)映射,即从经典数据库列名 A_COLUMN(下划线命名) 到经典 Java 属 性名 aColumn(驼峰命名) 的类似映射。

        注意: 此属性在 MyBatis 中原默认值为 false,在 MyBatis-Plus 中,此属性也将用于生成最终的 SQL 的 select body 如果您的数据库命名符合规则无需使用 @TableField 注解指定数据库字段名。

SpringBoot:

  1.  
    #关闭自动驼峰映射,该参数不能和mybatis-plus.config-location同时存在
  2.  
    mybatis-plus.configuration.map-underscore-to-camel-case=false

        2.cacheEnabled---配置是否需要缓存

  • 类型: boolean
  • 默认值: true

全局地开启或关闭配置文件中的所有映射器已经配置的任何缓存,默认为 true。

        SpringBoot:

 mybatis-plus.configuration.cache-enabled=false

3)DB 策略配置

1.idType---配置主键类型

  • 类型: com.baomidou.mybatisplus.annotation.IdType
  • 默认值: ID_WORKER

全局默认主键类型,设置后,即可省略实体对象中的@TableId(type = IdType.AUTO)配置。

SpringBoot: 

 mybatis-plus.global-config.db-config.id-type=auto

 SpringMVC:

  1.  
    <!--这里使用MP提供的sqlSessionFactory,完成了Spring与MP的整合-->
  2.  
    <bean id="sqlSessionFactory"
  3.  
    class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
  4.  
    <property name="dataSource" ref="dataSource"/>
  5.  
    <property name="globalConfig">
  6.  
    <bean class="com.baomidou.mybatisplus.core.config.GlobalConfig">
  7.  
    <property name="dbConfig">
  8.  
    <bean class="com.baomidou.mybatisplus.core.config.GlobalConfig$DbConfig">
  9.  
    <property name="idType" value="AUTO"/>
  10.  
    </bean>
  11.  
    </property>
  12.  
    </bean>
  13.  
    </property>
  14.  
    </bean>

3.tablePrefix----

  • 类型: String
  • 默认值: null

        表名前缀,全局配置后可省略@TableName()配置。

 SpringBoot:

 mybatis-plus.global-config.db-config.table-prefix=tb_

SpringMVC:

  1.  
    <bean id="sqlSessionFactory"
  2.  
    class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
  3.  
    <property name="dataSource" ref="dataSource"/>
  4.  
    <property name="globalConfig">
  5.  
    <bean class="com.baomidou.mybatisplus.core.config.GlobalConfig">
  6.  
    <property name="dbConfig">
  7.  
    <bean class="com.baomidou.mybatisplus.core.config.GlobalConfig$DbConfig">
  8.  
    <property name="idType" value="AUTO"/>
  9.  
    <property name="tablePrefix" value="tb_"/>
  10.  
    </bean>
  11.  
    </property>
  12.  
    </bean>
  13.  
    </property>
  14.  
    </bean>

七、条件构造器

在MP中,Wrapper接口的实现类关系如下:

学新通

  说明: QueryWrapper(LambdaQueryWrapper) 和 UpdateWrapper(LambdaUpdateWrapper) 的父类 用于生成 sql 的 where 条件, entity 属性也用于生成 sql 的 where 条件 注意: entity 生成的 where 条件与 使用各个 api 生成 的 where 条件没有任何关联行为。

一)allEq

①说明

  • allEq(Map params)
  • allEq(Map params, boolean null2IsNull)
  • allEq(boolean condition, Map params, boolean null2IsNull)

        个别参数说明: params : key 为数据库字段名, value 为字段值 null2IsNull : 为 true 则在 map 的 value 为 null 时调用 isNull 方法,为 false 时则忽略 value 为 null 的

  • 例1: allEq({id:1,name:"老王",age:null}) ---> id = 1 and name = '老王' and age is null
  • 例2: allEq({id:1,name:"老王",age:null}, false) ---> id = 1 and name = '老王'
  • allEq(BiPredicate filter, Map params)
  • allEq(BiPredicate filter, Map params, boolean null2IsNull)
  • allEq(boolean condition, BiPredicate filter, Map params, boolean null2IsNull)

个别参数说明: filter : 过滤函数,是否允许字段传入比对条件中 params 与 null2IsNull : 同上

        例1: allEq((k,v) -> k.indexOf("a") > 0, {id:1,name:"老王",age:null}) ---> name = '老王' and age is null

        例2: allEq((k,v) -> k.indexOf("a") > 0, {id:1,name:"老王",age:null}, false) ---> name = '老王'

测试: 

  1.  
    import cn.itcast.mp.mapper.UserMapper;
  2.  
    import cn.itcast.mp.pojo.User;
  3.  
    import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  4.  
    import org.junit.Test;
  5.  
    import org.junit.runner.RunWith;
  6.  
    import org.springframework.beans.factory.annotation.Autowired;
  7.  
    import org.springframework.boot.test.context.SpringBootTest;
  8.  
    import org.springframework.test.context.junit4.SpringRunner;
  9.  
    import java.util.HashMap;
  10.  
    import java.util.List;
  11.  
    import java.util.Map;
  12.  
     
  13.  
    @RunWith(SpringRunner.class)
  14.  
    @SpringBootTest
  15.  
    public class UserMapperTest {
  16.  
     
  17.  
    @Autowired
  18.  
    private UserMapper userMapper;
  19.  
     
  20.  
    @Test
  21.  
    public void testWrapper() {
  22.  
    QueryWrapper<User> wrapper = new QueryWrapper<>();
  23.  
     
  24.  
    //设置条件
  25.  
    Map<String,Object> params = new HashMap<>();
  26.  
    params.put("name", "曹操");
  27.  
    params.put("age", "20");
  28.  
    params.put("password", null);
  29.  
     
  30.  
    // wrapper.allEq(params);//SELECT * FROM tb_user WHERE password IS NULL AND name = ? AND age = ?
  31.  
     
  32.  
    // wrapper.allEq(params,false); //SELECT * FROM tb_user WHERE name = ? AND age = ?
  33.  
     
  34.  
    // wrapper.allEq((k, v) -> (k.equals("name") || k.equals("age")) ,params);//SELECT * FROM tb_user WHERE name = ? AND age = ?
  35.  
     
  36.  
    List<User> users = this.userMapper.selectList(wrapper);
  37.  
    for (User user : users) {
  38.  
    System.out.println(user);
  39.  
    }
  40.  
    }
  41.  
    }
  42.  
     
学新通

二)基本比较操作

  • eq                 等于 =
  • ne                 不等于 <>
  • gt                  大于 >
  • ge                 大于等于 >=
  • lt                   小于 <
  • le                  小于等于 <=
  • between        BETWEEN 值1 AND 值2
  • notBetween  NOT BETWEEN 值1 AND 值2
  • in                 字段 IN (value.get(0), value.get(1), ...)
  • notIn            字段 NOT IN (v0, v1, ...)
  1.  
    import cn.itcast.mp.mapper.UserMapper;
  2.  
    import cn.itcast.mp.pojo.User;
  3.  
    import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  4.  
    import org.junit.Test;
  5.  
    import org.junit.runner.RunWith;
  6.  
    import org.springframework.beans.factory.annotation.Autowired;
  7.  
    import org.springframework.boot.test.context.SpringBootTest;
  8.  
    import org.springframework.test.context.junit4.SpringRunner;
  9.  
    import java.util.List;
  10.  
     
  11.  
    @RunWith(SpringRunner.class)
  12.  
    @SpringBootTest
  13.  
    public class UserMapperTest {
  14.  
     
  15.  
    @Autowired
  16.  
    private UserMapper userMapper;
  17.  
     
  18.  
    @Test
  19.  
    public void testEq() {
  20.  
    QueryWrapper<User> wrapper = new QueryWrapper<>();
  21.  
     
  22.  
    //SELECT id,user_name,password,name,age,email FROM tb_user WHERE password = ? AND age >= ? AND name IN (?,?,?)
  23.  
     
  24.  
    wrapper.eq("password", "123456").ge("age", 20).in("name", "李四", "王五", "赵六");
  25.  
     
  26.  
    List<User> users = this.userMapper.selectList(wrapper);
  27.  
    for (User user : users) {
  28.  
    System.out.println(user);
  29.  
    }
  30.  
    }
  31.  
    }
学新通

三)模糊查询

  • like
    • LIKE '%值%'
    • 例: like("name", "王") ---> name like '%王%'
  • notLike
    • NOT LIKE '%值%'
    • 例: notLike("name", "王") ---> name not like '%王%'
  • likeLeft
    • LIKE '%值'
    • 例: likeLeft("name", "王") ---> name like '%王'
  • likeRight
    • LIKE '值%'
    • 例: likeRight("name", "王") ---> name like '王%'
  1.  
    import cn.itcast.mp.mapper.UserMapper;
  2.  
    import cn.itcast.mp.pojo.User;
  3.  
    import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  4.  
    import org.junit.Test;
  5.  
    import org.junit.runner.RunWith;
  6.  
    import org.springframework.beans.factory.annotation.Autowired;
  7.  
    import org.springframework.boot.test.context.SpringBootTest;
  8.  
    import org.springframework.test.context.junit4.SpringRunner;
  9.  
    import java.util.List;
  10.  
     
  11.  
    @RunWith(SpringRunner.class)
  12.  
    @SpringBootTest
  13.  
    public class UserMapperTest {
  14.  
     
  15.  
    @Autowired
  16.  
    private UserMapper userMapper;
  17.  
     
  18.  
    @Test
  19.  
    public void testWrapper() {
  20.  
     
  21.  
    QueryWrapper<User> wrapper = new QueryWrapper<>();
  22.  
     
  23.  
    //SELECT id,user_name,password,name,age,email FROM tb_user WHERE name LIKE ?
  24.  
    //Parameters: %曹%(String)
  25.  
     
  26.  
    wrapper.like("name", "曹");
  27.  
     
  28.  
    List<User> users = this.userMapper.selectList(wrapper);
  29.  
    for (User user : users) {
  30.  
    System.out.println(user);
  31.  
    }
  32.  
    }
  33.  
    }
学新通

四)排序

  • orderBy
    • 排序:ORDER BY 字段, ...
    • 例: orderBy(true, true, "id", "name") ---> order by id ASC,name ASC
  • orderByAsc
    • 排序:ORDER BY 字段, ... ASC
    • 例: orderByAsc("id", "name") ---> order by id ASC,name ASC
  • orderByDesc
    • 排序:ORDER BY 字段, ... DESC
    • 例: orderByDesc("id", "name") ---> order by id DESC,name DESC
  1.  
    import cn.itcast.mp.mapper.UserMapper;
  2.  
    import cn.itcast.mp.pojo.User;
  3.  
    import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  4.  
    import org.junit.Test;
  5.  
    import org.junit.runner.RunWith;
  6.  
    import org.springframework.beans.factory.annotation.Autowired;
  7.  
    import org.springframework.boot.test.context.SpringBootTest;
  8.  
    import org.springframework.test.context.junit4.SpringRunner;
  9.  
    import java.util.List;
  10.  
     
  11.  
    @RunWith(SpringRunner.class)
  12.  
    @SpringBootTest
  13.  
    public class UserMapperTest {
  14.  
     
  15.  
    @Autowired
  16.  
    private UserMapper userMapper;
  17.  
     
  18.  
    @Test
  19.  
    public void testWrapper() {
  20.  
    QueryWrapper<User> wrapper = new QueryWrapper<>();
  21.  
     
  22.  
    //SELECT id,user_name,password,name,age,email FROM tb_user ORDER BY age DESC
  23.  
     
  24.  
    wrapper.orderByDesc("age");
  25.  
     
  26.  
    List<User> users = this.userMapper.selectList(wrapper);
  27.  
    for (User user : users) {
  28.  
    System.out.println(user);
  29.  
    }
  30.  
    }
  31.  
    }
学新通

五)逻辑查询

  • or
    • 拼接 OR
    • 主动调用 or 表示紧接着下一个方法不是用 and 连接!(不调用 or 则默认为使用 and 连接)
  • and
    • AND 嵌套
    • 例: and(i -> i.eq("name", "李白").ne("status", "活着")) ---> and (name = '李白' and status <> '活着')
  1.  
    import cn.itcast.mp.mapper.UserMapper;
  2.  
    import cn.itcast.mp.pojo.User;
  3.  
    import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  4.  
    import org.junit.Test;
  5.  
    import org.junit.runner.RunWith;
  6.  
    import org.springframework.beans.factory.annotation.Autowired;
  7.  
    import org.springframework.boot.test.context.SpringBootTest;
  8.  
    import org.springframework.test.context.junit4.SpringRunner;
  9.  
    import java.util.List;
  10.  
     
  11.  
    @RunWith(SpringRunner.class)
  12.  
    @SpringBootTest
  13.  
    public class UserMapperTest {
  14.  
     
  15.  
    @Autowired
  16.  
    private UserMapper userMapper;
  17.  
     
  18.  
    @Test
  19.  
    public void testWrapper() {
  20.  
     
  21.  
    QueryWrapper<User> wrapper = new QueryWrapper<>();
  22.  
     
  23.  
    //SELECT id,user_name,password,name,age,email FROM tb_user WHERE name = ? OR age = ?
  24.  
     
  25.  
    wrapper.eq("name","李四").or().eq("age", 24);
  26.  
     
  27.  
    List<User> users = this.userMapper.selectList(wrapper);
  28.  
    for (User user : users) {
  29.  
    System.out.println(user);
  30.  
    }
  31.  
    }
  32.  
    }
学新通

六)select

在MP查询中,默认查询所有的字段,如果有需要也可以通过select方法进行指定字段。

  1.  
    import cn.itcast.mp.mapper.UserMapper;
  2.  
    import cn.itcast.mp.pojo.User;
  3.  
    import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  4.  
    import org.junit.Test;
  5.  
    import org.junit.runner.RunWith;
  6.  
    import org.springframework.beans.factory.annotation.Autowired;
  7.  
    import org.springframework.boot.test.context.SpringBootTest;
  8.  
    import org.springframework.test.context.junit4.SpringRunner;
  9.  
     
  10.  
    import java.util.List;
  11.  
     
  12.  
    @RunWith(SpringRunner.class)
  13.  
    @SpringBootTest
  14.  
    public class UserMapperTest {
  15.  
     
  16.  
    @Autowired
  17.  
    private UserMapper userMapper;
  18.  
     
  19.  
    @Test
  20.  
    public void testWrapper() {
  21.  
    QueryWrapper<User> wrapper = new QueryWrapper<>();
  22.  
     
  23.  
    //SELECT id,name,age FROM tb_user WHERE name = ? OR age = ?
  24.  
     
  25.  
    wrapper.eq("name", "李四").or().eq("age", 24).select("id", "name", "age");
  26.  
     
  27.  
    List<User> users = this.userMapper.selectList(wrapper);
  28.  
    for (User user : users) {
  29.  
    System.out.println(user);
  30.  
    }
  31.  
    }
  32.  
    }
学新通

八、ActiveRecord

        ActiveRecord也属于ORM(对象关系映射)层,由Rails最早提出,遵循标准的ORM模型:表映射到记录,记 录映射到对象,字段映射到对象属性。配合遵循的命名和配置惯例,能够很大程度的快速实现模型的操作,而 且简洁易懂。

        ActiveRecord的主要思想是:

  • 每一个数据库表对应创建一个类,类的每一个对象实例对应于数据库中表的一行记录;通常表的每个字段 在类中都有相应的Field;
  • ActiveRecord同时负责把自己持久化,在ActiveRecord中封装了对数据库的访问,即CURD;;
  • ActiveRecord是一种领域模型(Domain Model),封装了部分业务逻辑;

 一)开启AR之旅

在MP中,开启AR非常简单,只需要将实体对象继承Model即可。

  1.  
    import com.baomidou.mybatisplus.annotation.IdType;
  2.  
    import com.baomidou.mybatisplus.annotation.TableField;
  3.  
    import com.baomidou.mybatisplus.annotation.TableId;
  4.  
    import com.baomidou.mybatisplus.annotation.TableName;
  5.  
    import com.baomidou.mybatisplus.extension.activerecord.Model;
  6.  
    import lombok.AllArgsConstructor;
  7.  
    import lombok.Data;
  8.  
    import lombok.NoArgsConstructor;
  9.  
     
  10.  
    @Data
  11.  
    @NoArgsConstructor
  12.  
    @AllArgsConstructor
  13.  
    public class User extends Model<User> {
  14.  
    private Long id;
  15.  
    private String userName;
  16.  
    private String password;
  17.  
    private String name;
  18.  
    private Integer age;
  19.  
    private String email;
  20.  
    }
学新通

九、Mybatis-Plus的插件

一)mybatis的插件机制

MyBatis 允许你在已映射语句执行过程中的某一点进行拦截调用。默认情况下,MyBatis 允许使用插件来拦截的方法 调用包括:

        1. Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)                        拦截执行器的方法

        2. ParameterHandler (getParameterObject, setParameters)        拦截参数的处理

        3. ResultSetHandler (handleResultSets, handleOutputParameters)  拦截结果集的处理

        4. StatementHandler (prepare, parameterize, batch, update, query)   拦截Sql语法构建的处理

        我们看到了可以拦截Executor接口的部分方法,比如update,query,commit,rollback等方法,还有其他接口的 一些方法等。

        总体概括为:

                        1. 拦截执行器的方法

                        2. 拦截参数的处理

                        3. 拦截结果集的处理

                        4. 拦截Sql语法构建的处理

拦截器示例:

  1.  
    package cn.itcast.mp.plugins;
  2.  
     
  3.  
    import org.apache.ibatis.executor.Executor;
  4.  
    import org.apache.ibatis.mapping.MappedStatement;
  5.  
    import org.apache.ibatis.plugin.*;
  6.  
     
  7.  
    import java.util.Properties;
  8.  
     
  9.  
    @Intercepts({@Signature(
  10.  
    type= Executor.class,
  11.  
    method = "update",
  12.  
    args = {MappedStatement.class,Object.class})})
  13.  
    public class MyInterceptor implements Interceptor {
  14.  
     
  15.  
    @Override
  16.  
    public Object intercept(Invocation invocation) throws Throwable {
  17.  
    //拦截方法,具体业务逻辑编写的位置
  18.  
    return invocation.proceed();
  19.  
    }
  20.  
     
  21.  
    @Override
  22.  
    public Object plugin(Object target) {
  23.  
    //创建target对象的代理对象,目的是将当前拦截器加入到该对象中
  24.  
    return Plugin.wrap(target, this);
  25.  
    }
  26.  
     
  27.  
    @Override
  28.  
    public void setProperties(Properties properties) {
  29.  
    //属性设置
  30.  
    }
  31.  
    }
学新通

注入到Spring容器:

  1.  
    /**
  2.  
    * 自定义拦截器
  3.  
    */
  4.  
    @Bean
  5.  
    public MyInterceptor myInterceptor(){
  6.  
    return new MyInterceptor();
  7.  
    }

二)执行分析插件

        在MP中提供了对SQL执行的分析的插件,可用作阻断全表更新、删除的操作,

        注意:该插件仅适用于开发环境,不 适用于生产环境。

SpringBoot配置:

  1.  
    @Bean
  2.  
    public SqlExplainInterceptor sqlExplainInterceptor(){
  3.  
     
  4.  
    SqlExplainInterceptor sqlExplainInterceptor = new SqlExplainInterceptor();
  5.  
     
  6.  
    List<ISqlParser> sqlParserList = new ArrayList<>();
  7.  
     
  8.  
    // 攻击 SQL 阻断解析器、加入解析链
  9.  
    sqlParserList.add(new BlockAttackSqlParser());
  10.  
    sqlExplainInterceptor.setSqlParserList(sqlParserList);
  11.  
     
  12.  
    return sqlExplainInterceptor;
  13.  
    }

三)性能分析插件

        性能分析拦截器,用于输出每条 SQL 语句及其执行时间,可以设置最大执行时间,超过时间会抛出异常。

        该插件只用于开发环境,不建议生产环境使用。

配置:

  1.  
    <configuration>
  2.  
    <plugins>
  3.  
    <!-- 性能分析插件 -->
  4.  
    <!-- SQL 执行性能分析,开发环境使用,线上不推荐。 maxTime 指的是 sql 最大执行时长 -->
  5.  
    <plugin interceptor="com.baomidou.mybatisplus.extension.plugins.PerformanceInterceptor">
  6.  
    <!--最大的执行时间,单位为毫秒-->
  7.  
    <property name="maxTime" value="100"/>
  8.  
    <!--对输出的SQL做格式化,默认为false-->
  9.  
    <property name="format" value="true"/>
  10.  
    </plugin>
  11.  
    </configuration>

四)乐观锁插件

1.主要适用场景

意图: 当要更新一条记录的时候,希望这条记录没有被别人更新

乐观锁实现方式:

  • 取出记录时,获取当前version
  • 更新时,带上这个version
  • 执行更新时, set version = newVersion where version = oldVersion
  • 如果version不对,就更新失败

插件配置:

①spring xml:

<bean class="com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor"/>

②spring boot:

  1.  
    @Bean
  2.  
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
  3.  
    return new OptimisticLockerInterceptor();
  4.  
    }

使用步骤:

需要为实体字段添加@Version注解。

第一步,为表添加version字段,并且设置初始值为1:

  1.  
    ALTER TABLE `tb_user`
  2.  
    ADD COLUMN `version` int(10) NULL AFTER `email`;
  3.  
     
  4.  
    UPDATE `tb_user` SET `version`='1';

第二步,为User实体对象添加version字段,并且添加@Version注解:

  1.  
    @Version
  2.  
    private Integer version;

测试:

  1.  
    @Test
  2.  
    public void testUpdateVersion(){
  3.  
    User user = new User();
  4.  
    user.setId(2L);// 查询条件
  5.  
     
  6.  
    User userVersion = user.selectById();
  7.  
     
  8.  
    user.setAge(23); // 更新的数据
  9.  
    user.setVersion(userVersion.getVersion()); // 当前的版本信息
  10.  
     
  11.  
    boolean result = user.updateById();
  12.  
    System.out.println("result => " result);
  13.  
    }

特别说明:

  • 支持的数据类型只有:int,Integer,long,Long,Date,Timestamp,LocalDateTime
  • 整数类型下 newVersion = oldVersion 1
  • newVersion 会回写到 entity 中
  • 仅支持 updateById(id) 与 update(entity, wrapper) 方法
  • 在 update(entity, wrapper) 方法下, wrapper 不能复用!!!

十、Sql 注入器实现自定义全局操作

        当我们需要扩充BaseMapper中的方法,就需要用到Sql 注入器

①编写MyBaseMapper(其他的Mapper都可以继承该Mapper,这样实现了统一的扩展

  1.  
    import com.baomidou.mybatisplus.core.mapper.BaseMapper;
  2.  
    import java.util.List;
  3.  
     
  4.  
    public interface MyBaseMapper<T> extends BaseMapper<T> {
  5.  
    List<T> findAll();
  6.  
     
  7.  
    // 扩展其他的方法
  8.  
    }

注意:其他mapper都应该继承MyBaseMapper,而MyBaseMapper应该继承BaseMapper

 如:

  1.  
    package cn.itcast.mp.mapper;
  2.  
     
  3.  
    import cn.itcast.mp.pojo.User;
  4.  
     
  5.  
    public interface UserMapper extends MyBaseMapper<User> {
  6.  
     
  7.  
    User findById(Long id);
  8.  
    }

② 编写MySqlInjector

        如果直接继承AbstractSqlInjector的话,原有的BaseMapper中的方法将失效,所以我们选择继承DefaultSqlInjector 进行扩展。

  1.  
    package cn.itcast.mp.injectors;
  2.  
     
  3.  
    import com.baomidou.mybatisplus.core.injector.AbstractMethod;
  4.  
    import com.baomidou.mybatisplus.core.injector.DefaultSqlInjector;
  5.  
     
  6.  
    import java.util.ArrayList;
  7.  
    import java.util.List;
  8.  
     
  9.  
    public class MySqlInjector extends DefaultSqlInjector {
  10.  
     
  11.  
    @Override
  12.  
    public List<AbstractMethod> getMethodList() {
  13.  
    List<AbstractMethod> list = new ArrayList<>();
  14.  
     
  15.  
    // 获取父类中的集合
  16.  
    list.addAll(super.getMethodList());
  17.  
     
  18.  
    // 再扩充自定义的方法
  19.  
    list.add(new FindAll());
  20.  
     
  21.  
    return list;
  22.  
    }
  23.  
    }
学新通

③编写FindAll

  1.  
    package cn.itcast.mp.injectors;
  2.  
     
  3.  
    import com.baomidou.mybatisplus.core.injector.AbstractMethod;
  4.  
    import com.baomidou.mybatisplus.core.metadata.TableInfo;
  5.  
    import org.apache.ibatis.mapping.MappedStatement;
  6.  
    import org.apache.ibatis.mapping.SqlSource;
  7.  
     
  8.  
    public class FindAll extends AbstractMethod {
  9.  
     
  10.  
    @Override
  11.  
    public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
  12.  
     
  13.  
    String sql = "select * from " tableInfo.getTableName();
  14.  
    SqlSource sqlSource = languageDriver.createSqlSource(configuration,sql, modelClass);
  15.  
     
  16.  
    return this.addSelectMappedStatement(mapperClass, "findAll", sqlSource, modelClass, tableInfo);
  17.  
    }
  18.  
    }
学新通

④注册到Spring容器

  1.  
    /**
  2.  
    * 注入自定义的SQL注入器
  3.  
    * @return
  4.  
    */
  5.  
    @Bean
  6.  
    public MySqlInjector mySqlInjector(){
  7.  
    return new MySqlInjector();
  8.  
    }

十一、自动填充功能

        有些时候我们可能会有这样的需求,插入或者更新数据时,希望有些字段可以自动填充数据,比如密码、version 等。在MP中提供了这样的功能,可以实现自动填充。

开发步骤:

①添加@TableField注解

  1.  
    @TableField(fill = FieldFill.INSERT) //插入数据时进行填充
  2.  
    private String password;

FieldFill提供了多种模式选择: 

  1.  
    public enum FieldFill {
  2.  
    /**
  3.  
    * 默认不处理
  4.  
    */
  5.  
    DEFAULT,
  6.  
    /**
  7.  
    * 插入时填充字段
  8.  
    */
  9.  
    INSERT,
  10.  
    /**
  11.  
    * 更新时填充字段
  12.  
    */
  13.  
    UPDATE,
  14.  
    /**
  15.  
    * 插入和更新时填充字段
  16.  
    */
  17.  
    INSERT_UPDATE
  18.  
    }
学新通

② 编写MyMetaObjectHandler

  1.  
    package cn.itcast.mp.handler;
  2.  
     
  3.  
    import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
  4.  
    import org.apache.ibatis.reflection.MetaObject;
  5.  
    import org.springframework.stereotype.Component;
  6.  
     
  7.  
    @Component
  8.  
    public class MyMetaObjectHandler implements MetaObjectHandler {
  9.  
     
  10.  
    /**
  11.  
    * 插入数据时填充
  12.  
    * @param metaObject
  13.  
    */
  14.  
    @Override
  15.  
    public void insertFill(MetaObject metaObject) {
  16.  
    // 先获取到password的值,再进行判断,如果为空,就进行填充,如果不为空,就不做处理
  17.  
    Object password = getFieldValByName("password", metaObject);
  18.  
    //字段为空就填入
  19.  
    if(null == password){
  20.  
    setFieldValByName("password", "888888", metaObject);
  21.  
    }
  22.  
    }
  23.  
     
  24.  
    /**
  25.  
    * 更新数据时填充
  26.  
    * @param metaObject
  27.  
    */
  28.  
    @Override
  29.  
    public void updateFill(MetaObject metaObject) {
  30.  
     
  31.  
    }
  32.  
    }
学新通

十二、逻辑删除

        开发系统时,有时候在实现功能时,删除操作需要实现逻辑删除,所谓逻辑删除就是将数据标记为删除,而并非真正的物理删除(非DELETE操作),查询时需要携带状态条件,确保被标记的数据不被查询到。这样做的目的就是避免数据被真正的删除。

开发步骤:

 ①修改表结构

        为tb_user表增加deleted字段,用于表示数据是否被删除,1代表删除,0代表未删除。

  1.  
    ALTER TABLE `tb_user`
  2.  
    ADD COLUMN `deleted` int(1) NULL DEFAULT 0 COMMENT '1代表删除,0代表未删除' AFTER
  3.  
    `version`;

同时,也修改User实体,增加deleted属性并且添加@TableLogic注解

  1.  
    @TableLogic
  2.  
    private Integer deleted;

②配置 

application.properties:

  1.  
    # 逻辑已删除值(默认为 1)
  2.  
    mybatis-plus.global-config.db-config.logic-delete-value=1
  3.  
    # 逻辑未删除值(默认为 0)
  4.  
    mybatis-plus.global-config.db-config.logic-not-delete-value=0

十三、通用枚举

解决了繁琐的配置,让 mybatis 优雅的使用枚举属性!

开发步骤:

①修改表结构

  1.  
    ALTER TABLE `tb_user`
  2.  
    ADD COLUMN `sex` int(1) NULL DEFAULT 1 COMMENT '1-男,2-女' AFTER `deleted`;

②定义枚举

  1.  
    package cn.itcast.mp.enums;
  2.  
     
  3.  
    import com.baomidou.mybatisplus.core.enums.IEnum;
  4.  
     
  5.  
    public enum SexEnum implements IEnum<Integer> {
  6.  
     
  7.  
    MAN(1,"男"),
  8.  
    WOMAN(2,"女");
  9.  
     
  10.  
    private int value;
  11.  
    private String desc;
  12.  
     
  13.  
    SexEnum(int value, String desc) {
  14.  
    this.value = value;
  15.  
    this.desc = desc;
  16.  
    }
  17.  
     
  18.  
    @Override
  19.  
    public Integer getValue() {
  20.  
    return this.value;
  21.  
    }
  22.  
     
  23.  
    @Override
  24.  
    public String toString() {
  25.  
    return this.desc;
  26.  
    }
  27.  
    }
学新通

③配置

  1.  
    # 枚举包扫描
  2.  
    mybatis-plus.type-enums-package=cn.itcast.mp.enums

④修改实体

 private SexEnum sex;

十四、代码生成器

        AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。

开发步骤:

①创建工程导入包

  1.  
    <?xml version="1.0" encoding="UTF-8"?>
  2.  
    <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.  
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.  
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.  
    <modelVersion>4.0.0</modelVersion>
  6.  
     
  7.  
    <parent>
  8.  
    <groupId>org.springframework.boot</groupId>
  9.  
    <artifactId>spring-boot-starter-parent</artifactId>
  10.  
    <version>2.1.4.RELEASE</version>
  11.  
    </parent>
  12.  
     
  13.  
    <groupId>cn.itcast.mp</groupId>
  14.  
    <artifactId>itcast-mp-generator</artifactId>
  15.  
    <version>1.0-SNAPSHOT</version>
  16.  
     
  17.  
    <dependencies>
  18.  
    <dependency>
  19.  
    <groupId>org.springframework.boot</groupId>
  20.  
    <artifactId>spring-boot-starter-test</artifactId>
  21.  
    <scope>test</scope>
  22.  
    </dependency>
  23.  
     
  24.  
    <!--mybatis-plus的springboot支持-->
  25.  
    <dependency>
  26.  
    <groupId>com.baomidou</groupId>
  27.  
    <artifactId>mybatis-plus-boot-starter</artifactId>
  28.  
    <version>3.1.1</version>
  29.  
    </dependency>
  30.  
    <dependency>
  31.  
    <groupId>com.baomidou</groupId>
  32.  
    <artifactId>mybatis-plus-generator</artifactId>
  33.  
    <version>3.1.1</version>
  34.  
    </dependency>
  35.  
    <dependency>
  36.  
    <groupId>org.springframework.boot</groupId>
  37.  
    <artifactId>spring-boot-starter-freemarker</artifactId>
  38.  
    </dependency>
  39.  
    <!--mysql驱动-->
  40.  
    <dependency>
  41.  
    <groupId>mysql</groupId>
  42.  
    <artifactId>mysql-connector-java</artifactId>
  43.  
    <version>5.1.47</version>
  44.  
    </dependency>
  45.  
    <dependency>
  46.  
    <groupId>org.slf4j</groupId>
  47.  
    <artifactId>slf4j-log4j12</artifactId>
  48.  
    </dependency>
  49.  
     
  50.  
    </dependencies>
  51.  
     
  52.  
    <build>
  53.  
    <plugins>
  54.  
    <plugin>
  55.  
    <groupId>org.springframework.boot</groupId>
  56.  
    <artifactId>spring-boot-maven-plugin</artifactId>
  57.  
    </plugin>
  58.  
    </plugins>
  59.  
    </build>
  60.  
     
  61.  
    </project>
学新通

②写入代码(一般直接套用)

  1.  
    package cn.itcast.mp.generator;
  2.  
     
  3.  
    import java.util.ArrayList;
  4.  
    import java.util.List;
  5.  
    import java.util.Scanner;
  6.  
     
  7.  
    import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
  8.  
    import com.baomidou.mybatisplus.core.toolkit.StringPool;
  9.  
    import com.baomidou.mybatisplus.core.toolkit.StringUtils;
  10.  
    import com.baomidou.mybatisplus.generator.AutoGenerator;
  11.  
    import com.baomidou.mybatisplus.generator.InjectionConfig;
  12.  
    import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
  13.  
    import com.baomidou.mybatisplus.generator.config.FileOutConfig;
  14.  
    import com.baomidou.mybatisplus.generator.config.GlobalConfig;
  15.  
    import com.baomidou.mybatisplus.generator.config.PackageConfig;
  16.  
    import com.baomidou.mybatisplus.generator.config.StrategyConfig;
  17.  
    import com.baomidou.mybatisplus.generator.config.TemplateConfig;
  18.  
    import com.baomidou.mybatisplus.generator.config.po.TableInfo;
  19.  
    import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
  20.  
    import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
  21.  
     
  22.  
    /**
  23.  
    * <p>
  24.  
    * mysql 代码生成器演示例子
  25.  
    * </p>
  26.  
    */
  27.  
    public class MysqlGenerator {
  28.  
     
  29.  
    /**
  30.  
    * <p>
  31.  
    * 读取控制台内容
  32.  
    * </p>
  33.  
    */
  34.  
    public static String scanner(String tip) {
  35.  
    Scanner scanner = new Scanner(System.in);
  36.  
    StringBuilder help = new StringBuilder();
  37.  
    help.append("请输入" tip ":");
  38.  
    System.out.println(help.toString());
  39.  
    if (scanner.hasNext()) {
  40.  
    String ipt = scanner.next();
  41.  
    if (StringUtils.isNotEmpty(ipt)) {
  42.  
    return ipt;
  43.  
    }
  44.  
    }
  45.  
    throw new MybatisPlusException("请输入正确的" tip "!");
  46.  
    }
  47.  
     
  48.  
    /**
  49.  
    * RUN THIS
  50.  
    */
  51.  
    public static void main(String[] args) {
  52.  
    // 代码生成器
  53.  
    AutoGenerator mpg = new AutoGenerator();
  54.  
     
  55.  
    // 全局配置
  56.  
    GlobalConfig gc = new GlobalConfig();
  57.  
    String projectPath = System.getProperty("user.dir");
  58.  
    gc.setOutputDir(projectPath "/src/main/java");
  59.  
    gc.setAuthor("itcast");
  60.  
    gc.setOpen(false);
  61.  
    mpg.setGlobalConfig(gc);
  62.  
     
  63.  
    // 数据源配置
  64.  
    DataSourceConfig dsc = new DataSourceConfig();
  65.  
    dsc.setUrl("jdbc:mysql://127.0.0.1:3306/mp?useUnicode=true&useSSL=false&characterEncoding=utf8");
  66.  
    // dsc.setSchemaName("public");
  67.  
    dsc.setDriverName("com.mysql.jdbc.Driver");
  68.  
    dsc.setUsername("root");
  69.  
    dsc.setPassword("root");
  70.  
    mpg.setDataSource(dsc);
  71.  
     
  72.  
    // 包配置
  73.  
    PackageConfig pc = new PackageConfig();
  74.  
    pc.setModuleName(scanner("模块名"));
  75.  
    pc.setParent("cn.itcast.mp.generator");
  76.  
    mpg.setPackageInfo(pc);
  77.  
     
  78.  
    // 自定义配置
  79.  
    InjectionConfig cfg = new InjectionConfig() {
  80.  
    @Override
  81.  
    public void initMap() {
  82.  
    // to do nothing
  83.  
    }
  84.  
    };
  85.  
    List<FileOutConfig> focList = new ArrayList<>();
  86.  
    focList.add(new FileOutConfig("/templates/mapper.xml.ftl") {
  87.  
    @Override
  88.  
    public String outputFile(TableInfo tableInfo) {
  89.  
    // 自定义输入文件名称
  90.  
    return projectPath "/itcast-mp-generator/src/main/resources/mapper/" pc.getModuleName()
  91.  
    "/" tableInfo.getEntityName() "Mapper" StringPool.DOT_XML;
  92.  
    }
  93.  
    });
  94.  
    cfg.setFileOutConfigList(focList);
  95.  
    mpg.setCfg(cfg);
  96.  
    mpg.setTemplate(new TemplateConfig().setXml(null));
  97.  
     
  98.  
    // 策略配置
  99.  
    StrategyConfig strategy = new StrategyConfig();
  100.  
    strategy.setNaming(NamingStrategy.underline_to_camel);
  101.  
    strategy.setColumnNaming(NamingStrategy.underline_to_camel);
  102.  
    // strategy.setSuperEntityClass("com.baomidou.mybatisplus.samples.generator.common.BaseEntity");
  103.  
    strategy.setEntityLombokModel(true);
  104.  
    // strategy.setSuperControllerClass("com.baomidou.mybatisplus.samples.generator.common.BaseController");
  105.  
    strategy.setInclude(scanner("表名"));
  106.  
    strategy.setSuperEntityColumns("id");
  107.  
    strategy.setControllerMappingHyphenStyle(true);
  108.  
    strategy.setTablePrefix(pc.getModuleName() "_");
  109.  
    mpg.setStrategy(strategy);
  110.  
    // 选择 freemarker 引擎需要指定如下加,注意 pom 依赖必须有!
  111.  
    mpg.setTemplateEngine(new FreemarkerTemplateEngine());
  112.  
    mpg.execute();
  113.  
    }
  114.  
     
  115.  
    }
学新通

十五、MybatisX 快速开发插件

        MybatisX 是一款基于 IDEA 的快速开发插件,为效率而生。

        安装方法:打开 IDEA,进入 File -> Settings -> Plugins -> Browse Repositories,输入 mybatisx 搜索并安装。

        功能: Java 与 XML 调回跳转 Mapper 方法自动生成 XML

这篇好文章是转载于:学新通技术网

  • 版权申明: 本站部分内容来自互联网,仅供学习及演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系,请提供相关证据及您的身份证明,我们将在收到邮件后48小时内删除。
  • 本站站名: 学新通技术网
  • 本文地址: /boutique/detail/tanhgigaga
系列文章
更多 icon
同类精品
更多 icon
继续加载