Spring boot学习之集成 tk.mybatis(5)

ゝ一纸荒年。 2022-04-23 16:14 283阅读 0赞

## 集成tk.mybatis的目的是什么？ ##

如果非要我给一个答案，那就是：懒，java是一门让人偷懒的语言，spring、struts等优秀框架简化了servlet，只需要几个简单的注解就能轻松上手web项目，hibernate简化了传统的jdbc，mybatis、lombok这些就不一一细说了(lombok前面文章中有)

## tk.mybatis的作用是什么？ ##

简单点说，它就是通用mapper插件。它能帮你完成最常用的增、删、改、查，如果你想，它还可以帮你完成更复杂的工作，待会我们以例子来见证它的神奇之处。

## 集成 tk.mybatis ##

##### 1、在pom.xml中添加依赖 #####

<dependency>
         <groupId>tk.mybatis</groupId>
         <artifactId>mapper-spring-boot-starter</artifactId>
         <version>1.2.4</version>
     </dependency>

##### 2、在启动类中指定MapperScan的扫描路径(指定扫描的包，这个包下面放一些接口，相当于DAO层) #####

@SpringBootApplication
    @MapperScan(basePackages = {"com.xt.app.base.mapper"})
    public class StudentManagerApplication {
        public static void main(String[] args) {
            SpringApplication.run(StudentManagerApplication.class, args);
        }
    }

##### 3、在代码中新建一个基础的Mapper类(这个类不要放在 MapperScan 的扫描路径下) #####

这边的话，我使用的是MySQL数据库，也是项目需要所以多继承了一个MySqlMapper，使用它主要是因为它可以帮我生成一些更复杂的 insert 相关的SQL，这些可以从看源码中得到，就不细说了（按需继承，一般第一个就够了）

package com.xt.app.base;
    
    import tk.mybatis.mapper.common.Mapper;
    import tk.mybatis.mapper.common.MySqlMapper;
    
    /**
     * create: xiaotian
     * date: 2019/2/17
     * 基类，用于帮助自动生成 Mapper 及 MySQL Mapper
     */
    public interface BaseMapper<T> extends Mapper<T>, MySqlMapper<T> {
    
    }

##### 4、写个自己的Mapper继承下 BaseMapper(这个类必须写在第二步MapperScan所指定的路径下) #####

package com.xt.app.base.mapper;
    
    import com.xt.app.base.dto.UserDTO;
    import org.apache.ibatis.annotations.Mapper;
    
    
    /**
     * 自动生成常用的数据库操作方法
     * 如：select、update、insert、delete 等
     */
    @Mapper
    public interface UserMapper extends BaseMapper<UserDTO> {
    }

##### 5、可以看到在上面的代码中传入了一个UserDTO，接下来再看看它 #####

下面代码中用到了三个lombok的组件，不懂的可以直接：[lombok的使用][lombok]

package com.xt.app.base.dto;
    
    import lombok.AllArgsConstructor;
    import lombok.Builder;
    import lombok.NoArgsConstructor;
    
    import javax.persistence.Id;
    import javax.persistence.Table;
    
    @Builder
    @NoArgsConstructor
    @AllArgsConstructor
    // 指定该实体对应的表名，跟数据库字段对应，小驼峰命名
    // 当进行查询时，会自动将 t_user 表的字段按类型、名称进行值注入
    @Table(name = "t_user")
    public class UserDTO  {
    
        // @Id 指定这个字段是一个主键
        @Id
        private String userId;
        private String userName;
        private String pwd;
        private String phone;
        private String idCard;
        private String email;
        private String address;
    
        /**
         * 还有一些其它的注解
         * javax.persistence.Column：指定数据库的字段名称，字段名称跟属性名称强绑定
         * javax.persistence.GeneratedValue
         *   IDENTITY：采用数据库ID自增长的方式来自增主键字段，Oracle 不支持这种方式；
         *       AUTO： JPA自动选择合适的策略，是默认选项；
         *   SEQUENCE：通过序列产生主键，通过@SequenceGenerator 注解指定序列名，MySql不支持这种方式
         *      TABLE：通过表产生主键，框架借由表模拟序列产生主键，使用该策略可以使应用更易于数据库移植
         * 对这些不了解的可以多看看 JPA..
         */
    }

##### 6、开始使用 #####

