Mybatis-Plus的使用詳解

一、準備工作

1、導入相關依賴

   	<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
 	<dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
    //Mybatis-Plus依賴
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.1.1</version>
    </dependency>

2、文件目錄結構

在這裏插入圖片描述
User類

@Data
public class User {
    private int id;
    private String name;
    private int age;
    private String email;

	//用於Mybatis-Plus自動填充功能
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;

    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;
}

UserMapper接口

@Repository
public interface UserMapper extends BaseMapper<User> {

}

測試insert

@RunWith(SpringRunner.class)
@SpringBootTest
public class CRUDTests {
    @Autowired
    private UserMapper userMapper;
    
    @Test
    public void testInsert(){
        User user = new User();
        user.setName("Helen");
        user.setAge(18);
        user.setEmail("[email protected]");
        
        int result = userMapper.insert(user);
        System.out.println(result); //影響的行數
        System.out.println(user); //id自動回填
    }
}

注意:數據庫插入id值默認爲:全局唯一id
在這裏插入圖片描述

3、主鍵策略

(1)ID_WORKER

 MyBatis-Plus默認的主鍵策略是:ID_WORKER 全局唯一ID
 參考資料:分佈式系統唯一ID生成方案彙總:https://www.cnblogs.com/haoxinyue/p/5208136.html

(2)自增策略
要想主鍵自增需要配置如下主鍵策略

1 @TableId(type = IdType.AUTO)
2 private Long id;

要想影響所有實體的配置,可以設置全局主鍵配置

1 #全局設置主鍵生成策略
2 mybatis-plus.global-config.db-config.id-type=auto

其它主鍵策略:分析 IdType 源碼可知

@Getter
public enum IdType {
    /**
     * 數據庫ID自增
     */
    AUTO(0),
    /**
     * 該類型爲未設置主鍵類型
     */
    NONE(1),
    /**
     * 用戶輸入ID
     * 該類型可以通過自己註冊自動填充插件進行填充
     */
    INPUT(2),
    
	/* 以下3種類型、只有當插入對象ID 爲空,才自動填充。 */
	/**
	 * 全局唯一ID (idWorker)
	 */
	ID_WORKER(3),
	/**
	 * 全局唯一ID (UUID)
	 */
	UUID(4),
	/**
	 * 字符串全局唯一ID (idWorker 的字符串表示)
	 */
	ID_WORKER_STR(5);
	
	private int key;
	
	IdType(int key) {
	    this.key = key;
	}
}

3、update
(1) 根據Id更新操作
注意:update時生成的sql自動是動態sql:UPDATE user SET age=? WHERE id=?
在這裏插入圖片描述
(2)、自動填充

項目中經常會遇到一些數據,每次都使用相同的方式填充,例如記錄的創建時間,更新時間等。
我們可以使用MyBatis Plus的自動填充功能,完成這些字段的賦值工作:

數據庫表中添加自動填充字段
在User表中添加datetime類型的新的字段 create_time、update_time
實體上添加註解

@Data
public class User {
    ...

    @TableField(fill = FieldFill.INSERT)
    private Date createTime;

    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;
}

實現元對象處理器接口
注意:不要忘記添加 @Component 註解

@Component
public class MyMetaObjectHandler implements   MetaObjectHandler {

    private static final Logger logger = LoggerFactory.getLogger(MetaObjectHandler.class);

    @Override
    public void insertFill(MetaObject metaObject) {
        logger.info("start insert fill ....");

        this.setFieldValByName("createTime", new Date(), metaObject);

        this.setFieldValByName("updateTime", new Date(), metaObject);

    }

    @Override
    public void updateFill(MetaObject metaObject) {

        logger.info("start update fill ....");
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
}

④ 測試

(3)樂觀鎖
在這裏插入圖片描述
主要適用場景:當要更新一條記錄的時候,希望這條記錄沒有被別人更新,也就是說實現線程安全的數據更新
在這裏插入圖片描述
測試樂觀鎖
插入數據自動填充的時候設置版本初始值爲1

@Component
public class MyMetaObjectHandler implements   MetaObjectHandler {

