Springboot整合mybatis-plus 代碼生成器 增刪查改 條件查詢 分頁插件

關於Mybatis-plus的使用請參考官網：https://mp.baomidou.com/

官方有提供mybatis-plus和springboot整合的demo：https://gitee.com/baomidou/mybatisplus-spring-boot

 

1 添加mybatis-plus相關依賴

第二個是生成器依賴，第三個是默認的引擎velocity

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

 <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.3.1.tmp</version>
 </dependency>

 <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.2</version>
</dependency>

2 配置application.yml

如果代碼生成器生成的實體沒有id的話，不要設置id-type:auto

mybatis-plus:
  global-config:
    db-config:
      #id-type: auto
      table-underline: true
      logic-delete-value: 1 # 邏輯已刪除值(默認爲 1)
      logic-not-delete-value: 0 # 邏輯未刪除值(默認爲 0)
  mapper-locations: classpath:/mapper/*.xml
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  type-aliases-package: com.lane.entity

3 代碼生成器

可以自動生成entity、controller、service、mapper

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.isNotEmpty(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("lane");
        gc.setOpen(false);
        // gc.setSwagger2(true); 實體屬性 Swagger2 註解
        mpg.setGlobalConfig(gc);

        // 數據源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/mybatis?serverTimezone=UTC&userUnicode=true&characterEncoding=utf-8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername(" ");
        dsc.setPassword(" ");
        mpg.setDataSource(dsc);

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

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


        // 如果模板引擎是 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/java/com/" + pc.getModuleName()+"/mapper"
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判斷自定義文件夾是否需要創建
                checkDir("調用默認方法創建的目錄");
                return false;
            }
        });
        */
        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();
    }

}

4 分頁插件配置

@Configuration
public class MyBatisPlusConfig {
    /**
     * mybatis-plus分頁插件
     */
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
        return paginationInterceptor;
    }
}

5 實現增刪查改

mybatis-plus提供了2個CRUD接口，一個是mapper 接口，一個是service接口，下面代碼基於service.

https://mp.baomidou.com/guide/crud-interface.html#update

代碼生成器根據我的user表生成的user實體：User(id int,name String,pwd String)

controller：

@RestController
@RequestMapping("/lane")
public class UserController {
    @Resource
    private UserMapper userMapper;

    @Autowired
    private IUserService userService;


    //增
    @RequestMapping("/addUser/{id}/{name}/{pwd}")
    public String addUser(@PathVariable("id") int id,@PathVariable("name") String name,@PathVariable("pwd") String pwd)
    {
        User user=new User(id,name,pwd);
        userService.save(user);
        return "添加成功";
    }


    //刪
    @RequestMapping("/deleteUser/{id}")
    public String deleteUser(@PathVariable("id") int id) {
        userService.removeById(id);
        return "刪除成功";
    }

    //改
    @RequestMapping("/updateUser/{id}/{name}/{pwd}")
    public String updateUser(@PathVariable("id") int id,@PathVariable("name") String name,@PathVariable("pwd") String pwd)
    {
        User user=new User(id,name,pwd);
        userService.updateById(user);
        return "更新成功";
    }

    //查
    @RequestMapping("/queryUserById/{id}")
    public User getUser(@PathVariable("id") int id)
    {
        User user=userService.getById(id);
        return user;
    }

    //條件查詢
    @RequestMapping("/queryUserCondition/{low}/{high}")
    public List<User> queryUserCondition(@PathVariable("low") int low,@PathVariable("high") int high) {
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.ge("id", low).le("id",high);
        List<User> list=userService.list(queryWrapper);
        return list;
    }



    //分頁查詢
    @RequestMapping("/page/{current}/{size}")
    public List<User> getPage(@PathVariable("current") int current,@PathVariable("size") int size)
    {

        Map<String,Object> map = new HashMap<>();
        QueryWrapper<User> queryWrapper =  new QueryWrapper<>();
        queryWrapper.orderByDesc("id");//按id降序
        Page<User> page = new Page<>(current,size);  // 查詢第current頁，每頁大小爲size
        IPage<User> iPage = userMapper.selectPage(page,queryWrapper);
        return iPage.getRecords();
    }
}