MyBatis-plus快速入门

一、MyBatis-plus有什么特色

1.代码生成

2.条件构造器

对我而言，主要的目的是使用它强大的条件构建器。

二、快速使用步骤

1. 添加pom文件依赖

<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity</artifactId>
    <version>1.7</version>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus</artifactId>
    <version>2.0.1</version> 
</dependency>

注意：mybatis-plus会自动维护mybatis以及mybatis-spring的依赖，所以不需要引入后两者，避免发生版本冲突。

2. 修改配置文件

1）将mybatis的sqlSessionFactory替换成mybatis-plus的即可，mybatis-plus只做了一些功能的扩展：

<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean">
    <property name="dataSource" ref="pooledDataSource"/>
    <!-- 配置实体扫描路径，多个package可以用分号;逗号，分隔，支持通配符* -->
    <!-- com.a.b.entity;com.a.c.entity;com.d.*.entity-->
    <!-- <property name="typeAliasesPackage" value="com.atguigu.crud.bean"/> --><!-- 暂时取消 -->
    <!-- XML配置 -->
    <property name="mapperLocations" value="classpath:mapping/**Mapper.xml" />
    <!-- MP全局配置 -->
    <property name="configuration" ref="mybatisConfig"/>
    <!-- MP全局策略 -->
    <property name="globalConfig" ref="globalConfig"/>
    <property name="plugins">
        <array>
            <!-- 分页插件配置 -->
            <bean id="paginationInterceptor" class="com.baomidou.mybatisplus.plugins.PaginationInterceptor">
                <!-- <property name="sqlParser" ref="自定义解析类、可以没有" /> -->
                <property name="localPage" value="true" /><!-- 默认 false 改为 true 开启了 pageHeper 支持、可以没有 -->
                <!-- <property name="dialectClazz" value="自定义方言类、可以没有" /> -->
            </bean>
            <!-- 乐观锁插件 -->
            <bean id="optimisticLockerInterceptor" class="com.baomidou.mybatisplus.plugins.OptimisticLockerInterceptor"></bean>
            <!-- 性能拦截器，兼打印sql，不生产环境配置 -->
            <bean id="performanceInterceptor" class="com.baomidou.mybatisplus.plugins.PerformanceInterceptor">
                <!-- SQL 执行最大时长，超过自动停止运行，有助于发现问题。 -->
                <property name="maxTime" value="100"></property>
                <!-- SQL 是否格式化 -->
                <property name="format" value="false"></property>
            </bean>
        </array>
    </property>
</bean>

2）MP全局配置

<bean id="mybatisConfig" class="com.baomidou.mybatisplus.MybatisConfiguration">
    <!-- 驼峰命名规则 -->
    <property name="mapUnderscoreToCamelCase" value="true"/>
    <!-- 部分数据库不识别默认的NULL类型（比如oracle，需要配置该属性） -->
    <!-- <property name="jdbcTypeForNull">
        <util:constant static-field="org.apache.ibatis.type.JdbcType.NULL"/>
    </property> -->
</bean>

3）MP全局策略