    private static final Logger logger = LoggerFactory.getLogger(MetaObjectHandler.class);

    @Override
    public void insertFill(MetaObject metaObject) {
        logger.info("start insert fill ....");

        this.setFieldValByName("createTime", new Date(), metaObject);

        this.setFieldValByName("updateTime", new Date(), metaObject);

        this.setFieldValByName("version",1,metaObject);

    }
 //測試樂觀鎖(先查再改)
    @Test
    public void testOptimisticLocker() {
        User user = userMapper.selectById(7);
        user.setEmail("8999");

        userMapper.updateById(user);
    }

在這裏插入圖片描述

4、select

1、根據id查詢記錄
在這裏插入圖片描述
2、根據多個id批量查詢

 //測試根據多個id批量查詢
    @Test
    public void testSelectDemo1() {
        List<User> users = userMapper.selectBatchIds(Arrays.asList(1,2,3));
        System.out.println(users);

    }

3、分頁
MyBatis Plus自帶分頁插件,只要簡單的配置即可實現分頁功能
1)創建配置類
此時可以刪除主類中的 @MapperScan 掃描註解

@Configuration
@MapperScan("com.coderkun.mpdemo.mapper")
public class MpConfig {

    /*樂觀鎖插件*/
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor(){
        return new OptimisticLockerInterceptor();
    }

    /*分頁插件*/
    @Bean
    public PaginationInterceptor paginationInterceptor(){
        return new PaginationInterceptor();
    }
}

2)測試

//測試分頁
@Test
public void testPagination() {
    Page page = new Page(1,5);
    userMapper.selectPage(page,null);

    System.out.println(page.getCurrent());//當前第幾頁
    System.out.println(page.getRecords());//當前頁數據List集合
    System.out.println(page.getSize());//每頁顯示的記錄數
    System.out.println(page.getTotal());//總記錄數
    System.out.println(page.hasNext()); //是否有下一頁
    System.out.println(page.hasPrevious());//是否有上一頁

}

5、delete

(1)物理刪除

@Test
public void testDeleteById(){
    int result = userMapper.deleteById(8L);
    System.out.println(result);
}
 @Test
    public void testDeleteBatchIds() {
        int result = userMapper.deleteBatchIds(Arrays.asList(8, 9, 10));
        System.out.println(result);
    }

(2)邏輯刪除
① 數據庫中添加 deleted字段

ALTER TABLE `user` ADD COLUMN `deleted` boolean

② 實體類添加deleted 字段
並加上 @TableLogic 註解 和 @TableField(fill = FieldFill.INSERT) 註解

@Data
public class User {
    private int id;
    private String name;
    private int age;
    private String email;
    //版本號
    @Version
    @TableField(fill = FieldFill.INSERT)
    private Integer version;

    @TableField(fill = FieldFill.INSERT)
    private Date createTime;

    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

    @TableLogic  //邏輯刪除
    @TableField(fill = FieldFill.INSERT)
    private Boolean deleted;
}

③ 元對象處理器接口添加deleted的insert默認值

@Component
public class MyMetaObjectHandler implements   MetaObjectHandler {

    private static final Logger logger = LoggerFactory.getLogger(MetaObjectHandler.class);

    @Override
    public void insertFill(MetaObject metaObject) {
        logger.info("start insert fill ....");

       .........

        this.setFieldValByName("deleted", false, metaObject);


    }

    @Override
    public void updateFill(MetaObject metaObject) {

        logger.info("start update fill ....");
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
}

④ application.properties 加入配置

mybatis-plus.global-config.db-config.logic-delete-value=1

mybatis-plus.global-config.db-config.logic-not-delete-value=0

⑤ 在 MybatisPlusConfig 中註冊 Bean

@Bean
 public ISqlInjector sqlInjector() {
    return new LogicSqlInjector();
}

⑥ 測試邏輯刪除
測試後發現,數據並沒有被刪除,deleted字段的值由0變成了1
測試後分析打印的sql語句,是一條update
注意:被刪除數據的deleted 字段的值必須是 0,才能被選取出來執行邏輯刪除的操作

