Mybatis-Plus學(xué)習(xí)總結(jié)（建議收藏）

DROP TABLE IF EXISTS user;

CREATE TABLE user
(
 id BIGINT(20) NOT NULL COMMENT '主鍵ID',
 name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
 age INT(11) NULL DEFAULT NULL COMMENT '年齡',
 email VARCHAR(50) NULL DEFAULT NULL COMMENT '郵箱',
 PRIMARY KEY (id)
);
-- 真實(shí)開發(fā)中，version（樂(lè)觀鎖），deleted（邏輯刪除）、gmt_create、gem_mo


DELETE FROM user;

INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, '[email protected]'),
(2, 'Jack', 20, '[email protected]'),
(3, 'Tom', 28, '[email protected]'),
(4, 'Sandy', 21, '[email protected]'),
(5, 'Billie', 24, '[email protected]');

<?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>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.4.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <groupId>com.ly</groupId>
    <artifactId>mybatis-plus</artifactId>
    <version>1.0-SNAPSHOT</version>
    <name>mybatis-plus</name>
    <description>Demo project for Spring Boot</description>
    
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>

        <!--mybatis-plus 是自己開發(fā)的，非官方的！-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.3.1.tmp</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

spring:
  #配置數(shù)據(jù)源
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf-8
    username: root
    password: 123456

#配置日志，我們所用的sql現(xiàn)在是不可見的，我們希望知道他是怎么執(zhí)行的，所以我們必須要查看日志！
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

//在對(duì)應(yīng)的Mapper上繼承基本的類baseMapper
public interface UserMapper extends BaseMapper<User> {
    //所有的CRUD已經(jīng)編寫完成
    //不需要像以前的配置一些xml

}

@SpringBootApplication
@MapperScan("com.ly.mapper")//掃描mapper文件夾
public class MybatisPlusApplication {

    public static void main(String[] args) {
        SpringApplication.run(MybatisPlusApplication.class, args);
    }

}

@RunWith(SpringRunner.class)
@SpringBootTest
public class MybatisPlusTest {

    //繼承了BaseMapper，所有方法都來(lái)自父類
    //我們可以編寫自己的拓展方法
    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect() {
        System.out.println(("----- selectAll method test ------"));
        //參數(shù)是一個(gè)Wrapper，條件結(jié)構(gòu)器，這里先不用 填null
        //查詢所有的用戶 
        List<User> userList = userMapper.selectList(null);
        userList.forEach(System.out::println);
    }

}

@Test
public void testInsert() {

    User user = new User();
    user.setName("LY");
    user.setAge(100);
    user.setEmail("[email protected]");

    int result = userMapper.insert(user);  //幫我們生成id
    System.out.println(result);      //受影響的行數(shù)
    System.out.println(user);       //發(fā)現(xiàn)id會(huì)自動(dòng)回填
}

public enum IdType {
    AUTO(0),   //數(shù)據(jù)可id自增
    NONE(1),   //未設(shè)置主鍵
    INPUT(2),   //手動(dòng)輸入
    ID_WORKER(3), //默認(rèn)的全局唯一id
    UUID(4),  //全局唯一id uuid
    ID_WORKER_STR(5); // ID_WORKEK 字符串表示法

    private int key;

    private IdType(int key) {
        this.key = key;
    }

    public int getKey() {
        return this.key;
    }
}

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


#參數(shù)說(shuō)明
類型     參數(shù)名         描述
T     entity         實(shí)體對(duì)象 (set 條件值,可為 null)
Wrapper updateWrapper 實(shí)體對(duì)象封裝操作類（可以為 null,里面的 entity 用于生成 where 語(yǔ)句）

@Test
public void testUpdate() {
    //sql自動(dòng)動(dòng)態(tài)配置
    User user = new User();
    user.setName=("ZZ");
    user.setId(3L);
    user.setAge("50");
    
    //注意：updateById的參數(shù)是一個(gè)對(duì)象
    userMapper.updateById(user);
}

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;
    
 //創(chuàng)建時(shí)間,插入數(shù)據(jù)時(shí)操作
 @TableField(fill = FieldFill.INSERT)
 private Date createTime; 
 //更新時(shí)間，插入和更新是操作
 @TableField(fill = FieldFill.INSERT_UPDATE)
 private Date updateTime;
}

@Slf4j
@Component //不要忘記吧處理器加到IOC容器中
public class MyMetaObjectHandler implements MetaObjectHandler {

    //插入時(shí)候的填充策略
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill ....");  //日志
        //設(shè)置字段的值（String fieldName字段名,Object fieldVal要傳遞的值,MetaObject metaObject)
        this.setFieldValByName("createTime",new Date(),metaObject);
        this.setFieldValByName("updateTime",new Date(),metaObject);
        
    }

    //更新時(shí)間的填充策略
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start update fill ....");
        this.setFieldValByName("updateTime",new Date(),metaObject);
        
    }
}

