插件MybatisX的简单使用

插件MybatisX的简单使用

0.前置配置

起一个玩具级别的项目，简单配置必要环境

IDEA 2021.2.2
Maven 3.8.1
JDK 1.8
SpringBoot 2.x
Mysql 8.0

引入必要依赖

        <!--mybatis 和 mybatis-plus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.2.0</version>
        </dependency>

        <!-- mysql -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.27</version>
        </dependency>

在 文件 设置 插件 中找到 better-mybatis-generator 插件 依据需求可以选择所生成的实体类、DAO层和Servi层的路径以及映射文件.xml的路径。

但是要注意的一点，使用该生成插件时，对应的mybatis版本要对应，否则在dao层中所引用的BaseMapper基类会出现无法对应的情况而报错。

1.简单使用

1.1 实体类注解

	注解名	作用
1	@TableName(value=“表名”)	表名注解，用于标识实体类对应的表。
2	@TableId (type=IdType.AUTO) 用于主键注解	表示主键的类型，属性type的候选值为:AUTO(自增ID)，NONE(未设置类型)，INPUT(用户键入的ID)，ASSIGN_ID(为空是自动分配Number或String)，ASSIGN_UUID(传入为空时自动分配String类型主键)
3	@TableField 用于标识字段	非主键的其他字段，value可以用于标识非主键字段，完成JavaBean的映射。主要解决实体类的字段名与数据库的字段名部匹配的问题。fill属性通过FieldFill完成自动填充策略，condition属性设置查询 条件(不建议使用，不友好)。

1.2 CRUD常见用法

service层

需要有一个特有的接口如StudentInfo(不借用框架时接口命名应该规范)来继承IService这个父类接口，并且需要接口实现类XXXImpl实现该特有接口

/**
* @author jiusenguo
* @description 针对表【STUDENT_INFO】的数据库操作Service
* @createDate 2022-08-08 13:43:31
*/
public interface StudentInfoService extends IService<StudentInfo> {
}

/**
* @author jiusenguo
* @description 针对表【STUDENT_INFO】的数据库操作Service实现
* @createDate 2022-08-08 13:43:31
*/
@Service
public class StudentInfoServiceImpl extends ServiceImpl<StudentInfoMapper, StudentInfo>
    implements StudentInfoService{
}

BaseMapper

mybatis-plus 将常用的 CRUD 接口封装成了BaseMapper接口,我们只需要在自己的 Mapper 中继承

/**
* @author jiusenguo
* @description 针对表【STUDENT_INFO】的数据库操作Mapper
* @createDate 2022-08-08 13:43:31
* @Entity generator.domain.StudentInfo
*/
public interface StudentInfoMapper extends BaseMapper<StudentInfo> {
}

【主要用途】通过对baseMapper存在的一些通用方法或者自定义的部分逻辑方法完成创建，并在对应的xml中补全sql语句，详见第3节

1.3 其他用途

逻辑删除

通常追加字段 is-delete,通过全局配置的方式，配上其不同取值时的含义

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: isDelete # 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2)
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

也可以使用注解@TableLogic

@TableLogic
private Integer isDelete;

通用枚举配置

对前端而言，不再判断返回的值为0或1去展示男或女，直接采用枚举类。

自动填充

通过实现mybatis-plus所提供的接口MetaObjectHandler中的insertFill方法

在非主键字段上打上@TableField注解，并配置其fill属性值 fill = FildFill.INSERT

多元数据

多主多从

多种数据库

或者混合配置

@DS注解

同时存在就近原则，【方法上注解】优先于【类上注解】。

2.使用特性

2.1 XML跳转

在mapper接口中，在接口和方法前面都有红色头巾的飞鸟，点击即可跳转至resources路径下的对应xml格式的标签文件，用于完成sql语句的功能的填写。

2.2 重置模板

在Sratches and Consoles路径下找到MybatisX/templates/mybatis-plus3 可以对于生成的mapper的模板进行修改

2.3 JPA提示

可以通过对于表意性的提示，进行补全，然后采用上限文行动，创建mybatis的sql，可以见下图。

通过id和头衔按照降序查找id和年龄，使用JPA(太妙了)

3.mybatis使用

详见 MyBatis教程

MyBatis 教程_w3cschool

pom导入依赖

        <!--mybatis 和 mybatis-plus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.2.0</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-core</artifactId>
            <version>3.2.0</version>
        </dependency> 

4.常见Q&A

Q：为什么我启动报错啊? 明明mapper包的接口已经打上了@Repository注解啊？

nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'com.example.toyspringboot.generator.mapper.StudentInfoMapper' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {@org.springframework.beans.factory.annotation.Autowired(required=true)}

---

分析：没有将mapper下的接口识别为JavaBean，需要在项目启动入口类打上注解，告知mapper的扫描路径

@SpringBootApplication
@MapperScan("com.example.toyspringboot.generator.mapper")
public class ToyspringbootApplication {

    public static void main(String[] args) {
        SpringApplication.run(ToyspringbootApplication.class, args);
    }

}

Q：如何告知SpringBoot，xml类型的sql语句文件的路径呢？

---

如果 [java]路径下和[resources]路径下，路径相同+命名相同，则不用特地进行配置mapper-locations

若路径不同，则需要额外进行配置，告知其位置，防止扫描不到报错。

mybatis.mapper-locations=classpath:com/mapper/*.xml

但是，由于java和resources目录都有com/example目录，而上述配置在有相同目录的情况下，默认扫描的是java目录下的文件，从而导致xml文件加载不到resource路径下的配置文件扫描不到。

可以通过

• 修改.xml的位置

• 修改配置文件中的配置为

mybatis.mapper-locations=classpath*:com/mapper/*.xml

Q：关于classpath的写法与区别？

---

• classpath:xxx 和 classpath:/xxx 一样

• classpath:xxx 和 classpath*:xxx 不一样，前者表示引入一个(对于本次目的而言，扫描的是编译后的java所对应的class路径下)，后者表示引入多个(项目中满足要求的所有路径)

项目中含有多个classpath路径时，不加*表示仅仅加载的一个classpath路径，加了*则加载所有的（包括jar）

Q：mybatis是如何将mapper接口与.xml的sql语句文件进行对应呢？

---

具体可参考

mybatis如何通过接口查找对应的mapper.xml

大概画了个图… 也没画清楚 太琐碎了 工具也不太好用

大概意思就是首先会按递而来的Mapper名称去将文件中满足的mapper节点加入到一个容器中，SqlSession会通过接口的全路径来查找对应的xml，完成匹配。

在MapperRegistry.java中的方法

public <T> T getMapper(Class<T> type, SqlSession sqlSession) 

采用了动态代理设计模式。

【参考博客】

SpringBoot系列-- SpringBoot之Mybatis Generator生成器使用(多种方式)

Mybatis开发提高效率插件之mybatisx，mybatis-plus使用

看了我的mybatis-plus用法，同事也开始悄悄模仿了

mybatis mapper-locations作用