  /*邏輯刪除*/
    @Test
    public void testLoginDelete(){
        int result = userMapper.deleteById(10);
        System.out.println(result);

    }

⑦測試邏輯刪除後的查詢
MyBatis Plus中查詢操作也會自動添加邏輯刪除字段的判斷

   /*邏輯刪除後的查詢*/
    @Test
    public void testFindAllAfterLogigDel(){
        System.out.println(userMapper.selectList(null));

    }

測試後分析打印的sql語句,包含 WHERE deleted=0

SELECT id,name,age,email,create_time,update_time,deleted FROM user WHERE deleted=0

二、性能分析

性能分析攔截器,用於輸出每條 SQL 語句及其執行時間
SQL 性能執行分析,開發環境使用,超過指定時間,停止運行。有助於發現問題

1、配置插件

(1)參數說明
參數:maxTime: SQL 執行最大時長,超過自動停止運行,有助於發現問題。
參數:format: SQL是否格式化,默認false。

(2)在 MybatisPlusConfig 中配置

   /**
     * SQL 執行性能分析插件
     * 開發環境使用,線上不推薦。 maxTime 指的是 sql 最大執行時長
     */
    @Bean
    @Profile({"dev","test"})// 設置 dev test 環境開啓
    public PerformanceInterceptor performanceInterceptor(){
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        performanceInterceptor.setMaxTime(100); //ms,超過此處設置的ms則sql不執行
        performanceInterceptor.setFormat(true);
        return performanceInterceptor;
    }

(3)Spring Boot 中設置dev環境

#環境設置:dev、test、prod
spring.profiles.active=dev

可以針對各環境新建不同的配置文件application-dev.properties、application-test.properties、application-prod.properties,也可以自定義環境名稱:如test1、test2。

2、測試

(1)常規測試

   @Test
    public void insert() {
        User user = new User();
        user.setName("哈哈哈哈哈");
        user.setAge(888);
        user.setEmail("[email protected]");

        userMapper.insert(user);
    }

輸出:
在這裏插入圖片描述

三、MybatisPlus-Generator便捷生成代碼

public class CodeGenerator {

    @Test
    public void run() {

        // 1、創建代碼生成器
        AutoGenerator mpg = new AutoGenerator();

        // 2、全局配置
        GlobalConfig gc = new GlobalConfig();
//        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir("F:\\spignboot_Idea\\guli_parent\\service\\service-edu" + "/src/main/java");
        gc.setAuthor("testjava");
        gc.setOpen(false); //生成後是否打開資源管理器
        gc.setFileOverride(false); //重新生成時文件是否覆蓋

        gc.setServiceName("%sService");	//去掉Service接口的首字母I
        gc.setIdType(IdType.ID_WORKER_STR); //主鍵策略(主鍵類型爲Long爲ID_WORKER,爲String爲ID_WORKER_STR(char也是)
        gc.setDateType(DateType.ONLY_DATE);//定義生成的實體類中日期類型
        gc.setSwagger2(true);//開啓Swagger2模式

        mpg.setGlobalConfig(gc);

        // 3、數據源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/gulimall?serverTimezone=GMT%2B8");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("123456");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);

        // 4、包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("eduservice"); //模塊名
        pc.setParent("com.coderkun");
        pc.setController("controller");
        pc.setEntity("entity");
        pc.setService("service");
        pc.setMapper("mapper");
        mpg.setPackageInfo(pc);

        // 5、策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setInclude("edu_teacher");  //對應的表名
        strategy.setNaming(NamingStrategy.underline_to_camel);//數據庫表映射到實體的命名策略
        strategy.setTablePrefix(pc.getModuleName() + "_"); //生成實體時去掉表前綴

        strategy.setColumnNaming(NamingStrategy.underline_to_camel);//數據庫表字段映射到實體的命名策略
        strategy.setEntityLombokModel(true); // lombok 模型 @Accessors(chain = true) setter鏈式操作

        strategy.setRestControllerStyle(true); //restful api風格控制器
        strategy.setControllerMappingHyphenStyle(true); //url中駝峯轉連字符

        mpg.setStrategy(strategy);


        // 6、執行
        mpg.execute();
    }
}
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章