<bean id="globalConfig" class="com.baomidou.mybatisplus.entity.GlobalConfiguration">
    <!-- 逻辑删除，定义下面3个参数 -->
    <property name="sqlInjector" ref="logicSqlInjector"/>
    <property name="logicDeleteValue" value="-1"/>
    <property name="logicNotDeleteValue" value="1"/>
    <!-- 全局ID类型： AUTO->`0`("数据库ID自增") INPUT->`1`(用户输入ID") ID_WORKER->`2`("全局唯一ID") UUID->`3`("全局唯一ID") -->
    <property name="idType" value="2"/>
    <!-- 主键Sequence -->
    <!-- <property name="keyGenerator" ref="keyGenerator"/> -->
    <!-- 数据库类型MYSQL->`mysql` ORACLE->`oracle` DB2->`db2` HSQL->`hsql` -->
    <property name="dbType" value="mysql" />
    <!-- 全局表为下划线命名设置 true -->
    <property name="dbColumnUnderline" value="true" />
</bean>

4）配置oracle主键Sequence，其他类型数据库，请配置相应的类型

<!-- <bean id="keyGenerator" class="com.baomidou.mybatisplus.incrementer.OracleKeyGenerator"></bean> -->

5）逻辑删除Sql注入器

<bean id="logicSqlInjector" class="com.baomidou.mybatisplus.mapper.LogicSqlInjector"></bean>

6）配置mybatis扫描mapper接口的路径，相当于注解@MapperScan，@MapperScan("com.baomidou.mybatisplus.test.h2.entity.mapper")

<bean id="mapperScannerConfigurer" class="org.mybatis.spring.mapper.MapperScannerConfigurer">
    <property name="basePackage" value="com.ssmp.dao"></property>
</bean>

7）事务控制配置

<!-- 配置事务管理器 -->
<bean name="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
    <property name="dataSource" ref="pooledDataSource"></property>
</bean>
<!-- 事务管理属性 -->
<tx:advice id="transactionAdvice" transaction-manager="transactionManager">
    <tx:attributes>
        <tx:method name="insert*" propagation="REQUIRED"/>
        <tx:method name="update*" propagation="REQUIRED"/>
        <tx:method name="delete*" propagation="REQUIRED"/>
        <tx:method name="select*" propagation="SUPPORTS" read-only="true"/>
        <tx:method name="get*" propagation="SUPPORTS" read-only="true"/>
        <tx:method name="*" propagation="REQUIRED"/>
    </tx:attributes>
</tx:advice>
<!-- 配置切面 -->
<aop:config>
    <aop:pointcut id="transactionPointcut" expression="execution(* com.ssmp.serviceImpl..*.*(..))"/>
    <aop:advisor pointcut-ref="transactionPointcut" advice-ref="transactionAdvice"/>
</aop:config>

至此，配置工作就算大功告成了，接下来通过一个简单的例子来感受一下它的使用.

三、Java代码

1. 新建User表

@TableName("user")
public class User implements Serializable {
    private Long id;
    private String name;
    private Integer age;
    @TableField(exist = false)
    private String state;
}

这里有两个注解需要注意：

@tableName("user")，指定与数据库表的关联，数据库里应有一个名为user的表与之对应，并且数据表的列名应该就是User类的属性；

@TableField(exist = false)，对于User类中有而user表中没有的属性需要加上这个注解，表示排除User类中的属性。

2. 新建Dao层接口UserMapper

public interface UserMapper extends BaseMapper<User> {
    @Select("selectUserList")
    List<User> selectUserList(Pagination page,String state);
}

dao接口需要实现Basemapper，这样就能够使用封装好的很多通用方法，另外也可以自己编写方法，@select注解引用自第三步的UserMapper文件

3. 新建UserMapper配置文件

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.baomidou.springmvc.mapper.system.UserMapper">
    <!-- 通用查询结果列-->
    <sql id="Base_Column_List">
        id, name, age
    </sql>
    <select id="selectUserList" resultType="User">
        SELECT * FROM sys_user WHERE state=#{state}
    </select>
</mapper>

4.新建service层类UserService

@Service
public class UserService extends ServiceImpl<UserMapper, User>{
    public Page<User> selectUserPage(Page<User> page, String state) {
        page.setRecords(baseMapper.selectUserList(page,state));
        return page;
    }
}

UserService继承了ServiceImpl类，mybatis-plus通过这种方式为我们注入了UserMapper，这样可以使用service层默认为我们提供的很多方法，也可以调用我们自己在dao层编写的操作数据库的方法.Page类是mybatis-plus提供分页功能的一个model，继承了Pagination，这样我们也不需要自己再编写一个Page类，直接使用即可。

5. 新建controller层UserController

@Controller
public class UserController extends BaseController {
    @Autowired
    private IUserService userService;
    @ResponseBody
    @RequestMapping("/page")
    public Object selectPage(Model model){
        Page page=new Page(1,10);
        page = userService.selectUserPage(page, "NORMAL");
        return page;
    }
}

以上就完成了一个基本的功能，下面来看一下它的条件构建器.

四、mybatis-plus的条件构建器

1. 首先看一个条件构建器实例的简单实用

public void test(){
    EntityWrapper ew=new EntityWrapper();
    ew.setEntity(new User());
    String name="wang";
    Integer age=16;
    ew.where("name = {0}",name).andNew("age > {0}",age).orderBy("age");
    List<User> list = userService.selectList(ew);
    Page page2 = userService.selectPage(page, ew);
}

这里使用了一个条件包装类EntityWrapper，来进行对sql语句的拼装，原理也很好理解，上面的代码中，第一个list查询的结果就是查询数据库中name=wang并且age>16岁的所有记录并按照age排序.而第二个查询就是再多加一个分页的功能.

基本上来说，使用EntityWrapper可以简单地完成一些条件查询，但如果查询方法使用频率很高的话还是建议自己写在UserMapper里.

2. 自定义的mapper方法能不能使用EntityWrapper呢？当然可以

在Mappper中定义：

List<User> selectMyPage(RowBounds rowBounds, @Param("ew") Wrapper<T> wrapper);

在mapper文件中定义

<select id="selectMyPage" resultType="User">
    SELECT * FROM user ${ew.sqlSegment}
</select>

3. EntityMapper的条件拼接

对于EntityMapper的条件拼接，基本可以实现sql中常用的where，and，or，groupby，orderby等语法，具体构建方法可以灵活组合.

@Test
public void testTSQL11() {
    /*
     * 实体带查询使用方法  输出看结果
     */
    ew.setEntity(new User(1));
    ew.where("name={0}", "'zhangsan'").and("id=1")
            .orNew("status={0}", "0").or("status=1")
            .notLike("nlike", "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());
}