SpringBoot 整合 Mybatis-Plus实现简单的CRUD

描述：

MyBatis-Plus (简称 MP)是一个 MyBatis (opens new window)的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

官方文档： MyBatis-Plus 强烈建议，大家在使用一个技术之前，都应该先去看看官方文档，避免出错误。

整合:

先创建好一个spring boot 项目，这里可以使用 spring 官方的工具直接下载：spring

如果网络不好的话，可以使用 阿里提供的脚手架下载; aliyun.Spring

pom.xml

		<!-- mybatis-plu 依赖 -->
		<dependency>
			<groupId>com.baomidou</groupId>
			<artifactId>mybatis-plus-boot-starter</artifactId>
			<version>3.4.2</version>
		</dependency>
<!-- mybatis-plu 代码生成器 -->
		<dependency>
			<groupId>com.baomidou</groupId>
			<artifactId>mybatis-plus-generator</artifactId>
			<version>3.4.1</version>
		</dependency>
<!-- mybatis-plu 代码生成器模板 -->
		<dependency>
			<groupId>org.freemarker</groupId>
			<artifactId>freemarker</artifactId>
			<version>2.3.31</version>
		</dependency>

yml配置

spring:
  datasource:
    username: root
    password: root
    url: jdbc:mysql://localhost/user?serverTimezone=UTC&useSSL=false&allowMultiQueries=true
    driver-class-name: com.mysql.cj.jdbc.Driver
## 服务端口
server:
  port: 8080

##扫描的xml 路径和 实体类
mybatis:
  mapper-locations: classpath:mapper/**/*Mapper.xml,
  type-aliases-package: com.example.springbootmybatisplusintegrat.*.bean


## 打印sql日志:
logging:
  level:
    com.example.springbootmybatisplusintegrat: debug

简单的curd：

mapper接口

mapper接口继承BaseMapper 这样就可以使用 框架为我们提供的方法了，如果不继承也是可以的，可以自定义

但是需要在xml中写sql语句。

public interface UserMapper extends BaseMapper<User>

public interface BaseMapper<T> extends Mapper<T> {
    int insert(T entity);

    int deleteById(Serializable id);

    int deleteByMap(@Param("cm") Map<String, Object> columnMap);

    int delete(@Param("ew") Wrapper<T> queryWrapper);

    int deleteBatchIds(@Param("coll") Collection<? extends Serializable> idList);

    int updateById(@Param("et") T entity);

    int update(@Param("et") T entity, @Param("ew") Wrapper<T> updateWrapper);

    T selectById(Serializable id);

    List<T> selectBatchIds(@Param("coll") Collection<? extends Serializable> idList);

    List<T> selectByMap(@Param("cm") Map<String, Object> columnMap);

    T selectOne(@Param("ew") Wrapper<T> queryWrapper);

    Integer selectCount(@Param("ew") Wrapper<T> queryWrapper);

    List<T> selectList(@Param("ew") Wrapper<T> queryWrapper);

    List<Map<String, Object>> selectMaps(@Param("ew") Wrapper<T> queryWrapper);

    List<Object> selectObjs(@Param("ew") Wrapper<T> queryWrapper);

    <E extends IPage<T>> E selectPage(E page, @Param("ew") Wrapper<T> queryWrapper);

    <E extends IPage<Map<String, Object>>> E selectMapsPage(E page, @Param("ew") Wrapper<T> queryWrapper);
}

service接口

service接口继承 IService 接口

public interface IUserService extends IService<User>

service 实现类：继承IService 的实现类，实现IUserService 自己定义的接口

extends ServiceImpl<UserMapper, User> implements IUserService

简单crud 方法实现：

 @Autowired
    IUserService iUserService;

    @GetMapping("getUser")
    public User getUser(Integer id){
        return iUserService.getById(id);
    }

    @GetMapping("list")
    public List<User> list(){
        return iUserService.list();
    }


    @PutMapping("saveUser")
    public boolean saveUser(User user){
        boolean saveuser = iUserService.save(user);
        return  saveuser;
    }

    @DeleteMapping("deleteUser")
    public boolean deleteUser(Integer id){
        boolean removeUserById = iUserService.removeById(id);
            return  removeUserById;
    }

分页插件

定义配置属性：MybatisPlusConfig 类

/**
 * @Author qrn
 * @Title
 * @Date 2021/5/6 15:59
 * @time 15:59
 * 分页插件配置处理:
 */
@Configuration
public class MybatisPlusConfig {

    // 最新版
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }

}

分页插件使用

mapper定义查询的接口：

    /**
     * <p>
     * 查询 : 根据state状态查询用户列表，分页显示
     * </p>
     *
     * @param page 分页对象,xml中可以从里面进行取值,传递参数 Page 即自动分页,必须放在第一位(你可以继承Page实现自己的分页对象)
     * @return 分页对象
     */
    IPage<User> selectPageVo(Page<?> page);

xml实现：

    <select id="selectPageVo" resultType="com.example.springbootmybatisplusintegrat.user.bean.User">
        SELECT * FROM user
    </select>

service接口定义：

     IPage<User> selectUserPage(Page<User> page);

service实现类：

    @Override
    public IPage<User> selectUserPage(Page<User> page) {
        return baseMapper.selectPageVo(page);
    }

控制层：

    /**
     * 分页列表查询:
     * @param page 当前页
     * @param rows 页数
     * @return
     */
    @GetMapping("getPageUser")
    public IPage<User> getPageUser(Integer page,Integer rows){
        Page<User> userPage = new Page<User>();
        userPage.setCurrent(page);//设置页数
        userPage.setSize(rows); //页总数
        IPage<User> userIPage = iUserService.selectUserPage(userPage);
        return userIPage;
    }

代码生成

详细配置请看文档: generator-config

配置实例：

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")+"/spring-boot-mybatisplus-integrat";
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("qrn");
        gc.setOpen(false);
        mpg.setGlobalConfig(gc);

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

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

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };
        String templatePath = "/templates/mapper.xml.ftl";
        // 自定义输出配置
        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.setFileOutConfigList(focList);
        mpg.setCfg(cfg);
        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();
        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        // 表设置：
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
//        // 写于父类中的公共字段
        strategy.setSuperEntityColumns("id");
        //要生成的表名设置: 这里给的是获取控制台的名字，可以直接写死
     //   strategy.setInclude("user");
        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }

}

请大家根据自己的目录结构去调整，我这里是多模块所以

String projectPath = System.getProperty(“user.dir”)+“/spring-boot-mybatisplus-integrat”;

拼接上了 spring-boot-mybatisplus-integrat，如果大家的不是多模块项目，直接去掉就好了。

其他好玩的，请自行读文档，调试开发，实例代码在github上面需要的请自行拉取：spring-boot-integrate 然后后续会集成更多的模块进去，需要请点个star。

如果这篇文章，有帮助到大家的，请给作者一个一键三连，谢谢。