6.1 先把 UserMapper 自动注入  
![在这里插入图片描述][201904042000489.png]  
6.2 然后我们利用编辑器看一下它提供给我们的方法，我们以增、删、改、查四个方面来看  
![在这里插入图片描述][20190404200330720.png]![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwNjk4OTgz_size_16_color_FFFFFF_t_70]  
![在这里插入图片描述][2019040420042742.png]  
![在这里插入图片描述][20190404200443720.png]

##### 7、到现在大家应该也明白它是干嘛的了，简单易懂吧，为了让大家更快上手，我准备了几个常用的例子 #####

7.1 单条查询(组装数据部分用到的是 lombok 的链式写法，不知道的可以 baidu 一下)

// 组装需要查询的数据
    UserDTO queryUserDTO = UserDTO.builder()
            .userId(userLoginRequest.getUserId())
            .pwd(userLoginRequest.getPwd())
            .build();
    // 查询数据
    userMapper.selectOne(queryUserDTO);

7.2 多条查询

// 组装需要查询的数据
    UserDTO queryUserDTO = UserDTO.builder()
            .userId(userLoginRequest.getUserId())
            .pwd(userLoginRequest.getPwd())
            .build();
    // 查询数据
    userMapper.select(queryUserDTO);
    // 如果直接查全表
    userMapper.selectAll();

7.3 根据主键查询(这里我得提醒一下，selectByPrimaryKey 对应的参数是Object，但是传入的值一定要跟数据库类型对上，不然不会生效哦，别说我没提醒你~)

String userId = "123";
    UserDTO user = userMapper.selectByPrimaryKey(userId);

7.4 根据主键动态更新数据 (同样提醒一下，updateUserDTO中，主键必须有值，这个方法是动态更新字段的值，所以当字段为 null 的时候，不会进行更新)

UserDTO updateUserDTO = UserDTO.builder()
           .userId(userLoginRequest.getUserId())
            .pwd(userLoginRequest.getPwd())
            .build();
    userMapper.updateByPrimaryKeySelective(updateUserDTO);

上面的例子中，大家有看到如 selectByPrimaryKeySelective、deleteByPrimaryKeySelective 的用法都是一样的，只不过是查询、删除的意思，所以有一些只举例了几个，要学会举一反三哈，每个都说到是不可能的

7.5 自定义查询列，包括很多种查询方式

Example example = Example.builder(PlaceholderAlias.class).build();
    Example.Criteria criteria = example.createCriteria();
    // not in
    criteria.andNotIn("id", Arrays.asList(1, 3 , 5 , 7, 9));
    // equal
    criteria.andEqualTo("userId", "小天Smile");
    // between
    criteria.andBetween("age", 3, 20);
    // like
    criteria.andLike("idCard", "275423");
    // 大于、小于
    criteria.andGreaterThan("age", "60");
    criteria.andLessThan("age", "30");
    List<UserDTO> userList = userMapper.selectByExample(example);

7.6 自定义要修改的列以及where条件

// 要修改的列
    UserDTO record = UserDTO.builder().age(20).sex("女").build();
    
    // 要修改的where条件
    WeekendSqls<UserDTO> weekendSqls = WeekendSqls.custom();
    weekendSqls.andEqualTo("userId", "xiaotian");
    weekendSqls.andEqualTo("email", "xiaotian_test@qq.com");
    weekendSqls.andIn("age", Arrays.asList(19, 21));
    Example whereExample = Example.builder(UserDTO.class).where(weekendSqls).build();
    // 执行修改
    userMapper.updateByExampleSelective(record, whereExample);

后面两个例子(7.5、7.6)还有很多方法没有举例，但用法差不多的，目前这些已经能满足大部分业务要求了，最重要的还是需要大家去探索、学习~

[lombok]: https://blog.csdn.net/qq_20698983/article/details/83962002
[201904042000489.png]: /images/20220224/4459ed708ac54a95af23caef57008c96.png
[20190404200330720.png]: https://img-blog.csdnimg.cn/20190404200330720.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwNjk4OTgz_size_16_color_FFFFFF_t_70]: /images/20220224/65f9bd4f0a014a749219556a410f5ce9.png
[2019040420042742.png]: /images/20220224/40c7d372caec47fcb0824808f00c9dfe.png
[20190404200443720.png]: /images/20220224/89412b06fa974ae0a7f6b324fe53ab01.png