Mybatis-Plus 笔记

最新推荐文章于 2023-05-30 17:29:45 发布

Paracosm

最新推荐文章于 2023-05-30 17:29:45 发布

阅读量208

点赞数

文章标签： mybatis

本文链接：https://blog.csdn.net/Paracosm/article/details/110706987

版权

Mybatis的一个增强工具
官方文档:https://baomidou.com/guide/

1.加入Mybatis-Plus依赖

<!-- https://mvnrepository.com/artifact/com.baomidou/mybatis-plus-boot-starter -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.1</version>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.2.3</version>
</dependency>

2.入口类加入注解@Mapperscan(“dao包的位置”)

3.编写配置文件

spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis-plus?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=root

#配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

#logging.level.root=info
#logging.level.com.nmsl.dao=debug

4.创建数据库和表结构

drop table if exists `user`;
create table `user`(
	`id` int(11) not null auto_increment,
	`name` VARCHAR(255) default null,
	`age` int(11) default null,
	`bir` timestamp null default null,
	primary key (`id`)
	
)engine=InnoDB default charset=utf8;

set FOREIGN_KEY_CHECKS =1;

5.开发实体类

@Data
@AllArgsConstructor
@NoArgsConstructor
@ToString
@Accessors(chain = true)
public class User {
    private String id;
    private String name;
    private Integer age;
    private Date bir;
}

6.dao接口继承baseMapper接口

//使用mybatis-plus增强接口
public interface UserDao extends BaseMapper<User> {
    //基础crud不需要写,自己集成了
    
    //业务
}

7.测试

    @Resource
    private UserDao userDao;
    

	//查询所有
    @Test
    void selectList(){
        List<User> users = userDao.selectList(null);
        users.forEach(user -> System.out.println("user="+user));
    }

    //查询一个
    @Test
    void selectByid(){
        User user = userDao.selectById("2");
        System.out.println("user==="+user);
    }

主键生成策略

UUID
自增id
雪花算法
redis生产
zookeeper生成

雪花算法:

snowflake是twitter开源的分布式id生成算法,结果是一个long类型的id.

核心思想:使用41bit作为毫秒数,10bit作为机器id ( 5个bit是数据中心,5个bit是机器id) , 12bit作为毫秒内的流水号 ( 意味着每个节点在每毫秒可以产生4096个id ) , 最后还有个符号位永远是0.

主键自增

数字库字段配置自增
实体类字段上 @TableId(type= IdType.AUTO)

常用注解

@TableName
@TableId
@TableField

@TableName 用于实体类名与表名不相同时–>指定表名

描述: 用来将实体对象与数据库表名完成映射.

范围: 类上

常见属性:

value: String类型,指定映射的表名

resultMap: String类型,用来指定XML配置中resultMap的id值.

@TableId 指明某个主键字段

描述: 主键注解

范围: 属性上

常见属性:

value: String类型,指定实体类中与表中对应的主键列名.

type: 枚举类型,指定主键生成类型.

@TableName("t_user")//默认将类名作为表名
public class User {

    @TableId(value = "id", type = IdType.AUTO) 
    private String id;	
    
    private String name;
    private Integer age;
    private Date bir;
}

@TableField 指明非主键字段

描述: 字段注解(非主键)

修饰范围: 用在属性上

常用属性:

value: String类型,用来指定对应数据库表中的字段名

el: String类型,映射为原生 #{ … } 逻辑, 相当于写在xml中的 #{ … } 部分

exist: boolean 是否为数据表字段, true代表是数据库字段

    @TableField(value = "username")
    private String name;			//记得将数据库中原本的name字段改为username


    @TableField(exist = false)  //不映射数据库表中的任何字段,代表不存在数据库中,排除在外
    private String aaa;

条件查询

条件查询 QueryWrapper的API

//条件查询
@Test
void selectFind(){
    QueryWrapper<User> queryWrapper = new QueryWrapper<>(); //条件 数值类型查询
    //queryWrapper.eq("age",23);    //等值查询
    //queryWrapper.lt("age",23);//小于
    //queryWrapper.le("age",23);//小于等于 gt 大于 ge大于等于
    List<User> users = userDao.selectList(queryWrapper);
    users.forEach(System.out::println);
}

模糊查询 like

//模糊查询
@Test
void testFindList(){
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.likeRight("username","罗");  //like ==>  %?%
    //likeLeft ==> %?   likeRigth ==> ?%
    List<User> users = userDao.selectList(queryWrapper);
    users.forEach(user -> System.out.println(users));
}

