之前我也写过一篇关于mybatis plus的文章&＃xff0c;但是版本的迭代之后&＃xff0c;出现了很多不同之处&＃xff0c;所以又写了这篇整合篇。
- my.oschina.net/u/3080373/b…
mybatis plus
MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具&＃xff0c;在 MyBatis 的基础上只做增强不做改变&＃xff0c;为简化开发、提高效率而生。
以前我们使用mybatis的时候&＃xff0c;我们会使用MyBatis Generator优先生成单表的增删改查操作&＃xff0c;但当修改字段删除字段的时候&＃xff0c;是个痛苦的事情&＃xff0c;要修改xml的很多地方。
为了解决这个问题&＃xff0c;开源市场上出现了很多解决mybatis单表操作的问题&＃xff0c;比如tkMybatis、mybatis plus等。
使用这些工具之后&＃xff0c;我们就不再需要担心单表操作的问题&＃xff0c;更多的重心放在业务和复杂查询上。
关于mybatis plus的一下简介&＃xff0c;这里不再多介绍&＃xff0c;感兴趣的上官网查看&＃xff0c;
- mybatis.plus/guide/quick…
ok&＃xff0c;原理就不多说&＃xff0c;直接开始我们的框架集成&＃xff01;
技术版本- SpringBoot 2.2.2.RELEASE
- mybatis-plus 3.2.0
集成步骤
第一步&＃xff1a;导入jar包
pom中导入mybatis plus的jar包&＃xff0c;因为后面会涉及到代码生成&＃xff0c;所以我们还需要导入页面模板引擎&＃xff0c;这里我们用的是freemarker。
com.baomidou mybatis-plus-boot-starter 3.2.0org.springframework.boot spring-boot-starter-freemarkermysql mysql-connector-java runtime
第二步&＃xff1a;然后去写配置文件
# DataSource Configspring: datasource: driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://localhost:3306/markerhub?useUnicode&＃61;true&useSSL&＃61;false&characterEncoding&＃61;utf8&serverTimezone&＃61;UTC username: root password: adminmybatis-plus: mapper-locations: classpath*:/mapper/**Mapper.xml
上面除了配置数据库的信息&＃xff0c;还配置了myabtis plus的mapper的xml文件的扫描路径&＃xff0c;这一步不要忘记了。 第三步&＃xff1a;开启mapper接口扫描&＃xff0c;添加分页插件
通过&＃64;mapperScan注解指定要变成实现类的接口所在的包&＃xff0c;然后包下面的所有接口在编译之后都会生成相应的实现类。PaginationInterceptor是一个分页插件。
&＃64;Configuration&＃64;EnableTransactionManagement&＃64;MapperScan("com.markerhub.mapper")public class MybatisPlusConfig { &＃64;Bean public PaginationInterceptor paginationInterceptor() { PaginationInterceptor paginationInterceptor &＃61; new PaginationInterceptor(); return paginationInterceptor; }}
第四步&＃xff1a;代码生成
如果你没再用其他插件&＃xff0c;那么现在就已经可以使用mybatis plus了&＃xff0c;官方给我们提供了一个代码生成器&＃xff0c;然后我写上自己的参数之后&＃xff0c;就可以直接根据数据库表信息生成entity、service、mapper等接口和实现类。
// 演示例子&＃xff0c;执行 main 方法控制台输入模块表名回车自动生成对应项目目录中public class CodeGenerator { /** *
* 读取控制台内容 *
*/ public static String scanner(String tip) { Scanner scanner &＃61; new Scanner(System.in); StringBuilder help &＃61; new StringBuilder(); help.append("请输入" &＃43; tip &＃43; "&＃xff1a;"); System.out.println(help.toString()); if (scanner.hasNext()) { String ipt &＃61; scanner.next(); if (StringUtils.isNotEmpty(ipt)) { return ipt; } } throw new MybatisPlusException("请输入正确的" &＃43; tip &＃43; "&＃xff01;"); } public static void main(String[] args) { // 代码生成器 AutoGenerator mpg &＃61; new AutoGenerator(); // 全局配置 GlobalConfig gc &＃61; new GlobalConfig(); String projectPath &＃61; System.getProperty("user.dir"); gc.setOutputDir(projectPath &＃43; "/src/main/java");// gc.setOutputDir("D:est"); gc.setAuthor("关注公众号&＃xff1a;MarkerHub"); gc.setOpen(false); // gc.setSwagger2(true); 实体属性 Swagger2 注解 gc.setServiceName("%sService"); mpg.setGlobalConfig(gc); // 数据源配置 DataSourceConfig dsc &＃61; new DataSourceConfig(); dsc.setUrl("jdbc:mysql://localhost:3306/markerhub?useUnicode&＃61;true&useSSL&＃61;false&characterEncoding&＃61;utf8&serverTimezone&＃61;UTC"); // dsc.setSchemaName("public"); dsc.setDriverName("com.mysql.cj.jdbc.Driver"); dsc.setUsername("root"); dsc.setPassword("admin"); mpg.setDataSource(dsc); // 包配置 PackageConfig pc &＃61; new PackageConfig(); pc.setModuleName(null); pc.setParent("com.markerhub"); mpg.setPackageInfo(pc); // 自定义配置 InjectionConfig cfg &＃61; new InjectionConfig() { &＃64;Override public void initMap() { // to do nothing } }; // 如果模板引擎是 freemarker String templatePath &＃61; "/templates/mapper.xml.ftl"; // 如果模板引擎是 velocity // String templatePath &＃61; "/templates/mapper.xml.vm"; // 自定义输出配置 List focList &＃61; new ArrayList<>(); // 自定义配置会被优先输出 focList.add(new FileOutConfig(templatePath) { &＃64;Override public String outputFile(TableInfo tableInfo) { // 自定义输出文件名 &＃xff0c; 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化&＃xff01;&＃xff01; return projectPath &＃43; "/src/main/resources/mapper/" &＃43; "/" &＃43; tableInfo.getEntityName() &＃43; "Mapper" &＃43; StringPool.DOT_XML; } }); cfg.setFileOutConfigList(focList); mpg.setCfg(cfg); // 配置模板 TemplateConfig templateConfig &＃61; new TemplateConfig(); templateConfig.setXml(null); mpg.setTemplate(templateConfig); // 策略配置 StrategyConfig strategy &＃61; new StrategyConfig(); strategy.setNaming(NamingStrategy.underline_to_camel); strategy.setColumnNaming(NamingStrategy.underline_to_camel); strategy.setEntityLombokModel(true); strategy.setRestControllerStyle(true); strategy.setInclude(scanner("表名&＃xff0c;多个英文逗号分割").split(",")); strategy.setControllerMappingHyphenStyle(true); strategy.setTablePrefix(pc.getModuleName() &＃43; "_"); mpg.setStrategy(strategy); mpg.setTemplateEngine(new FreemarkerTemplateEngine()); mpg.execute(); }}首先我在数据库中新建了一个user表&＃xff1a;
CREATE TABLE &＃96;user&＃96; ( &＃96;id&＃96; bigint(20) NOT NULL AUTO_INCREMENT, &＃96;username&＃96; varchar(64) DEFAULT NULL, &＃96;avatar&＃96; varchar(255) DEFAULT NULL, &＃96;email&＃96; varchar(64) DEFAULT NULL, &＃96;password&＃96; varchar(64) DEFAULT NULL, &＃96;status&＃96; int(5) NOT NULL, &＃96;created&＃96; datetime DEFAULT NULL, &＃96;last_login&＃96; datetime DEFAULT NULL, PRIMARY KEY (&＃96;id&＃96;), KEY &＃96;UK_USERNAME&＃96; (&＃96;username&＃96;) USING BTREE) ENGINE&＃61;InnoDB DEFAULT CHARSET&＃61;utf8;
代码生成结果如下&＃xff1a;
简洁&＃xff01;方便&＃xff01;经过上面的步骤&＃xff0c;基本上我们已经把mybatis plus框架集成到项目中了。这里还要给大家介绍一下常用的插件&＃xff1a;
常用插件
之前有个性能分析插件&＃xff0c;但在3.2.0以后版本不再提供使用&＃xff0c;取而代之的是一个依赖p6spy的执行Sql分析打印插件。
所以&＃xff0c;如果你想在项目执行的过程中打印执行的sql&＃xff0c;那么需要按照以下步骤来安装插件&＃xff1a;
第一步&＃xff1a;p6spy 依赖引入
p6spy p6spy 3.8.6
第二步&＃xff1a;修改数据源链接配置
spring: datasource: driver-class-name: com.p6spy.engine.spy.P6SpyDriver url: jdbc:p6spy:mysql://localhost:3306/markerhub?useUnicode&＃61;true&useSSL&＃61;false&characterEncoding&＃61;utf8&serverTimezone&＃61;UTC username: root password: admin
可以发现&＃xff0c;改了两处地方&＃xff0c;首先是驱动driver-class-name&＃xff0c;然后url的前缀也改了&＃xff0c;加了 **p6spy: **。
第三步&＃xff1a;添加p6spy的配置信息
module.log&＃61;com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory# 自定义日志打印logMessageFormat&＃61;com.baomidou.mybatisplus.extension.p6spy.P6SpyLogger#日志输出到控制台appender&＃61;com.baomidou.mybatisplus.extension.p6spy.StdoutLogger# 使用日志系统记录 sql#appender&＃61;com.p6spy.engine.spy.appender.Slf4JLogger# 设置 p6spy driver 代理deregisterdrivers&＃61;true# 取消JDBC URL前缀useprefix&＃61;true# 配置记录 Log 例外,可去掉的结果集有error,info,batch,debug,statement,commit,rollback,result,resultset.excludecategories&＃61;info,debug,result,batch,resultset# 日期格式dateformat&＃61;yyyy-MM-dd HH:mm:ss# 实际驱动可多个#driverlist&＃61;org.h2.Driver# 是否开启慢SQL记录outagedetection&＃61;true# 慢SQL记录标准 2 秒outagedetectioninterval&＃61;2
可以根据上面的注释调整一下参数配置。 分析插件添加之后执行效果如下&＃xff1a;
当然了&＃xff0c;官方提示&＃xff1a;该插件有性能损耗&＃xff0c;不建议生产环境使用&＃xff01;所以测试时候用用就好啦&＃xff01;
另外&＃xff0c;还有其他比较好用的插件&＃xff0c;比如动态数据源&＃xff0c;乐观锁插件&＃xff0c;逻辑删除插件&＃xff0c;分布式事务插件等&＃xff0c;都是一些比较常用的扩展&＃xff0c;可以自行上官网学习哈。
增删改查
接下来&＃xff0c;我写一组基本的增删改查操作。
// 查找User user0 &＃61; userService.getById(1);User user1 &＃61; userService.getOne(new QueryWrapper() .eq("username", "markerhub"));System.out.println(user1.toString());int pn &＃61; ServletRequestUtils.getIntParameter(req, "pn", 1);int size &＃61; ServletRequestUtils.getIntParameter(req, "size", 2);Page p &＃61; new Page(pn, size);IPage page0 &＃61; userService.page(p, new QueryWrapper() .isNotNull("id") .orderByDesc("created"));System.out.println(page0.toString());// 嵌套查询IPage page1 &＃61; userService.page(p, new QueryWrapper() .inSql("id", "SELECT user_id FROM user_collection where post_id &＃61; 1"));// 增删改都是差不多&＃xff0c;直接调用apiuser0.setUsername("markerhub0");userService.saveOrUpdate(user0);userService.remove(new QueryWrapper().eq("username", "markerhub0"));
上面的关键点其实就是学会灵活运用QueryWrapper这个条件包装类。
结束语
ok&＃xff0c;今天的文章就到此结束啦&＃xff0c;简单得介绍了一下mybatis plus的使用&＃xff0c;更多还需要自己去探索&＃xff01;
作者&＃xff1a;MarkerHub
链接&＃xff1a;https://juejin.im/post/5e94387df265da480836b8b1
来源&＃xff1a;掘金
京公网安备 11010802041100号