MyBatis 添加元數(shù)據(jù)自定義元素標簽的實現(xiàn)代碼
更新時間：2020年07月24日 11:07:02 作者：小王886
這篇文章主要介紹了MyBatis 添加元數(shù)據(jù)自定義元素標簽的實現(xiàn)代碼，本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下
開發(fā)背景
現(xiàn)有系統(tǒng)中維護了一套業(yè)務表相關列、鍵的元數(shù)據(jù)，希望通過讀取元數(shù)據(jù)實現(xiàn)自動封裝 SQL 語句、自定義主鍵策略。實現(xiàn)方案為入侵式修改 MyBatis，增加元素標簽meta，支持業(yè)務開發(fā)中可以在XML映射文件中使用。
meta元素設計如下：
<!-- meta標簽 可根據(jù)參數(shù)獲取到對應的表名 動態(tài)生成語句 --> <!ELEMENT meta EMPTY> <!ATTLIST meta test CDATA #IMPLIED type (update|insert|select|columns|pk-col|load|load-columns) #IMPLIED ignore CDATA #IMPLIED table CDATA #IMPLIED func CDATA #IMPLIED alias CDATA #IMPLIED >
期望示例如下：
<insert id="insertMap" useGeneratedKeys="true" generator="meta">
<meta table="USER" type="insert"/>
</insert>
<update id="updateMap">
<meta table="USER" type="update"/>
</update>
<select id="selectOneByPk" resultType="java.util.HashMap">
select
<meta table="USER" type="columns"/>
from USER
where <meta table="USER" type="pk-col"/> = #{__PK_VALUE}
</select>
開發(fā)準備
新建項目并引入 mybatis 、 mybatis-spring 兩個核心依賴。
<!-- mybatis --> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> </dependency> <!-- mybatis-spring --> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis-spring</artifactId> </dependency>
增加自定義元素
創(chuàng)建 MetaHandler 和 MetaSqlNode
public class MetaHandler implements NodeHandler {
private final CustomConfiguration configuration;
protected MetaHandler(CustomConfiguration configuration) {
this.configuration = configuration;
}
@Override
public void handleNode(XNode nodeToHandle, List<SqlNode> targetContents) {
final String test = nodeToHandle.getStringAttribute("test");
final String type = nodeToHandle.getStringAttribute("type");
final String ignore = nodeToHandle.getStringAttribute("ignore");
final String table = nodeToHandle.getStringAttribute("table");
final String func = nodeToHandle.getStringAttribute("func");
String alias = nodeToHandle.getStringAttribute("alias");
if (!StringUtils.isEmpty(alias)) {
alias = alias.trim();
//是否無效 防止注入
boolean invalid = alias.contains(" ") || alias.contains(".");
if (invalid) {
throw new RuntimeException("alias is invalid : " + alias);
}
}
MetaSqlNode metaSqlNode = new MetaSqlNode(configuration, test, type, ignore, table, func, alias);
targetContents.add(metaSqlNode);
}
}
public class MetaSqlNode implements SqlNode {
/**
* mybatis核心數(shù)據(jù)
*/
private final CustomConfiguration configuration;
/**
* 判斷語句校驗器
*/
private final ExpressionEvaluator evaluator;
/**
* 判斷語句,同if標簽
*/
private final String test;
/**
* 生成語句類型 update|insert|select|columns|pk-col|load|load-columns
*/
private final TypeEnum type;
/**
* 忽略的列
*/
private final String ignore;
/**
* 表名，未指定則從調用參數(shù)中獲取
*/
private final String table;
/**
* 功能，未指定則從調用參數(shù)中獲取
*/
private final String func;
/**
* 動態(tài)列別名
*/
private final String alias;
public MetaSqlNode(CustomConfiguration configuration, String test, String type, String ignore, String table, String func, String alias) {
this.evaluator = new ExpressionEvaluator();
this.configuration = configuration;
this.test = test;
this.type = TypeEnum.parse(type);
this.ignore = ignore;
this.table = table;
this.func = func;
this.alias = alias;
}
@Override
public boolean apply(DynamicContext context) {
// TODO 解析type與table，向context中添加語句
context.appendSql(" insert ······ ");
}
}
創(chuàng)建 CustomXMLScriptBuilder
內容復制自org.apache.ibatis.scripting.xmltags.XMLScriptBuilder，在 initNodeHandlerMap 方法中添加 MetaHandler。
private void initNodeHandlerMap() {
nodeHandlerMap.put("trim", new TrimHandler());
nodeHandlerMap.put("where", new WhereHandler());
nodeHandlerMap.put("set", new SetHandler());
nodeHandlerMap.put("foreach", new ForEachHandler());
nodeHandlerMap.put("if", new IfHandler());
nodeHandlerMap.put("choose", new ChooseHandler());
nodeHandlerMap.put("when", new IfHandler());
nodeHandlerMap.put("otherwise", new OtherwiseHandler());
nodeHandlerMap.put("bind", new BindHandler());
//增加元數(shù)據(jù)標簽解析器
if (configuration instanceof CustomConfiguration) {
nodeHandlerMap.put("meta", new MetaHandler((CustomConfiguration) configuration));
}
}
創(chuàng)建 CustomXMLLanguageDriver
內容復制自org.apache.ibatis.scripting.xmltags.XMLLanguageDriver，在 createSqlSource 方法中使用 CustomXMLScriptBuilder 來解析Xml生成 SqlSource。
@Override
public SqlSource createSqlSource(Configuration configuration, XNode script, Class<?> parameterType) {
CustomXMLScriptBuilder builder = new CustomXMLScriptBuilder(configuration, script, parameterType);
return builder.parseScriptNode();
}
創(chuàng)建 CustomConfiguration
繼承org.apache.ibatis.session.Configuration，內容復制自 Configuration。將構造方法中的 XMLLanguageDriver 修改為 CustomConfiguration。
public CustomConfiguration() {
······
//默認使用自定義 LanguageDriver
typeAliasRegistry.registerAlias("XML", CustomXMLLanguageDriver.class);
······
//默認使用自定義 LanguageDriver
languageRegistry.setDefaultDriverClass(CustomXMLLanguageDriver.class);
······
}
創(chuàng)建 CustomXMLConfigBuilder
內容復制自org.apache.ibatis.builder.xml.XMLConfigBuilder，支持通過 XML 配置來創(chuàng)建 CustomConfiguration。
public class CustomXMLConfigBuilder extends BaseBuilder {
······
private CustomXMLConfigBuilder(XPathParser parser, String environment, Properties props) {
// 使用 CustomConfiguration
super(new CustomConfiguration());
ErrorContext.instance().resource("SQL Mapper Configuration");
this.configuration.setVariables(props);
this.parsed = false;
this.environment = environment;
this.parser = parser;
}
······
}
創(chuàng)建 SqlSessionFactory
復制自org.mybatis.spring.SqlSessionFactoryBean，將 buildSqlSessionFactory 方法中的 Configuration 替換為 CustomConfiguration。
protected SqlSessionFactory buildSqlSessionFactory() throws Exception {
final Configuration targetConfiguration;
CustomXMLConfigBuilder xmlConfigBuilder = null;
if (this.configuration != null) {
targetConfiguration = this.configuration;
if (targetConfiguration.getVariables() == null) {
targetConfiguration.setVariables(this.configurationProperties);
} else if (this.configurationProperties != null) {
targetConfiguration.getVariables().putAll(this.configurationProperties);
}
} else if (this.configLocation != null) {
// 使用 CustomXMLConfigBuilder 創(chuàng)建 CustomConfiguration
xmlConfigBuilder = new CustomXMLConfigBuilder(this.configLocation.getInputStream(), null, this.configurationProperties);
targetConfiguration = xmlConfigBuilder.getConfiguration();
} else {
LOGGER.debug(
() -> "Property 'configuration' or 'configLocation' not specified, using default MyBatis Configuration");
// 使用 CustomConfiguration
targetConfiguration = new CustomConfiguration();
Optional.ofNullable(this.configurationProperties).ifPresent(targetConfiguration::setVariables);
}
······
return this.sqlSessionFactoryBuilder.build(targetConfiguration);
}
修改DTD約束
MyBatis 的約束文件并不支持自定義的 meta 元素，需要使用 CDATA 來處理。示例如下：
<insert id="insertMap" useGeneratedKeys="true" generator="meta"> <![CDATA[[ <meta table="USER" type="insert"/> ]]> </insert>
如果不想要 CDATA，則需要通過修改DTD約束來完成。
- 在 classes 下指定位置添加DTD約束文件org/apache/ibatis/builder/xml/mybatis-3-config.dtd達到覆蓋 MyBatis DTD的效果。
- 重寫代碼來使用指定 DTD 。
創(chuàng)建 CustomXMLMapperEntityResolver
復制自org.apache.ibatis.builder.xml.XMLMapperEntityResolver，將MYBATIS_MAPPER_DTD修改為指向本地 mybatis-3-mapper.dtd 文件，并在DTD文件中添加 meta 元素的約束。
public class CustomXMLMapperEntityResolver implements EntityResolver {
······
private static final String MYBATIS_MAPPER_DTD = "com/my/ibatis/builder/xml/mybatis-3-mapper.dtd";
······
}
<!-- meta標簽 可根據(jù)參數(shù)獲取到對應的表名 動態(tài)生成語句 --> <!ELEMENT meta EMPTY> <!ATTLIST meta test CDATA #IMPLIED type (update|insert|select|columns|pk-col|load|load-columns) #IMPLIED ignore CDATA #IMPLIED table CDATA #IMPLIED func CDATA #IMPLIED alias CDATA #IMPLIED >
CustomXMLLanguageDriver
Mapper動態(tài)語句注解處理使用 CustomXMLMapperEntityResolver。
/**
* Mapper動態(tài)語句注解調用
* <p>
* "<script>select * from user <if test=\"id !=null \">where id = #{id} </if></script>"
*
* @param configuration mybatis配置
* @param script 動態(tài)語句字符串
* @param parameterType 參數(shù)類型
* @return org.apache.ibatis.mapping.SqlSource
*/
@Override
public SqlSource createSqlSource(Configuration configuration, String script, Class<?> parameterType) {
// issue #3
if (script.startsWith("<script>")) {
//將動態(tài)語句字符串轉換為XNode對象
XPathParser parser = new XPathParser(script, false, configuration.getVariables(), new CustomXMLMapperEntityResolver());
return createSqlSource(configuration, parser.evalNode("/script"), parameterType);
} else {
// issue #127
script = PropertyParser.parse(script, configuration.getVariables());
TextSqlNode textSqlNode = new TextSqlNode(script);
if (textSqlNode.isDynamic()) {
return new CustomDynamicSqlSource(configuration, textSqlNode);
} else {
return new RawSqlSource(configuration, script, parameterType);
}
}
}
創(chuàng)建 CustomXMLMapperBuilder
復制自org.apache.ibatis.builder.xml.XMLMapperBuilder，修改構造函數(shù)使用 CustomXMLMapperEntityResolver 解析xml。
public CustomXMLMapperBuilder(InputStream inputStream, Configuration configuration, String resource, Map<String, XNode> sqlFragments) {
this(new XPathParser(inputStream, true, configuration.getVariables(), new CustomXMLMapperEntityResolver()),
configuration, resource, sqlFragments);
}
SqlSessionFactory
修改 buildSqlSessionFactory 方法，使用 CustomXMLMapperBuilder 來解析xml。
protected SqlSessionFactory buildSqlSessionFactory() throws Exception {
······
try {
//使用自定義 XMLMapperBuilder
CustomXMLMapperBuilder xmlMapperBuilder = new CustomXMLMapperBuilder(mapperLocation.getInputStream(),
targetConfiguration, mapperLocation.toString(), targetConfiguration.getSqlFragments());
xmlMapperBuilder.parse();
} catch (Exception e) {
throw new NestedIOException("Failed to parse mapping resource: '" + mapperLocation + "'", e);
} finally {
ErrorContext.instance().reset();
}
······
}
創(chuàng)建 CustomMapperAnnotationBuilder
復制自org.apache.ibatis.builder.annotation.MapperAnnotationBuilder，修改 loadXmlResource 方法使用 CustomXMLMapperBuilder。
private void loadXmlResource() {
if (!configuration.isResourceLoaded("namespace:" + type.getName())) {
······
if (inputStream != null) {
//使用自定義解析器支持自定義標簽
CustomXMLMapperBuilder xmlParser = new CustomXMLMapperBuilder(inputStream, assistant.getConfiguration(), xmlResource, configuration.getSqlFragments(), type.getName());
xmlParser.parse();
}
}
}
創(chuàng)建 CustomMapperRegistry
復制自org.apache.ibatis.binding.MapperRegistry，修改 addMapper 方法使用 CustomMapperAnnotationBuilder。
@Override
public <T> void addMapper(Class<T> type) {
if (type.isInterface()) {
······
try {
knownMappers.put(type, new MapperProxyFactory<>(type));
// It's important that the type is added before the parser is run
// otherwise the binding may automatically be attempted by the
// mapper parser. If the type is already known, it won't try.
CustomMapperAnnotationBuilder parser = new CustomMapperAnnotationBuilder(config, type);
parser.parse();
loadCompleted = true;
} finally {
if (!loadCompleted) {
knownMappers.remove(type);
}
}
}
}
CustomConfiguration
修改 mapperRegistry 屬性使用 CustomMapperRegistry。
public class CustomConfiguration extends Configuration {
······
protected final MapperRegistry mapperRegistry = new CustomMapperRegistry(this);
······
}
在Spring中使用
<!-- Mybatis SessionFactory--> <bean id="sqlSessionFactory" class="com.my.ibatis.SqlSessionFactoryBean"> <property name="dataSource" ref="dataSource" /> <property name="configurationProperties" > <bean class="org.springframework.beans.factory.config.PropertiesFactoryBean"> <property name="locations" value="classpath*:mybatis.properties"/> </bean> </property> </bean>
@Configuration
public class MybatisConfig {
@Bean
public PropertiesFactoryBean createPropertiesFactoryBean() throws IOException {
PropertiesFactoryBean bean = new PropertiesFactoryBean();
bean.setLocation(new ClassPathResource("mybatis.properties"));
return bean;
}
@Bean("sqlSessionFactory")
public SqlSessionFactoryBean createSqlSessionFactory(DataSource dataSource, PropertiesFactoryBean bean) throws IOException {
SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
factoryBean.setDataSource(dataSource);
factoryBean.setConfigurationProperties(bean.getObject());
return factoryBean;
}
}
到此這篇關于MyBatis 添加元數(shù)據(jù)自定義元素標簽的實現(xiàn)代碼的文章就介紹到這了,更多相關MyBatis自定義元素標簽內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
這篇文章主要為大家詳細介紹了java文件處理工具類的相關資料，具有一定的參考價值，感興趣的小伙伴們可以參考一下2019-04-04
在RedisTemplate中使用scan代替keys指令操作
這篇文章主要介紹了在RedisTemplate中使用scan代替keys指令操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-11-11
這篇文章主要介紹了C# log4net使用案例詳解,本篇文章通過簡要的案例,講解了該項技術的了解與使用,以下就是詳細內容,需要的朋友可以參考下2021-08-08
Java畢業(yè)設計實戰(zhàn)之線上水果超市商城的實現(xiàn)
這是一個使用了java+SSM+springboot+redis開發(fā)的網(wǎng)上水果超市商城，是一個畢業(yè)設計的實戰(zhàn)練習，具有水果超市商城該有的所有功能，感興趣的朋友快來看看吧2022-01-01
小伙熬夜用Java重現(xiàn)經(jīng)典超級馬里奧代碼實例
這篇文章主要介紹了Java重現(xiàn)經(jīng)典超級馬里奧，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2019-04-04
Java使用Tinify實現(xiàn)圖片無損壓縮(4M無損壓縮到1M)的方法
在當今的數(shù)字化時代,圖片已成為網(wǎng)站、應用和社交媒體中不可或缺的元素,然而,大尺寸的圖片不僅會增加頁面或者客戶端加載時間,還會占用大量的存儲空間,本文將詳細介紹如何利用Tinify壓縮圖片,并將其上傳至OSS,重點介紹圖片壓縮實現(xiàn)方式,需要的朋友可以參考下2024-08-08
本篇文章主要介紹了Java使用強大的Elastisearch搜索引擎實例代碼，具有一定的參考價值，有興趣的可以了解一下2017-05-05
這篇文章主要介紹了XML解析四種方式代碼示例詳解,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-12-12
slf4j?jcl?jul?log4j1?log4j2?logback各組件系統(tǒng)日志切換
這篇文章主要介紹了slf4j、jcl、jul、log4j1、log4j2、logback的大總結，各個組件的jar包以及目前系統(tǒng)日志需要切換實現(xiàn)方式的方法，有需要的朋友可以借鑒參考下2022-03-03
Springboot集成Elasticsearch的步驟與相關功能
ElasticSearch是開源搜索平臺領域的一個新成員,?ElasticSearch是一個基于Lucene構建的開源,分布式,RESTful搜索引擎,這篇文章主要給大家介紹了關于Springboot集成Elasticsearch的相關資料,需要的朋友可以參考下2021-12-12