樂(lè)觀鎖：1、先查詢，獲得版本號(hào) version=1
--A
update user set name ="shuishui" ,version =version+1
where id =2 and version=1

--B 如果線程搶先完成，這個(gè)時(shí)候version=2，會(huì)導(dǎo)致A修改失敗
update user set name ="shuishui" ,version =version+1
where id =2 and version=1

@Version //樂(lè)觀鎖Version注解
private Integer version;

@EnableTransactionManagement
@MapperScan("com.ly.mapper")
@Configuration//配置類
public class MyBatisPlusConfig{
    //注冊(cè)樂(lè)觀鎖插件
    @Bean
 public OptimisticLockerInterceptor optimisticLockerInterceptor() {
     return new OptimisticLockerInterceptor();
 }
}

//測(cè)試樂(lè)觀鎖成功
@Test
public void testOptimisticLocker(){
    //1、查詢用戶信息
    User user = userMapper.selectById(1L);
    //2、修改用戶信息
    user.setName("LZY");
    user.setEmail("[email protected]");
    //執(zhí)行更新操作
    userMapper.updateById(user);
}

//測(cè)試樂(lè)觀鎖失敗
@Test
public void testOptimisticLocker2(){
    //1、查詢用戶信息
    User user = userMapper.selectById(1L);
    //2、修改用戶信息
    user.setName("LZY1");
    user.setEmail("[email protected]");

    //1、模擬另一個(gè)線程執(zhí)行了插隊(duì)操作
    User user2 = userMapper.selectById(1L);
    //2、修改用戶信息
    user2.setName("LZY2");
    user2.setEmail("[email protected]");

    //執(zhí)行更新操作
    userMapper.updateById(user2);

    //執(zhí)行更新操作
    userMapper.updateById(user); //如果沒(méi)有樂(lè)觀鎖就會(huì)覆蓋插隊(duì)線程的值
}

@Test
public void testSelectById(){
    User user =userMapper.selectById(1);
    System.out.println(user);
}

//測(cè)試批量查詢
@Test
public void testSelectByBatchId(){
    List<User> users =userMapper.selectBatchIds(Arrays.asList(1,2,3));
    users.forEach(System.out::println);
}

