springboot与mybatis-plus的整合
一、导入依赖
<!-- mybatis-plus 相关的jar -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.0</version>
</dependency>
<!-- 数据库与连接池 相关的jar -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.17</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.1.10</version>
</dependency>
<!-- mp自动生成 相关的jar -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.0</version>
</dependency>
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.2</version>
</dependency>
二、修改yml配置
mybatis-plus:
mapper-locations: classpath:mapping/*Mapper.xml
type-aliases-package: com.example.demo.entity
注意,整合后发现一个问题
发现写mybatus-plus自己的CRUD方法完全可以,但是执行之前自己的sql+接口映射报:org.apache.ibatis.binding.BindingException: Invalid bound statement (not found):的问题。问题在于application.yml中mybatis环境配置与mybatus-plus配置有冲突,应改为:用mybatis-plus的配置,这样就能扫描到mapper.xml
三、启动类加上扫描注解
@MapperScan("com.example.demo.mapper")
注意,这个注解是mybatis的mapper,也要吧mybatis的类扫描进来,不然类上加上@mapper。
四、逆向工程
注意,mp的逆向工程和mybaits的逆向工程不是同一个,mybatis的逆向工程是读取配置,而mp的逆向工程是全代码的。
public class GeneratorCodeConfig {
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 (StringUtil.isNotEmpty(ipt)) {
return ipt;
}
}
throw new MybatisPlusException("请输入正确的" + tip + "!");
}
public static void main(String[] args) {
// 代码生成器
AutoGenerator mpg = new AutoGenerator();
//选择默认模板引擎
// mpg.setTemplateEngine(new FreemarkerTemplateEngine());
// 全局配置
GlobalConfig gc = new GlobalConfig();
//读取配置里的user.dir
String projectPath = System.getProperty("user.dir");
gc.setOutputDir(projectPath+ "/activity-server/src/main");
gc.setAuthor("wzy");//作者
gc.setFileOverride(true);//多次生成是否覆盖
gc.setServiceName("%sService");//设置生成的service接口的名字的首字母是否为I
gc.setBaseResultMap(true);//设置生成的xml是否包含baseresultMap
gc.setBaseColumnList(true);//设置生成的xml是否包含列
gc.setOpen(false);
//实体属性 Swagger2 注解
gc.setSwagger2(false);
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setDbType(DbType.MYSQL);
dsc.setUrl("jdbc:mysql://192.168.0.206:3307/skf_ito?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC&allowPublicKeyRetrieval=true&verifyServerCertificate=false&useSSL=false&serverTimezone=GMT%2B8");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("123456");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
// pc.setModuleName(scanner("模块名"));
pc.setParent("java/com.xy.microservice.activityserver");
pc.setEntity("entity");
pc.setMapper("mapper");
pc.setService("service");
pc.setServiceImpl("service.impl");
pc.setController("controller");
pc.setXml("../mapping");
mpg.setPackageInfo(pc);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setCapitalMode(true);//全局大写命名
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
//实体类是否继承其他类,AR模式需要设置
// strategy.setSuperEntityClass("com.baomidou.mybatisplus.extension.activerecord.Model");
strategy.setEntityLombokModel(false);//实体类是否需要lombok形式
strategy.setRestControllerStyle(true);//controller是否需要rest注解
// 公共父类
// strategy.setSuperControllerClass("com.baomidou.ant.common.BaseController");
// 写于父类中的公共字段
// strategy.setSuperEntityColumns("id");
//设置mapper继承的类
// strategy.setSuperMapperClass("");
strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
strategy.setControllerMappingHyphenStyle(true);
strategy.setTablePrefix(pc.getModuleName() + "_");
mpg.setStrategy(strategy);
//
// // 自定义配置
// 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/mapping/" + pc.getModuleName()
// + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
// }
// });
//
// cfg.setFileCreate(new IFileCreate() {
// @Override
// public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
// // 判断自定义文件夹是否需要创建
// checkDir(projectPath + "/src/main/resources/mapping");
// return false;
// }
// });
//
// cfg.setFileOutConfigList(focList);
// mpg.setCfg(cfg);
// // 配置模板,我设置只生成entity,xml,mapper。其他不生成,利用自定义设置来生成
TemplateConfig templateConfig = new TemplateConfig();
// // 配置自定义输出模板
// //指定自定义模板路径,注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
// // templateConfig.setEntity("templates/entity2.java");
templateConfig.setService(null);
templateConfig.setController(null);
templateConfig.setServiceImpl(null);
//
// templateConfig.setXml(null);
mpg.setTemplate(templateConfig);
mpg.execute();
}
}
该有的注解都有了,但是有个缺陷
注意一点的是,逆向工程的xml路径有问题,没办法生成在resources里,他指定了生成路径,指定了src,后续xml的路径拼接就在src这里,指定java层面,那么包路径就有问题。所以解决办法就是生成xml后自己移动到resource。
注意,如果只想使用mybatis-plus的逆向工程,如果发现什么classnotfound这种错误,可能是你之前的工程的mp的版本冲突,笔者在一个模块单独引入这个模块,发现报错,然后分析依赖,发现父模块引入了2点几的版本mp,然后公共模块引入了mp的3点几版本的注释,这里注释要3.4
五、设置公共字段填充
我们这里的实体类都有个create_by,create_date,update_by,update_date,remarks,version,del_flag这几个字段。
那么我们进行更新和插入,删除,修改操作的时候,都需要自己手动设置值,这样比较繁琐,好点也就是添加个反射工具类,mp提供了公共字段填充,其实就是插件执行前,执行你配置的对象处理器,然后再进行操作,不过是将反射工具类注册到了插件里。没啥东西。
1.创建填充处理器:MetaObjectHandlerConfig
@Slf4j
@Service
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
private static final Logger LOGGER = LoggerFactory.getLogger(MyMetaObjectHandler.class);
private static final String UPDATE_BY = "updateBy";
private static final String CREATE_BY = "createBy";
private static final String CREATE_DATE = "createDate";
private static final String UPDATE_DATE = "updateDate";
private static final String DEL_FLAG = "delFlag";
private static final String ID = "id";
public static final String DEL_FLAG_VAL = "0";
/**
* 插入时自动填充
*
* @param metaObject
*/
@Override
public void insertFill(MetaObject metaObject) {
//取出当前参数值
LoginUser currentUser = UserUtils.getCurrentUser();
Object createBy = getFieldValByName(CREATE_BY, metaObject);
Object updateBy = getFieldValByName(UPDATE_BY, metaObject);
Object id = getFieldValByName(ID, metaObject);
//有时候可能这些数据会被设置 所以做一个判空操作 因为对象类型是Object 所以用null判空
if (createBy == null) {
this.setFieldValByName(CREATE_BY, currentUser.getId(), metaObject);
}
if (updateBy == null) {
this.setFieldValByName(UPDATE_BY, currentUser.getId(), metaObject);
}
if (id.equals("0")) {
this.setFieldValByName(ID, IdGen.uuid(), metaObject);
}
this.setFieldValByName(CREATE_DATE, new Date(), metaObject);
this.setFieldValByName(UPDATE_DATE, new Date(), metaObject);
this.setFieldValByName(DEL_FLAG, DEL_FLAG_VAL, metaObject);
}
/**
* 更新时自动填充
*
* @param metaObject
*/
@Override
public void updateFill(MetaObject metaObject) {
LoginUser currentUser = UserUtils.getCurrentUser();
this.setFieldValByName(UPDATE_DATE, new Date(), metaObject);
this.setFieldValByName(UPDATE_BY, currentUser.getId(), metaObject);
}
}
2.配置填充处理器:
@EnableTransactionManagement
@Configuration
@MapperScan(basePackages = "com.xy.microservice.contractserver.mapper", sqlSessionFactoryRef = "sysSqlSessionFactory")
public class DataSourceConfig {
@Value("${spring.datasource.data-username}")
private String username;
@Value("${spring.datasource.data-password}")
private String password;
@Value("${spring.datasource.url}")
private String jdbcurl;
@Value("${spring.datasource.driver-class-name}")
private String jdbcdriver;
@Bean
public DataSource dataSource() {
DruidDataSource druidDataSource = new DruidDataSource();
druidDataSource.setUsername(username);
druidDataSource.setPassword(password);
druidDataSource.setUrl(jdbcurl);
druidDataSource.setDriverClassName(jdbcdriver);
return druidDataSource;
}
//配置MetaObjectHandler
@Bean
public MyMetaObjectHandler metaObjectHandler() {
return new MyMetaObjectHandler();
}
@Bean(name = "sysSqlSessionFactory")
public SqlSessionFactory sqlSessionFactory() throws Exception {
MybatisSqlSessionFactoryBean sqlSessionFactory = new MybatisSqlSessionFactoryBean();
//加载数据源
sqlSessionFactory.setDataSource(dataSource());
MybatisConfiguration configuration = new MybatisConfiguration();
//驼峰标识
configuration.setMapUnderscoreToCamelCase(true);
configuration.setCacheEnabled(false);
configuration.setCallSettersOnNulls(true);
sqlSessionFactory.setConfiguration(configuration);
String mapperLocations = "classpath*:XMLMapper/*Mapper.xml";
PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
sqlSessionFactory.setMapperLocations(resolver.getResources(mapperLocations));
sqlSessionFactory.setPlugins(new Interceptor[]{pageInterceptor()});
sqlSessionFactory.setTypeHandlers(typeHandler());
//全局配置
GlobalConfig globalConfig = new GlobalConfig();
globalConfig.setMetaObjectHandler(metaObjectHandler());
globalConfig.setSqlInjector(new SqlInjectionHangler());
sqlSessionFactory.setGlobalConfig(globalConfig);
return sqlSessionFactory.getObject();
}
@Bean
public TypeHandler<?>[] typeHandler() {
return new TypeHandler[]{new DecimalTypeHandler()};
}
@Bean
public PaginationInterceptor paginationInterceptor(){
return new PaginationInterceptor();
}
@Bean
public PageInterceptor pageInterceptor() {
PageInterceptor pageInterceptor = new PageInterceptor();
Properties p = new Properties();
p.setProperty("offsetAsPageNum", "true");
p.setProperty("rowBoundsWithCount", "true");
p.setProperty("reasonable", "true");
pageInterceptor.setProperties(p);
return pageInterceptor;
}
@Bean(name = "transactionTemplate")
public TransactionTemplate getTransactionTemplate() {
TransactionTemplate transactionTemplate = new TransactionTemplate();
transactionTemplate.setTimeout(30000);
transactionTemplate.setTransactionManager(getTransactionManager());
return transactionTemplate;
}
@Bean(name = "TransactionManager")
public DataSourceTransactionManager getTransactionManager() {
return new DataSourceTransactionManager(dataSource());
}
}
这个可能繁琐了点,自己配置了数据源,其实没必要
@Configuration
public class MyBatisPlusCofig {
@Bean
public MybatisSqlSessionFactoryBean sqlSessionFactory( DataSource dataSource) throws IOException {
MybatisSqlSessionFactoryBean mybatisPlus = new MybatisSqlSessionFactoryBean();
//加载数据源
mybatisPlus.setDataSource(dataSource);
//全局配置
GlobalConfig globalConfig = new GlobalConfig();
//配置填充器
globalConfig.setMetaObjectHandler(new MetaObjectHandlerConfig());
mybatisPlus.setGlobalConfig(globalConfig);
return mybatisPlus;
}
}
3.使用的时候,设置填充字段的填充注解
@TableField(fill = FieldFill.INSERT)
private Date createDate;
六、Mapper可以自己定义吗
Mp提供了自定义全局操作,允许用户可以自写注册接口方法,那么就有很大的操作空间了
一.我们可以自己写通用的mapper方法。比如说,删除所有数据,想象力匮乏,比如说,批量更新?
(1)操作方法:在 Mapper 接口中定义相关的 CRUD 方法。
public interface MyMapper<T> extends BaseMapper<T> {
int deleteAll();
}
自定义接口继承mp的baseMapper,那么后续接口的继承可以直接继承我们的mapper,可以直接使用定义的方法。
(2)扩展 AutoSqlInjector inject 方法,实现 Mapper 接口中方法要注入的 SQL。
/**
* 自定义全局操作
*/
public class MySqlInjector extends AutoSqlInjector{
/**
* 扩展inject 方法,完成自定义全局操作
*/
@Override
public void inject(Configuration configuration, MapperBuilderAssistant builderAssistant, Class<?> mapperClass,
Class<?> modelClass, TableInfo table) {
//将EmployeeMapper中定义的deleteAll,处理成对应的MappedStatement对象,加入到configuration对象中。
//注入的SQL语句
String sql = "delete from " +table.getTableName();
//注入的方法名一定要与EmployeeMapper接口中的方法名一致
String method = "deleteAll" ;
//构造SqlSource对象
SqlSource sqlSource = languageDriver.createSqlSource(configuration, sql, modelClass);
//构造一个删除的MappedStatement
this.addDeleteMappedStatement(mapperClass, method, sqlSource);
}
}
(3)在 MybatisPlus 全局策略中,配置自定义注入器。
//全局配置
GlobalConfig globalConfig = new GlobalConfig();
globalConfig.setMetaObjectHandler(metaObjectHandler());
globalConfig.setSqlInjector(new SqlInjectionHangler());
sqlSessionFactory.setGlobalConfig(globalConfig);
二.我们可以重写basemapper的方法,比如讲删除操作替换为逻辑删除。已经有实现类了。自定义注入器的应用之逻辑删除
\https://blog.csdn.net/lizhiqiang1217/article/details/89740680\
@Component
public class SqlInjectionHangler extends DefaultSqlInjector {
@Override
public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
List<AbstractMethod> methodList = super.getMethodList(mapperClass);
methodList.add(new LogicDeleteByIdWithFill());
return methodList;
七、插件的使用
Mybatis 通过插件(Interceptor) 可以做到拦截四大对象相关方法的执行,根据需求,完成相关数据的动态改变。
四大对象的每个对象在创建时,都会执行 interceptorChain.pluginAll(),会经过每个插件对象的 plugin()方法,目的是为当前的四大对象创建代理。代理对象就可以拦截到四大对象相关方法的执行,因为要执行四大对象的方法需要经过代理.
那么我们就可以拦截自己的sql方法,替换为自己拼接的sql。
具体应用:乐观锁插件
但是我们需要知道的是,拦截的是mybatis的方法,所以其实就是说拦截的myabtis的操作,mp的方法也会拦截哦。顺序是先自定义操作,注册了操作,然后插件拦截。
八、个性化使用
我们的数据库规范是每个表都有create_by,create_date,update_by,
update_date,remarks,version,del_flag这几个字段,
那么功能就有,乐观锁,设置公共字段填充,逻辑删除
推荐注册乐观锁插件,重新定义basemapper的删除替换为逻辑删除
我推荐是,抽象出一个实体类,拥有这几个字段,后续的实体类继承这个类,并且抽象出一个自定义的mapper,方便后续写通用的接口方法。
public class MyEntity {
@TableField(fill = FieldFill.INSERT)
protected String createBy;
@TableField(fill = FieldFill.INSERT)
protected Date createDate;
@TableField(fill = FieldFill.INSERT_UPDATE)
protected String updateBy;
@TableField(fill = FieldFill.INSERT_UPDATE)
protected Date updateDate;
@Version
@TableField(fill = FieldFill.INSERT)
protected Integer version;
protected String remarks;
@TableLogic
@TableField(fill = FieldFill.INSERT)
protected String delFlag;
}
/**
* @NAME MyBaseMapper
* @DATE 2020-08-19 19:56
* @AUTHOR Zheng Jianhong
* @DESC 这里做这个是之后
* 我们可能需要sql注入器去写一下我们自己的sql
* 所以我们单独写一个出来 当然可以不写
**/
public interface MyBaseMapper<T> extends BaseMapper<T> {
/**
* 填充更新时间式逻辑删除
* @param entity
* @return
*/
int deleteByIdWithFill(T entity);
}
逆向工程支持实体类继承某个类,也支持mapper继承某个类。
strategy.setSuperEntityClass("com.example.demo.config.MyEntity");
strategy.setSuperMapperClass("com.example.demo.config.MyMapper");
后续观感
使用后感观:
妈的,我本来以为mybatis-plus没有tkmapper香的,结果我自己整合了一下发现,我们的原来那个框架的service和mybaits-plus的自动生成的很像,也是这个原理。所以,反而是mybatis-plus受众广,插件多。我自己写了以后,发现真香。主要是mybatis-plus提供了很多插件。都很不错的。
mp的条件构造器好像比tkmapper的条件构造器好点
我们这里的实体类都有个create_by,create_date,update_by,
update_date,remarks,version,del_flag这几个字段。
那么我们进行更新和插入,删除,修改操作的时候,都需要自己手动设置值,这样比较繁琐,好点也就是添加个反射工具类。
但是mp提供了公共字段填充,就是说你指定某个类的某个属性,如果进行了insert或者update操作的时候,帮你填充,那么create_by,create_date,update_by,update_date,remarks,version,del_flag这些我就可以之间不用处理,交给mp来填充了。
其实就是插件执行前,执行你配置的对象处理器,然后再进行操作,不过是将反射工具类注册到了插件里,但是这个口子留的很好。
然后version这个字段的话,平常可以加个乐观锁,如果我们自己写的话,就是更新的时候,比较更新的对象和原来的对象的version是否改变,但是现在有乐观锁插件,也可以无感的操作