mybatis-plus的使用
MyBatis-Plus（简称 MP）是一个 MyBatis的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。
特性：
-
无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
-
损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
-
强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求
-
支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
-
支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题
-
支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作
-
支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
-
内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用
-
内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询
-
分页插件支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库
-
内置性能分析插件：可输出 Sql 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
-
内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作
引入pom.xml依赖
<dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus</artifactId> <version>3.3.1</version> </dependency>
mybatis-config.xml
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd"> <configuration> <settings> <setting name="logImpl" value="LOG4J"/> </settings> </configuration>
log4j.properties
# 全局日志配置
log4j.rootLogger=INFO, stdout
# MyBatis 日志配置
log4j.logger.com.mashibing=truce
# 控制台输出
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n
db.properties
driverClassname=com.mysql.cj.jdbc.Driver
username=root
password=123456
url=jdbc:mysql://localhost:3306/demo?serverTimezone=UTC
spring.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" xmlns:tx="http://www.springframework.org/schema/tx" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd"> <context:property-placeholder location="classpath:db.properties"></context:property-placeholder> <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource"> <property name="driverClassName" value="${driverClassname}"></property> <property name="url" value="${url}"></property> <property name="username" value="${username}"></property> <property name="password" value="${password}"></property> </bean> <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager"> <property name="dataSource" ref="dataSource"></property> </bean> <tx:annotation-driven transaction-manager="transactionManager"></tx:annotation-driven>
<bean id="sqlSessionFactoryBean" class="org.mybatis.spring.SqlSessionFactoryBean"> <property name="dataSource" ref="dataSource"></property> <property name="configLocation" value="classpath:mybatis-config.xml"></property> </bean> <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer"> <property name="basePackage" value="com.mashibing.dao"></property> </bean> </beans>
测试类
package com.llxazy; import com.alibaba.druid.pool.DruidDataSource; import org.junit.Test; import org.springframework.context.ApplicationContext; import org.springframework.context.support.ClassPathXmlApplicationContext; import java.sql.SQLException; public class MyTest { ApplicationContext context = new ClassPathXmlApplicationContext("spring.xml"); @Test public void test01() throws SQLException { DruidDataSource dataSource = context.getBean("dataSource", DruidDataSource.class); System.out.println(dataSource.getConnection()); } }
在集成mybatis-plus的时候非常简单，只需要替换mybatis自己的sqlSessionFactoryBean对象即可
<bean id="sqlSessionFactoryBean" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
<property name="dataSource" ref="dataSource"></property>
<property name="configLocation" value="classpath:mybatis-config.xml"></property>
<property name="typeAliasesPackage" value="com.llxazy.bean"></property>
</bean>
在Mybatis中，我们需要编写对应的Dao接口，并在接口中定义相关的方法，然后提供与该接口相同名称的Dao.xml文件，在文件中填写对应的sql语句，才能完成对应的操作
在Mybatis-plus中，我们只需要定义接口，然后继承BaseMapper<T>类即可，此前做的所有操作都是由Mybatis-plus来帮我们完成，不需要创建sql映射文件
EmpDao.java
package com.llxazy.dao; import com.baomidou.mybatisplus.core.mapper.BaseMapper; import com.llxazy.bean.Emp; /** * 在mybatis操作的时候，我们需要自己定义接口中实现的方法，并添加与之对应的EmpDao.xml文件，编写对应的sql语句 * 在mybatis-plus操作的时候，我们只需要继承BaseMapper接口即可，其中的泛型T表示我们要实际操作的实体类对象 */ public interface EmpDao extends BaseMapper<Emp> { }
实体类的名称跟表的名称不匹配，因此在实现的是需要添加@TableName注解，指定具体的表的名称x
定义实体类的时候并没有声明其中的主键是哪个列，以及使用什么样的主键生成策略，因此，可以在类的属性上添加@TableId注解
属性名称和表的字段名称不匹配，可以再属性的上面添加@TableField注解
@TableName("emp")
public class Emp { @TableId(value = "empno",type = IdType.AUTO) private Integer empno;
@TableField(value = "e_name") private String eName; private String job; private Integer mgr; private Date hiredate; private Double sal; private Double comm; private Integer deptno; //set、get、tostring方法省略 }
1）
package com.llxazy; import com.alibaba.druid.pool.DruidDataSource; import com.llxazy.bean.Emp; import com.llxazy.dao.EmpDao; import org.junit.Test; import org.springframework.context.ApplicationContext; import org.springframework.context.support.ClassPathXmlApplicationContext; import java.sql.SQLException; import java.util.Date; public class MyTest { ApplicationContext context = new ClassPathXmlApplicationContext("spring.xml"); private EmpDao empDao = context.getBean("empDao",EmpDao.class); @Test public void testInsert(){ Emp emp = new Emp(); emp.seteName("zhangsan"); emp.setJob("Teacher"); emp.setMgr(100); emp.setSal(1000.0); emp.setComm(500.0); emp.setHiredate(new Date()); emp.setDeptno(10); int insert = empDao.insert(emp); System.out.println(insert); } }
mybatis-plus会根据我会输入的对象的字段的个数来动态的调整我们的sql语句插入的字段
2）
@Test public void testUpdate(){ Emp emp = new Emp(); emp.setEmpno(1); emp.seteName("lisi"); emp.setJob("student"); emp.setMgr(100); emp.setSal(1000.0); emp.setComm(500.0); emp.setHiredate(new Date()); emp.setDeptno(10); int update = empDao.updateById(emp); System.out.println(update); }
@Test public void testDelete(){ // 1、根据id删除数据 int i = empDao.deleteById(1); System.out.println(i); // 2、根据一组id删除数据 int j = empDao.deleteBatchIds(Arrays.asList(2, 3, 4)); System.out.println(j); // 3、根据条件删除数据 QueryWrapper queryWrapper = new QueryWrapper(); queryWrapper.in("empno",Arrays.asList(5,6,7)); int delete = empDao.delete(queryWrapper); System.out.println(delete); // 4、条件封装map删除数据 Map<String,Object> map = new HashMap<>(); map.put("empno",9); int k = empDao.deleteByMap(map); System.out.println(k); }
@Test public void testselect(){ // 1、根据id查询对象 // Emp emp = empDao.selectById(1); // System.out.println(emp); // 2、根据实体包装类查询单个对象，返回的结果集有且仅能有一个对象 // QueryWrapper<Emp> emp = new QueryWrapper<Emp>(); // emp.eq("empno",2).eq("e_name","zhangsan"); // Emp emp1 = empDao.selectOne(emp); // System.out.println(emp1); // 3、通过多个id值进行查询 // List<Emp> list = empDao.selectBatchIds(Arrays.asList(1, 2, 3)); // for (Emp emp : list) { // System.out.println(emp); // } // 4、通过map封装进行条件查询 // Map<String,Object> map = new HashMap<String, Object>(); // map.put("e_name","zhangsan"); // map.put("sal",1000.0); // List<Emp> list = empDao.selectByMap(map); // for (Emp emp : list) { // System.out.println(emp); // } // 5、分页查询,需要添加分页插件 /** * <property name="plugins"> * <array> * <bean class="com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor"></bean> * </array> * </property> */ // Page<Emp> empPage = empDao.selectPage(new Page<>(2, 5), null); // List<Emp> records = empPage.getRecords(); // System.out.println(records); // 6、根据条件返回查询结果总数 // QueryWrapper<Emp> queryWrapper = new QueryWrapper<>(); // queryWrapper.eq("e_name","zhangsan"); // Integer integer = empDao.selectCount(queryWrapper); // System.out.println(integer); // 7、根据条件查询所有结果返回list集合 // List<Emp> list = empDao.selectList(null); // for (Emp emp : list) { // System.out.println(emp); // } // 8、根据条件查询结果封装成map的list结构 // List<Map<String, Object>> maps = empDao.selectMaps(null); // System.out.println(maps); }
在mybatis中我们可以在mybatis-config配置文件中可以添加<settings>标签，设置全局的默认策略，在Mybatis-Plus中也具备相同的功能，只不过配置方式有所不同，我们可以在spring.xml文件中添加配置。
在此链接中包含了非常多的配置项，用户可以按照自己的需求添加需要的配置，配置方式如下：
<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
<property name="configuration" ref="configuration"/> <!-- 非必须 -->
<property name="globalConfig" ref="globalConfig"/> <!-- 非必须 -->
......
</bean>
<bean id="configuration" class="com.baomidou.mybatisplus.core.MybatisConfiguration">
<!--在mybatis-plus中会引入些默认的配置，这个选项的默认配置为true，因此可以完成对应的实现。打开驼峰标识-->
<property name="mapUnderscoreToCamelCase" value="true"></property>
<!--打开日志功能-->
<property name="logImpl" value="org.apache.ibatis.logging.log4j.Log4jImpl"></property>
</bean>
<bean id="globalConfig" class="com.baomidou.mybatisplus.core.config.GlobalConfig">
<property name="dbConfig" ref="dbConfig"/> <!-- 非必须 -->
......
</bean>
<bean id="dbConfig" class="com.baomidou.mybatisplus.core.config.GlobalConfig.DbConfig">
<!--每个类可能都需要写主键生成策略，这是比较麻烦的，因此可以选择将主键配置策略设置到全局配置中-->
<property name="idType" ref="idType"></property>
<!--如果表的名字都具备相同的前缀，那么可以设置默认的前缀配置策略，此时的话可以将实体类上的@TableName标签省略不写-->
<property name="tablePrefix" value="tbl_"></property>
</bean>
<util:constant id="idType" static-field="com.baomidou.mybatisplus.annotation.IdType.AUTO"></util:constant>
<dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>3.3.1.tmp</version> </dependency>
添加 模板引擎 依赖，MyBatis-Plus 支持 Velocity（默认）、Freemarker、Beetl，用户可以选择自己熟悉的模板引擎，如果都不满足您的要求，可以采用自定义模板引擎。
<dependency> <groupId>org.apache.velocity</groupId> <artifactId>velocity-engine-core</artifactId> <version>2.2</version> </dependency> <dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> <version>2.3.30</version> </dependency> <dependency> <groupId>com.ibeetl</groupId> <artifactId>beetl</artifactId> <version>3.1.1.RELEASE</version> </dependency>
2）编写生成类
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.rules.NamingStrategy; import org.junit.Test; public class MyTest { @Test public void testGenerator(){ //此处默认有两个对应的实现类，大家不要导错包 GlobalConfig globalConfig = new GlobalConfig(); //设置全局的配置 globalConfig.setActiveRecord(true)//是否支持AR模式 .setAuthor("lian")//设置作者 .setOutputDir("e:\\self_project\\mybatisplus_generatorcode\\src\\main\\java")//设置生成路径 .setFileOverride(true)//设置文件覆盖 .setIdType(IdType.AUTO) //设置主键生成策略 .setServiceName("%sService")//设置生成的serivce接口的名字 .setBaseResultMap(true) //设置基本的结果集映射 .setBaseColumnList(true);//设置基本的列集合 //设置数据源的配置 DataSourceConfig dataSourceConfig = new DataSourceConfig(); dataSourceConfig.setDriverName("com.mysql.cj.jdbc.Driver") .setUrl("jdbc:mysql://localhost:3306/mp?serverTimezone=UTC") .setUsername("root").setPassword("123456"); // 进行策略配置 StrategyConfig strategyConfig = new StrategyConfig(); strategyConfig.setCapitalMode(true)//设置全局大写命名 .setNaming(NamingStrategy.underline_to_camel)//数据库表映射到实体的命名策略 .setTablePrefix("tbl_")//设置表名前缀 .setInclude("tbl_emp");//生成的表 // 进行包名的策略配置 PackageConfig packageConfig = new PackageConfig(); packageConfig.setParent("com.mashibing") .setMapper("mapper") .setService("service") .setController("controller") .setEntity("bean") .setXml("mapper"); //整合配置 AutoGenerator autoGenerator = new AutoGenerator(); autoGenerator.setGlobalConfig(globalConfig).setDataSource(dataSourceConfig).setStrategy(strategyConfig) .setPackageInfo(packageConfig); autoGenerator.execute(); } }
注意，当通过上述代码实现之后，大家发现可以在Controller层可以直接实现调用，这些调用的实现最核心的功能就在于ServiceImpl类，这个类中自动完成mapper的注入，同时提供了一系列CRUD的方法。
<property name="plugins"> <array> <bean class="com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor"></bean> </array> </property>
编写测试类
@Test public void TestPage(){ Page page = new Page(2,2); Page page1 = empDao.selectPage(page, null); List records = page1.getRecords(); for (Object record : records) { System.out.println(record); }
System.out.println("获取总条数："+page.getTotal()); System.out.println("当前页码："+page.getCurrent()); System.out.println("总页码："+page.getPages()); System.out.println("每页显示的条数："+page.getSize()); System.out.println("是否有上一页："+page.hasPrevious()); System.out.println("是否有下一页："+page.hasNext()); }
2）
当要更新一条记录的时候，希望这条记录没有被别人更新
乐观锁实现方式：
取出记录时，获取当前version
更新时，带上这个version
执行更新时， set version = newVersion where version = oldVersion
如果version不对，就更新失败
添加配置：
<bean class="com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor"></bean>
修改实体类添加version字段并在表中添加version字段
测试类：
@Test public void testOptimisticLocker(){ Emp emp = new Emp(); emp.setEmpno(22); emp.seteName("zhang"); emp.setSal(10000.0); emp.setComm(1000.0); emp.setVersion(2); empDao.updateById(emp); }
3）
<bean class="com.baomidou.mybatisplus.extension.plugins.SqlExplainInterceptor"> <property name="sqlParserList"> <list> <bean class="com.baomidou.mybatisplus.extension.parsers.BlockAttackSqlParser"></bean> </list> </property> </bean>
@Test public void testSqlExplain(){ int delete = empDao.delete(null); System.out.println(delete); }
4）
<bean class="com.baomidou.mybatisplus.extension.plugins.IllegalSQLInterceptor"></bean>
@Test public void testSqlIllegal(){ QueryWrapper<Emp> queryWrapper = new QueryWrapper<>(); queryWrapper.or(); List<Emp> list = empDao.selectList(queryWrapper); for (Emp emp : list) { System.out.println(emp); } }
6、
package com.llxazy.injector; import com.baomidou.mybatisplus.core.injector.AbstractMethod; import com.baomidou.mybatisplus.core.injector.AbstractSqlInjector; import java.util.List; import java.util.stream.Collectors; import java.util.stream.Stream; public class MyInjector extends AbstractSqlInjector{ @Override public List<AbstractMethod> getMethodList(Class<?> mapperClass) { return Stream.of(new DeleteAll()).collect(Collectors.toList()); } }
添加配置：
<bean id="globalConfig" class="com.baomidou.mybatisplus.core.config.GlobalConfig"> <property name="dbConfig" ref="dbConfig"></property> <property name="sqlInjector" ref="myinject"></property> </bean> <bean id="myinject" class="com.llxazy.injector.MyInjector"></bean>
package com.llxazy.injector; import com.baomidou.mybatisplus.core.injector.AbstractMethod; import com.baomidou.mybatisplus.core.metadata.TableInfo; import org.apache.ibatis.mapping.MappedStatement; import org.apache.ibatis.mapping.SqlSource; public class DeleteAll extends AbstractMethod { @Override public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) { String sql; MySqlMethod mySqlMethod = MySqlMethod.DELETE_ALL; if (tableInfo.isLogicDelete()) { sql = String.format(mySqlMethod.getSql(), tableInfo.getTableName(), tableInfo, sqlWhereEntityWrapper(true,tableInfo)); } else { mySqlMethod = MySqlMethod.DELETE_ALL; sql = String.format(mySqlMethod.getSql(), tableInfo.getTableName(), sqlWhereEntityWrapper(true,tableInfo)); } SqlSource sqlSource = languageDriver.createSqlSource(configuration, sql, modelClass); return addUpdateMappedStatement(mapperClass, modelClass, mySqlMethod.getMethod(), sqlSource); } }
package com.llxazy.injector; /** * 自定义全局删除方法 */ public enum MySqlMethod { /** * 删除全部 */ DELETE_ALL("deleteAll", "根据 entity 条件删除记录", "<script>\nDELETE FROM %s %s\n</script>"); private final String method; private final String desc; private final String sql; MySqlMethod(String method, String desc, String sql) { this.method = method; this.desc = desc; this.sql = sql; } public String getMethod() { return method; } public String getDesc() { return desc; } public String getSql() { return sql; } }
package com.llxazy.dao; import com.baomidou.mybatisplus.core.mapper.BaseMapper; import com.llxazy.bean.Emp; /** * 在mybatis操作的时候，我们需要自己定义接口中实现的方法，并添加与之对应的EmpDao.xml文件，编写对应的sql语句 * 在mybatis-plus操作的时候，我们只需要继承BaseMapper接口即可，其中的泛型T表示我们要实际操作的实体类对象 */ public interface EmpDao extends BaseMapper<Emp> { Integer deleteAll(); }
7、
-
-
注解填充字段
@TableField(.. fill = FieldFill.INSERT)生成器策略部分也可以配置！
编写自定义的公共字段填充
package com.llxazy.fill; import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler; import org.apache.ibatis.reflection.MetaObject; import java.time.LocalDateTime; import java.util.stream.Stream; public class MyMetaObjectHandler implements MetaObjectHandler { @Override public void insertFill(MetaObject metaObject) { this.strictInsertFill(metaObject, "eName", String.class, "lian"); // 起始版本 3.3.0(推荐使用) // this.fillStrategy(metaObject, "createTime", LocalDateTime.now()); // 也可以使用(3.3.0 该方法有bug请升级到之后的版本如`3.3.1.8-SNAPSHOT`) } @Override public void updateFill(MetaObject metaObject) { this.strictUpdateFill(metaObject, "eName", String.class,"lian"); // 起始版本 3.3.0(推荐使用) // this.fillStrategy(metaObject, "updateTime", LocalDateTime.now()); // 也可以使用(3.3.0 该方法有bug请升级到之后的版本如`3.3.1.8-SNAPSHOT`) } }
添加到对应的配置中：
<bean id="globalConfig" class="com.baomidou.mybatisplus.core.config.GlobalConfig"> <property name="dbConfig" ref="dbConfig"></property> <property name="metaObjectHandler" ref="myMeta"></property> </bean> <bean id="myMeta" class="com.llxazy.fill.MyMetaObjectHandler"></bean>
测试：
@Test public void testMeta(){ int insert = empDao.insert(new Emp()); System.out.println(insert); }
浙公网安备 33010602011771号