Mybatis-Plus——为Mybatis简化开发、提高效率

  • A+
所属分类:java

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

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

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

  1. 集成依赖,pom中加入依赖即可,不多说:
<!-- mybatis mybatis-plus mybatis-spring mvc -->
<dependency>
  <groupId>com.baomidou</groupId>
  <artifactId>mybatis-plus</artifactId>
  <version>${mybatis-plus.version}</version>
</dependency>
<dependency>
  <groupId>org.apache.velocity</groupId>
  <artifactId>velocity-engine-core</artifactId>
  <version>2.0</version>
</dependency>

说明:爱编程小编使用的版本为:mybatis-plus.version=2.1-gamma,上边的代码中有两个依赖,第一个是mybatis-plus核心依赖,第二个是使用代码生成器时需要的模板引擎依赖,若果你不打算使用代码生成器,此处可不引入。

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

2.集成依赖,pom中加入依赖即可,不多说:

<bean id="sqlSessionFactory"
  class="com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean">
  <!-- 配置数据源 -->
  <property name="dataSource" ref="dataSource" />
  <!-- 自动扫描 Xml 文件位置 -->
  <property name="mapperLocations" value="classpath*:com/ds/orm/mapper/**/*.xml" />
  <!-- 配置 Mybatis 配置文件(可无) -->
  <property name="configLocation" value="classpath:mybatis-config.xml" />
  <!-- 配置包别名,支持通配符 * 或者 ; 分割 -->
  <property name="typeAliasesPackage" value="com.ds.orm.model" />
  <!-- 枚举属性配置扫描,支持通配符 * 或者 ; 分割 -->
  <!-- <property name="typeEnumsPackage" value="com.baomidou.springmvc.entity.*.enums" 
    /> -->
  <!-- 以上配置和传统 Mybatis 一致 -->
 
  <!-- MP 全局配置注入 -->
  <property name="globalConfig" ref="globalConfig" />
</bean>
 