//條件查詢
public void testSelectByBatchIds(){
    HashMap<String,Object> map=new HashMap<>();
    //自定義查詢
    map.put("name","LZY");
    map.put("age",18);

    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

@EnableTransactionManagement
@Configuration
@MapperScan("com.ly.mapper")
public class MybatisPlusConfig {

    @Bean
    public PaginationInterceptor paginationInterceptor() {
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
        // 設(shè)置請(qǐng)求的頁(yè)面大于最大頁(yè)后操作， true調(diào)回到首頁(yè)，false 繼續(xù)請(qǐng)求  默認(rèn)false
        // paginationInterceptor.setOverflow(false);
        // 設(shè)置最大單頁(yè)限制數(shù)量，默認(rèn) 500 條，-1 不受限制
        // paginationInterceptor.setLimit(500);
        // 開啟 count 的 join 優(yōu)化,只針對(duì)部分 left join
        paginationInterceptor.setCountSqlParser(new JsqlParserCountOptimize(true));
        return paginationInterceptor;
    }
}

//測(cè)試分頁(yè)查詢
@Test
public void testPage(){
    // 參數(shù)一：當(dāng)前頁(yè)
    // 參數(shù)二：頁(yè)面大小
    // 使用了分頁(yè)插件之后，所有的分頁(yè)操作也變得簡(jiǎn)單了
    Page<User> page =new Page<>(2,5);
    userMapper.selectPage(page,null);

    page.getRecords().forEach(System.out::println);
    //獲取總數(shù)
    page.getTotal();
}

@Test
public void testDeleteById(){
    userMapper.deleteById(1);
}

//批量刪除
@Test
public void testDeleteBatchId(){
    userMapper.deleteBatchIds(Arrays.asList(1,2));
}

//條件刪除
@Test
public void testDeleteMap(){
    HashMap<String,Object> map = new HashMap<>();
    map.put("name","LZY");
    userMapper.deleteByMap(map);
}

@TableLogic  //3.1.1開始可以不用這一步，但如果實(shí)體類上有 @TableLogic 則以實(shí)體上的為準(zhǔn)，忽略全局
private Integer deleted;

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: flag  #全局邏輯刪除字段值 3.3.0開始支持，詳情看下面。
      logic-delete-value: 1     # 邏輯已刪除值(默認(rèn)為 1)
      logic-not-delete-value: 0 # 邏輯未刪除值(默認(rèn)為 0)

@Test
public void findByAgeLessThan(){
    // 查詢name不為null的用戶，并且郵箱不為null的永不，年齡大于等于35的用戶
    QueryWrapper<User> wrapper =new QueryWrapper<>();
    wrapper.isNotNull("name");
    wrapper.isNotNull("email");
    wrapper.ge("age",35);
    userMapper.selectList(wrapper).forEach(System.out::println);
}

@Test
public void findByName(){
    // 查詢name為L(zhǎng)ZY的用戶
    QueryWrapper<User> wrapper =new QueryWrapper<>();
    wrapper.eq("name","LY");
    User user=userMapper.selectOne(wrapper);
    System.out.println(user);
}

@Test
public void findByAgeBetween(){
    // 查詢年齡在10~30歲之間的用戶
    QueryWrapper<User> wrapper =new QueryWrapper<>();
    wrapper.between("age",10,30);
    Integer count =userMapper.selectCount(wrapper);//查詢結(jié)果數(shù)
    System.out.println(count);
}

//模糊查詢
@Test
public void findByLink(){
    QueryWrapper<User> wrapper =new QueryWrapper<>();

    wrapper.notLike("name","Z");//相當(dāng)于NOT LIKE '%Z%'
    wrapper.likeLeft("email","@qq.com");//相當(dāng)于LIKE '%@qq.com'
    List<Map<String,Object>> maps =userMapper.selectMaps(wrapper);//查詢結(jié)果數(shù)
    maps.forEach(System.out::println);
}

@Test
public void findById() {
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //子查詢
    wrapper.inSql("id", "select id from user where id<5");
    List<Object> objects = userMapper.selectObjs(wrapper);
    objects.forEach(System.out::println);
}

@Test
public void findByIdOrderByIdAsc(){
    QueryWrapper<User> wrapper =new QueryWrapper<>();
    //通過(guò)id進(jìn)行排序
    wrapper.orderByAsc("id");
    List<User> users =userMapper.selectList(wrapper);
    users.forEach(System.out::println);
}

<!--在之前pom.xml文件的基礎(chǔ)上添加-->
<!--代碼生成器依賴.3.0.3以后需要添加該依賴-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.3.1</version>
</dependency>
<!--默認(rèn)的模板引擎velocity-->
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.3</version>
</dependency>

spring:
  #配置數(shù)據(jù)源
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf-8
    username: root
    password: 123456
  #設(shè)置開發(fā)環(huán)境
  profiles:
    active: dev
#配置日志，我們所用的sql現(xiàn)在是不可見的，我們希望知道他是怎么執(zhí)行的，所以我們必須要查看日志！
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  global-config:
    db-config:
      logic-delete-field: flag  # 全局邏輯刪除的實(shí)體字段名(since 3.3.0,配置后可以忽略不配置步驟2)
      logic-delete-value: 1 # 邏輯已刪除值(默認(rèn)為 1)
      logic-not-delete-value: 0 # 邏輯未刪除值(默認(rèn)為 0)
server:
  port: 8010

/**
 * @Author: Ly
 * @Date: 2021-04-16 09:06
 */
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;

import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import java.util.ArrayList;

// 代碼自動(dòng)生成器
public class MyBatisPlusGenerator {
    public static void main(String[] args) {
        // 需要構(gòu)建一個(gè) 代碼自動(dòng)生成器 對(duì)象
        AutoGenerator mpg = new AutoGenerator();
        // 配置策略
        // 1、全局配置
        GlobalConfig gc = new GlobalConfig();
        //獲取當(dāng)前項(xiàng)目路徑
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath+"/src/main/java");
        gc.setAuthor("龍?jiān)磍ll");
        gc.setOpen(false);
        gc.setFileOverride(false);  // 是否覆蓋
        gc.setServiceName("%sService"); // 去Service的I前綴
        gc.setIdType(IdType.AUTO);
        gc.setDateType(DateType.ONLY_DATE);
        gc.setSwagger2(true);
        mpg.setGlobalConfig(gc);

        //2、設(shè)置數(shù)據(jù)源
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf-8");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("520992");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);

        //3、包的配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("blog");
        pc.setParent("com.ly");
        pc.setEntity("entity");
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setController("controller");
        mpg.setPackageInfo(pc);

        //4、策略配置
        StrategyConfig strategy = new StrategyConfig();
        //strategy.setInclude("table1","table2",...); // 設(shè)置要映射的表名
        strategy.setInclude("user"); // 設(shè)置要映射的表名
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        // 自動(dòng)lombok
        strategy.setEntityLombokModel(true);
        strategy.setLogicDeleteFieldName("deleted");
        // 自動(dòng)填充配置
        TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
        TableFill gmtModified = new TableFill("gmt_modified", FieldFill.INSERT_UPDATE);
        ArrayList<TableFill> tableFills = new ArrayList<>();
        tableFills.add(gmtCreate);
        tableFills.add(gmtModified);
        strategy.setTableFillList(tableFills);
        // 樂(lè)觀鎖
        strategy.setVersionFieldName("version");
        strategy.setRestControllerStyle(true);
        strategy.setControllerMappingHyphenStyle(true);
        // localhost:8080/hello_id_2
        mpg.setStrategy(strategy);
        mpg.execute();
        //執(zhí)行
    }
}