mybatis-plus使用

   Mybatis-Plus是一个Mybatis的增强工具，它在Mybatis的基础上做了增强，却不做改变。我们在使用Mybatis-Plus之后既可以使用Mybatis-Plus的特有功能，又能够正常使用Mybatis的原生功能。Mybatis-Plus(以下简称MP)是为简化开发、提高开发效率而生，但它也提供了一些很有意思的插件，比如SQL性能监控、乐观锁、执行分析等。

    Mybatis虽然已经给我们提供了很大的方便，但它还是有不足之处，实际上没有什么东西是完美的，MP的存在就是为了稍稍弥补Mybatis的不足。在我们使用Mybatis时会发现，每当要写一个业务逻辑的时候都要在DAO层写一个方法，再对应一个SQL，即使是简单的条件查询、即使仅仅改变了一个条件都要在DAO层新增一个方法，针对这个问题，MP就提供了一个很好的解决方案，之后我会进行介绍。另外，MP的代码生成器也是一个很有意思的东西，它可以让我们避免许多重复性的工作，下面我将介绍如何在你的项目中集成MP。

集成步骤↓：(首先，你要有个spring项目)

1. 集成依赖，pom中加入依赖即可，不多说：
   Java代码  

   1. <!-- mybatis mybatis-plus mybatis-spring mvc -->  
   2. <dependency>  
   3.     <groupId>com.baomidou</groupId>  
   4.     <artifactId>mybatis-plus</artifactId>  
   5.     <version>${mybatis-plus.version}</version>  
   6. </dependency>  
   7. <dependency>  
   8.     <groupId>org.apache.velocity</groupId>  
   9.     <artifactId>velocity-engine-core</artifactId>  
   10.     <version>2.0</version>  
   11. </dependency>  
    说明：笔者使用的版本为：mybatis-plus.version=2.1-gamma，上边的代码中有两个依赖，第一个是mybatis-plus核心依赖，第二个是使用代码生成器时需要的模板引擎依赖，若果你不打算使用代码生成器，此处可不引入。

   注意：mybatis-plus的核心jar包中已集成了mybatis和mybatis-spring，所以为避免冲突，请勿再次引用这两个jar包。

2. 在spring中配置MP：
   Java代码  

   1. <bean id="sqlSessionFactory"  
   2.     class="com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean">  
   3.     <!-- 配置数据源 -->  
   4.     <property name="dataSource" ref="dataSource" />  
   5.     <!-- 自动扫描 Xml 文件位置 -->  
   6.     <property name="mapperLocations" value="classpath*:com/ds/orm/mapper/**/*.xml" />  
   7.     <!-- 配置 Mybatis 配置文件（可无） -->  
   8.     <property name="configLocation" value="classpath:mybatis-config.xml" />  
   9.     <!-- 配置包别名，支持通配符 * 或者 ; 分割 -->  
   10.     <property name="typeAliasesPackage" value="com.ds.orm.model" />  
   11.     <!-- 枚举属性配置扫描，支持通配符 * 或者 ; 分割 -->  
   12.     <!-- <property name="typeEnumsPackage" value="com.baomidou.springmvc.entity.*.enums"   
   13.         /> -->  
   14.     <!-- 以上配置和传统 Mybatis 一致 -->  
   15.   
   16.     <!-- MP 全局配置注入 -->  
   17.     <property name="globalConfig" ref="globalConfig" />  
   18. </bean>  
   19.   
   20. <!-- 定义 MP 全局策略 -->  
   21. <bean id="globalConfig" class="com.baomidou.mybatisplus.entity.GlobalConfiguration">  
   22.     <!-- 主键策略配置 -->  
   23.     <!-- 可选参数 AUTO->`0`("数据库ID自增") INPUT->`1`(用户输入ID") ID_WORKER->`2`("全局唯一ID")   
   24.         UUID->`3`("全局唯一ID") -->  
   25.     <property name="idType" value="2" />  
   26.     <!-- 数据库类型配置 -->  
   27.     <!-- 可选参数（默认mysql） MYSQL->`mysql` ORACLE->`oracle` DB2->`db2` H2->`h2`   
   28.         HSQL->`hsql` SQLITE->`sqlite` POSTGRE->`postgresql` SQLSERVER2005->`sqlserver2005`   
   29.         SQLSERVER->`sqlserver` -->  
   30.     <property name="dbType" value="mysql" />  
   31.     <!-- 全局表为下划线命名设置 true -->  
   32.     <property name="dbColumnUnderline" value="true" />  
   33.     <property name="sqlInjector">  
   34.         <bean class="com.baomidou.mybatisplus.mapper.AutoSqlInjector" />  
   35.     </property>  
   36. </bean>  
   37. <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">  
   38.     <description>DAO接口所在包名，Spring会自动查找其下的类</description>  
   39.     <property name="basePackage" value="com.ds.orm.mapper" />  
   40.     <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />  
   41. </bean>  
   42. <!-- 乐观锁插件 -->  
   43. <bean class="com.baomidou.mybatisplus.plugins.OptimisticLockerInterceptor" />  
   44.   
   45. <!-- xml mapper热加载 sqlSessionFactory:session工厂 mapperLocations:mapper匹配路径   
   46.     enabled:是否开启动态加载 默认:false delaySeconds:项目启动延迟加载时间 单位：秒 默认:10s sleepSeconds:刷新时间间隔   
   47.     单位：秒 默认:20s -->  
   48. <bean class="com.baomidou.mybatisplus.spring.MybatisMapperRefresh">  
   49.     <constructor-arg name="sqlSessionFactory" ref="sqlSessionFactory" />  
   50.     <constructor-arg name="mapperLocations"  
   51.         value="classpath*:com/ds/orm/mapper/*/*.xml" />  
   52.     <constructor-arg name="delaySeconds" value="10" />  
   53.     <constructor-arg name="sleepSeconds" value="20" />  
   54.     <constructor-arg name="enabled" value="true" />  
   55. </bean>  
   56.   
   57. <!-- 事务 -->  
   58. <bean id="transactionManager"  
   59.     class="org.springframework.jdbc.datasource.DataSourceTransactionManager">  
   60.     <property name="dataSource" ref="dataSource" />  
   61. </bean>  
   62. <tx:annotation-driven transaction-manager="transactionManager"  
   63.     proxy-target-class="true" />  
    注意：只要做如上配置就可以正常使用mybatis了，不要重复配置。MP的配置和mybatis一样，都是配置一个sqlSessionFactory，只是现在所配置的类在原本的SqlSessionFactoryBean基础上做了增强。插件等配置请按需取舍。
3. 插件配置，按需求配置就可以，此处把可以配置的插件都列了出来，具体的请看代码注释：
   Java代码  

   1. <configuration>  
   2.     <settings>  
   3.         <setting name="logImpl" value="SLF4J" />  
   4.         <!-- 字段为空时仍调用model的set方法或map的put方法 -->  
   5.         <setting name="callSettersOnNulls" value="true" />  
   6.     </settings>  
   7.     <plugins>  
   8.         <!-- | 分页插件配置 | 插件提供二种方言选择：1、默认方言 2、自定义方言实现类，两者均未配置则抛出异常！ | overflowCurrent   
   9.             溢出总页数，设置第一页 默认false | optimizeType Count优化方式 （ 版本 2.0.9 改为使用 jsqlparser 不需要配置   
   10.             ） | -->  
   11.         <!-- 注意!! 如果要支持二级缓存分页使用类 CachePaginationInterceptor 默认、建议如下！！ -->  
   12.         <plugin interceptor="com.baomidou.mybatisplus.plugins.PaginationInterceptor">  
   13.             <property name="dialectType" value="mysql" />  
   14.             <!--<property name="sqlParser" ref="自定义解析类、可以没有" />  
   15.             <property name="localPage" value="默认 false 改为 true 开启了 pageHeper 支持、可以没有" />  
   16.             <property name="dialectClazz" value="自定义方言类、可以没有" /> -->  
   17.         </plugin>  
   18.   
   19.         <!-- SQL 执行性能分析，开发环境使用，线上不推荐。 maxTime 指的是 sql 最大执行时长 -->  
   20.         <plugin interceptor="com.baomidou.mybatisplus.plugins.PerformanceInterceptor">  
   21.             <property name="maxTime" value="2000" />  
   22.             <!--SQL是否格式化 默认false -->  
   23.             <property name="format" value="true" />  
   24.         </plugin>  
   25.   
   26.         <!-- SQL 执行分析拦截器 stopProceed 发现全表执行 delete update 是否停止运行 该插件只用于开发环境，不建议生产环境使用。。。 -->  
   27.         <plugin interceptor="com.baomidou.mybatisplus.plugins.SqlExplainInterceptor">  
   28.             <property name="stopProceed" value="false" />  
   29.         </plugin>  
   30.     </plugins>  
   31. </configuration>  
    注意：执行分析拦截器和性能分析推荐只在开发时调试程序使用，为保证程序性能和稳定性，建议在生产环境中注释掉这两个插件。
4. 数据源：(此处使用druid)
   Java代码  

   1. <!-- 配置数据源 -->  
   2. <bean name="dataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">  
   3.     <!--     <property name="driverClassName" value="${jdbc.driverClassName}" /> -->  
   4.     <property name="url" value="${jdbc.url}" />   
   5.     <property name="username" value="${jdbc.username}" />   
   6.     <property name="password" value="${jdbc.password}" />   
   7.     <property name="initialSize" value="${jdbc.initialSize}" />   
   8.     <property name="minIdle" value="${jdbc.minIdle}" />   
   9.     <property name="maxActive" value="${jdbc.maxActive}" />   
   10.     <property name="maxWait" value="${jdbc.maxWait}" />   
   11.     <property name="timeBetweenEvictionRunsMillis" value="${jdbc.timeBetweenEvictionRunsMillis}" />   
   12.     <property name="minEvictableIdleTimeMillis" value="${jdbc.minEvictableIdleTimeMillis}" />   
   13.     <property name="validationQuery" value="${jdbc.validationQuery}" />   
   14.     <property name="testWhileIdle" value="${jdbc.testWhileIdle}" />   
   15.     <property name="testOnBorrow" value="${jdbc.testOnBorrow}" />   
   16.     <property name="testOnReturn" value="${jdbc.testOnReturn}" />   
   17.     <property name="removeAbandoned" value="${jdbc.removeAbandoned}" />   
   18.     <property name="removeAbandonedTimeout" value="${jdbc.removeAbandonedTimeout}" />   
   19.     <!--     <property name="logAbandoned" value="${jdbc.logAbandoned}" /> -->  
   20.     <property name="filters" value="${jdbc.filters}" />  
   21.     <!-- 关闭abanded连接时输出错误日志 -->  
   22.     <property name="logAbandoned" value="true" />  
   23.     <property name="proxyFilters">  
   24.         <list>  
   25.             <ref bean="log-filter"/>  
   26.         </list>  
   27.     </property>  
   28.   
   29.     <!-- 监控数据库 -->  
   30.     <!-- <property name="filters" value="stat" /> -->  
   31.     <!--     <property name="filters" value="mergeStat" />-->  
   32. </bean>  

到此，MP已经集成进我们的项目中了，下面将介绍它是如何简化我们的开发的。

 

简单的CURD操作↓：

假设我们有一张user表，且已经建立好了一个与此表对应的实体类User，我们来介绍对user的简单增删改查操作。

1. 建立DAO层接口。我们在使用普通的mybatis时会建立一个DAO层接口，并对应一个xml用来写SQL。在这里我们同样要建立一个DAO层接口，但是若无必要，我们甚至不需要建立xml，就可以进行资源的CURD操作了，我们只需要让我们建立的DAO继承MP提供的BaseMapper<?>即可：
   Java代码  

   1. public interface UserMapper extends BaseMapper<User> { }  
    然后在我们需要做数据CURD时，像下边这样就好了：
   Java代码  

   1. // 初始化 影响行数  
   2. int result = 0;  
   3. // 初始化 User 对象  
   4. User user = new User();  
   5.   
   6. // 插入 User (插入成功会自动回写主键到实体类)  
   7. user.setName("Tom");  
   8. result = userMapper.insert(user);  
   9.   
   10. // 更新 User  
   11. user.setAge(18);  
   12. result = userMapper.updateById(user);//user要设置id哦，具体的在下边我会详细介绍  
   13.   
   14. // 查询 User  
   15. User exampleUser = userMapper.selectById(user.getId());  
   16.   
   17. // 查询姓名为‘张三’的所有用户记录  
   18. List<User> userList = userMapper.selectList(  
   19.         new EntityWrapper<User>().eq("name", "张三")  
   20. );  
   21.   
   22. // 删除 User  
   23. result = userMapper.deleteById(user.getId());  
    方便吧？如果只使用mybatis可是要写4个SQL和4个方法喔，当然了，仅仅上边这几个方法还远远满足不了我们的需求，请往下看：
2. 多条件分页查询：
   Java代码  

   1. // 分页查询 10 条姓名为‘张三’、性别为男，且年龄在18至50之间的用户记录  
   2. List<User> userList = userMapper.selectPage(  
   3.         new Page<User>(1, 10),  
   4.         new EntityWrapper<User>().eq("name", "张三")  
   5.                 .eq("sex", 0)  
   6.                 .between("age", "18", "50")  
   7. );  
   8.   
   9. /**等价于SELECT * 
   10. *FROM sys_user 
   11. *WHERE (name='张三' AND sex=0 AND age BETWEEN '18' AND '50') 
   12. *LIMIT 0,10 
   13. */  
    下边这个，多条件构造器。其实对于条件过于复杂的查询，笔者还是建议使用原生mybatis的方式实现，易于维护且逻辑清晰，如果所有的数据操作都强行使用MP，就失去了MP简化开发的意义了。所以在使用时请按实际情况取舍，在这里还是先介绍一下。
   Java代码  

   1. public Page<T> selectPage(Page<T> page, EntityWrapper<T> entityWrapper) {  
   2.   if (null != entityWrapper) {  
   3.       entityWrapper.orderBy(page.getOrderByField(), page.isAsc());//排序  
   4.   }  
   5.   page.setRecords(baseMapper.selectPage(page, entityWrapper));//将查询结果放入page中  
   6.   return page;  
   7. }  
    条件构造一(上边方法的entityWrapper参数)：
   
   Java代码  

   1. public void testTSQL11() {  
   2.     /* 
   3.      * 实体带查询使用方法  输出看结果 
   4.      */  
   5.     EntityWrapper<User> ew = new EntityWrapper<User>();  
   6.     ew.setEntity(new User(1));  
   7.     ew.where("user_name={0}", "'zhangsan'").and("id=1")  
   8.             .orNew("user_status={0}", "0").or("status=1")  
   9.             .notLike("user_nickname", "notvalue")  
   10.             .andNew("new=xx").like("hhh", "ddd")  
   11.             .andNew("pwd=11").isNotNull("n1,n2").isNull("n3")  
   12.             .groupBy("x1").groupBy("x2,x3")  
   13.             .having("x1=11").having("x3=433")  
   14.             .orderBy("dd").orderBy("d1,d2");  
   15.     System.out.println(ew.getSqlSegment());  
   16. }  
     条件构造二（同上）：
   Java代码  

   1. int buyCount = selectCount(Condition.create()  
   2.                 .setSqlSelect("sum(quantity)")  
   3.                 .isNull("order_id")  
   4.                 .eq("user_id", 1)  
   5.                 .eq("type", 1)  
   6.                 .in("status", new Integer[]{0, 1})  
   7.                 .eq("product_id", 1)  
   8.                 .between("created_time", startDate, currentDate)  
   9.                 .eq("weal", 1));  
    自定义条件使用entityWrapper：
   Java代码  

   1. List<User> selectMyPage(RowBounds rowBounds, @Param("ew") Wrapper<T> wrapper);  
    
   Xml代码  

   1. <select id="selectMyPage" resultType="User">  
   2.   SELECT * FROM user   
   3.   <where>  
   4.   ${ew.sqlSegment}  
   5.   </where>  
   6. </select>  
    注意：此处不用担心SQL注入，MP已对ew做了字符串转义处理。

其实在使用MP做数据CURD时，还有另外一个方法，AR(ActiveRecord )，很简单，让我们的实体类继承MP提供Model<?>就好了，这和我们常用的方法可能会有些不同，下边简单说一下吧：

Java代码  

1. //实体类  
2. @TableName("sys_user") // 注解指定表名  
3. public class User extends Model<User> {  
4.   
5.   ... // fields  
6.   
7.   ... // getter and setter  
8.   
9.   /** 指定主键 */  
10.   @Override  
11.   protected Serializable pkVal() {  //一定要指定主键哦  
12.       return this.id;  
13.   }  
14. }  

 下边就是CURD操作了：

Java代码  

1. // 初始化 成功标识  
2. boolean result = false;  
3. // 初始化 User  
4. User user = new User();  
5.   
6. // 保存 User  
7. user.setName("Tom");  
8. result = user.insert();  
9.   
10. // 更新 User  
11. user.setAge(18);  
12. result = user.updateById();  
13.   
14. // 查询 User  
15. User exampleUser = t1.selectById();  
16.   
17. // 查询姓名为‘张三’的所有用户记录  
18. List<User> userList1 = user.selectList(  
19.         new EntityWrapper<User>().eq("name", "张三")  
20. );  
21.   
22. // 删除 User  
23. result = t2.deleteById();  

 

Java代码  

1. // 分页查询 10 条姓名为‘张三’、性别为男，且年龄在18至50之间的用户记录  
2. List<User> userList = user.selectPage(  
3.         new Page<User>(1, 10),  
4.         new EntityWrapper<User>().eq("name", "张三")  
5.                 .eq("sex", 0)  
6.                 .between("age", "18", "50")  
7. ).getRecords();  

 就是这样了，可能你会说MP封装的有些过分了，这样做会分散数据逻辑到不同的层面中，难以管理，使代码难以理解。其实确实是这样，这就需要你在使用的时候注意一下了，在简化开发的同时也要保证你的代码层次清晰，做一个战略上的设计或者做一个取舍与平衡。

 

其实上边介绍的功能也不是MP的全部啦，下边介绍一下MP最有意思的模块——代码生成器。

步骤↓：

1. 如上边所说，使用代码生成器一定要引入velocity-engine-core(模板引擎)这个依赖。
2. 准备工作：

• 选择主键策略，就是在上边最开始时候我介绍MP配置时其中的这项配置，如果你不记得了，请上翻！MP提供了如下几个主键策略： 值 描述

  IdType.AUTO	数据库ID自增
  IdType.INPUT	用户输入ID
  IdType.ID_WORKER	全局唯一ID，内容为空自动填充（默认配置）
  IdType.UUID	全局唯一ID，内容为空自动填充

  MP默认使用的是ID_WORKER，这是MP在Sequence的基础上进行部分优化，用于产生全局唯一ID。

• 表及字段命名策略选择，同上，还是在那个配置中。下边这段复制至MP官方文档：

  在MP中，我们建议数据库表名采用下划线命名方式，而表字段名采用驼峰命名方式。

  这么做的原因是为了避免在对应实体类时产生的性能损耗，这样字段不用做映射就能直接和实体类对应。当然如果项目里不用考虑这点性能损耗，那么你采用下滑线也是没问题的，只需要在生成代码时配置dbColumnUnderline属性就可以。

• 建表(命名规则依照刚才你所配置的，这会影响生成的代码的类名、字段名是否正确)。
• 执行下边的main方法，生成代码：
  Java代码  

  1. import java.util.HashMap;  
  2. import java.util.Map;  
  3.   
  4. import com.baomidou.mybatisplus.generator.AutoGenerator;  
  5. import com.baomidou.mybatisplus.generator.InjectionConfig;  
  6. import com.baomidou.mybatisplus.generator.config.DataSourceConfig;  
  7. import com.baomidou.mybatisplus.generator.config.GlobalConfig;  
  8. import com.baomidou.mybatisplus.generator.config.PackageConfig;  
  9. import com.baomidou.mybatisplus.generator.config.StrategyConfig;  
  10. import com.baomidou.mybatisplus.generator.config.rules.DbType;  
  11. import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;  
  12.   
  13. /** 
  14.  * <p> 
  15.  * 代码生成器演示 
  16.  * </p> 
  17.  */  
  18. public class MpGenerator {  
  19.   
  20.     /** 
  21.      * <p> 
  22.      * MySQL 生成演示 
  23.      * </p> 
  24.      */  
  25.     public static void main(String[] args) {  
  26.         AutoGenerator mpg = new AutoGenerator();  
  27.   
  28.         // 全局配置  
  29.         GlobalConfig gc = new GlobalConfig();  
  30.         gc.setOutputDir("D://");  
  31.         gc.setFileOverride(true);  
  32.         gc.setActiveRecord(true);// 不需要ActiveRecord特性的请改为false  
  33.         gc.setEnableCache(false);// XML 二级缓存  
  34.         gc.setBaseResultMap(true);// XML ResultMap  
  35.         gc.setBaseColumnList(false);// XML columList  
  36.     // .setKotlin(true) 是否生成 kotlin 代码  
  37.         gc.setAuthor("Yanghu");  
  38.   
  39.         // 自定义文件命名，注意 %s 会自动填充表实体属性！  
  40.         // gc.setMapperName("%sDao");  
  41.         // gc.setXmlName("%sDao");  
  42.         // gc.setServiceName("MP%sService");  
  43.         // gc.setServiceImplName("%sServiceDiy");  
  44.         // gc.setControllerName("%sAction");  
  45.         mpg.setGlobalConfig(gc);  
  46.   
  47.         // 数据源配置  
  48.         DataSourceConfig dsc = new DataSourceConfig();  
  49.         dsc.setDbType(DbType.MYSQL);  
  50.         dsc.setTypeConvert(new MySqlTypeConvert(){  
  51.             // 自定义数据库表字段类型转换【可选】  
  52.             @Override  
  53.             public DbColumnType processTypeConvert(String fieldType) {  
  54.                 System.out.println("转换类型：" + fieldType);  
  55.         // 注意！！processTypeConvert 存在默认类型转换，如果不是你要的效果请自定义返回、非如下直接返回。  
  56.                 return super.processTypeConvert(fieldType);  
  57.             }  
  58.         });  
  59.         dsc.setDriverName("com.mysql.jdbc.Driver");  
  60.         dsc.setUsername("root");  
  61.         dsc.setPassword("521");  
  62.         dsc.setUrl("jdbc:mysql://127.0.0.1:3306/mybatis-plus?characterEncoding=utf8");  
  63.         mpg.setDataSource(dsc);  
  64.   
  65.         // 策略配置  
  66.         StrategyConfig strategy = new StrategyConfig();  
  67.     // strategy.setCapitalMode(true);// 全局大写命名 ORACLE 注意  
  68.         strategy.setTablePrefix(new String[] { "tlog_", "tsys_" });// 此处可以修改为您的表前缀  
  69.         strategy.setNaming(NamingStrategy.underline_to_camel);// 表名生成策略  
  70.         // strategy.setInclude(new String[] { "user" }); // 需要生成的表  
  71.         // strategy.setExclude(new String[]{"test"}); // 排除生成的表  
  72.         // 自定义实体父类  
  73.         // strategy.setSuperEntityClass("com.baomidou.demo.TestEntity");  
  74.         // 自定义实体，公共字段  
  75.         // strategy.setSuperEntityColumns(new String[] { "test_id", "age" });  
  76.         // 自定义 mapper 父类  
  77.         // strategy.setSuperMapperClass("com.baomidou.demo.TestMapper");  
  78.         // 自定义 service 父类  
  79.         // strategy.setSuperServiceClass("com.baomidou.demo.TestService");  
  80.         // 自定义 service 实现类父类  
  81.         // strategy.setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl");  
  82.         // 自定义 controller 父类  
  83.         // strategy.setSuperControllerClass("com.baomidou.demo.TestController");  
  84.         // 【实体】是否生成字段常量（默认 false）  
  85.         // public static final String ID = "test_id";  
  86.         // strategy.setEntityColumnConstant(true);  
  87.         // 【实体】是否为构建者模型（默认 false）  
  88.         // public User setName(String name) {this.name = name; return this;}  
  89.         // strategy.setEntityBuilderModel(true);  
  90.         mpg.setStrategy(strategy);  
  91.   
  92.         // 包配置  
  93.         PackageConfig pc = new PackageConfig();  
  94.         pc.setParent("com.baomidou");  
  95.         pc.setModuleName("test");  
  96.         mpg.setPackageInfo(pc);  
  97.   
  98.         // 注入自定义配置，可以在 VM 中使用 cfg.abc 【可无】  
  99.         InjectionConfig cfg = new InjectionConfig() {  
  100.             @Override  
  101.             public void initMap() {  
  102.                 Map<String, Object> map = new HashMap<String, Object>();  
  103.                 map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp");  
  104.                 this.setMap(map);  
  105.             }  
  106.         };  
  107.   
  108.         // 自定义 xxList.jsp 生成  
  109.         List<FileOutConfig> focList = new ArrayList<FileOutConfig>();  
  110.         focList.add(new FileOutConfig("/template/list.jsp.vm") {  
  111.             @Override  
  112.             public String outputFile(TableInfo tableInfo) {  
  113.                 // 自定义输入文件名称  
  114.                 return "D://my_" + tableInfo.getEntityName() + ".jsp";  
  115.             }  
  116.         });  
  117.         cfg.setFileOutConfigList(focList);  
  118.         mpg.setCfg(cfg);  
  119.   
  120.     // 调整 xml 生成目录演示  
  121.          focList.add(new FileOutConfig("/templates/mapper.xml.vm") {  
  122.             @Override  
  123.             public String outputFile(TableInfo tableInfo) {  
  124.                 return "/develop/code/xml/" + tableInfo.getEntityName() + ".xml";  
  125.             }  
  126.         });  
  127.         cfg.setFileOutConfigList(focList);  
  128.         mpg.setCfg(cfg);  
  129.   
  130.         // 关闭默认 xml 生成，调整生成 至 根目录  
  131.         TemplateConfig tc = new TemplateConfig();  
  132.         tc.setXml(null);  
  133.         mpg.setTemplate(tc);  
  134.   
  135.         // 自定义模板配置，可以 copy 源码 mybatis-plus/src/main/resources/templates 下面内容修改，  
  136.         // 放置自己项目的 src/main/resources/templates 目录下, 默认名称一下可以不配置，也可以自定义模板名称  
  137.         // TemplateConfig tc = new TemplateConfig();  
  138.         // tc.setController("...");  
  139.         // tc.setEntity("...");  
  140.         // tc.setMapper("...");  
  141.         // tc.setXml("...");  
  142.         // tc.setService("...");  
  143.         // tc.setServiceImpl("...");  
  144.     // 如上任何一个模块如果设置 空 OR Null 将不生成该模块。  
  145.         // mpg.setTemplate(tc);  
  146.   
  147.         // 执行生成  
  148.         mpg.execute();  
  149.   
  150.         // 打印注入设置【可无】  
  151.         System.err.println(mpg.getCfg().getMap().get("abc"));  
  152.     }  
  153.   
  154. }  
   说明：中间的内容请自行修改，注释很清晰。

成功生成代码，将生成的代码拷贝到你的项目中就可以了，这个东西节省了我们大量的时间和精力！

 

下边我将介绍MP提供的很有意思的插件：

1. 分页插件：插件的配置请看上边开篇时的MP配置部分。
   Java代码  

   1. public interface UserMapper{//可以继承或者不继承BaseMapper  
   2.     /** 
   3.      * <p> 
   4.      * 查询 : 根据state状态查询用户列表，分页显示 
   5.      * </p> 
   6.      * 
   7.      * @param page 
   8.      *            翻页对象，可以作为 xml 参数直接使用，传递参数 Page 即自动分页 
   9.      * @param state 
   10.      *            状态 
   11.      * @return 
   12.      */  
   13.     List<User> selectUserList(Pagination page, Integer state);  
   14. }  
    
   Java代码  

   1. public Page<User> selectUserPage(Page<User> page, Integer state) {  
   2.     page.setRecords(userMapper.selectUserList(page, state));  
   3.     return page;  
   4. }  
    
   Java代码  

   1. <select id="selectUserList" resultType="User">  
   2.     SELECT * FROM user WHERE state=#{state}  
   3. </select>  
    
2. 乐观锁插件：当要更新一条记录的时候，希望这条记录没有被别人更新过。

   其实原理很简单：

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

    插件的配置请看上边开篇时的MP配置部分，使用该插件的表必须拥有能够作为version的字段，比如update_date：

   Java代码  

   1. public class User {  
   2.   
   3.     @Version  
   4.     private Integer version;  
   5.   
   6.     ...  
   7. }  

    说明：version仅支持int,Integer,long,Long,Date,Timestamp类型。

   Java代码  

   1. int id = 100;  
   2. int version = 2;  
   3.   
   4. User u = new User();  
   5. u.setId(id);  
   6. u.setVersion(version);  
   7. u.setXXX(xxx);  
   8.   
   9. if(userService.updateById(u)){  
   10.     System.out.println("Update successfully");  
   11. }else{  
   12.     System.out.println("Update failed due to modified by others");  
   13. }  
   14. //等价于:<span style="color: #525252; font-family: 'Roboto Mono', Monaco, courier, monospace; font-size: 12.8px; background-color: #f8f8f8;">update tbl_user set name='update',version=3 where id=100 and version=2;  
   15. </span>  
3. 执行分析插件，作用是分析处理 DELETE UPDATE 语句， 防止小白或者恶意 delete update 全表操作，不推荐生产环境使用。具体配置请看上边开篇时的MP配置部分。
4. 性能分析插件，用于输出每条 SQL 语句及其执行时间，不推荐生产环境使用。具体配置请看上边开篇时的MP配置部分。
5. xml热加载插件，具体配置请看上边开篇时的MP配置部分。

好了，插件介绍到这，以下是注解说明，摘自官方文档：

注解说明

表名注解 @TableName

• com.baomidou.mybatisplus.annotations.TableName

值 描述

value	表名（ 默认空 ）
resultMap	xml 字段映射 resultMap ID

主键注解 @TableId

• com.baomidou.mybatisplus.annotations.TableId

值 描述

value	字段值（驼峰命名方式，该值可无）
type	主键 ID 策略类型（ 默认 INPUT ，全局开启的是 ID_WORKER ）

暂不支持组合主键

字段注解 @TableField

• com.baomidou.mybatisplus.annotations.TableField

值 描述

value	字段值（驼峰命名方式，该值可无）
el	详看注释说明
exist	是否为数据库表字段（ 默认 true 存在，false 不存在 ）
strategy	字段验证 （ 默认 非 null 判断，查看 com.baomidou.mybatisplus.enums.FieldStrategy ）
fill	字段填充标记 （ FieldFill, 配合自动填充使用 ）

• 字段填充策略 FieldFill

值 描述

DEFAULT	默认不处理
INSERT	插入填充字段
UPDATE	更新填充字段
INSERT_UPDATE	插入和更新填充字段

序列主键策略 注解 @KeySequence

• com.baomidou.mybatisplus.annotations.KeySequence

值 描述

value	序列名
clazz	id的类型

乐观锁标记注解 @Version

• com.baomidou.mybatisplus.annotations.Version

排除非表字段、查看文档常见问题部分！

 

 

     总结：MP的宗旨是简化开发，但是它在提供方便的同时却容易造成代码层次混乱，我们可能会把大量数据逻辑写到service层甚至contoller层中，使代码难以阅读。凡事过犹不及，在使用MP时一定要做分析，不要将所有数据操作都交给MP去实现。毕竟MP只是mybatis的增强工具，它并没有侵入mybatis的原生功能，在使用MP的增强功能的同时，原生mybatis的功能依然是可以正常使用的。