<!-- 定义 MP 全局策略 -->
<bean id="globalConfig" class="com.baomidou.mybatisplus.entity.GlobalConfiguration">
  <!-- 主键策略配置 -->
  <!-- 可选参数 AUTO->`0`("数据库ID自增") INPUT->`1`(用户输入ID") ID_WORKER->`2`("全局唯一ID") 
    UUID->`3`("全局唯一ID") -->
  <property name="idType" value="2" />
  <!-- 数据库类型配置 -->
  <!-- 可选参数(默认mysql) MYSQL->`mysql` ORACLE->`oracle` DB2->`db2` H2->`h2` 
    HSQL->`hsql` SQLITE->`sqlite` POSTGRE->`postgresql` SQLSERVER2005->`sqlserver2005` 
    SQLSERVER->`sqlserver` -->
  <property name="dbType" value="mysql" />
  <!-- 全局表为下划线命名设置 true -->
  <property name="dbColumnUnderline" value="true" />
  <property name="sqlInjector">
    <bean class="com.baomidou.mybatisplus.mapper.AutoSqlInjector" />
  </property>
</bean>
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
  <description>DAO接口所在包名,Spring会自动查找其下的类</description>
  <property name="basePackage" value="com.ds.orm.mapper" />
  <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
</bean>
<!-- 乐观锁插件 -->
<bean class="com.baomidou.mybatisplus.plugins.OptimisticLockerInterceptor" />
<!-- xml mapper热加载 sqlSessionFactory:session工厂 mapperLocations:mapper匹配路径 
  enabled:是否开启动态加载 默认:false delaySeconds:项目启动延迟加载时间 单位:秒 默认:10s sleepSeconds:刷新时间间隔 
  单位:秒 默认:20s -->
<bean class="com.baomidou.mybatisplus.spring.MybatisMapperRefresh">
  <constructor-arg name="sqlSessionFactory" ref="sqlSessionFactory" />
  <constructor-arg name="mapperLocations"
    value="classpath*:com/ds/orm/mapper/*/*.xml" />
  <constructor-arg name="delaySeconds" value="10" />
  <constructor-arg name="sleepSeconds" value="20" />
  <constructor-arg name="enabled" value="true" />
</bean>
<!-- 事务 -->
<bean id="transactionManager"
  class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
  <property name="dataSource" ref="dataSource" />
</bean>
<tx:annotation-driven transaction-manager="transactionManager"
  proxy-target-class="true" />

注意:只要做如上配置就可以正常使用mybatis了,不要重复配置。MP的配置和mybatis一样,都是配置一个sqlSessionFactory,只是现在所配置的类在原本的SqlSessionFactoryBean基础上做了增强。插件等配置请按需取舍。

3.插件配置,按需求配置就可以,此处把可以配置的插件都列了出来,具体的请看代码注释:

<configuration>
  <settings>
    <setting name="logImpl" value="SLF4J" />
    <!-- 字段为空时仍调用model的set方法或map的put方法 -->
    <setting name="callSettersOnNulls" value="true" />
  </settings>
  <plugins>
    <!-- | 分页插件配置 | 插件提供二种方言选择:1、默认方言 2、自定义方言实现类,两者均未配置则抛出异常! | overflowCurrent 
      溢出总页数,设置第一页 默认false | optimizeType Count优化方式 ( 版本 2.0.9 改为使用 jsqlparser 不需要配置 
      ) | -->
    <!-- 注意!! 如果要支持二级缓存分页使用类 CachePaginationInterceptor 默认、建议如下!! -->
    <plugin interceptor="com.baomidou.mybatisplus.plugins.PaginationInterceptor">
      <property name="dialectType" value="mysql" />
      <!--<property name="sqlParser" ref="自定义解析类、可以没有" />
      <property name="localPage" value="默认 false 改为 true 开启了 pageHeper 支持、可以没有" />
      <property name="dialectClazz" value="自定义方言类、可以没有" /> -->
    </plugin>
 
    <!-- SQL 执行性能分析,开发环境使用,线上不推荐。 maxTime 指的是 sql 最大执行时长 -->
    <plugin interceptor="com.baomidou.mybatisplus.plugins.PerformanceInterceptor">
      <property name="maxTime" value="2000" />
      <!--SQL是否格式化 默认false -->
      <property name="format" value="true" />
    </plugin>
 
    <!-- SQL 执行分析拦截器 stopProceed 发现全表执行 delete update 是否停止运行 该插件只用于开发环境,不建议生产环境使用。。。 -->
    <plugin interceptor="com.baomidou.mybatisplus.plugins.SqlExplainInterceptor">
      <property name="stopProceed" value="false" />
    </plugin>
  </plugins>
</configuration>

注意:执行分析拦截器和性能分析推荐只在开发时调试程序使用,为保证程序性能和稳定性,建议在生产环境中注释掉这两个插件。

4.数据源:(此处使用druid)

<!-- 配置数据源 -->
<bean name="dataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">
  <!--		<property name="driverClassName" value="${jdbc.driverClassName}" /> -->
  <property name="url" value="${jdbc.url}" /> 
  <property name="username" value="${jdbc.username}" /> 
  <property name="password" value="${jdbc.password}" /> 
  <property name="initialSize" value="${jdbc.initialSize}" /> 
  <property name="minIdle" value="${jdbc.minIdle}" /> 
  <property name="maxActive" value="${jdbc.maxActive}" /> 
  <property name="maxWait" value="${jdbc.maxWait}" /> 
  <property name="timeBetweenEvictionRunsMillis" value="${jdbc.timeBetweenEvictionRunsMillis}" /> 
  <property name="minEvictableIdleTimeMillis" value="${jdbc.minEvictableIdleTimeMillis}" /> 
  <property name="validationQuery" value="${jdbc.validationQuery}" /> 
  <property name="testWhileIdle" value="${jdbc.testWhileIdle}" /> 
  <property name="testOnBorrow" value="${jdbc.testOnBorrow}" /> 
  <property name="testOnReturn" value="${jdbc.testOnReturn}" /> 
  <property name="removeAbandoned" value="${jdbc.removeAbandoned}" /> 
  <property name="removeAbandonedTimeout" value="${jdbc.removeAbandonedTimeout}" /> 
  <!--	    <property name="logAbandoned" value="${jdbc.logAbandoned}" /> -->
  <property name="filters" value="${jdbc.filters}" />
  <!-- 关闭abanded连接时输出错误日志 -->
  <property name="logAbandoned" value="true" />
  <property name="proxyFilters">
    <list>
      <ref bean="log-filter"/>
    </list>
  </property>
 
  <!-- 监控数据库 -->
  <!-- <property name="filters" value="stat" /> -->
  <!--		<property name="filters" value="mergeStat" />-->
</bean>

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

简单的CURD操作↓:

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

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

然后在我们需要做数据CURD时,像下边这样就好了:

// 初始化 影响行数
int result = 0;
// 初始化 User 对象
User user = new User();
 
// 插入 User (插入成功会自动回写主键到实体类)
user.setName("Tom");
result = userMapper.insert(user);
 
// 更新 User
user.setAge(18);
result = userMapper.updateById(user);//user要设置id哦,具体的在下边我会详细介绍
 
// 查询 User
User exampleUser = userMapper.selectById(user.getId());
 
// 查询姓名为‘张三’的所有用户记录
List<User> userList = userMapper.selectList(
        new EntityWrapper<User>().eq("name", "张三")
);
 
// 删除 User
result = userMapper.deleteById(user.getId());

方便吧?如果只使用mybatis可是要写4个SQL和4个方法喔,当然了,仅仅上边这几个方法还远远满足不了我们的需求,请往下看:

2.多条件分页查询:

// 分页查询 10 条姓名为‘张三’、性别为男,且年龄在18至50之间的用户记录
List<User> userList = userMapper.selectPage(
        new Page<User>(1, 10),
        new EntityWrapper<User>().eq("name", "张三")
                .eq("sex", 0)
                .between("age", "18", "50")
);
 
/**等价于SELECT *
*FROM sys_user
*WHERE (name='张三' AND sex=0 AND age BETWEEN '18' AND '50')
*LIMIT 0,10
*/

下边这个,多条件构造器。其实对于条件过于复杂的查询,笔者还是建议使用原生mybatis的方式实现,易于维护且逻辑清晰,如果所有的数据操作都强行使用MP,就失去了MP简化开发的意义了。所以在使用时请按实际情况取舍,在这里还是先介绍一下。

public Page<T> selectPage(Page<T> page, EntityWrapper<T> entityWrapper) {
  if (null != entityWrapper) {
      entityWrapper.orderBy(page.getOrderByField(), page.isAsc());//排序
  }
  page.setRecords(baseMapper.selectPage(page, entityWrapper));//将查询结果放入page中
  return page;
}

条件构造一(上边方法的entityWrapper参数):

public void testTSQL11() {
    /*
     * 实体带查询使用方法  输出看结果
     */
    EntityWrapper<User> ew = new EntityWrapper<User>();
    ew.setEntity(new User(1));
    ew.where("user_name={0}", "'zhangsan'").and("id=1")
            .orNew("user_status={0}", "0").or("status=1")
            .notLike("user_nickname", "notvalue")
            .andNew("new=xx").like("hhh", "ddd")
            .andNew("pwd=11").isNotNull("n1,n2").isNull("n3")
            .groupBy("x1").groupBy("x2,x3")
            .having("x1=11").having("x3=433")
            .orderBy("dd").orderBy("d1,d2");
    System.out.println(ew.getSqlSegment());
}

条件构造二(同上):

int buyCount = selectCount(Condition.create()
                .setSqlSelect("sum(quantity)")
                .isNull("order_id")
                .eq("user_id", 1)
                .eq("type", 1)
                .in("status", new Integer[]{0, 1})
                .eq("product_id", 1)
                .between("created_time", startDate, currentDate)
                .eq("weal", 1));

自定义条件使用entityWrapper:

List<User> selectMyPage(RowBounds rowBounds, @Param("ew") Wrapper<T> wrapper);
  1. <select id="selectMyPage" resultType="User">
      SELECT * FROM user 
      <where>
      ${ew.sqlSegment}
      </where>
    </select>

    注意:此处不用担心SQL注入,MP已对ew做了字符串转义处理。

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

//实体类
@TableName("sys_user") // 注解指定表名
public class User extends Model<User> {
 
  ... // fields
 
  ... // getter and setter
 
  /** 指定主键 */
  @Override
  protected Serializable pkVal() {  //一定要指定主键哦
      return this.id;
  }
}

下边就是CURD操作了:

// 初始化 成功标识
boolean result = false;
// 初始化 User
User user = new User();
 
// 保存 User
user.setName("Tom");
result = user.insert();
 
// 更新 User
user.setAge(18);
result = user.updateById();
 
// 查询 User
User exampleUser = t1.selectById();
 
// 查询姓名为‘张三’的所有用户记录
List<User> userList1 = user.selectList(
        new EntityWrapper<User>().eq("name", "张三")
);
 
// 删除 User
result = t2.deleteById();

 

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

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

avatar

发表评论

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen: