AI专业者开发社区 1 号成员
  •  0 回帖  •  1 浏览  •  5 个月前
   

优雅高效的MyBatis-Plus工具快速入门使用

　　　目前正在维护的公司的一个项目是一个 ssm 架构的 java 项目,dao 层的接口有大量数据库查询的方法, 一个条件变化就要对应一个方法, 再加上一些通用的 curd 方法, 对应一张表的 dao 层方法有时候多达近 20 个, 果断决定优化一下, 经过一番探索, 发现了一个 mybatis 的好伴侣,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. 修改配置文件

　　将 mybatis 的 sqlSessionFactory 替换成 mybatis-plus 的即可,mybatis-plus 只做了一些功能的扩展:

<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"/>
        <!-- 自动扫描 Mapping.xml 文件 -->
        <property name="mapperLocations" value="classpath:mybatis/*/*.xml"/>
        <property name="configLocation" value="classpath:mybatis/mybatis-config.xml"/>
        <property name="typeAliasesPackage" value="com.baomidou.springmvc.model.*"/>
        <property name="plugins">
            <array>
                <!-- 分页插件配置 -->
                <bean id="paginationInterceptor" class="com.baomidou.mybatisplus.plugins.PaginationInterceptor">
                    <property name="dialectType" value="mysql"/>
                </bean>
            </array>
        </property>
        <!-- 全局配置注入 -->
        <property name="globalConfig" ref="globalConfig" /> 
</bean>

　　在上面的配置中, 除了 mybatis 的常规配置, 多了一个分页插件的配置和全局配置,mybatis-plus 提供了很方便的使用分页的插件, 还有一个全局配置如下:　　

<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`
            ORACLE->`oracle`
            DB2->`db2`
            H2->`h2`
            HSQL->`hsql`
            SQLITE->`sqlite`
            POSTGRE->`postgresql`
            SQLSERVER2005->`sqlserver2005`
            SQLSERVER->`sqlserver`
        -->
        <!-- Oracle 需要添加该项 -->
        <!-- <property name="dbType" value="oracle" /> -->
        <!-- 全局表为下划线命名设置 true -->
        <property name="dbColumnUnderline" value="true" />
    </bean>

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

　　1. 新建一个 User 表:

@TableName("user")
public class User implements Serializable {

</span><span style="color: rgba(0, 128, 0, 1)">/**</span><span style="color: rgba(0, 128, 0, 1)"> 用户ID </span><span style="color: rgba(0, 128, 0, 1)">*/</span>
<span style="color: rgba(0, 0, 255, 1)">private</span><span style="color: rgba(0, 0, 0, 1)"> Long id;

</span><span style="color: rgba(0, 128, 0, 1)">/**</span><span style="color: rgba(0, 128, 0, 1)"> 用户名 </span><span style="color: rgba(0, 128, 0, 1)">*/</span>
<span style="color: rgba(0, 0, 255, 1)">private</span><span style="color: rgba(0, 0, 0, 1)"> String name;

</span><span style="color: rgba(0, 128, 0, 1)">/**</span><span style="color: rgba(0, 128, 0, 1)"> 用户年龄 </span><span style="color: rgba(0, 128, 0, 1)">*/</span>
<span style="color: rgba(0, 0, 255, 1)">private</span><span style="color: rgba(0, 0, 0, 1)"> Integer age;

@TableField(exist </span>= <span style="color: rgba(0, 0, 255, 1)">false</span><span style="color: rgba(0, 0, 0, 1)">)
</span><span style="color: rgba(0, 0, 255, 1)">private</span><span style="color: rgba(0, 0, 0, 1)"> String state;



}

　　这里有两个注解需要注意, 第一是@tableName("user"), 它是指定与数据库表的关联, 这里的注解意味着你的数据库里应该有一个名为 user 的表与之对应, 并且数据表的列名应该就是 User 类的属性, 对于 User 类中有而 user 表中没有的属性需要加第二个注解@TableField(exist = false), 表示排除 User 类中的属性.

     2. 新建 Dao 层接口 UserMapper:

/**
 * User 表数据库控制层接口
 */
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">

<span style="color: rgba(0, 128, 0, 1)">&lt;!--</span><span style="color: rgba(0, 128, 0, 1)"> 通用查询结果列</span><span style="color: rgba(0, 128, 0, 1)">--&gt;</span>
<span style="color: rgba(0, 0, 255, 1)">&lt;</span><span style="color: rgba(128, 0, 0, 1)">sql </span><span style="color: rgba(255, 0, 0, 1)">id</span><span style="color: rgba(0, 0, 255, 1)">="Base_Column_List"</span><span style="color: rgba(0, 0, 255, 1)">&gt;</span><span style="color: rgba(0, 0, 0, 1)">
    id, name, age
</span><span style="color: rgba(0, 0, 255, 1)">&lt;/</span><span style="color: rgba(128, 0, 0, 1)">sql</span><span style="color: rgba(0, 0, 255, 1)">&gt;</span>

<span style="color: rgba(0, 0, 255, 1)">&lt;</span><span style="color: rgba(128, 0, 0, 1)">select </span><span style="color: rgba(255, 0, 0, 1)">id</span><span style="color: rgba(0, 0, 255, 1)">="<strong><span style="color: rgba(0, 0, 0, 1)">selectUserList</span></strong>"</span><span style="color: rgba(255, 0, 0, 1)"> resultType</span><span style="color: rgba(0, 0, 255, 1)">="User"</span><span style="color: rgba(0, 0, 255, 1)">&gt;</span><span style="color: rgba(0, 0, 0, 1)">
    SELECT * FROM sys_user WHERE state=#{state}
</span><span style="color: rgba(0, 0, 255, 1)">&lt;/</span><span style="color: rgba(128, 0, 0, 1)">select</span><span style="color: rgba(0, 0, 255, 1)">&gt;</span>



</mapper>

　　4. 新建 service 层类 UserService:

/**
 *
 * User 表数据服务层接口实现类
 *
 */
@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
</span><span style="color: rgba(0, 0, 255, 1)">private</span><span style="color: rgba(0, 0, 0, 1)"> IUserService userService;

@ResponseBody
@RequestMapping(</span>"/page"<span style="color: rgba(0, 0, 0, 1)">)
</span><span style="color: rgba(0, 0, 255, 1)">public</span><span style="color: rgba(0, 0, 0, 1)"> Object selectPage(Model model){

    Page page</span>=<span style="color: rgba(0, 0, 255, 1)">new</span> Page(1,10<span style="color: rgba(0, 0, 0, 1)">);
    page </span>= userService.selectUserPage(page, "NORMAL"<span style="color: rgba(0, 0, 0, 1)">);
    </span><span style="color: rgba(0, 0, 255, 1)">return</span><span style="color: rgba(0, 0, 0, 1)"> page;
}</span></pre>

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

mybatis-plus 的条件构建器

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

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 里.

　　那么自定义的 mapper 方法能不能使用 EntityWrapper 呢, 当然也是可以的.

　　文档中给了一个这样的例子.

　　1. 在 Mappper 中定义:

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

 　　2. 在 mapper 文件中定义:

<select id="selectMyPage" resultType="User">

　　 SELECT * FROM user ${ew.sqlSegment}

</select>

 　　对于 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());
}

 参考文档

    mybaits-plus 官方文档