发现mybatis plus的牛逼，解决单表操作！

小Hub领读：

小Hub今天开始要发原创啦，星标置顶小Hub的公众号MarkerHub，一起加油哈！

之前我也写过一篇关于mybatis plus的文章，但是版本的迭代之后，出现了很多不同之处，所以又写了这篇整合篇。

• https://my.oschina.net/u/3080373/blog/1615885

mybatis plus

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

以前我们使用mybatis的时候，我们会使用MyBatis Generator优先生成单表的增删改查操作，但当修改字段删除字段的时候，是个痛苦的事情，要修改xml的很多地方。

为了解决这个问题，开源市场上出现了很多解决mybatis单表操作的问题，比如tkMybatis、mybatis plus等。

使用这些工具之后，我们就不再需要担心单表操作的问题，更多的重心放在业务和复杂查询上。

关于mybatis plus的一下简介，这里不再多介绍，感兴趣的上官网查看，

• https://mybatis.plus/guide/quick-start.html

另外，在慕课网上知道了了mybatis plus的入门优秀视频：

• MyBatis-Plus 入门 - 视频教程 - 慕课网

• MyBatis-Plus 进阶 - 视频教程 - 慕课网

ok，原理就不多说，直接开始我们的框架集成！

技术版本

• SpringBoot 2.2.2.RELEASE

• mybatis-plus 3.2.0

集成步骤

第一步：导入jar包

pom中导入mybatis plus的jar包，因为后面会涉及到代码生成，所以我们还需要导入页面模板引擎，这里我们用的是freemarker。

<!--mp--><dependency>    <groupId>com.baomidou</groupId>    <artifactId>mybatis-plus-boot-starter</artifactId>    <version>3.2.0</version></dependency><dependency>    <groupId>org.springframework.boot</groupId>    <artifactId>spring-boot-starter-freemarker</artifactId></dependency><dependency>    <groupId>mysql</groupId>    <artifactId>mysql-connector-java</artifactId>    <scope>runtime</scope></dependency>

第二步：然后去写配置文件

# DataSource Configspring:  datasource:    driver-class-name: com.mysql.cj.jdbc.Driver    url: jdbc:mysql://localhost:3306/markerhub?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=UTC    username: root    password: adminmybatis-plus:  mapper-locations: classpath*:/mapper/**Mapper.xml

上面除了配置数据库的信息，还配置了myabtis plus的mapper的xml文件的扫描路径，这一步不要忘记了。 第三步：开启mapper接口扫描，添加分页插件

通过@mapperScan注解指定要变成实现类的接口所在的包，然后包下面的所有接口在编译之后都会生成相应的实现类。PaginationInterceptor是一个分页插件。

1. @Configuration

2. @EnableTransactionManagement

3. @MapperScan("com.markerhub.mapper")

4. public class MybatisPlusConfig {

5. 
   

6.    @Bean

7.    public PaginationInterceptor paginationInterceptor() {

8.        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();

9.        return paginationInterceptor;

10.    }

11. }

第四步：代码生成

如果你没再用其他插件，那么现在就已经可以使用mybatis plus了，官方给我们提供了一个代码生成器，然后我写上自己的参数之后，就可以直接根据数据库表信息生成entity、service、mapper等接口和实现类。

1. // 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中

2. public class CodeGenerator {

3. 
   

4.    /**

5.     * <p>

6.     * 读取控制台内容

7.     * </p>

8.     */

9.    public static String scanner(String tip) {

10.        Scanner scanner = new Scanner(System.in);

11.        StringBuilder help = new StringBuilder();

12.        help.append("请输入" + tip + "：");

13.        System.out.println(help.toString());

14.        if (scanner.hasNext()) {

15.            String ipt = scanner.next();

16.            if (StringUtils.isNotEmpty(ipt)) {

17.                return ipt;

18.            }

19.        }

20.        throw new MybatisPlusException("请输入正确的" + tip + "！");

21.    }

22. 
    

23.    public static void main(String[] args) {

24.        // 代码生成器

25.        AutoGenerator mpg = new AutoGenerator();

26. 
    

27.        // 全局配置

28.        GlobalConfig gc = new GlobalConfig();

29.        String projectPath = System.getProperty("user.dir");

30.        gc.setOutputDir(projectPath + "/src/main/java");

31. //        gc.setOutputDir("D:\\test");

32.        gc.setAuthor("关注公众号：MarkerHub");

33.        gc.setOpen(false);

34.        // gc.setSwagger2(true); 实体属性 Swagger2 注解

35.        gc.setServiceName("%sService");

36.        mpg.setGlobalConfig(gc);

37. 
    

38.        // 数据源配置

39.        DataSourceConfig dsc = new DataSourceConfig();

40.        dsc.setUrl("jdbc:mysql://localhost:3306/markerhub?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=UTC");

41.        // dsc.setSchemaName("public");

42.        dsc.setDriverName("com.mysql.cj.jdbc.Driver");

43.        dsc.setUsername("root");

44.        dsc.setPassword("admin");

45.        mpg.setDataSource(dsc);

46. 
    

47.        // 包配置

48.        PackageConfig pc = new PackageConfig();

49.        pc.setModuleName(null);

50.        pc.setParent("com.markerhub");

51.        mpg.setPackageInfo(pc);

52. 
    

53.        // 自定义配置

54.        InjectionConfig cfg = new InjectionConfig() {

55.            @Override

56.            public void initMap() {

57.                // to do nothing

58.            }

59.        };

60. 
    

61.        // 如果模板引擎是 freemarker

62.        String templatePath = "/templates/mapper.xml.ftl";

63.        // 如果模板引擎是 velocity

64.        // String templatePath = "/templates/mapper.xml.vm";

65. 
    

66.        // 自定义输出配置

67.        List<FileOutConfig> focList = new ArrayList<>();

68.        // 自定义配置会被优先输出

69.        focList.add(new FileOutConfig(templatePath) {

70.            @Override

71.            public String outputFile(TableInfo tableInfo) {

72.                // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！

73.                return projectPath + "/src/main/resources/mapper/"

74.                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;

75.            }

76.        });

77. 
    

78.        cfg.setFileOutConfigList(focList);

79.        mpg.setCfg(cfg);

80. 
    

81.        // 配置模板

82.        TemplateConfig templateConfig = new TemplateConfig();

83. 
    

84.        templateConfig.setXml(null);

85.        mpg.setTemplate(templateConfig);

86. 
    

87.        // 策略配置

88.        StrategyConfig strategy = new StrategyConfig();

89.        strategy.setNaming(NamingStrategy.underline_to_camel);

90.        strategy.setColumnNaming(NamingStrategy.underline_to_camel);

91.        strategy.setEntityLombokModel(true);

92.        strategy.setRestControllerStyle(true);

93.        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));

