Spring Boot整合MyBatis Plus完整配置教程

spring boot整合mybatis plus可通过以下步骤实现:1. 添加mybatis plus和数据库连接器依赖;2. 配置数据源信息;3. 创建与表对应的实体类;4. 创建继承basemapper的mapper接口;5. 编写service调用mapper方法;6. 创建controller提供api接口。此外,可使用mybatis plus代码生成器自动生成代码,通过配置生成器参数并运行生成代码。分页查询可通过引入page对象并在mapper中调用selectpage方法实现。自定义sql注入器需创建继承defaultsqlinjector的类并添加自定义方法,同时定义对应sql逻辑并在mapper接口中声明。乐观锁功能则通过在实体类添加@version注解字段并配置optimisticlockerinnerinterceptor拦截器实现,更新数据时自动处理版本号以防止并发冲突。

Spring Boot整合MyBatis Plus完整配置教程

spring boot整合MyBatis Plus,简单来说,就是让你的Spring Boot项目能更方便地操作数据库。MyBatis Plus简化了MyBatis的很多繁琐配置,让开发者可以更专注于业务逻辑。下面就来详细说说怎么配置。

Spring Boot整合MyBatis Plus完整配置教程

解决方案

  1. 添加依赖

首先,在你的pom.xml文件中添加MyBatis Plus的依赖。

   <dependency>        <groupId>com.baomidou</groupId>        <artifactId>mybatis-plus-boot-starter</artifactId>        <version>3.5.3.1</version> <!-- 使用最新版本 -->    </dependency>    <dependency>        <groupId>mysql</groupId>        <artifactId>mysql-connector-java</artifactId>        <version>8.0.33</version> <!-- 使用最新版本 -->    </dependency>

这里顺便加上了MySQL的连接器,因为大部分项目都会用MySQL。如果你用的是其他数据库,比如postgresql,就要换成对应的连接器。

Spring Boot整合MyBatis Plus完整配置教程

  1. 配置数据源

在application.properties或者application.yml中配置数据源。

application.properties:

Spring Boot整合MyBatis Plus完整配置教程

   spring.datasource.url=jdbc:mysql://localhost:3306/your_database?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai    spring.datasource.username=your_username    spring.datasource.password=your_password    spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

application.yml:

   spring:      datasource:        url: jdbc:mysql://localhost:3306/your_database?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai        username: your_username        password: your_password        driver-class-name: com.mysql.cj.jdbc.Driver

别忘了把your_database、your_username、your_password改成你自己的数据库信息。serverTimezone也要设置成你所在的时区,不然可能会遇到时间问题。

  1. 创建实体类

创建一个实体类,对应数据库中的表。

   import com.baomidou.mybatisplus.annotation.IdType;    import com.baomidou.mybatisplus.annotation.TableId;    import com.baomidou.mybatisplus.annotation.TableName;    import lombok.Data;     @Data    @TableName("user") // 对应数据库中的表名    public class User {        @TableId(type = IdType.AUTO) // 主键自增        private Long id;        private String name;        private Integer age;        private String email;    }

@TableName注解用来指定表名,@TableId注解用来指定主键,@Data是Lombok的注解,可以自动生成getter和setter方法。

  1. 创建Mapper接口

