mybatis-plus有一个好处是一些简单的CRUD可以不用写xml,因为以前项目常用,基于若依框架改造时发现没有,不太习惯,故引入。
依赖版本:父pom的依赖申明dependencyManagement中引入,再在common模块中引入,使用是在业务模块,业务模块再依赖common模块。
<mybatisplus.version>3.2.0</mybatisplus.version>
<!--Mybatis-plus支持-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>${mybatisplus.version}</version>
<exclusions>
<exclusion>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
</exclusion>
</exclusions>
</dependency>
引入后调用任意默认的CRUD方法,诸如list()、getById()等方法,会报invalid bind statement(not found)。甚不解,不是说好不用写xml吗,怎么和说的不一样呢?
怀疑MybatisPlus没有自动启动,检查依赖确实使用的mybatis-plus-boot-starter没有问题。
源码跟踪MybatisPlusAutoConfiguration类,断点到sqlSessionFactory(DataSource dataSource) 方法发现此方法未执行。对比以前正常的mybatis-plus项目,启动时是会走这个方法的。
这个方法很重要,因为MybatisPlus是通过这个方法入口实现的自动加载默认CRUD方法,而实现的不用手写xml。
关键方法注入断点:AbstractMethod.inject 可以断点此方法跟踪。
/**
* 注入自定义方法
*/
public void inject(MapperBuilderAssistant builderAssistant, Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
this.configuration = builderAssistant.getConfiguration();
this.builderAssistant = builderAssistant;
this.languageDriver = configuration.getDefaultScriptingLanguageInstance();
/* 注入自定义方法 */
injectMappedStatement(mapperClass, modelClass, tableInfo);
}
继续寻找MybatisPlusAutoConfiguration.sqlSessionFactory未执行的原因。其带注解ConditionalOnMissingBean,即有此Bean则不执行此方法,此方法的Bean为SqlSessionFactory。
经查原系统配置中存在MyBatisConfig配置,产生过SqlSessionFactory。
@Configuration
public class MyBatisConfig
{
@Autowired
private Environment env;
static final String DEFAULT_RESOURCE_PATTERN = "**/*.class";
.....
@Bean
public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception
{
String typeAliasesPackage = env.getProperty("mybatis.typeAliasesPackage");
String mapperLocations = env.getProperty("mybatis.mapperLocations");
String configLocation = env.getProperty("mybatis.configLocation");
typeAliasesPackage = setTypeAliasesPackage(typeAliasesPackage);
VFS.addImplClass(SpringBootVFS.class);
final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
sessionFactory.setDataSource(dataSource);
sessionFactory.setTypeAliasesPackage(typeAliasesPackage);
sessionFactory.setMapperLocations(resolveMapperLocations(StringUtils.split(mapperLocations, ",")));
sessionFactory.setConfigLocation(new DefaultResourceLoader().getResource(configLocation));
return sessionFactory.getObject();
}
【解决方式】注释掉@Configuration
再次启动发现,可以正常加载MybatisPlusAutoConfiguration.sqlSessionFactory.
另引入mybatis-plus后,原mybatis配置就可以不要了。
#mybatis:
# # 搜索指定包别名
# typeAliasesPackage: com.ruoyi.**.domain
# # 配置mapper的扫描,找到所有的mapper.xml映射文件
# mapperLocations: classpath*:mapper/**/*Mapper.xml
# # 加载全局的配置文件
# configLocation: classpath:mybatis/mybatis-config.xml
改为
#mybatis
mybatis-plus:
mapper-locations: classpath*:mapper/**/*Mapper.xml
# config-location: classpath:mybatis/mybatis-config.xml
#实体扫描,多个package用逗号或者分号分隔
typeAliasesPackage: com.ruoyi.**.domain
global-config:
#数据库相关配置
db-config:
#主键类型 AUTO:"数据库ID自增", INPUT:"用户输入ID", ID_WORKER:"全局唯一ID (数字类型唯一ID)", UUID:"全局唯一ID UUID";
id-type: AUTO
logic-delete-value: -1
logic-not-delete-value: 0
banner: false
#原生配置
configuration:
map-underscore-to-camel-case: true
cache-enabled: false
call-setters-on-nulls: true
jdbc-type-for-null: 'null'
注意:要去掉 # config-location: classpath:mybatis/mybatis-config.xml 此配置,因为yml中的Configuration和mybatis-config文件的configruation配置是不能共存的。否则会报以下错误
Property 'configuration' and 'configLocation' can not specified with together
其他相关知识点:yml中的配置,一般在何处使用。
每个AutoConfiguration通常都会有一些配置参数,是可以开发给开发者进行配置的,以mybatis-plus为例
其配置使用点在MybatisPlusProperties.class
String MYBATIS_PLUS = "mybatis-plus";
@Data
@Accessors(chain = true)
@ConfigurationProperties(prefix = Constants.MYBATIS_PLUS)
public class MybatisPlusProperties {
}