首页 > 其他分享> > 详讲mybatis-plus基本操作API

详讲mybatis-plus基本操作API

2021-01-07 20:31:22 作者：互联网

文章目录

概念
配置
操作前的准备
mapper接口基本的crud操作演示
关于wrapper的条件查询用法

概念

无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑

损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作

强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求

支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错

支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题

支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作

支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）

内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用

内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询

分页插件支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库

内置性能分析插件：可输出 Sql 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询

内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作

配置

pom.xml配置

springboot方式的依赖

   <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.0</version>
        </dependency>

App.class配置

这里要加MybatisPlusInterceptor用于分页的配置,mybatisPlus自带分页的Api
这里添加的WebMvcConfigurer 是为了作跨域访问而配置

@SpringBootApplication
@MapperScan("com.edt.mapper")
public class App {
    public static void main(String[] args) {
        SpringApplication.run(App.class,args);
    }

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        PaginationInnerInterceptor paginationInnerInterceptor = new PaginationInnerInterceptor(DbType.MYSQL);
        paginationInnerInterceptor.setOverflow(true); //合理化
        interceptor.addInnerInterceptor(paginationInnerInterceptor);
        return interceptor;
    }

    //跨域访问
    @Bean
    public WebMvcConfigurer corsConfigurer() {
        return new WebMvcConfigurer() {
            @Override
            //重写父类提供的跨域请求处理的接口
            public void addCorsMappings(CorsRegistry registry) {
                //添加映射路径
                registry.addMapping("/**")
                        //放行哪些原始域
                        .allowedOrigins("*")
                        //是否发送Cookie信息
                        .allowCredentials(true)
                        //放行哪些原始域(请求方式)
                        .allowedMethods("GET", "POST", "PUT", "DELETE","OPTIONS")
                        //放行哪些原始域(头部信息)
                        .allowedHeaders("*")
                        //暴露哪些头部信息（因为跨域访问默认不能获取全部头部信息）
                        .exposedHeaders("Header1", "Header2");
            }
        };

    }
}

application.properties配置

#连接数据库
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql:///test?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=19980220

#mybatis-plus - 打印sql日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImp

@SpringBootApplication
@MapperScan("com.edt.mapper")
public class App {
    public static void main(String[] args) {
        SpringApplication.run(App.class,args);
    }

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        PaginationInnerInterceptor paginationInnerInterceptor = new PaginationInnerInterceptor(DbType.MYSQL);
        paginationInnerInterceptor.setOverflow(true); //合理化
        interceptor.addInnerInterceptor(paginationInnerInterceptor);
        return interceptor;
    }
}

操作前的准备

使用mybatisPlus的mapper接口

使用mybatisPlus以后,则无需写xml文件里的sql语句了(指基本的增删改),默认就拥有了基本的api,例如deleteByid,updateById等
想要自定义其他sql写法和连表操作,还是可以使用xml配置写sql语句的方式,mybatisplus 只是对mybatis做增强,原来的操作一样可以
继承以下BaseMapper<实体类>即可

public interface EmployeeMapper extends BaseMapper<Employee> {

}

使用mybatisPlus的service接口

IXXXService

继承mybatisPlus的类 IService

public interface IEmployeeService extends IService<Employee> {

    Page<Employee> queryPage(EmployeeQueryObject qo);
}

XXXServiceImpl

实现接口以外,还要继承mybatisPlus提供的ServiceImpl类,原因是ServiceImpl实现了IService接口的通用的crud方法,所以此业务层也能直接使用基本crud的api了

继承ServiceImpl类需要明确2个泛型

     参数一: mybatis-plus 映射接口XXXMapper  

     参数二: service操作的实体对象

@Service
public class EmployeeServiceImpl extends ServiceImpl<EmployeeMapper, Employee> implements IEmployeeService {

    @Override
    public Page<Employee> queryPage(EmployeeQueryObject qo) {
        Page<Employee> page = new Page<>(qo.getCurrentPage(), qo.getPageSize());
//        查询条件
        QueryWrapper<Employee> wrapper = new QueryWrapper<>();
        wrapper.like("name",qo.getKeyWord());
        return super.page(page,wrapper);
    }
}

实体类所要贴的注解

mybatisPlus 让实体类映射数据库流程图

mybatisPlust实体类的相关注解说明
mybatisPlus会自动将实体类按照驼峰命名法解析到数据库,所以有些情况需要一些注解去优化
@TableName(“表名”) 贴在实体类上与表名一致,默认是驼峰命名匹配,若默认方式不匹配则需要贴这个注解
@TableId(value = “id”,type = IdType.AUTO)//指定id自动增长
@TableField(exist = false)指定当前属性不参与sql解析,此属性不映射表的列
@TableField(“xxx”) 指定当前属性对应的列名

@Setter
@Getter
@ToString
//@TableName("t_employee")//默认实体类名与表名一致,要更改则加此注解
public class Employee {
    @TableId(value = "id",type = IdType.AUTO)//指定id自动增长
    private Long id;
    //@TableField("employeeName")//指定当前属性对应的列名
    private String name;
    private String password;
    private String email;
    private int age;
    private int admin;
    private Long deptId;
    @TableField(exist = false) //指定当前属性不参与sql解析,此属性不映射表的列
    private Department dept;
}