创建一个Mapper接口,继承BaseMapper。

   import com.baomidou.mybatisplus.core.mapper.BaseMapper;    import org.apache.ibatis.annotations.Mapper;     @Mapper    public interface UserMapper extends BaseMapper<User> {        // 可以自定义sql语句,也可以使用MyBatis Plus提供的通用方法    }

@Mapper注解是MyBatis的注解,用来告诉Spring这是一个Mapper接口。BaseMapper是MyBatis Plus提供的通用Mapper接口,里面有很多常用的CRUD方法。

  1. 编写Service

创建一个Service类,调用Mapper接口的方法。

   import org.springframework.beans.factory.annotation.Autowired;    import org.springframework.stereotype.Service;     import java.util.List;     @Service    public class UserService {         @Autowired        private UserMapper userMapper;         public User getUserById(Long id) {            return userMapper.selectById(id);        }         public List<User> getAllUsers() {            return userMapper.selectList(null);        }         public void addUser(User user) {            userMapper.insert(user);        }         public void updateUser(User user) {            userMapper.updateById(user);        }         public void deleteUser(Long id) {            userMapper.deleteById(id);        }    }

这里使用了@Autowired注解来注入UserMapper。然后就可以调用userMapper的方法来操作数据库了。

  1. 编写Controller

创建一个Controller类,提供API接口。

   import org.springframework.beans.factory.annotation.Autowired;    import org.springframework.web.bind.annotation.*;     import java.util.List;     @RestController    @RequestMapping("/users")    public class UserController {         @Autowired        private UserService userService;         @GetMapping("/{id}")        public User getUserById(@PathVariable Long id) {            return userService.getUserById(id);        }         @GetMapping        public List<User> getAllUsers() {            return userService.getAllUsers();        }         @PostMapping        public void addUser(@RequestBody User user) {            userService.addUser(user);        }         @PutMapping("/{id}")        public void updateUser(@PathVariable Long id, @RequestBody User user) {            user.setId(id);            userService.updateUser(user);        }         @DeleteMapping("/{id}")        public void deleteUser(@PathVariable Long id) {            userService.deleteUser(id);        }    }

这里使用了@RestController和@RequestMapping注解来定义API接口。然后就可以通过http请求来访问这些接口了。

MyBatis Plus 代码生成器如何使用?

MyBatis Plus的代码生成器可以帮你自动生成实体类、Mapper接口、Service和Controller,大大提高开发效率。

  1. 添加代码生成器依赖
   <dependency>        <groupId>com.baomidou</groupId>        <artifactId>mybatis-plus-generator</artifactId>        <version>3.5.3.1</version>    </dependency>    <dependency>        <groupId>org.apache.velocity</groupId>        <artifactId>velocity-engine-core</artifactId>        <version>2.3</version> <!-- 使用最新版本 -->    </dependency>

这里添加了mybatis-plus-generator和velocity-engine-core的依赖。velocity-engine-core是代码生成器使用的模板引擎。

  1. 编写代码生成器配置

创建一个类,编写代码生成器的配置。

   import com.baomidou.mybatisplus.generator.FastAutoGenerator;    import com.baomidou.mybatisplus.generator.config.OutputFile;    import com.baomidou.mybatisplus.generator.engine.VelocityTemplateEngine;     import java.util.Collections;     public class CodeGenerator {         public static void main(String[] args) {            FastAutoGenerator.create("jdbc:mysql://localhost:3306/your_database?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai", "your_username", "your_password")                    .globalConfig(builder -> {                        builder.author("Your Name") // 设置作者                                .outputDir("D://code") // 设置输出目录                                .commentDate("yyyy-MM-dd")                                .enableSwagger() // 开启 swagger 模式                                .fileOverride(); // 覆盖已生成文件                    })                    .packageConfig(builder -> {                        builder.parent("com.example") // 设置父包名                                .moduleName("demo") // 设置父包模块名                                .entity("entity") // 设置实体类包名                                .service("service") // 设置service包名                                .serviceImpl("service.impl") // 设置serviceImpl包名                                .mapper("mapper") // 设置mapper包名                                .xml("mapper.xml")                                .controller("controller") // 设置controller包名                                .pathInfo(Collections.singletonMap(OutputFile.mapperXml, "D://code//mapper")); // 设置mapperXml生成路径                    })                    .strategyConfig(builder -> {                        builder.addInclude("user") // 设置需要生成的表名                                .addTablePrefix("t_", "c_") // 设置过滤表前缀                                .entityBuilder()                                .enableLombok()                                .enableTableFieldAnnotation()                                .controllerBuilder()                                .enableRestStyle();                    })                    .templateEngine(new VelocityTemplateEngine()) // 使用Velocity引擎模板                    .execute();        }    }

这里使用了FastAutoGenerator来配置代码生成器。你需要修改数据库连接信息、作者、输出目录、包名、表名等信息。

  1. 运行代码生成器

运行CodeGenerator类的main方法,就可以自动生成代码了。

MyBatis Plus 如何进行分页查询?

MyBatis Plus提供了非常方便的分页查询功能。

  1. 引入Page对象
   import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
  1. 编写分页查询方法
   public Page<User> getUsersByPage(int pageNum, int pageSize) {        Page<User> page = new Page<>(pageNum, pageSize);        return userMapper.selectPage(page, null);    }

这里使用了Page对象来封装分页信息。pageNum是页码,pageSize是每页显示的条数。selectPage方法会自动进行分页查询。

  1. 在Controller中调用分页查询方法
   @GetMapping("/page")    public Page<User> getUsersByPage(@RequestParam(defaultValue = "1") int pageNum, @RequestParam(defaultValue = "10") int pageSize) {        return userService.getUsersByPage(pageNum, pageSize);    }

这里使用了@RequestParam注解来获取页码和每页显示的条数。

如何自定义 MyBatis Plus 的 SQL 注入器?

MyBatis Plus允许你自定义SQL注入器,添加自定义的SQL方法。

  1. 创建自定义SQL注入器
   import com.baomidou.mybatisplus.core.injector.AbstractMethod;    import com.baomidou.mybatisplus.core.injector.DefaultSqlInjector;    import org.springframework.stereotype.Component;     import java.util.List;     @Component    public class MySqlInjector extends DefaultSqlInjector {         @Override        public List<AbstractMethod> getMethodList(Class<?> mapperClass) {            List<AbstractMethod> methodList = super.getMethodList(mapperClass);            methodList.add(new MyCustomMethod()); // 添加自定义方法            return methodList;        }    }

这里继承了DefaultSqlInjector,并重写了getMethodList方法,添加了自定义的SQL方法。

  1. 创建自定义SQL方法
   import com.baomidou.mybatisplus.core.injector.AbstractMethod;    import com.baomidou.mybatisplus.core.metadata.TableInfo;    import org.apache.ibatis.mapping.MappedStatement;    import org.apache.ibatis.mapping.SqlSource;     public class MyCustomMethod extends AbstractMethod {         @Override        public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {            String sql = "select * from " + tableInfo.getTableName() + " where age > 18";            SqlSource sqlSource = languageDriver.createSqlSource(configuration, sql, modelClass);            return addSelectMappedStatement(mapperClass, "selectAdultUsers", sqlSource, modelClass, tableInfo);        }    }

这里继承了AbstractMethod,并重写了injectMappedStatement方法,定义了自定义的SQL语句。

  1. 在Mapper接口中使用自定义方法
   import org.apache.ibatis.annotations.Mapper;     import java.util.List;     @Mapper    public interface UserMapper extends BaseMapper<User> {        List<User> selectAdultUsers(); // 使用自定义方法    }

在Mapper接口中声明自定义方法,就可以使用了。

如何使用 MyBatis Plus 的乐观锁?

乐观锁是一种并发控制机制,可以避免多个用户同时修改同一条数据导致的数据冲突。

  1. 在实体类中添加版本号字段
   import com.baomidou.mybatisplus.annotation.Version;    import lombok.Data;     @Data    public class User {        private Long id;        private String name;        private Integer age;        private String email;        @Version // 乐观锁版本号字段        private Integer version;    }

这里使用了@Version注解来标记版本号字段。

  1. 配置乐观锁拦截器
   import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;    import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;    import org.springframework.context.annotation.Bean;    import org.springframework.context.annotation.Configuration;     @Configuration    public class MybatisPlusConfig {         @Bean        public MybatisPlusInterceptor mybatisPlusInterceptor() {            MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();            interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor()); // 添加乐观锁拦截器            return interceptor;        }    }

这里配置了OptimisticLockerInnerInterceptor拦截器,用来实现乐观锁功能。

  1. 更新数据时,MyBatis Plus会自动更新版本号
   public void updateUser(User user) {        userMapper.updateById(user); // 更新数据时,MyBatis Plus会自动更新版本号    }

在更新数据时,MyBatis Plus会自动更新版本号,如果版本号不一致,就会抛出异常。

© 版权声明
THE END
喜欢就支持一下吧
点赞6 分享