插入一条记录

    //添加记录
    @Test
    void save(){
        User user = new User();
        user.setName("王志涛").setAge(19).setId("4").setBir(new Date());
        userDao.insert(user);
    }

修改记录

 //修改方法
    //基于主键id进行修改
    @Test
    void updateById(){
        User user = userDao.selectById("4");
        user.setName("陈松悦");
        userDao.updateById(user);
    }



//批量修改 (通过条件来批量修改记录)

    @Test
    void update1(){
        User user = new User();
        user.setName("23岁的帅哥");    //除了指定的名字以外的属性值全部变的和四号一样了
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.eq("age",23);
        userDao.update(user,queryWrapper);
    }


    @Test
    void update2(){
        User user = new User();
        user.setName("23岁的帅哥").setBir(null).setAge(23);     //将属性设为null就不会改变原本的内容了
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.eq("age",19);
        userDao.update(user,queryWrapper);
    }

删除记录

//基于id删除
	@Test
    void deleteById(){
        userDao.deleteById("");
    }

//批量删除
    @Test
    void deleteByIdList(){
        List list = new ArrayList();
        list.add("1");
        list.add("4");
        list.add("5");
        userDao.deleteBatchIds(list);
        list.forEach(System.out::println);
    }

 //基于条件删除
    @Test
    void deleteByWrapper(){
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.eq("age",23);
        userDao.delete(queryWrapper);
    }

分页查询

原理是在查询结果之后加上一个分页的拦截,通过拦截来过滤分页效果

以springboot为例

//预先配置
@Configuration
@MapperScan("com.nmsl.dao")
@EnableTransactionManagement    //启用事务管理
public class MybatisPlusConfig {

    @Bean
    //分页拦截器对象 PaginationInterceptor
    public PaginationInterceptor paginationInterceptor() {
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
        // 设置请求的页面大于最大页后操作， true调回到首页，false 继续请求  默认false
        // paginationInterceptor.setOverflow(false);
        // 设置最大单页限制数量，默认 500 条，-1 不受限制
        // paginationInterceptor.setLimit(500);
        // 开启 count 的 join 优化,只针对部分 left join
        paginationInterceptor.setCountSqlParser(new JsqlParserCountOptimize(true));
        return paginationInterceptor;
    }
}


//===================================================================================
//分页查询  (不带条件)
    @Test
    void FindPage(){
        //参数1:当前页 , 参数2:每页显示记录数
        IPage<User> page = new Page<>();    //default(1,10)
        IPage<User> userIPage = userDao.selectPage(page, null);
        long total = userIPage.getTotal();
        System.out.println("总记录数"+total);
        userIPage.getRecords().forEach(user -> System.out.println("user"+user));
    }

//分页查询 (带条件 QueryWrapper)
    @Test
    void FindPage(){
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.eq("age",23);
        //参数1:当前页 , 参数2:每页显示记录数
        IPage<User> page = new Page<>();    //default(1,10)
        IPage<User> userIPage = userDao.selectPage(page, null);
        long total = userIPage.getTotal();
        System.out.println("总记录数"+total);
        userIPage.getRecords().forEach(user -> System.out.println("user"+user));
    }

Ps: 目前分页查询仅仅支持单表查询,不能用于表连接.如果非要相应的数据的话,可以使用子查询

乐观锁 : 每次更新的时候携带版本号, 通过比较版本号来判断数据有没有更新. 只对写操作加锁.

悲观锁 : 先上锁再操作

乐观锁插件字段上加 @Version 注解

取出记录时获取当前version
更新时带上这个version
执行更新时,set version = newVersion where version = oldVersion
如果version不对,就更新失败.

//使用方法.
@Version
private Integer version;

注册组件

//插件主体 MybatisPlusInterceptor

@Configuration
@MapperScan("scan.your.mapper.package")
public class MybatisPlusConfig {

   /**
    * 新的分页插件,一缓和二缓遵循mybatis的规则,需要设置 MybatisConfiguration#useDeprecatedExecutor = false 避免缓存出现问题(该属性会在旧插件移除后一同移除)
    */
   @Bean
   public MybatisPlusInterceptor mybatisPlusInterceptor() {
       MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
       interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
       return interceptor;
   }

   @Bean
   public ConfigurationCustomizer configurationCustomizer() {
       return configuration -> configuration.setUseDeprecatedExecutor(false);
   }
}

多数据源配置