94.        strategy.setControllerMappingHyphenStyle(true);

95.        strategy.setTablePrefix(pc.getModuleName() + "_");

96.        mpg.setStrategy(strategy);

97.        mpg.setTemplateEngine(new FreemarkerTemplateEngine());

98.        mpg.execute();

99.    }

100. }

首先我在数据库中新建了一个user表：

CREATE TABLE `user` (  `id` bigint(20) NOT NULL AUTO_INCREMENT,  `username` varchar(64) DEFAULT NULL,  `avatar` varchar(255) DEFAULT NULL,  `email` varchar(64) DEFAULT NULL,  `password` varchar(64) DEFAULT NULL,  `status` int(5) NOT NULL,  `created` datetime DEFAULT NULL,  `last_login` datetime DEFAULT NULL,  PRIMARY KEY (`id`),  KEY `UK_USERNAME` (`username`) USING BTREE) ENGINE=InnoDB DEFAULT CHARSET=utf8;

代码生成结果如下：

简洁！方便！经过上面的步骤，基本上我们已经把mybatis plus框架集成到项目中了。这里还要给大家介绍一下常用的插件：

常用插件

之前有个性能分析插件，但在3.2.0以后版本不再提供使用，取而代之的是一个依赖p6spy的执行Sql分析打印插件。

所以，如果你想在项目执行的过程中打印执行的sql，那么需要按照以下步骤来安装插件：

第一步：p6spy 依赖引入

<!-- sql分析器 --><dependency>    <groupId>p6spy</groupId>    <artifactId>p6spy</artifactId>    <version>3.8.6</version></dependency>

第二步：修改数据源链接配置

spring:  datasource:    driver-class-name: com.p6spy.engine.spy.P6SpyDriver    url: jdbc:p6spy:mysql://localhost:3306/markerhub?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=UTC    username: root    password: admin

可以发现，改了两处地方，首先是驱动driver-class-name，然后url的前缀也改了，加了 *p6spy: *。第三步：添加p6spy的配置信息

• spy.properties

module.log=com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory# 自定义日志打印logMessageFormat=com.baomidou.mybatisplus.extension.p6spy.P6SpyLogger#日志输出到控制台appender=com.baomidou.mybatisplus.extension.p6spy.StdoutLogger# 使用日志系统记录 sql#appender=com.p6spy.engine.spy.appender.Slf4JLogger# 设置 p6spy driver 代理deregisterdrivers=true# 取消JDBC URL前缀useprefix=true# 配置记录 Log 例外,可去掉的结果集有error,info,batch,debug,statement,commit,rollback,result,resultset.excludecategories=info,debug,result,batch,resultset# 日期格式dateformat=yyyy-MM-dd HH:mm:ss# 实际驱动可多个#driverlist=org.h2.Driver# 是否开启慢SQL记录outagedetection=true# 慢SQL记录标准 2 秒outagedetectioninterval=2

可以根据上面的注释调整一下参数配置。分析插件添加之后执行效果如下：

当然了，官方提示：该插件有性能损耗，不建议生产环境使用！所以测试时候用用就好啦！

另外，还有其他比较好用的插件，比如动态数据源，乐观锁插件，逻辑删除插件，分布式事务插件等，都是一些比较常用的扩展，可以自行上官网学习哈。

增删改查

接下来，我写一组基本的增删改查操作。

1. // 查找

2. User user0 = userService.getById(1);

3. User user1 = userService.getOne(new QueryWrapper<User>()

4.        .eq("username", "markerhub"));

5. System.out.println(user1.toString());

6. 
   

7. int pn = ServletRequestUtils.getIntParameter(req, "pn", 1);

8. int size = ServletRequestUtils.getIntParameter(req, "size", 2);

9. Page p = new Page(pn, size);

10. IPage page0 = userService.page(p, new QueryWrapper<User>()

11.        .isNotNull("id")

12.        .orderByDesc("created"));

13. System.out.println(page0.toString());

14. 
    

15. // 嵌套查询

16. IPage page1 = userService.page(p, new QueryWrapper<User>()

17.        .inSql("id", "SELECT user_id FROM user_collection where post_id = 1")

18. );

19. 
    

20. // 增删改都是差不多，直接调用api

21. user0.setUsername("markerhub0");

22. userService.saveOrUpdate(user0);

23. userService.remove(new QueryWrapper<User>().eq("username", "markerhub0"));

上面的关键点其实就是学会灵活运用QueryWrapper这个条件包装类。

结束语

ok，今天的文章就到此结束啦，简单得介绍了一下mybatis plus的使用，更多还需要自己去探索！

标签：插件,p6spy,plus,单表,mybatis,new,com
来源： https://blog.51cto.com/u_15127539/2696858