Mybatis-Plus入门之通用CRUD+基本配置介绍
1、了解Mybatis-Plus
1.1、Mybatis-Plus介紹
MyBatis-Plus(簡稱 MP)是一個 MyBatis 的增強工具,在 MyBatis 的基礎(chǔ)上只做增強不做改變,為簡化開發(fā)、提高效率而生。
官網(wǎng):https://mybatis.plus/ 或 https://mp.baomidou.com/
?
愿景
我們的愿景是成為 MyBatis 最好的搭檔,就像 魂斗羅 中的 1P、2P,基友搭配,效率翻倍。
?
1.2、代碼以及文檔
文檔地址:https://mybatis.plus/guide/
源碼地址:https://github.com/baomidou/mybatis-plus
1.3、特性
-
無侵入:只做增強不做改變,引入它不會對現(xiàn)有工程產(chǎn)生影響,如絲般順滑
-
損耗小:啟動即會自動注入基本 CURD,性能基本無損耗,直接面向?qū)ο蟛僮?/p>
-
強大的 CRUD 操作:內(nèi)置通用 Mapper、通用 Service,僅僅通過少量配置即可實現(xiàn)單表大部分 CRUD 操作,更有強大的條件構(gòu)造器,滿足各類使用需求
-
支持 Lambda 形式調(diào)用:通過 Lambda 表達(dá)式,方便的編寫各類查詢條件,無需再擔(dān)心字段寫錯
-
支持多種數(shù)據(jù)庫:支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer2005、SQLServer 等多種數(shù)據(jù)庫
-
支持主鍵自動生成:支持多達(dá) 4 種主鍵策略(內(nèi)含分布式唯一 ID 生成器 - Sequence),可自由配置,完美解決主鍵問題
-
支持 XML 熱加載:Mapper 對應(yīng)的 XML 支持熱加載,對于簡單的 CRUD 操作,甚至可以無 XML 啟動
-
支持 ActiveRecord 模式:支持 ActiveRecord 形式調(diào)用,實體類只需繼承 Model 類即可進行強大的 CRUD 操作
-
支持自定義全局通用操作:支持全局通用方法注入( Write once, use anywhere )
-
支持關(guān)鍵詞自動轉(zhuǎn)義:支持?jǐn)?shù)據(jù)庫關(guān)鍵詞(order、key......)自動轉(zhuǎn)義,還可自定義關(guān)鍵詞
-
內(nèi)置代碼生成器:采用代碼或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 層代碼,支持模板引擎,更有超多自定義配置等您來使用
-
內(nèi)置分頁插件:基于 MyBatis 物理分頁,開發(fā)者無需關(guān)心具體操作,配置好插件之后,寫分頁等同于普通 List 查詢
-
內(nèi)置性能分析插件:可輸出 Sql 語句以及其執(zhí)行時間,建議開發(fā)測試時啟用該功能,能快速揪出慢查詢
-
內(nèi)置全局?jǐn)r截插件:提供全表 delete 、 update 操作智能分析阻斷,也可自定義攔截規(guī)則,預(yù)防誤操作
-
內(nèi)置 Sql 注入剝離器:支持 Sql 注入剝離,有效預(yù)防 Sql 注入攻擊
1.4、架構(gòu)
?
1.5、作者
Mybatis-Plus是由baomidou(苞米豆)組織開發(fā)并且開源的,目前該組織大概有30人左右。
碼云地址:https://gitee.com/organizations/baomidou
?
2、快速開始
對于Mybatis整合MP有常常有三種用法,分別是Mybatis+MP、Spring+Mybatis+MP、Spring Boot+Mybatis+MP。
2.1、創(chuàng)建數(shù)據(jù)庫以及表
?
-- 創(chuàng)建測試表 CREATE TABLE `tb_user` (`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主鍵ID',`user_name` varchar(20) NOT NULL COMMENT '用戶名',`password` varchar(20) NOT NULL COMMENT '密碼',`name` varchar(30) DEFAULT NULL COMMENT '姓名',`age` int(11) DEFAULT NULL COMMENT '年齡',`email` varchar(50) DEFAULT NULL COMMENT '郵箱',PRIMARY KEY (`id`) ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8; ? -- 插入測試數(shù)據(jù) INSERT INTO `tb_user` (`id`, `user_name`, `password`, `name`, `age`, `email`) VALUES ('1', 'zhangsan', '123456', '張三', '18', 'test1@itcast.cn'); INSERT INTO `tb_user` (`id`, `user_name`, `password`, `name`, `age`, `email`) VALUES ('2', 'lisi', '123456', '李四', '20', 'test2@itcast.cn'); INSERT INTO `tb_user` (`id`, `user_name`, `password`, `name`, `age`, `email`) VALUES ('3', 'wangwu', '123456', '王五', '28', 'test3@itcast.cn'); INSERT INTO `tb_user` (`id`, `user_name`, `password`, `name`, `age`, `email`) VALUES ('4', 'zhaoliu', '123456', '趙六', '21', 'test4@itcast.cn'); INSERT INTO `tb_user` (`id`, `user_name`, `password`, `name`, `age`, `email`) VALUES ('5', 'sunqi', '123456', '孫七', '24', 'test5@itcast.cn');2.2、創(chuàng)建工程
?
導(dǎo)入依賴:
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion> ?<groupId>cn.itcast.mp</groupId><artifactId>itcast-mybatis-plus</artifactId><version>1.0-SNAPSHOT</version><modules><module>itcast-mybatis-plus-simple</module></modules><packaging>pom</packaging> ?<dependencies><!-- mybatis-plus插件依賴 --><dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus</artifactId><version>3.1.1</version></dependency><!-- MySql --><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>5.1.47</version></dependency><!-- 連接池 --><dependency><groupId>com.alibaba</groupId><artifactId>druid</artifactId><version>1.0.11</version></dependency><!--簡化bean代碼的工具包--><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional><version>1.18.4</version></dependency><dependency><groupId>junit</groupId><artifactId>junit</artifactId><version>4.12</version></dependency><dependency><groupId>org.slf4j</groupId><artifactId>slf4j-log4j12</artifactId><version>1.6.4</version></dependency></dependencies> ?<build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId><configuration><source>1.8</source><target>1.8</target></configuration></plugin></plugins></build> ? </project>2.3、Mybatis + MP
下面演示,通過純Mybatis與Mybatis-Plus整合。
2.3.1、創(chuàng)建子Module
<?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"><parent><artifactId>itcast-mybatis-plus</artifactId><groupId>cn.itcast.mp</groupId><version>1.0-SNAPSHOT</version></parent><modelVersion>4.0.0</modelVersion><packaging>jar</packaging> ?<artifactId>itcast-mybatis-plus-simple</artifactId> ? </project>log4j.properties:
log4j.rootLogger=DEBUG,A1 ? log4j.appender.A1=org.apache.log4j.ConsoleAppender log4j.appender.A1.layout=org.apache.log4j.PatternLayout log4j.appender.A1.layout.ConversionPattern=[%t] [%c]-[%p] %m%n2.3.2、Mybatis實現(xiàn)查詢User
第一步,編寫mybatis-config.xml文件:
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE configurationPUBLIC "-//mybatis.org//DTD Config 3.0//EN""http://mybatis.org/dtd/mybatis-3-config.dtd"> <configuration><environments default="development"><environment id="development"><transactionManager type="JDBC"/><dataSource type="POOLED"><property name="driver" value="com.mysql.jdbc.Driver"/><property name="url" value="jdbc:mysql://127.0.0.1:3306/mp?useUnicode=true&characterEncoding=utf8&autoReconnect=true&allowMultiQueries=true&useSSL=false"/><property name="username" value="root"/><property name="password" value="root"/></dataSource></environment></environments><mappers><mapper resource="UserMapper.xml"/></mappers> </configuration>第二步,編寫User實體對象:(這里使用lombok進行了進化bean操作)
package cn.itcast.mp.simple.pojo; ? import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; ? @Data @NoArgsConstructor @AllArgsConstructor public class User { ?private Long id;private String userName;private String password;private String name;private Integer age;private String email; } ?第三步,編寫UserMapper接口:
package cn.itcast.mp.simple.mapper; ? import cn.itcast.mp.simple.pojo.User; ? import java.util.List; ? public interface UserMapper { ?List<User> findAll(); ? }第四步,編寫UserMapper.xml文件:
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="cn.itcast.mp.simple.mapper.UserMapper"> ?<select id="findAll" resultType="cn.itcast.mp.simple.pojo.User">select * from tb_user</select> ? </mapper>第五步,編寫TestMybatis測試用例:
public class TestMybatis {@Testpublic void testUserList() throws Exception{String resource = "mybatis-config.xml";InputStream inputStream = Resources.getResourceAsStream(resource);SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);SqlSession sqlSession = sqlSessionFactory.openSession();UserMapper userMapper = sqlSession.getMapper(UserMapper.class);List<User> list = userMapper.findAll();for (User user : list) {System.out.println(user);}}}測試結(jié)果:
[main] [cn.itcast.mp.simple.mapper.UserMapper.findAll]-[DEBUG] ==> Parameters: [main] [cn.itcast.mp.simple.mapper.UserMapper.findAll]-[DEBUG] <== Total: 5 User(id=1, userName=null, password=123456, name=張三, age=18, email=test1@itcast.cn) User(id=2, userName=null, password=123456, name=李四, age=20, email=test2@itcast.cn) User(id=3, userName=null, password=123456, name=王五, age=28, email=test3@itcast.cn) User(id=4, userName=null, password=123456, name=趙六, age=21, email=test4@itcast.cn) User(id=5, userName=null, password=123456, name=孫七, age=24, email=test5@itcast.cn)2.3.3、Mybatis+MP實現(xiàn)查詢User
第一步,將UserMapper繼承BaseMapper,將擁有了BaseMapper中的所有方法:
package cn.itcast.mp.simple.mapper;import cn.itcast.mp.simple.pojo.User; import com.baomidou.mybatisplus.core.mapper.BaseMapper;import java.util.List;public interface UserMapper extends BaseMapper<User> {List<User> findAll();}第二步,使用MP中的MybatisSqlSessionFactoryBuilder進程構(gòu)建:
package cn.itcast.mp.simple;import cn.itcast.mp.simple.mapper.UserMapper; import cn.itcast.mp.simple.pojo.User; import com.baomidou.mybatisplus.core.MybatisSqlSessionFactoryBuilder; import org.apache.ibatis.io.Resources;import org.apache.ibatis.session.SqlSession; import org.apache.ibatis.session.SqlSessionFactory; import org.apache.ibatis.session.SqlSessionFactoryBuilder; import org.junit.Test;import java.io.InputStream; import java.util.List;public class TestMybatisPlus {@Testpublic void testUserList() throws Exception{String resource = "mybatis-config.xml";InputStream inputStream = Resources.getResourceAsStream(resource);//這里使用的是MP中的MybatisSqlSessionFactoryBuilderSqlSessionFactory sqlSessionFactory = new MybatisSqlSessionFactoryBuilder().build(inputStream);SqlSession sqlSession = sqlSessionFactory.openSession();UserMapper userMapper = sqlSession.getMapper(UserMapper.class);// 可以調(diào)用BaseMapper中定義的方法List<User> list = userMapper.selectList(null);for (User user : list) {System.out.println(user);}}}運行報錯:
解決:在User對象中添加@TableName,指定數(shù)據(jù)庫表名?
測試:
[main] [cn.itcast.mp.simple.mapper.UserMapper.selectList]-[DEBUG] ==> Preparing: SELECT id,user_name,password,name,age,email FROM tb_user [main] [cn.itcast.mp.simple.mapper.UserMapper.selectList]-[DEBUG] ==> Parameters: [main] [cn.itcast.mp.simple.mapper.UserMapper.selectList]-[DEBUG] <== ? ? Total: 5 User(id=1, userName=zhangsan, password=123456, name=張三, age=18, email=test1@itcast.cn) User(id=2, userName=lisi, password=123456, name=李四, age=20, email=test2@itcast.cn) User(id=3, userName=wangwu, password=123456, name=王五, age=28, email=test3@itcast.cn) User(id=4, userName=zhaoliu, password=123456, name=趙六, age=21, email=test4@itcast.cn) User(id=5, userName=sunqi, password=123456, name=孫七, age=24, email=test5@itcast.cn)簡單說明:
-
由于使用了MybatisSqlSessionFactoryBuilder進行了構(gòu)建,繼承的BaseMapper中的方法就載入到了SqlSession中,所以就可以直接使用相關(guān)的方法;
-
如圖:?
2.4、Spring + Mybatis + MP
引入了Spring框架,數(shù)據(jù)源、構(gòu)建等工作就交給了Spring管理。
2.4.1、創(chuàng)建子Module
<?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"><parent><artifactId>itcast-mybatis-plus</artifactId><groupId>cn.itcast.mp</groupId><version>1.0-SNAPSHOT</version></parent><modelVersion>4.0.0</modelVersion><artifactId>itcast-mybatis-plus-spring</artifactId><properties><spring.version>5.1.6.RELEASE</spring.version></properties><dependencies><dependency><groupId>org.springframework</groupId><artifactId>spring-webmvc</artifactId><version>${spring.version}</version></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-jdbc</artifactId><version>${spring.version}</version></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-test</artifactId><version>${spring.version}</version></dependency></dependencies></project>2.4.2、實現(xiàn)查詢User
第一步,編寫jdbc.properties
jdbc.driver=com.mysql.jdbc.Driver jdbc.url=jdbc:mysql://127.0.0.1:3306/mp?useUnicode=true&characterEncoding=utf8&autoReconnect=true&allowMultiQueries=true&useSSL=false jdbc.username=root jdbc.password=root第二步,編寫applicationContext.xml
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:context="http://www.springframework.org/schema/context"xsi:schemaLocation="http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans.xsdhttp://www.springframework.org/schema/contexthttp://www.springframework.org/schema/context/spring-context.xsd"><context:property-placeholder location="classpath:*.properties"/><!-- 定義數(shù)據(jù)源 --><bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource"destroy-method="close"><property name="url" value="${jdbc.url}"/><property name="username" value="${jdbc.username}"/><property name="password" value="${jdbc.password}"/><property name="driverClassName" value="${jdbc.driver}"/><property name="maxActive" value="10"/><property name="minIdle" value="5"/></bean><!--這里使用MP提供的sqlSessionFactory,完成了Spring與MP的整合--><bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean"><property name="dataSource" ref="dataSource"/></bean><!--掃描mapper接口,使用的依然是Mybatis原生的掃描器--><bean class="org.mybatis.spring.mapper.MapperScannerConfigurer"><property name="basePackage" value="cn.itcast.mp.simple.mapper"/></bean></beans>第三步,編寫User對象以及UserMapper接口:
package cn.itcast.mp.simple.pojo;import com.baomidou.mybatisplus.annotation.TableName; import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor;@Data @NoArgsConstructor @AllArgsConstructor @TableName("tb_user") public class User {private Long id;private String userName;private String password;private String name;private Integer age;private String email; } package cn.itcast.mp.simple.mapper;import cn.itcast.mp.simple.pojo.User; import com.baomidou.mybatisplus.core.mapper.BaseMapper;public interface UserMapper extends BaseMapper<User> {}第四步,編寫測試用例:
package cn.itcast.mp.simple;import cn.itcast.mp.simple.mapper.UserMapper; import cn.itcast.mp.simple.pojo.User; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;import java.util.List;@RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration(locations = "classpath:applicationContext.xml") public class TestSpringMP {@Autowiredprivate UserMapper userMapper;@Testpublic void testSelectList(){List<User> users = this.userMapper.selectList(null);for (User user : users) {System.out.println(user);}}}測試:
[main] [cn.itcast.mp.simple.mapper.UserMapper.selectList]-[DEBUG] ==> Preparing: SELECT id,user_name,password,name,age,email FROM tb_user [main] [cn.itcast.mp.simple.mapper.UserMapper.selectList]-[DEBUG] ==> Parameters: [main] [cn.itcast.mp.simple.mapper.UserMapper.selectList]-[DEBUG] <== Total: 5 [main] [org.mybatis.spring.SqlSessionUtils]-[DEBUG] Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@74287ea3] User(id=1, userName=zhangsan, password=123456, name=張三, age=18, email=test1@itcast.cn) User(id=2, userName=lisi, password=123456, name=李四, age=20, email=test2@itcast.cn) User(id=3, userName=wangwu, password=123456, name=王五, age=28, email=test3@itcast.cn) User(id=4, userName=zhaoliu, password=123456, name=趙六, age=21, email=test4@itcast.cn) User(id=5, userName=sunqi, password=123456, name=孫七, age=24, email=test5@itcast.cn)2.5、SpringBoot + Mybatis + MP
使用SpringBoot將進一步的簡化MP的整合,需要注意的是,由于使用SpringBoot需要繼承parent,所以需要重新創(chuàng)建工程,并不是創(chuàng)建子Module。
2.5.1、創(chuàng)建工程
2.5.2、導(dǎo)入依賴
<?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.1.4.RELEASE</version></parent> ?<groupId>cn.itcast.mp</groupId><artifactId>itcast-mp-springboot</artifactId><version>1.0-SNAPSHOT</version> ?<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter</artifactId><exclusions><exclusion><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-logging</artifactId></exclusion></exclusions></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency> ?<!--簡化代碼的工具包--><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional></dependency><!--mybatis-plus的springboot支持--><dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>3.1.1</version></dependency><!--mysql驅(qū)動--><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>5.1.47</version></dependency><dependency><groupId>org.slf4j</groupId><artifactId>slf4j-log4j12</artifactId></dependency> ?</dependencies> ?<build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin></plugins></build> ? </project>log4j.properties:
log4j.rootLogger=DEBUG,A1 ? log4j.appender.A1=org.apache.log4j.ConsoleAppender log4j.appender.A1.layout=org.apache.log4j.PatternLayout log4j.appender.A1.layout.ConversionPattern=[%t] [%c]-[%p] %m%n2.5.3、編寫application.properties
spring.application.name = itcast-mp-springboot ? spring.datasource.driver-class-name=com.mysql.jdbc.Driver spring.datasource.url=jdbc:mysql://127.0.0.1:3306/mp?useUnicode=true&characterEncoding=utf8&autoReconnect=true&allowMultiQueries=true&useSSL=false spring.datasource.username=root spring.datasource.password=root2.5.4、編寫pojo
package cn.itcast.mp.pojo;import com.baomidou.mybatisplus.annotation.TableName; import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor;@Data @NoArgsConstructor @AllArgsConstructor @TableName("tb_user") public class User {private Long id;private String userName;private String password;private String name;private Integer age;private String email; }2.5.5、編寫mapper
package cn.itcast.mp.mapper;import cn.itcast.mp.pojo.User; import com.baomidou.mybatisplus.core.mapper.BaseMapper;public interface UserMapper extends BaseMapper<User> { }2.5.6、編寫啟動類
package cn.itcast.mp;import org.mybatis.spring.annotation.MapperScan; import org.springframework.boot.SpringApplication; import org.springframework.boot.WebApplicationType; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.builder.SpringApplicationBuilder;@MapperScan("cn.itcast.mp.mapper") //設(shè)置mapper接口的掃描包 @SpringBootApplication public class MyApplication {public static void main(String[] args) {SpringApplication.run(MyApplication.class, args);}}2.5.7、編寫測試用例
package cn.itcast.mp;import cn.itcast.mp.mapper.UserMapper; import cn.itcast.mp.pojo.User; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner;import java.util.List;@RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest {@Autowiredprivate UserMapper userMapper;@Testpublic void testSelect() {List<User> userList = userMapper.selectList(null);for (User user : userList) {System.out.println(user);}}}測試:
[main] [cn.itcast.mp.mapper.UserMapper.selectList]-[DEBUG] ==> Preparing: SELECT id,user_name,password,name,age,email FROM tb_user [main] [cn.itcast.mp.mapper.UserMapper.selectList]-[DEBUG] ==> Parameters: [main] [cn.itcast.mp.mapper.UserMapper.selectList]-[DEBUG] <== Total: 5 [main] [org.mybatis.spring.SqlSessionUtils]-[DEBUG] Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@14faa38c] User(id=1, userName=zhangsan, password=123456, name=張三, age=18, email=test1@itcast.cn) User(id=2, userName=lisi, password=123456, name=李四, age=20, email=test2@itcast.cn) User(id=3, userName=wangwu, password=123456, name=王五, age=28, email=test3@itcast.cn) User(id=4, userName=zhaoliu, password=123456, name=趙六, age=21, email=test4@itcast.cn) User(id=5, userName=sunqi, password=123456, name=孫七, age=24, email=test5@itcast.cn)3、通用CRUD
通過前面的學(xué)習(xí),我們了解到通過繼承BaseMapper就可以獲取到各種各樣的單表操作,接下來我們將詳細(xì)講解這些操作。
?
3.1、插入操作
3.1.1、方法定義
/*** 插入一條記錄** @param entity 實體對象*/int insert(T entity);3.1.2、測試用例
package cn.itcast.mp;import cn.itcast.mp.mapper.UserMapper; import cn.itcast.mp.pojo.User; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner;import java.util.List;@RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest {@Autowiredprivate UserMapper userMapper;@Testpublic void testInsert(){User user = new User();user.setAge(20);user.setEmail("test@itcast.cn");user.setName("曹操");user.setUserName("caocao");user.setPassword("123456");int result = this.userMapper.insert(user); //返回的result是受影響的行數(shù),并不是自增后的idSystem.out.println("result = " + result); System.out.println(user.getId()); //自增后的id會回填到對象中}}3.1.3、測試
[main] [cn.itcast.mp.mapper.UserMapper.insert]-[DEBUG] ==> Preparing: INSERT INTO tb_user ( id, user_name, password, name, age, email ) VALUES ( ?, ?, ?, ?, ?, ? ) [main] [cn.itcast.mp.mapper.UserMapper.insert]-[DEBUG] ==> Parameters: 1122045867793072130(Long), caocao(String), 123456(String), 曹操(String), 20(Integer), test@itcast.cn(String) [main] [cn.itcast.mp.mapper.UserMapper.insert]-[DEBUG] <== Updates: 1 [main] [org.mybatis.spring.SqlSessionUtils]-[DEBUG] Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@411291e5] result = 1 1122045867793072130可以看到,數(shù)據(jù)已經(jīng)寫入到了數(shù)據(jù)庫,但是,id的值不正確,我們期望的是數(shù)據(jù)庫自增長,實際是MP生成了id的值寫入到了數(shù)據(jù)庫。
如何設(shè)置id的生成策略呢?
MP支持的id策略:
package com.baomidou.mybatisplus.annotation;import lombok.Getter;/*** 生成ID類型枚舉類** @author hubin* @since 2015-11-10*/ @Getter public enum IdType {/*** 數(shù)據(jù)庫ID自增*/AUTO(0),/*** 該類型為未設(shè)置主鍵類型*/NONE(1),/*** 用戶輸入ID* <p>該類型可以通過自己注冊自動填充插件進行填充</p>*/INPUT(2),/* 以下3種類型、只有當(dāng)插入對象ID 為空,才自動填充。 *//*** 全局唯一ID (idWorker)*/ID_WORKER(3),/*** 全局唯一ID (UUID)*/UUID(4),/*** 字符串全局唯一ID (idWorker 的字符串表示)*/ID_WORKER_STR(5);private final int key;IdType(int key) {this.key = key;} }修改User對象:
package cn.itcast.mp.pojo;import com.baomidou.mybatisplus.annotation.IdType; import com.baomidou.mybatisplus.annotation.TableId; import com.baomidou.mybatisplus.annotation.TableName; import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor;@Data @NoArgsConstructor @AllArgsConstructor @TableName("tb_user") public class User {@TableId(type = IdType.AUTO) //指定id類型為自增長private Long id;private String userName;private String password;private String name;private Integer age;private String email; }數(shù)據(jù)插入成功:
3.1.4、@TableField
在MP中通過@TableField注解可以指定字段的一些屬性,常常解決的問題有2個:
1、對象中的屬性名和字段名不一致的問題(非駝峰)
2、對象中的屬性字段在表中不存在的問題
使用:
其他用法,如大字段不加入查詢字段:
效果:
3.2、更新操作
在MP中,更新操作有2種,一種是根據(jù)id更新,另一種是根據(jù)條件更新。
3.2.1、根據(jù)id更新
方法定義:
/*** 根據(jù) ID 修改** @param entity 實體對象*/int updateById(@Param(Constants.ENTITY) T entity);測試:
@RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest {@Autowiredprivate UserMapper userMapper;@Testpublic void testUpdateById() {User user = new User();user.setId(6L); //主鍵user.setAge(21); //更新的字段//根據(jù)id更新,更新不為null的字段this.userMapper.updateById(user);}}結(jié)果:
[main] [cn.itcast.mp.mapper.UserMapper.updateById]-[DEBUG] ==> Preparing: UPDATE tb_user SET age=? WHERE id=? [main] [cn.itcast.mp.mapper.UserMapper.updateById]-[DEBUG] ==> Parameters: 21(Integer), 6(Long) [main] [cn.itcast.mp.mapper.UserMapper.updateById]-[DEBUG] <== Updates: 13.2.2、根據(jù)條件更新
方法定義:
/*** 根據(jù) whereEntity 條件,更新記錄** @param entity 實體對象 (set 條件值,可以為 null)* @param updateWrapper 實體對象封裝操作類(可以為 null,里面的 entity 用于生成 where 語句)*/int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> updateWrapper);測試用例:
package cn.itcast.mp;import cn.itcast.mp.mapper.UserMapper; import cn.itcast.mp.pojo.User; import com.baomidou.mybatisplus.core.conditions.Wrapper; import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper; import net.minidev.json.writer.UpdaterMapper; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner;import java.util.List;@RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest {@Autowiredprivate UserMapper userMapper;@Testpublic void testUpdate() {User user = new User();user.setAge(22); //更新的字段//更新的條件QueryWrapper<User> wrapper = new QueryWrapper<>();wrapper.eq("id", 6);//執(zhí)行更新操作int result = this.userMapper.update(user, wrapper);System.out.println("result = " + result);}}或者,通過UpdateWrapper進行更新:
? ?@Testpublic void testUpdate() {//更新的條件以及字段UpdateWrapper<User> wrapper = new UpdateWrapper<>();wrapper.eq("id", 6).set("age", 23); ?//執(zhí)行更新操作int result = this.userMapper.update(null, wrapper);System.out.println("result = " + result);}測試結(jié)果:
[main] [cn.itcast.mp.mapper.UserMapper.update]-[DEBUG] ==> Preparing: UPDATE tb_user SET age=? WHERE id = ? [main] [cn.itcast.mp.mapper.UserMapper.update]-[DEBUG] ==> Parameters: 23(Integer), 6(Integer) [main] [cn.itcast.mp.mapper.UserMapper.update]-[DEBUG] <== ? Updates: 1均可達(dá)到更新的效果。
關(guān)于wrapper更多的用法后面會詳細(xì)講解。
3.3、刪除操作
3.3.1、deleteById
方法定義:
/*** 根據(jù) ID 刪除** @param id 主鍵ID*/ int deleteById(Serializable id);測試用例:
package cn.itcast.mp;import cn.itcast.mp.mapper.UserMapper; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner;@RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest {@Autowiredprivate UserMapper userMapper;@Testpublic void testDeleteById() {//執(zhí)行刪除操作int result = this.userMapper.deleteById(6L);System.out.println("result = " + result);}}結(jié)果:
[main] [cn.itcast.mp.mapper.UserMapper.deleteById]-[DEBUG] ==> Preparing: DELETE FROM tb_user WHERE id=? [main] [cn.itcast.mp.mapper.UserMapper.deleteById]-[DEBUG] ==> Parameters: 6(Long) [main] [cn.itcast.mp.mapper.UserMapper.deleteById]-[DEBUG] <== Updates: 1數(shù)據(jù)被刪除。
3.3.2、deleteByMap
方法定義:
/*** 根據(jù) columnMap 條件,刪除記錄** @param columnMap 表字段 map 對象*/int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);測試用例:
package cn.itcast.mp;import cn.itcast.mp.mapper.UserMapper; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner;import java.util.HashMap; import java.util.Map;@RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest {@Autowiredprivate UserMapper userMapper;@Testpublic void testDeleteByMap() {Map<String, Object> columnMap = new HashMap<>();columnMap.put("age",20);columnMap.put("name","張三");//將columnMap中的元素設(shè)置為刪除的條件,多個之間為and關(guān)系int result = this.userMapper.deleteByMap(columnMap);System.out.println("result = " + result);}}結(jié)果:
[main] [cn.itcast.mp.mapper.UserMapper.deleteByMap]-[DEBUG] ==> Preparing: DELETE FROM tb_user WHERE name = ? AND age = ? [main] [cn.itcast.mp.mapper.UserMapper.deleteByMap]-[DEBUG] ==> Parameters: 張三(String), 20(Integer) [main] [cn.itcast.mp.mapper.UserMapper.deleteByMap]-[DEBUG] <== ? Updates: 03.3.3、delete
方法定義:
/*** 根據(jù) entity 條件,刪除記錄** @param wrapper 實體對象封裝操作類(可以為 null)*/ int delete(@Param(Constants.WRAPPER) Wrapper<T> wrapper);測試用例:
package cn.itcast.mp; ? import cn.itcast.mp.mapper.UserMapper; import cn.itcast.mp.pojo.User; import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner; ? import java.util.HashMap; import java.util.Map; ? @RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest { ?@Autowiredprivate UserMapper userMapper; ?@Testpublic void testDeleteByMap() {User user = new User();user.setAge(20);user.setName("張三"); ?//將實體對象進行包裝,包裝為操作條件QueryWrapper<User> wrapper = new QueryWrapper<>(user); ?int result = this.userMapper.delete(wrapper);System.out.println("result = " + result);} ? }結(jié)果:
[main] [cn.itcast.mp.mapper.UserMapper.delete]-[DEBUG] ==> Preparing: DELETE FROM tb_user WHERE name=? AND age=? [main] [cn.itcast.mp.mapper.UserMapper.delete]-[DEBUG] ==> Parameters: 張三(String), 20(Integer) [main] [cn.itcast.mp.mapper.UserMapper.delete]-[DEBUG] <== Updates: 03.3.4、deleteBatchIds
方法定義:
/*** 刪除(根據(jù)ID 批量刪除)** @param idList 主鍵ID列表(不能為 null 以及 empty)*/int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);測試用例:
package cn.itcast.mp; ? import cn.itcast.mp.mapper.UserMapper; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner; ? import java.util.Arrays; ? @RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest { ?@Autowiredprivate UserMapper userMapper; ?@Testpublic void testDeleteByMap() {//根據(jù)id集合批量刪除int result = this.userMapper.deleteBatchIds(Arrays.asList(1L,10L,20L));System.out.println("result = " + result);} ? }結(jié)果:
[main] [cn.itcast.mp.mapper.UserMapper.deleteBatchIds]-[DEBUG] ==> Preparing: DELETE FROM tb_user WHERE id IN ( ? , ? , ? ) [main] [cn.itcast.mp.mapper.UserMapper.deleteBatchIds]-[DEBUG] ==> Parameters: 1(Long), 10(Long), 20(Long) [main] [cn.itcast.mp.mapper.UserMapper.deleteBatchIds]-[DEBUG] <== ? Updates: 13.4、查詢操作
MP提供了多種查詢操作,包括根據(jù)id查詢、批量查詢、查詢單條數(shù)據(jù)、查詢列表、分頁查詢等操作。
3.4.1、selectById
方法定義:
? ?/*** 根據(jù) ID 查詢** @param id 主鍵ID*/T selectById(Serializable id);測試用例:
package cn.itcast.mp; ? import cn.itcast.mp.mapper.UserMapper; import cn.itcast.mp.pojo.User; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner; ? @RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest { ?@Autowiredprivate UserMapper userMapper; ?@Testpublic void testSelectById() {//根據(jù)id查詢數(shù)據(jù)User user = this.userMapper.selectById(2L);System.out.println("result = " + user);} ? }結(jié)果:
[main] [cn.itcast.mp.mapper.UserMapper.selectById]-[DEBUG] ==> Preparing: SELECT id,user_name,password,name,age,email FROM tb_user WHERE id=? [main] [cn.itcast.mp.mapper.UserMapper.selectById]-[DEBUG] ==> Parameters: 2(Long) [main] [cn.itcast.mp.mapper.UserMapper.selectById]-[DEBUG] <== ? ? Total: 1 ? result = User(id=2, userName=lisi, password=123456, name=李四, age=20, email=test2@itcast.cn, address=null)3.4.2、selectBatchIds
方法定義:
/*** 查詢(根據(jù)ID 批量查詢)** @param idList 主鍵ID列表(不能為 null 以及 empty)*/ List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);測試用例:
package cn.itcast.mp; ? import cn.itcast.mp.mapper.UserMapper; import cn.itcast.mp.pojo.User; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner; ? import java.util.Arrays; import java.util.List; ? @RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest { ?@Autowiredprivate UserMapper userMapper; ?@Testpublic void testSelectBatchIds() {//根據(jù)id集合批量查詢List<User> users = this.userMapper.selectBatchIds(Arrays.asList(2L, 3L, 10L));for (User user : users) {System.out.println(user);}} ? }結(jié)果:
[main] [cn.itcast.mp.mapper.UserMapper.selectBatchIds]-[DEBUG] ==> Preparing: SELECT id,user_name,password,name,age,email FROM tb_user WHERE id IN ( ? , ? , ? ) [main] [cn.itcast.mp.mapper.UserMapper.selectBatchIds]-[DEBUG] ==> Parameters: 2(Long), 3(Long), 10(Long) [main] [cn.itcast.mp.mapper.UserMapper.selectBatchIds]-[DEBUG] <== ? ? Total: 2 ? User(id=2, userName=lisi, password=123456, name=李四, age=20, email=test2@itcast.cn, address=null) User(id=3, userName=wangwu, password=123456, name=王五, age=28, email=test3@itcast.cn, address=null)3.4.3、selectOne
方法定義:
/*** 根據(jù) entity 條件,查詢一條記錄** @param queryWrapper 實體對象封裝操作類(可以為 null)*/ T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);測試用例:
package cn.itcast.mp;import cn.itcast.mp.mapper.UserMapper; import cn.itcast.mp.pojo.User; import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner;@RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest {@Autowiredprivate UserMapper userMapper;@Testpublic void testSelectOne() {QueryWrapper<User> wrapper = new QueryWrapper<User>();wrapper.eq("name", "李四");//根據(jù)條件查詢一條數(shù)據(jù),如果結(jié)果超過一條會報錯User user = this.userMapper.selectOne(wrapper);System.out.println(user);}}結(jié)果:
[main] [cn.itcast.mp.mapper.UserMapper.selectOne]-[DEBUG] ==> Preparing: SELECT id,user_name,password,name,age,email FROM tb_user WHERE name = ? [main] [cn.itcast.mp.mapper.UserMapper.selectOne]-[DEBUG] ==> Parameters: 李四(String) [main] [cn.itcast.mp.mapper.UserMapper.selectOne]-[DEBUG] <== Total: 1User(id=2, userName=lisi, password=123456, name=李四, age=20, email=test2@itcast.cn, address=null)3.4.4、selectCount
方法定義:
/*** 根據(jù) Wrapper 條件,查詢總記錄數(shù)** @param queryWrapper 實體對象封裝操作類(可以為 null)*/ Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);測試用例:
package cn.itcast.mp;import cn.itcast.mp.mapper.UserMapper; import cn.itcast.mp.pojo.User; import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner;@RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest {@Autowiredprivate UserMapper userMapper;@Testpublic void testSelectCount() {QueryWrapper<User> wrapper = new QueryWrapper<User>();wrapper.gt("age", 23); //年齡大于23歲//根據(jù)條件查詢數(shù)據(jù)條數(shù)Integer count = this.userMapper.selectCount(wrapper);System.out.println("count = " + count);}}結(jié)果:
[main] [cn.itcast.mp.mapper.UserMapper.selectCount]-[DEBUG] ==> Preparing: SELECT COUNT( 1 ) FROM tb_user WHERE age > ? [main] [cn.itcast.mp.mapper.UserMapper.selectCount]-[DEBUG] ==> Parameters: 23(Integer) [main] [cn.itcast.mp.mapper.UserMapper.selectCount]-[DEBUG] <== Total: 1count = 23.4.5、selectList
方法定義:
/*** 根據(jù) entity 條件,查詢?nèi)坑涗?* @param queryWrapper 實體對象封裝操作類(可以為 null)*/ List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);測試用例:
package cn.itcast.mp; ? import cn.itcast.mp.mapper.UserMapper; import cn.itcast.mp.pojo.User; import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner; ? import java.util.List; ? @RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest { ?@Autowiredprivate UserMapper userMapper; ?@Testpublic void testSelectList() {QueryWrapper<User> wrapper = new QueryWrapper<User>();wrapper.gt("age", 23); //年齡大于23歲 ?//根據(jù)條件查詢數(shù)據(jù)List<User> users = this.userMapper.selectList(wrapper);for (User user : users) {System.out.println("user = " + user);}} ? }結(jié)果:
[main] [cn.itcast.mp.mapper.UserMapper.selectList]-[DEBUG] ==> Preparing: SELECT id,user_name,password,name,age,email FROM tb_user WHERE age > ? [main] [cn.itcast.mp.mapper.UserMapper.selectList]-[DEBUG] ==> Parameters: 23(Integer) [main] [cn.itcast.mp.mapper.UserMapper.selectList]-[DEBUG] <== ? ? Total: 2 ? user = User(id=3, userName=wangwu, password=123456, name=王五, age=28, email=test3@itcast.cn, address=null) user = User(id=5, userName=sunqi, password=123456, name=孫七, age=24, email=test5@itcast.cn, address=null)3.4.6、selectPage
方法定義:
/*** 根據(jù) entity 條件,查詢?nèi)坑涗?#xff08;并翻頁)** @param page ? ? ? ? 分頁查詢條件(可以為 RowBounds.DEFAULT)* @param queryWrapper 實體對象封裝操作類(可以為 null)*/ IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);配置分頁插件:
package cn.itcast.mp; ? import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor; import org.mybatis.spring.annotation.MapperScan; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; ? @Configuration @MapperScan("cn.itcast.mp.mapper") //設(shè)置mapper接口的掃描包 public class MybatisPlusConfig { ?/*** 分頁插件*/@Beanpublic PaginationInterceptor paginationInterceptor() {return new PaginationInterceptor();} }測試用例:
package cn.itcast.mp; ? import cn.itcast.mp.mapper.UserMapper; import cn.itcast.mp.pojo.User; import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; import com.baomidou.mybatisplus.core.metadata.IPage; import com.baomidou.mybatisplus.extension.plugins.pagination.Page; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner; ? import java.util.List; ? @RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest { ?@Autowiredprivate UserMapper userMapper; ?@Testpublic void testSelectPage() {QueryWrapper<User> wrapper = new QueryWrapper<User>();wrapper.gt("age", 20); //年齡大于20歲 ?Page<User> page = new Page<>(1,1); ?//根據(jù)條件查詢數(shù)據(jù)IPage<User> iPage = this.userMapper.selectPage(page, wrapper);System.out.println("數(shù)據(jù)總條數(shù):" + iPage.getTotal());System.out.println("總頁數(shù):" + iPage.getPages()); ? ?List<User> users = iPage.getRecords();for (User user : users) {System.out.println("user = " + user);}} ? }結(jié)果:
[main] [cn.itcast.mp.mapper.UserMapper.selectPage]-[DEBUG] ==> Preparing: SELECT COUNT(1) FROM tb_user WHERE age > ? [main] [cn.itcast.mp.mapper.UserMapper.selectPage]-[DEBUG] ==> Parameters: 20(Integer) [main] [cn.itcast.mp.mapper.UserMapper.selectPage]-[DEBUG] ==> Preparing: SELECT id,user_name,password,name,age,email FROM tb_user WHERE age > ? LIMIT ?,? [main] [cn.itcast.mp.mapper.UserMapper.selectPage]-[DEBUG] ==> Parameters: 20(Integer), 0(Long), 1(Long) [main] [cn.itcast.mp.mapper.UserMapper.selectPage]-[DEBUG] <== ? ? Total: 1 [main] [org.mybatis.spring.SqlSessionUtils]-[DEBUG] Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@6ecd665] 數(shù)據(jù)總條數(shù):3 總頁數(shù):3 user = User(id=3, userName=wangwu, password=123456, name=王五, age=28, email=test3@itcast.cn, address=null)?
4、配置
在MP中有大量的配置,其中有一部分是Mybatis原生的配置,另一部分是MP的配置,詳情:https://mybatis.plus/config/
下面我們對常用的配置做講解。
4.1、基本配置
4.1.1、configLocation
MyBatis 配置文件位置,如果您有單獨的 MyBatis 配置,請將其路徑配置到 configLocation 中。 MyBatis Configuration 的具體內(nèi)容請參考MyBatis 官方文檔
Spring Boot:
mybatis-plus.config-location = classpath:mybatis-config.xmlSpring MVC:
<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean"><property name="configLocation" value="classpath:mybatis-config.xml"/> </bean>4.1.2、mapperLocations
MyBatis Mapper 所對應(yīng)的 XML 文件位置,如果您在 Mapper 中有自定義方法(XML 中有自定義實現(xiàn)),需要進行該配置,告訴 Mapper 所對應(yīng)的 XML 文件位置。
Spring Boot:
mybatis-plus.mapper-locations = classpath*:mybatis/*.xmlSpring MVC:
<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean"><property name="mapperLocations" value="classpath*:mybatis/*.xml"/> </bean>Maven 多模塊項目的掃描路徑需以 classpath*: 開頭 (即加載多個 jar 包下的 XML 文件)
測試:
UserMapper.xml:
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="cn.itcast.mp.mapper.UserMapper"> ?<select id="findById" resultType="cn.itcast.mp.pojo.User">select * from tb_user where id = #{id}</select> ? </mapper> package cn.itcast.mp.mapper; ? import cn.itcast.mp.pojo.User; import com.baomidou.mybatisplus.core.mapper.BaseMapper; ? public interface UserMapper extends BaseMapper<User> { ?User findById(Long id); }測試用例:
package cn.itcast.mp; ? import cn.itcast.mp.mapper.UserMapper; import cn.itcast.mp.pojo.User; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner; ? @RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest { ?@Autowiredprivate UserMapper userMapper; ?@Testpublic void testSelectPage() {User user = this.userMapper.findById(2L);System.out.println(user); ?} ? }運行結(jié)果:
4.1.3、typeAliasesPackage
MyBaits 別名包掃描路徑,通過該屬性可以給包中的類注冊別名,注冊后在 Mapper 對應(yīng)的 XML 文件中可以直接使用類名,而不用使用全限定的類名(即 XML 中調(diào)用的時候不用包含包名)。
Spring Boot:
mybatis-plus.type-aliases-package = cn.itcast.mp.pojoSpring MVC:
<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean"><property name="typeAliasesPackage" value="com.baomidou.mybatisplus.samples.quickstart.entity"/> </bean>4.2、進階配置
本部分(Configuration)的配置大都為 MyBatis 原生支持的配置,這意味著您可以通過 MyBatis XML 配置文件的形式進行配置。
4.2.1、mapUnderscoreToCamelCase
-
類型:boolean
-
默認(rèn)值:true
是否開啟自動駝峰命名規(guī)則(camel case)映射,即從經(jīng)典數(shù)據(jù)庫列名 A_COLUMN(下劃線命名) 到經(jīng)典 Java 屬性名 aColumn(駝峰命名) 的類似映射。
注意:
此屬性在 MyBatis 中原默認(rèn)值為 false,在 MyBatis-Plus 中,此屬性也將用于生成最終的 SQL 的 select body
如果您的數(shù)據(jù)庫命名符合規(guī)則無需使用 @TableField 注解指定數(shù)據(jù)庫字段名
示例(SpringBoot):
#關(guān)閉自動駝峰映射,該參數(shù)不能和mybatis-plus.config-location同時存在 mybatis-plus.configuration.map-underscore-to-camel-case=false4.2.2、cacheEnabled
-
類型:boolean
-
默認(rèn)值:true
全局地開啟或關(guān)閉配置文件中的所有映射器已經(jīng)配置的任何緩存,默認(rèn)為 true。
示例:
mybatis-plus.configuration.cache-enabled=false4.3、DB 策略配置
4.3.1、idType
-
類型:com.baomidou.mybatisplus.annotation.IdType
-
默認(rèn)值:ID_WORKER
全局默認(rèn)主鍵類型,設(shè)置后,即可省略實體對象中的@TableId(type = IdType.AUTO)配置。
示例:
SpringBoot:
mybatis-plus.global-config.db-config.id-type=autoSpringMVC:
<!--這里使用MP提供的sqlSessionFactory,完成了Spring與MP的整合--><bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean"><property name="dataSource" ref="dataSource"/><property name="globalConfig"><bean class="com.baomidou.mybatisplus.core.config.GlobalConfig"><property name="dbConfig"><bean class="com.baomidou.mybatisplus.core.config.GlobalConfig$DbConfig"><property name="idType" value="AUTO"/></bean></property></bean></property></bean>4.3.2、tablePrefix
-
類型:String
-
默認(rèn)值:null
表名前綴,全局配置后可省略@TableName()配置。
SpringBoot:
mybatis-plus.global-config.db-config.table-prefix=tb_SpringMVC:
<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean"><property name="dataSource" ref="dataSource"/><property name="globalConfig"><bean class="com.baomidou.mybatisplus.core.config.GlobalConfig"><property name="dbConfig"><bean class="com.baomidou.mybatisplus.core.config.GlobalConfig$DbConfig"><property name="idType" value="AUTO"/><property name="tablePrefix" value="tb_"/></bean></property></bean></property></bean>5、條件構(gòu)造器
在MP中,Wrapper接口的實現(xiàn)類關(guān)系如下:
可以看到,AbstractWrapper和AbstractChainWrapper是重點實現(xiàn),接下來我們重點學(xué)習(xí)AbstractWrapper以及其子類。
說明:
QueryWrapper(LambdaQueryWrapper) 和 UpdateWrapper(LambdaUpdateWrapper) 的父類 用于生成 sql 的 where 條件, entity 屬性也用于生成 sql 的 where 條件 注意: entity 生成的 where 條件與 使用各個 api 生成的 where 條件沒有任何關(guān)聯(lián)行為
官網(wǎng)文檔地址:https://mybatis.plus/guide/wrapper.html
5.1、allEq
5.1.1、說明
allEq(Map<R, V> params) allEq(Map<R, V> params, boolean null2IsNull) allEq(boolean condition, Map<R, V> params, boolean null2IsNull)-
全部eq(或個別isNull)
個別參數(shù)說明: params : key為數(shù)據(jù)庫字段名,value為字段值 null2IsNull : 為true則在map的value為null時調(diào)用 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<R, V> filter, Map<R, V> params) allEq(BiPredicate<R, V> filter, Map<R, V> params, boolean null2IsNull) allEq(boolean condition, BiPredicate<R, V> filter, Map<R, V> params, boolean null2IsNull)個別參數(shù)說明: filter : 過濾函數(shù),是否允許字段傳入比對條件中 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 = '老王'
5.1.2、測試用例
package cn.itcast.mp; ? import cn.itcast.mp.mapper.UserMapper; import cn.itcast.mp.pojo.User; import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner; ? import java.util.HashMap; import java.util.List; import java.util.Map; ? @RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest { ?@Autowiredprivate UserMapper userMapper; ?@Testpublic void testWrapper() {QueryWrapper<User> wrapper = new QueryWrapper<>(); ?//設(shè)置條件Map<String,Object> params = new HashMap<>();params.put("name", "曹操");params.put("age", "20");params.put("password", null); ? // ? ? ? wrapper.allEq(params);//SELECT * FROM tb_user WHERE password IS NULL AND name = ? AND age = ? // ? ? ? wrapper.allEq(params,false); //SELECT * FROM tb_user WHERE name = ? AND age = ? ? // ? ? ? wrapper.allEq((k, v) -> (k.equals("name") || k.equals("age")) ,params);//SELECT * FROM tb_user WHERE name = ? AND age = ? ?List<User> users = this.userMapper.selectList(wrapper);for (User user : users) {System.out.println(user);} ?} ? }5.2、基本比較操作
-
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, ...)
-
測試用例:
package cn.itcast.mp;import cn.itcast.mp.mapper.UserMapper; import cn.itcast.mp.pojo.User; import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner;import java.util.List;@RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest {@Autowiredprivate UserMapper userMapper;@Testpublic void testEq() {QueryWrapper<User> wrapper = new QueryWrapper<>();//SELECT id,user_name,password,name,age,email FROM tb_user WHERE password = ? AND age >= ? AND name IN (?,?,?)wrapper.eq("password", "123456").ge("age", 20).in("name", "李四", "王五", "趙六");List<User> users = this.userMapper.selectList(wrapper);for (User user : users) {System.out.println(user);}}}5.3、模糊查詢
-
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 '王%'
-
測試用例:
package cn.itcast.mp;import cn.itcast.mp.mapper.UserMapper; import cn.itcast.mp.pojo.User; import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner;import java.util.List;@RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest {@Autowiredprivate UserMapper userMapper;@Testpublic void testWrapper() {QueryWrapper<User> wrapper = new QueryWrapper<>();//SELECT id,user_name,password,name,age,email FROM tb_user WHERE name LIKE ?//Parameters: %曹%(String)wrapper.like("name", "曹");List<User> users = this.userMapper.selectList(wrapper);for (User user : users) {System.out.println(user);}}}5.4、排序
-
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
-
測試用例:
package cn.itcast.mp;import cn.itcast.mp.mapper.UserMapper; import cn.itcast.mp.pojo.User; import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner;import java.util.List;@RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest {@Autowiredprivate UserMapper userMapper;@Testpublic void testWrapper() {QueryWrapper<User> wrapper = new QueryWrapper<>();//SELECT id,user_name,password,name,age,email FROM tb_user ORDER BY age DESCwrapper.orderByDesc("age");List<User> users = this.userMapper.selectList(wrapper);for (User user : users) {System.out.println(user);}}}5.5、邏輯查詢
-
or
-
拼接 OR
-
主動調(diào)用or表示緊接著下一個方法不是用and連接!(不調(diào)用or則默認(rèn)為使用and連接)
-
-
and
-
AND 嵌套
-
例: and(i -> i.eq("name", "李白").ne("status", "活著"))--->and (name = '李白' and status <> '活著')
-
測試用例:
package cn.itcast.mp;import cn.itcast.mp.mapper.UserMapper; import cn.itcast.mp.pojo.User; import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner;import java.util.List;@RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest {@Autowiredprivate UserMapper userMapper;@Testpublic void testWrapper() {QueryWrapper<User> wrapper = new QueryWrapper<>();//SELECT id,user_name,password,name,age,email FROM tb_user WHERE name = ? OR age = ?wrapper.eq("name","李四").or().eq("age", 24);List<User> users = this.userMapper.selectList(wrapper);for (User user : users) {System.out.println(user);}}}5.6、select
在MP查詢中,默認(rèn)查詢所有的字段,如果有需要也可以通過select方法進行指定字段。
package cn.itcast.mp;import cn.itcast.mp.mapper.UserMapper; import cn.itcast.mp.pojo.User; import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner;import java.util.List;@RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest {@Autowiredprivate UserMapper userMapper;@Testpublic void testWrapper() {QueryWrapper<User> wrapper = new QueryWrapper<>();//SELECT id,name,age FROM tb_user WHERE name = ? OR age = ?wrapper.eq("name", "李四").or().eq("age", 24).select("id", "name", "age");List<User> users = this.userMapper.selectList(wrapper);for (User user : users) {System.out.println(user);}}}總結(jié)
以上是生活随笔為你收集整理的Mybatis-Plus入门之通用CRUD+基本配置介绍的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: Python中的异常处理详解
- 下一篇: 数据结构之数组、链表、栈和队列