为保证数据库产品稳定性,很多数据库都有双机热备功能. 一主多从. 一台主要是对外提供增删改查业务的生产服务器,从机负责读.

1.加入依赖

<!-- https://mvnrepository.com/artifact/com.baomidou/dynamic-datasource-spring-boot-starter -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
    <version>3.2.1</version>
</dependency>

2.配置文件

#指定默认数据源
spring.datasource.dynamic.primary=master 

spring.datasource.dynamic.datasource.master.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.dynamic.datasource.master.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.dynamic.datasource.master.url=jdbc:mysql://localhost:3306/mybatis-plus?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC
spring.datasource.dynamic.datasource.master.username=root
spring.datasource.dynamic.datasource.master.password=root

spring.datasource.dynamic.datasource..slave_1.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.dynamic.datasource..slave_1.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.dynamic.datasource..slave_1.url=jdbc:mysql://localhost:3306/mybatis-plus-1?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC
spring.datasource.dynamic.datasource..slave_1.username=root
spring.datasource.dynamic.datasource..slave_1.password=root



logging.level.root=info
logging.level.com.nmsl.dao=debug

3.编写service接口并实现

public interface UserService {
    List<User> selectAll(); //走从库
    void save(User user);   //走主库
}



@Service
@Transactional
@DS("master")
public class UserServiceImpl implements UserService {

    @Resource
    private UserDao userDao;

    @Override
    @DS("slave_1")    
    public List<User> selectAll() {
        //表示查询所有
        return userDao.selectList(null);
    }

    @Override
    public void save(User user) {
        userDao.insert(user);
    }
}



 @Test
    void select(){
    //如果没设置,默认走的主库,需要在实现类中用@DS注解来指明数据源
        userService.selectAll().forEach(user -> System.out.println("user" + user)); 
    }

如何切换数据源???

@DS注解

作用: 切换数据源

范围:方法 / 类 . 同时存在的话, 方法注解优先于类注解

value属性: 切换数据源名称

@Test
void select(){
    //如果没设置,默认走的主库,需要在实现类中用@DS注解来指明数据源
    userService.selectAll().forEach(user -> System.out.println("user" + user));
}

@Test
void saveMaster(){	//默认主数据源
    userService.save(new User("","2",23,null,null));
}

//Ps:这里主从同步还需要额外配置,这里只是为了说明两个方法分别对应的两个不同的主从数据库.
//建议观看官方文档 https://baomidou.com/guide/

代码生成器

<!-- https://mvnrepository.com/artifact/p6spy/p6spy -->
<!--性能分析器-->
<dependency>
    <groupId>p6spy</groupId>
    <artifactId>p6spy</artifactId>
    <version>3.9.1</version>
</dependency>

<!--代码生成器-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.4.1</version>
</dependency>

<!--默认模板引擎 Velocity-->
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.2</version>
</dependency>

可以采用自定义模板引擎 Freemarker、Beetl等,去官方文档查看.但如果是非默认引起需要AutoGenerator 中设置模板引擎。

public class CodeGenerator{

    /**
     * <p>
     * 读取控制台内容
     * </p>
     */
    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("请输入" + tip + "：");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotBlank(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "！");
    }

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("jobob");
        gc.setOpen(false);
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/ant?useUnicode=true&useSSL=false&characterEncoding=utf8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("密码");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(scanner("模块名"));
        pc.setParent("com.baomidou.ant");
        mpg.setPackageInfo(pc);

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };

        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 velocity
        // String templatePath = "/templates/mapper.xml.vm";

        // 自定义输出配置
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
                return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判断自定义文件夹是否需要创建
                checkDir("调用默认方法创建的目录，自定义目录用");
                if (fileType == FileType.MAPPER) {
                    // 已经生成 mapper 文件判断存在，不想重新生成返回 false
                    return !new File(filePath).exists();
                }
                // 允许生成模板文件
                return true;
            }
        });
        */
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();

        // 配置自定义输出模板
        //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
        // templateConfig.setEntity("templates/entity2.java");
        // templateConfig.setService();
        // templateConfig.setController();

        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父类
        strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
        // 写于父类中的公共字段
        strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }

}

Ps:发现最新版跟之前改动了很多,比如说性能分析器变成了执行 SQL 分析打印…

Paracosm

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Mybatis-Plus 笔记

Mybatis的一个增强工具官方文档:https://baomidou.com/guide/1.加入Mybatis-Plus依赖<dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plu
复制链接

扫一扫