Я также писал статью о mybatis plus ранее, но после итерации версии было много отличий, поэтому я снова написал эту статью об интеграции.
mybatis plus
MyBatis-Plus(называемый MP) являетсяMyBatisИнструмент улучшения MyBatis только расширяет и не изменяет на основе MyBatis и создан для упрощения разработки и повышения эффективности.
В прошлом, когда мы использовали mybatis, мы использовали MyBatis Generator, чтобы сначала сгенерировать операции добавления, удаления, модификации и запроса одной таблицы, но при изменении полей для удаления полей это было болезненно, и во многих местах в xml пришлось изменить.
Чтобы решить эту проблему, на рынке с открытым исходным кодом существует множество проблем для решения однотабличной операции mybatis, таких как tkMybatis, mybatis plus и т. д.
После использования этих инструментов нам больше не нужно беспокоиться об операциях с одной таблицей и больше сосредоточиться на бизнесе и сложных запросах.
О введении mybatis plus я не буду здесь больше рассказывать, если вам интересно, вы можете проверить это на официальном сайте.
Кроме того, я узнал о прекрасном вступительном видео mybatis plus на МООК онлайн:
хорошо, не будем говорить о принципе, просто начнем интеграцию нашего фреймворка!
техническая версия
- SpringBoot 2.2.2.RELEASE
- mybatis-plus 3.2.0
Шаги интеграции
Шаг 1. Импортируйте пакет jar
Импортируйте jar-пакет mybatis plus в pom, потому что генерация кода будет задействована позже, поэтому нам также нужно импортировать механизм шаблонов страниц, здесь мы используем 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>
Шаг 2: Затем перейдите к записи файла конфигурации
# DataSource Config
spring:
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: admin
mybatis-plus:
mapper-locations: classpath*:/mapper/**Mapper.xml
В дополнение к приведенной выше информации о базе данных конфигурации также настраивается путь сканирования файла xml модуля сопоставления myabtis plus.Не забудьте этот шаг.Шаг 3: Включите сканирование интерфейса картографа и добавьте плагины подкачки
Укажите пакет, в котором находится интерфейс, который должен стать классом реализации, с помощью аннотации @mapperScan, и тогда все интерфейсы в пакете будут генерировать соответствующие классы реализации после компиляции. PaginationInterceptor — это плагин для разбиения на страницы.
@Configuration
@EnableTransactionManagement
@MapperScan("com.markerhub.mapper")
public class MybatisPlusConfig {
@Bean
public PaginationInterceptor paginationInterceptor() {
PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
return paginationInterceptor;
}
}
Шаг 4: Генерация кода
Если вы не используете другие плагины, то вы можете использовать mybatis plus прямо сейчас.Официальный предоставляет нам генератор кода, и после того, как я напишу свои собственные параметры, я могу напрямую генерировать сущность, сервис, маппер на основе информации таблицы базы данных и других интерфейсы и классы реализации.
// 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
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.setOutputDir("D:\\test");
gc.setAuthor("关注公众号：MarkerHub");
gc.setOpen(false);
// gc.setSwagger2(true); 实体属性 Swagger2 注解
gc.setServiceName("%sService");
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/markerhub?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=UTC");
// dsc.setSchemaName("public");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("admin");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
pc.setModuleName(null);
pc.setParent("com.markerhub");
mpg.setPackageInfo(pc);
// 自定义配置
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
// to do nothing
}
};
// 如果模板引擎是 freemarker
String templatePath = "/templates/mapper.xml.ftl";
// 如果模板引擎是 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/resources/mapper/"
+ "/" + 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.setInclude(scanner("表名，多个英文逗号分割").split(","));
strategy.setControllerMappingHyphenStyle(true);
strategy.setTablePrefix(pc.getModuleName() + "_");
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
}
Сначала я создал пользовательскую таблицу в базе данных:
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 он больше не доступен, вместо этого он представляет собой подключаемый модуль для выполнения анализа Sql и печати, основанный на p6spy.
Итак, если вы хотите распечатать выполненный sql во время выполнения проекта, вам необходимо установить плагин, выполнив следующие действия:
Первый шаг: знакомство с зависимостями p6spy
<!-- sql分析器 -->
<dependency>
<groupId>p6spy</groupId>
<artifactId>p6spy</artifactId>
<version>3.8.6</version>
</dependency>
Шаг 2. Измените конфигурацию ссылки на источник данных
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
Можно обнаружить, что два места были изменены, первое — это имя класса драйвера драйвера, а затем префикс URL-адреса также был изменен, добавив **p6spy: **. Шаг 3: Добавьте информацию о конфигурации 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
Вы можете настроить конфигурацию параметров в соответствии с комментариями выше. После добавления плагина анализа эффект выполнения выглядит следующим образом:
Конечно, официальный совет: этот плагин имеет потерю производительности и не рекомендуется для производственных сред! Так что хорошо использовать его при тестировании!
Кроме того, существуют другие простые в использовании подключаемые модули, такие как источники динамических данных, подключаемые модули оптимистической блокировки, подключаемые модули логического удаления, подключаемые модули распределенных транзакций и т. д., которые являются одними из наиболее часто используемых. расширения, и вы можете изучить их на официальном сайте самостоятельно.
CRUD
Затем я пишу набор основных операций CRUD.
// 查找
User user0 = userService.getById(1);
User user1 = userService.getOne(new QueryWrapper<User>()
.eq("username", "markerhub"));
System.out.println(user1.toString());
int pn = ServletRequestUtils.getIntParameter(req, "pn", 1);
int size = ServletRequestUtils.getIntParameter(req, "size", 2);
Page p = new Page(pn, size);
IPage page0 = userService.page(p, new QueryWrapper<User>()
.isNotNull("id")
.orderByDesc("created"));
System.out.println(page0.toString());
// 嵌套查询
IPage page1 = userService.page(p, new QueryWrapper<User>()
.inSql("id", "SELECT user_id FROM user_collection where post_id = 1")
);
// 增删改都是差不多，直接调用api
user0.setUsername("markerhub0");
userService.saveOrUpdate(user0);
userService.remove(new QueryWrapper<User>().eq("username", "markerhub0"));
Ключевым моментом выше является то, что на самом деле нужно научиться гибко использовать условный класс-оболочку QueryWrapper.
заключительные замечания
хорошо, это конец сегодняшней статьи Я кратко представил использование mybatis plus, и мне нужно изучить больше!
Добро пожаловать, чтобы обратить внимание на мой общедоступный номер:MarkerHub
Рекомендуемое чтение:Слишком жестоко! Загрузите 5000-страничное руководство по разработке основных учебных пособий по Java!